t3-code-android-nightly/.repos/effect-smol/packages/tools/docgen/schema.json
Julius Marminge 108e01746c
Upgrade Effect and Alchemy betas (#4643)
Prepare Relay production infrastructure for the PlanetScale PS_20 HA topology, upgrade Effect and Alchemy to compatible betas, reconcile migration state, and preserve patched MCP session termination behavior.\n\nCo-authored-by: codex <codex@users.noreply.github.com>
2026-07-27 16:21:02 +02:00

113 lines
3.8 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"$defs": {
"ConfigurationSchema": {
"type": "object",
"required": [],
"properties": {
"$schema": {
"type": "string"
},
"projectHomepage": {
"type": "string",
"description": "Will link to the project homepage from the Auxiliary Links of the generated documentation."
},
"srcLink": {
"type": "string",
"description": "Will link to the project source code."
},
"srcDir": {
"type": "string",
"description": "The directory in which docgen will search for TypeScript files to parse.",
"default": "src"
},
"outDir": {
"type": "string",
"description": "The directory to which docgen will generate its output markdown documents.",
"default": "docs"
},
"theme": {
"type": "string",
"description": "The theme that docgen will specify should be used for GitHub Docs in the generated _config.yml file.",
"default": "mikearnaldi/just-the-docs"
},
"enableSearch": {
"type": "boolean",
"description": "Whether or not search should be enabled for GitHub Docs in the generated _config.yml file.",
"default": true
},
"enforceDescriptions": {
"type": "boolean",
"description": "Whether or not descriptions for each module export should be required.",
"default": false
},
"enforceExamples": {
"type": "boolean",
"description": "Whether or not @example tags for each module export should be required. (Note: examples will not be enforced in module documentation)",
"default": false
},
"enforceVersion": {
"type": "boolean",
"description": "Whether or not @since tags for each module export should be required.",
"default": true
},
"tscExecutable": {
"type": "string",
"description": "The path to the TypeScript compiler executable that docgen should use when invoking the compiler programmatically.",
"default": "tsc"
},
"runExamples": {
"type": "boolean",
"description": "Whether or not docgen should attempt to run example code snippets and include the output in the generated documentation.",
"default": false
},
"exclude": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of glob strings specifying files that should be excluded from the documentation.",
"default": []
},
"parseCompilerOptions": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": {
"$id": "/schemas/unknown",
"title": "unknown"
}
}
],
"description": "tsconfig for parsing options (or path to a tsconfig)",
"default": {}
},
"examplesCompilerOptions": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"required": [],
"properties": {},
"additionalProperties": {
"$id": "/schemas/unknown",
"title": "unknown"
}
}
],
"description": "tsconfig for the examples options (or path to a tsconfig)",
"default": {}
}
},
"additionalProperties": false
}
},
"$ref": "#/$defs/ConfigurationSchema"
}