jsdoc

JSDoc configuration file

Type object
File match conf.json jsdoc.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/jsdoc/latest.json
Source https://www.schemastore.org/jsdoc-1.0.0.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

plugins array

Enables plugins for JSDoc

Default:
[]
Examples: ["plugins/markdown","plugins/summarize"]
recurseDepth integer

Controls recursion depth for source files and tutorials

Default: 10
source object

Determines the set of input files

4 nested properties
include array

An array of paths to input files

Examples: ["myProject/a.js","myProject/lib","myProject/_private"]
exclude array

An array of paths to exclude from input

Examples: ["myProject/lib/ignore.js"]
includePattern string

Forces input filenames to match regular expression

Default: ".+\.js(doc|x)?$"
excludePattern string

Forces input filenames to match regular expression

Default: "(^|\/|\\)_"
sourceType string

Determines how input files are parsed

Default: "module"
Values: "module" "script"
opts object

Determines flags that jsdoc command will be invoked with

11 nested properties
access string

Only display symbols with the given access property

Default: "all"
Values: "all" "private" "protected" "public" "undefined"
debug boolean

Log information that can help debug issues in JSDoc itself

destination string

The path to the output folder for the generated documentation

Default: "./out/"
encoding string

Assume this encoding when reading all source files

Default: "utf8"
package string

The package.json file that contains the project name, version, and other details

pedantic boolean

Treat errors as fatal errors, and treat warnings as errors

Default: false
readme string

The README.md file to include in the generated documentation

recurse boolean

Recurses to subdirectories when searching input files

Default: false
template string

The path to the template to use for generating output

Default: "templates/default"
test boolean

Run JSDoc's test suite, and print the results to the console

Default: false
tutorials string

Directory in which JSDoc should search for tutorials

Examples: "path/to/tutorials", "./docs/tutorials"
tags object

Controls allowed JSDoc tags and their interpretation

2 nested properties
allowUnknownTags boolean | array

Determines how to handle unrecognized tags

Default: true
uniqueItems=true
dictionaries string[]

Controls which tags JSDoc recognizes and how they are interpreted

templates object

Affects the appearance and content of generated documentation

3 nested properties
cleverLinks boolean

Controls @link tag text rendering

Default: false
default
5 nested properties
includeDate boolean

Controls if current date is displayed in the footer of documentation

Default: true
layoutFile string

Path to layout file to use for documentation template

Default: "layout.tmpl"
outputSourceFiles boolean

Disables pretty-printed source files

Default: true
staticFiles object
4 nested properties
exclude string[]

An array of paths that should not be copied to the output directory

excludePattern string

A regular expression indicating which files to skip

include string[]

An array of paths whose contents should be copied to the output directory

includePattern string

A regular expression indicating which files to copy

useLongnameInNav boolean

Controls if shortened or longhand version of a symbol will be shown in documentation

Default: false
monospaceLinks boolean

Controls @link tag text rendering

Default: false