| 1 | { |
| 2 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 3 | "$defs": { |
| 4 | "ConfigurationSchema": { |
| 5 | "type": "object", |
| 6 | "required": [], |
| 7 | "properties": { |
| 8 | "$schema": { |
| 9 | "type": "string" |
| 10 | }, |
| 11 | "projectHomepage": { |
| 12 | "type": "string", |
| 13 | "description": "Will link to the project homepage from the Auxiliary Links of the generated documentation." |
| 14 | }, |
| 15 | "srcLink": { |
| 16 | "type": "string", |
| 17 | "description": "Will link to the project source code." |
| 18 | }, |
| 19 | "srcDir": { |
| 20 | "type": "string", |
| 21 | "description": "The directory in which docgen will search for TypeScript files to parse.", |
| 22 | "default": "src" |
| 23 | }, |
| 24 | "outDir": { |
| 25 | "type": "string", |
| 26 | "description": "The directory to which docgen will generate its output markdown documents.", |
| 27 | "default": "docs" |
| 28 | }, |
| 29 | "theme": { |
| 30 | "type": "string", |
| 31 | "description": "The theme that docgen will specify should be used for GitHub Docs in the generated _config.yml file.", |
| 32 | "default": "mikearnaldi/just-the-docs" |
| 33 | }, |
| 34 | "enableSearch": { |
| 35 | "type": "boolean", |
| 36 | "description": "Whether or not search should be enabled for GitHub Docs in the generated _config.yml file.", |
| 37 | "default": true |
| 38 | }, |
| 39 | "enforceDescriptions": { |
| 40 | "type": "boolean", |
| 41 | "description": "Whether or not descriptions for each module export should be required.", |
| 42 | "default": false |
| 43 | }, |
| 44 | "enforceExamples": { |
| 45 | "type": "boolean", |
| 46 | "description": "Whether or not @example tags for each module export should be required. (Note: examples will not be enforced in module documentation)", |
| 47 | "default": false |
| 48 | }, |
| 49 | "enforceVersion": { |
| 50 | "type": "boolean", |
| 51 | "description": "Whether or not @since tags for each module export should be required.", |
| 52 | "default": true |
| 53 | }, |
| 54 | "tscExecutable": { |
| 55 | "type": "string", |
| 56 | "description": "The path to the TypeScript compiler executable that docgen should use when invoking the compiler programmatically.", |
| 57 | "default": "tsc" |
| 58 | }, |
| 59 | "runExamples": { |
| 60 | "type": "boolean", |
| 61 | "description": "Whether or not docgen should attempt to run example code snippets and include the output in the generated documentation.", |
| 62 | "default": false |
| 63 | }, |
| 64 | "exclude": { |
| 65 | "type": "array", |
| 66 | "items": { |
| 67 | "type": "string" |
| 68 | }, |
| 69 | "description": "An array of glob strings specifying files that should be excluded from the documentation.", |
| 70 | "default": [] |
| 71 | }, |
| 72 | "parseCompilerOptions": { |
| 73 | "anyOf": [ |
| 74 | { |
| 75 | "type": "string" |
| 76 | }, |
| 77 | { |
| 78 | "type": "object", |
| 79 | "required": [], |
| 80 | "properties": {}, |
| 81 | "additionalProperties": { |
| 82 | "$id": "/schemas/unknown", |
| 83 | "title": "unknown" |
| 84 | } |
| 85 | } |
| 86 | ], |
| 87 | "description": "tsconfig for parsing options (or path to a tsconfig)", |
| 88 | "default": {} |
| 89 | }, |
| 90 | "examplesCompilerOptions": { |
| 91 | "anyOf": [ |
| 92 | { |
| 93 | "type": "string" |
| 94 | }, |
| 95 | { |
| 96 | "type": "object", |
| 97 | "required": [], |
| 98 | "properties": {}, |
| 99 | "additionalProperties": { |
| 100 | "$id": "/schemas/unknown", |
| 101 | "title": "unknown" |
| 102 | } |
| 103 | } |
| 104 | ], |
| 105 | "description": "tsconfig for the examples options (or path to a tsconfig)", |
| 106 | "default": {} |
| 107 | } |
| 108 | }, |
| 109 | "additionalProperties": false |
| 110 | } |
| 111 | }, |
| 112 | "$ref": "#/$defs/ConfigurationSchema" |
| 113 | } |