Schema registry

jsdoc

JSDoc configuration file

conf.jsonjsdoc.json

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your conf.json and it validates in your browser — nothing is uploaded.

Validate a conf.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`plugins`	`array`	Enables plugins for JSDoc default: `[]`
`recurseDepth`	`integer`	Controls recursion depth for source files and tutorials default: `10`
`source`	`object`	Determines the set of input files
`source.include`	`array`	An array of paths to input files
`source.exclude`	`array`	An array of paths to exclude from input
`source.includePattern`	`string`	Forces input filenames to match regular expression default: `".+\\.js(doc\|x)?$"`
`source.excludePattern`	`string`	Forces input filenames to match regular expression default: `"(^\|\\/\|\\\\)_"`
`sourceType`	`string`	Determines how input files are parsed default: `"module"` one of: `"module", "script"`
`opts`	`object`	Determines flags that `jsdoc` command will be invoked with
`opts.access`	`string`	Only display symbols with the given `access` property default: `"all"` one of: `"all", "private", "protected", "public", "undefined"`
`opts.debug`	`boolean`	Log information that can help debug issues in JSDoc itself
`opts.destination`	`string`	The path to the output folder for the generated documentation default: `"./out/"`
`opts.encoding`	`string`	Assume this encoding when reading all source files default: `"utf8"`
`opts.package`	`string`	The `package.json` file that contains the project name, version, and other details
`opts.pedantic`	`boolean`	Treat errors as fatal errors, and treat warnings as errors default: `false`
`opts.readme`	`string`	The README.md file to include in the generated documentation
`opts.recurse`	`boolean`	Recurses to subdirectories when searching input files default: `false`
`opts.template`	`string`	The path to the template to use for generating output default: `"templates/default"`
`opts.test`	`boolean`	Run JSDoc's test suite, and print the results to the console default: `false`
`opts.tutorials`	`string`	Directory in which JSDoc should search for tutorials
`tags`	`object`	Controls allowed JSDoc tags and their interpretation
`tags.allowUnknownTags`	`boolean \| array`	Determines how to handle unrecognized tags default: `true`
`tags.dictionaries`	`array<string>`	Controls which tags JSDoc recognizes and how they are interpreted
`templates`	`object`	Affects the appearance and content of generated documentation
`templates.cleverLinks`	`boolean`	Controls @link tag text rendering default: `false`
`templates.default`	`object`	—
`templates.default.includeDate`	`boolean`	Controls if current date is displayed in the footer of documentation default: `true`
`templates.default.layoutFile`	`string`	Path to layout file to use for documentation template default: `"layout.tmpl"`
`templates.default.outputSourceFiles`	`boolean`	Disables pretty-printed source files default: `true`
`templates.default.staticFiles`	`object`	—
`templates.default.useLongnameInNav`	`boolean`	Controls if shortened or longhand version of a symbol will be shown in documentation default: `false`
`templates.monospaceLinks`	`boolean`	Controls @link tag text rendering default: `false`

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
27 properties, 96% carrying a description, max nesting depth 6.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$comment`	JSON Schema Core, draft 2020-12	§8.3 — Comments With "$comment"
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`examples`	JSON Schema Validation, draft 2020-12	§9.5 — "examples"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`uniqueItems`	JSON Schema Validation, draft 2020-12	§6.4.3 — "uniqueItems"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas