eslint-plugin-json-schema-validator/schemastore/json.schemastore.org/jsdoc-1.0.0.json

ESLint plugin that validates data using JSON Schema Validator.

{"$schema":"https://json-schema.org/draft-07/schema","type":"object","title":"JSON Schema for JSDoc configuration files","properties":{"plugins":{"type":"array","title":"Configuring plugins","default":[],"examples":[["plugins/markdown","plugins/summarize"]]},"recurseDepth":{"type":"integer","title":"Specifying recursion depth","default":10,"$comment":"Is used only if `jsdoc` command is invoked with `-r` flag"},"source":{"type":"object","title":"Specifying input files","properties":{"include":{"examples":[["myProject/a.js","myProject/lib","myProject/_private"]],"type":"array","title":"Input files paths","$comment":"`-r` flag for `jsdoc` command will recurse in subdirectories of paths listed"},"exclude":{"examples":[["myProject/lib/ignore.js"]],"type":"array","title":"Input files exclusion paths","$comment":"With JSDoc ^3.3.0 may include subdirectories of include"},"includePattern":{"type":"string","title":"Inclusion RegExp","default":".+\\.js(doc|x)?$","$comment":"By default, .js, .jsx, .jsdoc files are included"},"excludePattern":{"type":"string","title":"Exclusion RegExp","default":"(^|\\/|\\\\)_","$comment":"By default, underscored files and folders are excluded"}},"additionalProperties":false},"sourceType":{"type":"string","enum":["module","script"],"default":"module","title":"Specifying source type"},"opts":{"$comment":"The command line options take precedence over config file","type":"object","title":"Incorporating CLI options","additionalProperties":false,"properties":{"access":{"$comment":"Equivalent to `-a` flag","default":"all","enum":["all","private","protected","public","undefined"],"title":"Symbol access","type":"string"},"debug":{"$comment":"Equivalent to `--debug` flag","title":"Log debug info","type":"boolean"},"destination":{"$comment":"Equivalent to `-d` flag","default":"./out/","title":"Output folder","type":"string"},"encoding":{"$comment":"Equivalent to `-e` flag","default":"utf8","title":"Input files encoding","type":"string"},"package":{"$comment":"Equivalent to `-p` flag","title":"Package","type":"string"},"pedantic":{"default":false,"title":"Pedantic","type":"boolean"},"readme":{"$comment":"Equivalent to `-R` flag","title":"README.md","type":"string"},"recurse":{"$comment":"Equivalent to `-r` flag","default":false,"title":"Recurse to subdirectories","type":"boolean"},"template":{"$comment":"Equivalent to `-t` flag","default":"templates/default","title":"Output template","type":"string"},"test":{"$comment":"Equivalent to `-T` flag. Won't work if installed via NPM","default":false,"title":"Run tests","type":"boolean"},"tutorials":{"$comment":"Equivalent to `-u` flag","examples":["path/to/tutorials","./docs/tutorials"],"title":"Tutorials path","type":"string"}}},"tags":{"additionalProperties":false,"properties":{"allowUnknownTags":{"$comment":"If set to `false`, emits a warning. If set to an array, whitelists tags","default":true,"items":{"title":"JSDoc tag","type":"string"},"title":"Unknown tags","type":["boolean","array"],"uniqueItems":true},"dictionaries":{"items":{"$comment":"^3.3.0 two dictionaries: JSDoc and Closure Compiler","default":["jsdoc","closure"],"enum":["jsdoc","closure"],"title":"Dictionary","type":"string"},"title":"JSDoc dictionaries","type":"array"}},"title":"Configuring tags and tag dictionaries","type":"object"},"templates":{"properties":{"cleverLinks":{"$comment":"If `true`, text of @link tag that is a URL will be rendered in normal font, else in monospace","default":false,"title":"@link URL","type":"boolean"},"default":{"properties":{"includeDate":{"$comment":"^3.3.0 can be set to `false` to omit current date","default":true,"title":"Showing the current date","type":"boolean"},"layoutFile":{"$comment":"^3.4.0 can be set to custom layout file","default":"layout.tmpl","title":"Overriding layout file","type":"string"},"outputSourceFiles":{"$comment":"^3.3.0 can be set to `false` to remove links to source files","default":true,"title":"Generating pretty-printed source files","type":"boolean"},"staticFiles":{"additionalProperties":false,"properties":{"exclude":{"items":{"type":"string"},"type":"array"},"excludePattern":{"type":"string"},"include":{"items":{"type":"string"},"type":"array"},"includePattern":{"type":"string"}},"title":"Copying static files","type":"object"},"useLongnameInNav":{"$comment":"^3.4.0 can be set to `true` to use longhands","default":false,"title":"Showing longnames","type":"boolean"}}},"monospaceLinks":{"$comment":"If `true`, all link text of inline @link tag will be rendered in monospace font","default":false,"title":"@link text","type":"boolean"}},"title":"Configuring templates","type":"object"}}}