Reference

This page lists every setting and command the extension contributes, grouped by purpose. Each name links to its full entry in the User Manual, with its default and examples.

Note

Every setting’s fully qualified name begins with ceedlingExplorer.. As an example, projects below is ceedlingExplorer.projects in settings.json. Command IDs begin with the same slug.

Projects

• mixins — Ceedling mixins for every project without its own
• projects — The Ceedling projects in a workspace folder
  • debugLaunchConfig — The launch.json configuration that debugs the project
  • mixins — The project’s own mixins, in place of mixins above
  • name — The project’s label in the Testing view
  • path — The project’s directory or YAML file

Running Ceedling

• ansiEscapeSequencesRemoved — Remove terminal colors from Ceedling’s output
• ceedlingCommand — The command that runs Ceedling
• shellPath — The shell Ceedling runs in
• testCommandArgs — Ceedling’s arguments for a test run

Test labels

• prettyTestFileLabel — Shorten each test file’s label
• prettyTestLabel — Shorten each test’s label

Code coverage

• coverageCommandArgs — Ceedling’s arguments for a coverage run
• coverageResetsCounters — Clear earlier runs’ coverage before each coverage run

Problem matching

• problemMatching — Report compiler and linker problems in the editor
  • mode — Off, the gcc preset, or custom patterns
  • patterns — The custom patterns

Pattern properties

Each custom pattern in problemMatching.patterns is an object with these properties. Only regexp, message, and file are required.

• column — The capture group holding the first column
• file — The capture group holding the file
• filePrefix — Prepended to a relative file path
• lastColumn — The capture group holding the last column
• lastLine — The capture group holding the last line
• line — The capture group holding the first line
• message — The capture group holding the message
• regexp — The regular expression matching a problem line
• scanStderr — Scan Ceedling’s stderr
• scanStdout — Scan Ceedling’s stdout
• severity — The severity of the problems found

Commands

• clean — Run ceedling clean in every project
• clobber — Run ceedling clobber in every project