schema.json

{
  "$id": "https://unpkg.com/onsystem/schema.json",
  "title": "onsystem config",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string"
    },
    "extends": {
      "description": "Whether this config builds on the one a design-system package declares (\"onsystem\" in the package.json of a dependency, found from the dependencies): its rules apply over the package's, and, unless it sets components of its own, what it leaves out comes from the package's (components with their importPath, docs, elements, tokens and libraries). Default: true. false reads this config alone.",
      "type": "boolean"
    },
    "components": {
      "description": "Globs for component source files, relative to the root.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "exclude": {
      "description": "Globs for files to leave out, relative to the root: `check` in folders and globs, the ESLint plugin, the Claude Code hook and check_ui leave them out, and finding components skips them. A folder (`app/legacy`) covers everything in it. Adds to the defaults (node_modules, .d.ts files, tests and stories); a pattern that starts with `!` takes out the default it names, such as `!**/*.d.ts`.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tokens": {
      "description": "Token files: W3C DTCG JSON (*.json), CSS custom properties (*.css) or a DESIGN.md's front matter (*.md).",
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "File or glob."
                },
                "prefix": {
                  "description": "DTCG only: custom property prefix, e.g. \"acme\" for --acme-color-primary.",
                  "type": "string"
                }
              },
              "required": [
                "path"
              ],
              "additionalProperties": false
            }
          ]
        },
        {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "object",
                "properties": {
                  "path": {
                    "type": "string",
                    "description": "File or glob."
                  },
                  "prefix": {
                    "description": "DTCG only: custom property prefix, e.g. \"acme\" for --acme-color-primary.",
                    "type": "string"
                  }
                },
                "required": [
                  "path"
                ],
                "additionalProperties": false
              }
            ]
          }
        }
      ]
    },
    "docs": {
      "description": "Globs for per-component Markdown/MDX docs.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "tsconfig": {
      "description": "tsconfig used to resolve types and path aliases.",
      "type": "string"
    },
    "importPath": {
      "description": "Package name components are imported from, e.g. \"@acme/ui\", or a pattern for packages imported by path: \"@acme/ui/{path}\" is @acme/ui/primitives/button for primitives/button.tsx in the package. An installed dependency it names exactly, whose component sources the project does not read, is read from its type declarations (.d.ts). Default: inferred from package exports and tsconfig paths.",
      "type": "string"
    },
    "elements": {
      "description": "Extra native element → component mappings, e.g. { \"a\": \"Link\" }.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "libraries": {
      "description": "Published component libraries to read from their type declarations when the project depends on them. Omitted: every one onsystem reads (mui). false: none. A list: only those, e.g. [\"mui\"].",
      "anyOf": [
        {
          "type": "boolean",
          "const": false
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "mui"
            ]
          }
        }
      ]
    },
    "includeDesignSystem": {
      "description": "check: lint the design system's own component files too. Off by default: they implement the scale and primitives the rules enforce.",
      "type": "boolean"
    },
    "rules": {
      "description": "Rule severities and options: \"off\" | \"warn\" | \"error\" | [severity, { allow }].",
      "type": "object",
      "propertyNames": {
        "type": "string",
        "enum": [
          "no-hardcoded-color",
          "no-hardcoded-spacing",
          "no-hardcoded-radius",
          "prefer-design-system-component",
          "no-unknown-component",
          "no-unknown-prop",
          "no-unknown-variant",
          "icon-button-accessible-name"
        ]
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "off",
              "warn",
              "error"
            ]
          },
          {
            "type": "array",
            "items": [
              {
                "type": "string",
                "enum": [
                  "off",
                  "warn",
                  "error"
                ]
              }
            ],
            "additionalItems": false,
            "minItems": 1,
            "maxItems": 1
          },
          {
            "type": "array",
            "items": [
              {
                "type": "string",
                "enum": [
                  "off",
                  "warn",
                  "error"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "allow": {
                    "description": "Values the rule accepts anyway: colors, lengths, element or component names.",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "additionalProperties": false
              }
            ],
            "additionalItems": false,
            "minItems": 2,
            "maxItems": 2
          }
        ]
      }
    },
    "overrides": {
      "description": "Rules for some files: [{ \"files\": [\"app/legacy/**\"], \"rules\": { \"no-hardcoded-color\": \"warn\" } }]. Later entries win.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "files": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ],
            "description": "Globs, relative to the root, of the files these rules apply to: \"app/legacy/**\", \"**/*.generated.tsx\"."
          },
          "rules": {
            "type": "object",
            "propertyNames": {
              "type": "string",
              "enum": [
                "no-hardcoded-color",
                "no-hardcoded-spacing",
                "no-hardcoded-radius",
                "prefer-design-system-component",
                "no-unknown-component",
                "no-unknown-prop",
                "no-unknown-variant",
                "icon-button-accessible-name"
              ]
            },
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "off",
                    "warn",
                    "error"
                  ]
                },
                {
                  "type": "array",
                  "items": [
                    {
                      "type": "string",
                      "enum": [
                        "off",
                        "warn",
                        "error"
                      ]
                    }
                  ],
                  "additionalItems": false,
                  "minItems": 1,
                  "maxItems": 1
                },
                {
                  "type": "array",
                  "items": [
                    {
                      "type": "string",
                      "enum": [
                        "off",
                        "warn",
                        "error"
                      ]
                    },
                    {
                      "type": "object",
                      "properties": {
                        "allow": {
                          "description": "Values the rule accepts anyway: colors, lengths, element or component names.",
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "additionalItems": false,
                  "minItems": 2,
                  "maxItems": 2
                }
              ]
            },
            "description": "Rule severities and options for those files, over \"rules\"."
          }
        },
        "required": [
          "files",
          "rules"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}