Check Plugin
Documenting all checks¶
You can list all checks with the check directive:
:::{curvenote:check}
:::Referencing checks inline¶
You can reference specific checks inline (or their options) with the check role: {curvenote:check}`Max Abstract Length <abstract-length.max>`, for example see Max Abstract Length
Documenting one specific checks¶
You can also specify individual checks by id:
:::{curvenote:check} abstract-length
:::Documenting filtered checks¶
You can specify category and/or source values to filter checks. Currently the only source values are 'myst' and 'curvenote'; there are may category values - these show up in the documented checks.
:::{curvenote:check}
:category: code
:source: myst
:::Checks¶
The following are all available checks:
Abstract Exists¶
abstractabstract-existsEnsure abstract exists in MyST project
Abstract Length¶
abstractabstract-lengthEnsure abstract in MyST project is the correct length
- Options
- max (string, required)
Maximum word count for abstract
Availability Statement Exists¶
availabilityavailability-existsEnsure availability statement exists in MyST project
Citation is unique¶
citationcitation-is-uniqueCitation does not have any duplicate identifiers in the MyST project.
Bib file exists¶
citationbib-file-existsBib file referenced in config file exists in the MyST project.
MyST citation checks pass¶
citationmyst-citationNo citation-related errors or warnings are produced during MyST build.
Code metadata lifted¶
codecode-metadata-liftedMetadata defined on code is lifted to blocks; often failures are associated with multiple code metadata definitions within one block.
Code metatags valid¶
codecode-metatags-validTags in code metadata must be a list of strings, and they must not conflict with each other.
Code lang defined¶
codecode-lang-definedCode blocks should define their language
Code metadata loads¶
codecode-metadata-loadsCode metadata must be valid yaml.
Inline expression renders¶
codeinline-expression-rendersInline expression must be a recognized mime bundle.
MyST code checks pass¶
codemyst-codeNo code-related errors or warnings are produced during MyST build.
Known Directive¶
directivedirective-knownCheck if directive is recognized.
Directive Argument Validates¶
directivedirective-argument-correctArgument is valid, according to the rules of the specific directive.
Directive Options Validate¶
directivedirective-options-correctOptions are valid, according to the rules of the specific directive.
Directive Body Validates¶
directivedirective-body-correctBody is valid, according to the rules of the specific directive.
MyST directive checks pass¶
directivemyst-directiveNo directive-related errors or warnings are produced during MyST build.
DOCX Renders Successfully¶
exportdocx-rendersThe document renders to DOCX format without errors.
JATS Renders Successfully¶
exportjats-rendersThe document renders to JATS format without errors.
Markdown Renders Successfully¶
exportmd-rendersThe document renders to Markdown format without errors.
MECA Includes JATS¶
exportmeca-includes-jatsMECA bundle includes a single JATS document.
MECA Includes Manuscripts¶
exportmeca-exports-builtManuscript files (pdf, docx, etc) are built and included in MECA bundle.
MECA Includes Files¶
exportmeca-files-copiedFiles are copied successfully to MECA bundle.
PDF Builds Without Errors¶
exportpdf-builds-without-errorsPDF generation completes without errors.
PDF Builds Successfully¶
exportpdf-buildsThe document builds to PDF format without errors.
TeX Renders Successfully¶
exporttex-rendersThe document renders to TeX format without errors.
Export Extension Correct¶
exportexport-extension-correctThe exported file has the correct file extension.
Exported Article Exists¶
exportexport-article-existsThe exported article exists as expected.
MyST export checks pass¶
exportmyst-exportNo export-related errors or warnings are produced during MyST build.
Valid Config Structure¶
frontmattervalid-config-structureThe configuration file has a valid structure.
Site Config Exists¶
frontmattersite-config-existsThe site configuration file exists.
Project Config Exists¶
frontmatterproject-config-existsThe project configuration file exists.
Valid Site Config¶
frontmattervalid-site-configThe site configuration is valid.
Valid Project Config¶
frontmattervalid-project-configThe project configuration is valid.
Config Has No Deprecated Fields¶
frontmatterconfig-has-no-deprecated-fieldsThere are no deprecated fields in the configuration file.
Frontmatter Is YAML¶
frontmatterfrontmatter-is-yamlThe frontmatter format is YAML.
Valid Page Frontmatter¶
frontmattervalid-page-frontmatterThe page frontmatter is valid.
Valid Export List¶
frontmattervalid-frontmatter-export-listThe frontmatter export list is valid.
MyST frontmatter checks pass¶
frontmattermyst-frontmatterNo frontmatter-related errors or warnings are produced during MyST build.
Image Downloads¶
imageimage-downloadsRemote images are downloaded successfully.
Image Exists¶
imageimage-existsThe image exists on disk.
Image Format Converts¶
imageimage-format-convertsImage format is converted successfully from unsupported to supported format.
Image Copied¶
imageimage-copiedImage is copied successfully from source location.
Image Format Optimizes¶
imageimage-format-optimizesImages format is converted to webp for optimal web performance.
MyST image checks pass¶
imagemyst-imageNo image-related errors or warnings are produced during MyST build.
Valid MyST Link¶
linkmyst-link-validMyst link to local or intersphinx content is valid.
Valid RRID Link¶
linkrrid-link-validThe RRID link matches expected pattern.
Valid Wikipedia Link¶
linkwikipedia-link-validWikipedia link matches expected pattern.
Valid DOI Link¶
linkdoi-link-validDOI link is a valid DOI.
Link Resolves¶
linklink-resolvesLink can be successfully fetched.
MyST link checks pass¶
linkmyst-linkNo link-related errors or warnings are produced during MyST build.
Math Label Lifted¶
mathmath-label-liftedEnumerated math label is identified and lifted from latex.
Math Equation Env Removed¶
mathmath-equation-env-removedEquation environment is removed from latex.
Eqnarray Replaced¶
mathmath-eqnarray-replacedLatex align environment should be used instead of eqnarray.
Math Alignment Adjusted¶
mathmath-alignment-adjustedMath align environment renders correctly.
Math Renders Successfully¶
mathmath-rendersEquation renders without any warning or errors.
MyST math checks pass¶
mathmyst-mathNo math-related errors or warnings are produced during MyST build.
MDAST Snippet Imports¶
miscellaneousmdast-snippet-importsMDAST snippet imports are resolved and loaded.
Include Content Filters¶
miscellaneousinclude-content-filtersLine number filters apply to include content successfully.
Include Content Loads¶
miscellaneousinclude-content-loadsInclude content resolves and loads.
Gated Nodes Join¶
miscellaneousgated-nodes-joinGated nodes are successfully joined.
Glossary Uses Definition List¶
miscellaneousglossary-uses-definition-listGlossary contains terms as a definition list.
Block Metadata Loads¶
miscellaneousblock-metadata-loadsBlock metadata is loaded successfully.
MyST miscellaneous content checks pass¶
miscellaneousmyst-miscellaneousNo miscellaneous content-related errors or warnings are produced during MyST build.
Notebook Attachments Resolve¶
notebooknotebook-attachments-resolveNotebook attachments successfully load.
Notebook Output Copied¶
notebooknotebook-output-copiedNotebook output is copied to separate file.
MyST notebook checks pass¶
notebookmyst-notebookNo notebook-related errors or warnings are produced during MyST build.
TeX Parses¶
parsetex-parsesTeX source file parses to MyST
JATS Parses¶
parsejats-parsesJATS source file parses to MyST
MyST File Loads¶
parsemyst-file-loadsMyST markdown/notebook file parses to MyST
MyST parse checks pass¶
parsemyst-parseNo parse-related errors or warnings are produced during MyST build.
Reference Template Fills¶
referencereference-template-fillsTemplate for reference enumeration is valid and fills.
Unique Identifier¶
referenceidentifier-is-uniqueIdentifiers are unique.
Reference Target Resolves¶
referencereference-target-resolvesCross-reference target exists and resolves.
Valid Reference Syntax¶
referencereference-syntax-validCross-reference syntax is valid.
Explicit Reference Target¶
referencereference-target-explicitCross-reference target is explicitly specified.
Footnote References Definition¶
referencefootnote-references-definitionFootnote references correctly point to their definitions.
Intersphinx References Resolve¶
referenceintersphinx-references-resolveIntersphinx references successfully resolve.
MyST reference checks pass¶
referencemyst-referenceNo reference-related errors or warnings are produced during MyST build.
Known Role¶
rolerole-knownCheck if role is recognized.
Role Body Validates¶
rolerole-body-correctBody is valid, according to the rules of the specific role.
MyST role checks pass¶
rolemyst-roleNo role-related errors or warnings are produced during MyST build.
Static File Copied¶
staticstatic-file-copiedStatic site asset successfully copied.
Export File Copied¶
staticexport-file-copiedExported file is successfully copied.
Source File Copied¶
staticsource-file-copiedSource file for MyST site is successfully copied.
Template File Copied¶
statictemplate-file-copiedSupporting template file is successfully copied.
Static Action File Copied¶
staticstatic-action-file-copiedStatic site action file is successfully copied.
MyST static file checks pass¶
staticmyst-staticNo static-file-related errors or warnings are produced during MyST build.
TOC Contents Exist¶
toctoc-contents-existThe table of contents points to existing files.
Valid TOC Structure¶
tocvalid-toc-structureThe table of contents has a valid basic structure.
Valid TOC¶
tocvalid-tocThe table of contents is able to load.
MyST toc checks pass¶
tocmyst-tocNo toc-related errors or warnings are produced during MyST build.