utils/node_modules/@rushstack/rig-package/lib/schemas/rig.schema.json
2024-02-07 01:33:07 -05:00

28 lines
1.1 KiB
JSON

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Describes the config/rig.json file",
"description": "The rig.json file is a standard for sharing project configuration in a monorepo without duplicating files",
"type": "object",
"additionalProperties": false,
"properties": {
"$schema": {
"description": "Part of the JSON Schema standard, this optional keyword declares the URL of the schema that the file conforms to. Editors may download the schema and use it to perform syntax highlighting.",
"type": "string"
},
"rigPackageName": {
"type": "string",
"description": "(Required) The name of the rig package to inherit from. It should be an NPM package name with the \"-rig\" suffix."
},
"rigProfile": {
"type": "string",
"description": "Selects a config profile from the rig package. The name must consist of lowercase alphanumeric words separated by hyphens, for example \"sample-profile\". If omitted, then the \"default\" profile will be used."
}
},
"required": ["rigPackageName"]
}