Curvenote CLI

Settings and file association

Change these in the VS Code Settings editor (search for Curvenote), or in settings.json; a workspace’s .vscode/settings.json changes them for one project.

Setting	Default	What it does
`curvenote.checkFormatting`	`true`	Show a hint when a file isn’t in its canonical formatting.
`curvenote.frontmatter.checkRecords`	`true`	Look up ORCID iDs and ROR IDs, check names and places against them, and show them on hover.
`curvenote.frontmatter.forms`	`{}`	Whether a picked key is written as a single value (`license:` ) or opens its fields; see below.
`curvenote.trace.server`	`off`	Trace the communication with the language server, for reporting an issue.

curvenote.frontmatter.forms takes keys by type.key, by key, or * for every key and *[] for every list: { "person.name": "object" } writes a person’s name as given and family, and { "*": "object" } opens every key’s fields. Settings from before the extension was renamed (remyst.*) are still read.

File association¶

The extension opens .md and .myst files as MyST, and works in myst.yml and curvenote.yml too. MyST is a superset of Markdown, so plain Markdown files work as they are. They are formatted on save too, which this turns off:

{
  "[myst]": { "editor.formatOnSave": false },
}

To keep .md files as plain Markdown (for VS Code’s Markdown preview, or another Markdown extension), add this to your settings, or to a workspace’s .vscode/settings.json for one project:

{
  "files.associations": { "*.md": "markdown" },
}

.myst files stay MyST either way. To open one .md file as the other language, use Change Language Mode in the status bar. The Curvenote CLI reads .md files as MyST whichever language VS Code uses.

Abbreviations¶

MyST: Markedly Structured Text