knip/schema.json

Find unused files, dependencies and exports in your TypeScript and JavaScript projects

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Knip configuration for JSON",
  "description": "See https://github.com/webpro-nl/knip",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/definitions/workspace"
    },
    {
      "$ref": "#/definitions/plugins"
    },
    {
      "properties": {
        "$schema": {
          "type": "string",
          "title": "JSON Schema",
          "description": "Pointer to the schema against which this document should be validated."
        }
      }
    }
  ],
  "properties": {
    "ignoreBinaries": {
      "title": "Binaries to ignore (regex allowed)",
      "examples": ["rm", "docker-compose", "curl"],
      "$ref": "#/definitions/list"
    },
    "ignoreDependencies": {
      "title": "Dependencies from package.json to ignore (regex allowed)",
      "examples": ["husky", "lint-staged"],
      "$ref": "#/definitions/list"
    },
    "ignoreMembers": {
      "title": "Class and enum members to ignore (regex allowed)",
      "examples": ["render", "on.*"],
      "$ref": "#/definitions/list"
    },
    "ignoreWorkspaces": {
      "title": "Workspaces to ignore",
      "examples": ["packages/ignore-me"],
      "$ref": "#/definitions/list"
    },
    "include": {
      "title": "Include issue types in the report",
      "examples": ["files", "dependencies"],
      "$ref": "#/definitions/issueTypes"
    },
    "exclude": {
      "title": "Exclude issue types from the report",
      "examples": ["classMembers", "enumMembers"],
      "$ref": "#/definitions/issueTypes"
    },
    "ignoreExportsUsedInFile": {
      "title": "Ignore exports used in file",
      "examples": [
        {
          "ignoreExportsUsedInFile": true
        },
        {
          "ignoreExportsUsedInFile": {
            "interface": true,
            "type": true
          }
        }
      ],
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "object",
          "properties": {
            "class": {
              "type": "boolean"
            },
            "enum": {
              "type": "boolean"
            },
            "function": {
              "type": "boolean"
            },
            "interface": {
              "type": "boolean"
            },
            "member": {
              "type": "boolean"
            },
            "type": {
              "type": "boolean"
            }
          }
        }
      ]
    },
    "includeEntryExports": {
      "title": "Include entry files when reporting unused exports",
      "type": "boolean"
    },
    "workspaces": {
      "title": "Configuration for workspaces",
      "type": "object",
      "additionalProperties": {
        "allOf": [
          {
            "$ref": "#/definitions/workspace"
          },
          {
            "$ref": "#/definitions/plugins"
          }
        ],
        "unevaluatedProperties": false
      }
    },
    "rules": {
      "type": "object",
      "properties": {
        "binaries": {
          "$ref": "#/definitions/ruleValue"
        },
        "classMembers": {
          "$ref": "#/definitions/ruleValue"
        },
        "dependencies": {
          "$ref": "#/definitions/ruleValue"
        },
        "devDependencies": {
          "$ref": "#/definitions/ruleValue"
        },
        "optionalPeerDependencies": {
          "$ref": "#/definitions/ruleValue"
        },
        "duplicates": {
          "$ref": "#/definitions/ruleValue"
        },
        "enumMembers": {
          "$ref": "#/definitions/ruleValue"
        },
        "exports": {
          "$ref": "#/definitions/ruleValue"
        },
        "files": {
          "$ref": "#/definitions/ruleValue"
        },
        "nsExports": {
          "$ref": "#/definitions/ruleValue"
        },
        "nsTypes": {
          "$ref": "#/definitions/ruleValue"
        },
        "types": {
          "$ref": "#/definitions/ruleValue"
        },
        "unlisted": {
          "$ref": "#/definitions/ruleValue"
        },
        "unresolved": {
          "$ref": "#/definitions/ruleValue"
        }
      }
    }
  },
  "unevaluatedProperties": false,
  "definitions": {
    "list": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "issueTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "binaries",
          "classMembers",
          "dependencies",
          "duplicates",
          "enumMembers",
          "exports",
          "files",
          "nsExports",
          "nsTypes",
          "types",
          "unlisted",
          "unresolved"
        ]
      }
    },
    "globPatterns": {
      "description": "Use file paths and glob patterns to match files. Knip uses fast-glob and picomatch (https://github.com/micromatch/picomatch)",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "workspace": {
      "type": "object",
      "properties": {
        "entry": {
          "title": "The entry files target the starting point(s) to resolve the rest of the imported code.",
          "example": ["lib/index.ts"],
          "default": ["index.{js,ts,tsx}", "src/index.{js,ts,tsx}"],
          "$ref": "#/definitions/globPatterns"
        },
        "project": {
          "title": "The project files should contain all files to match against the files resolved from the entry files, including potentially unused files.",
          "example": ["lib/**/*.ts"],
          "default": ["**/*.{js,ts,tsx}"],
          "$ref": "#/definitions/globPatterns"
        },
        "paths": {
          "title": "",
          "example": {
            "~": ["."]
          },
          "default": {},
          "$ref": "#/definitions/paths"
        },
        "ignore": {
          "title": "Files to ignore in the analysis.",
          "example": ["**/fixtures", "mocks"],
          "default": [],
          "$ref": "#/definitions/globPatterns"
        },
        "ignoreBinaries": {
          "title": "Binaries to ignore (regex allowed)",
          "examples": ["rm", "docker-compose", "curl"],
          "$ref": "#/definitions/list"
        },
        "ignoreDependencies": {
          "title": "Dependencies from package.json to ignore (regex allowed)",
          "examples": ["husky", "lint-staged"],
          "$ref": "#/definitions/list"
        },
        "includeEntryExports": {
          "title": "Include entry files when reporting unused exports",
          "type": "boolean"
        }
      }
    },
    "plugin": {
      "description": "Knip plugin configuration. See https://knip.dev/explanations/plugins",
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "$ref": "#/definitions/globPatterns"
        },
        {
          "type": "object",
          "properties": {
            "config": {
              "title": "The custom dependency resolver of this plugin is applied to the files listed here. Also see https://knip.dev/explanations/plugins",
              "examples": [".eslintrc.json"],
              "$ref": "#/definitions/globPatterns"
            },
            "entry": {
              "title": "The entry files target the starting point(s) to resolve its imported dependencies, like regular source code.",
              "examples": ["**/*.story.ts", "**/*.spec.ts"],
              "$ref": "#/definitions/globPatterns"
            },
            "project": {
              "title": "The project files should contain all files to match against the files resolved from the entry files for this plugin, including potentially unused files.",
              "$ref": "#/definitions/globPatterns"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "plugins": {
      "properties": {
        "angular": {
          "title": "angular plugin configuration (https://knip.dev/reference/plugins/angular)",
          "$ref": "#/definitions/plugin"
        },
        "astro": {
          "title": "astro plugin configuration (https://knip.dev/reference/plugins/astro)",
          "$ref": "#/definitions/plugin"
        },
        "ava": {
          "title": "ava plugin configuration (https://knip.dev/reference/plugins/ava)",
          "$ref": "#/definitions/plugin"
        },
        "babel": {
          "title": "Babel plugin configuration (https://knip.dev/reference/plugins/babel)",
          "$ref": "#/definitions/plugin"
        },
        "c8": {
          "title": "c8 plugin configuration (https://knip.dev/reference/plugins/c8)",
          "$ref": "#/definitions/plugin"
        },
        "capacitor": {
          "title": "Capacitor plugin configuration (https://knip.dev/reference/plugins/capacitor)",
          "$ref": "#/definitions/plugin"
        },
        "changesets": {
          "title": "Changesets plugin configuration (https://knip.dev/reference/plugins/changesets)",
          "$ref": "#/definitions/plugin"
        },
        "commitizen": {
          "title": "commitizen plugin configuration (https://knip.dev/reference/plugins/commitizen)",
          "$ref": "#/definitions/plugin"
        },
        "commitlint": {
          "title": "commitlint plugin configuration (https://knip.dev/reference/plugins/commitlint)",
          "$ref": "#/definitions/plugin"
        },
        "cspell": {
          "title": "cspell plugin configuration (https://knip.dev/reference/plugins/cspell)",
          "$ref": "#/definitions/plugin"
        },
        "cucumber": {
          "title": "cucumber plugin configuration (https://knip.dev/reference/plugins/cucumber)",
          "$ref": "#/definitions/plugin"
        },
        "cypress": {
          "title": "Cypress plugin configuration (https://knip.dev/reference/plugins/cypress)",
          "$ref": "#/definitions/plugin"
        },
        "dependency-cruiser": {
          "title": "dependency-cruiser plugin configuration (https://knip.dev/reference/plugins/dependency-cruiser)",
          "$ref": "#/definitions/plugin"
        },
        "dotenv": {
          "title": "dotenv plugin configuration (https://knip.dev/reference/plugins/dotenv)",
          "$ref": "#/definitions/plugin"
        },
        "drizzle": {
          "title": "Drizzle plugin configuration (https://knip.dev/reference/plugins/drizzle)",
          "$ref": "#/definitions/plugin"
        },
        "eleventy": {
          "title": "eleventy plugin configuration (https://knip.dev/reference/plugins/eleventy)",
          "$ref": "#/definitions/plugin"
        },
        "eslint": {
          "title": "ESLint plugin configuration (https://knip.dev/reference/plugins/eslint)",
          "$ref": "#/definitions/plugin"
        },
        "expo": {
          "title": "Expo plugin configuration (https://knip.dev/reference/plugins/expo)",
          "$ref": "#/definitions/plugin"
        },
        "gatsby": {
          "title": "Gatsby plugin configuration (https://knip.dev/reference/plugins/gatsby)",
          "$ref": "#/definitions/plugin"
        },
        "github-actions": {
          "title": "github-actions plugin configuration (https://knip.dev/reference/plugins/github-actions)",
          "$ref": "#/definitions/plugin"
        },
        "graphql-codegen": {
          "title": "graphql-codegen plugin configuration (https://knip.dev/reference/plugins/graphql-codegen)",
          "$ref": "#/definitions/plugin"
        },
        "husky": {
          "title": "husky plugin configuration (https://knip.dev/reference/plugins/husky)",
          "$ref": "#/definitions/plugin"
        },
        "jest": {
          "title": "Jest plugin configuration (https://knip.dev/reference/plugins/jest)",
          "$ref": "#/definitions/plugin"
        },
        "karma": {
          "title": "karma plugin configuration (https://knip.dev/reference/plugins/karma)",
          "$ref": "#/definitions/plugin"
        },
        "ladle": {
          "title": "ladle plugin configuration (https://knip.dev/reference/plugins/ladle)",
          "$ref": "#/definitions/plugin"
        },
        "lefthook": {
          "title": "lefthook plugin configuration (https://knip.dev/reference/plugins/lefthook)",
          "$ref": "#/definitions/plugin"
        },
        "lint-staged": {
          "title": "lint-staged plugin configuration (https://knip.dev/reference/plugins/lint-staged)",
          "$ref": "#/definitions/plugin"
        },
        "linthtml": {
          "title": "linthtml plugin configuration (https://knip.dev/reference/plugins/linthtml)",
          "$ref": "#/definitions/plugin"
        },
        "lockfile-lint": {
          "title": "lockfile-lint plugin configuration (https://knip.dev/reference/plugins/lockfile-lint)",
          "$ref": "#/definitions/plugin"
        },
        "lost-pixel": {
          "title": "lost-pixel plugin configuration (https://knip.dev/reference/plugins/lost-pixel)",
          "$ref": "#/definitions/plugin"
        },
        "markdownlint": {
          "title": "markdownlint plugin configuration (https://knip.dev/reference/plugins/markdownlint)",
          "$ref": "#/definitions/plugin"
        },
        "metro": {
          "title": "metro plugin configuration (https://knip.dev/reference/plugins/metro)",
          "$ref": "#/definitions/plugin"
        },
        "mocha": {
          "title": "Mocha plugin configuration (https://knip.dev/reference/plugins/mocha)",
          "$ref": "#/definitions/plugin"
        },
        "moonrepo": {
          "title": "moonrepo plugin configuration (https://knip.dev/reference/plugins/moonrepo)",
          "$ref": "#/definitions/plugin"
        },
        "msw": {
          "title": "Mocha plugin configuration (https://knip.dev/reference/plugins/msw)",
          "$ref": "#/definitions/plugin"
        },
        "nest": {
          "title": "nest plugin configuration (https://knip.dev/reference/plugins/nest)",
          "$ref": "#/definitions/plugin"
        },
        "netlify": {
          "title": "Netlify plugin configuration (https://knip.dev/reference/plugins/netlify)",
          "$ref": "#/definitions/plugin"
        },
        "next": {
          "title": "Next.js plugin configuration (https://knip.dev/reference/plugins/main)",
          "$ref": "#/definitions/plugin"
        },
        "node": {
          "title": "node plugin configuration (https://knip.dev/reference/plugins/node)",
          "$ref": "#/definitions/plugin"
        },
        "node-test-runner": {
          "title": "node-test-runner plugin configuration (https://knip.dev/reference/plugins/node-test-runner)",
          "$ref": "#/definitions/plugin"
        },
        "nodemon": {
          "title": "nodemon plugin configuration (https://knip.dev/reference/plugins/nodemon)",
          "$ref": "#/definitions/plugin"
        },
        "npm-package-json-lint": {
          "title": "npm-package-json-lint plugin configuration (https://knip.dev/reference/plugins/npm-package-json-lint)",
          "$ref": "#/definitions/plugin"
        },
        "nuxt": {
          "title": "Nuxt plugin configuration (https://knip.dev/reference/plugins/nuxt)",
          "$ref": "#/definitions/plugin"
        },
        "nx": {
          "title": "Nx plugin configuration (https://knip.dev/reference/plugins/nx)",
          "$ref": "#/definitions/plugin"
        },
        "nyc": {
          "title": "nyc plugin configuration (https://knip.dev/reference/plugins/nyc)",
          "$ref": "#/definitions/plugin"
        },
        "oclif": {
          "title": "oclif plugin configuration (https://knip.dev/reference/plugins/oclif)",
          "$ref": "#/definitions/plugin"
        },
        "playwright": {
          "title": "Playwright plugin configuration (https://knip.dev/reference/plugins/playwright)",
          "$ref": "#/definitions/plugin"
        },
        "playwright-ct": {
          "title": "Playwright for components plugin configuration (https://knip.dev/reference/plugins/playwright-ct)",
          "$ref": "#/definitions/plugin"
        },
        "playwright-test": {
          "title": "playwright-test plugin configuration (https://knip.dev/reference/plugins/playwright-test)",
          "$ref": "#/definitions/plugin"
        },
        "postcss": {
          "title": "PostCSS plugin configuration (https://knip.dev/reference/plugins/postcss)",
          "$ref": "#/definitions/plugin"
        },
        "preconstruct": {
          "title": "preconstruct plugin configuration (https://knip.dev/reference/plugins/preconstruct)",
          "$ref": "#/definitions/plugin"
        },
        "prettier": {
          "title": "Prettier plugin configuration (https://knip.dev/reference/plugins/prettier)",
          "$ref": "#/definitions/plugin"
        },
        "react-cosmos": {
          "title": "react-cosmos plugin configuration (https://knip.dev/reference/plugins/react-cosmos)",
          "$ref": "#/definitions/plugin"
        },
        "release-it": {
          "title": "Release It plugin configuration (https://knip.dev/reference/plugins/release-it)",
          "$ref": "#/definitions/plugin"
        },
        "remark": {
          "title": "Remark plugin configuration (https://knip.dev/reference/plugins/remark)",
          "$ref": "#/definitions/plugin"
        },
        "remix": {
          "title": "Remix plugin configuration (https://knip.dev/reference/plugins/remix)",
          "$ref": "#/definitions/plugin"
        },
        "rollup": {
          "title": "Rollup plugin configuration (https://knip.dev/reference/plugins/rollup)",
          "$ref": "#/definitions/plugin"
        },
        "rsbuild": {
          "title": "rsbuild plugin configuration (https://knip.dev/reference/plugins/rsbuild)",
          "$ref": "#/definitions/plugin"
        },
        "rspack": {
          "title": "rspack plugin configuration (https://knip.dev/reference/plugins/rspack)",
          "$ref": "#/definitions/plugin"
        },
        "semantic-release": {
          "title": "semantic-release plugin configuration (https://knip.dev/reference/plugins/semantic-release)",
          "$ref": "#/definitions/plugin"
        },
        "sentry": {
          "title": "Sentry plugin configuration (https://knip.dev/reference/plugins/sentry)",
          "$ref": "#/definitions/plugin"
        },
        "simple-git-hooks": {
          "title": "simple-git-hooks plugin configuration (https://knip.dev/reference/plugins/simple-git-hooks)",
          "$ref": "#/definitions/plugin"
        },
        "size-limit": {
          "title": "size-limit plugin configuration (https://knip.dev/reference/plugins/size-limit)",
          "$ref": "#/definitions/plugin"
        },
        "storybook": {
          "title": "Storybook plugin configuration (https://knip.dev/reference/plugins/storybook)",
          "$ref": "#/definitions/plugin"
        },
        "stryker": {
          "title": "Stryker plugin configuration (https://knip.dev/reference/plugins/stryker)",
          "$ref": "#/definitions/plugin"
        },
        "stylelint": {
          "title": "stylelint plugin configuration (https://knip.dev/reference/plugins/stylelint)",
          "$ref": "#/definitions/plugin"
        },
        "svelte": {
          "title": "svelte plugin configuration (https://knip.dev/reference/plugins/svelte)",
          "$ref": "#/definitions/plugin"
        },
        "syncpack": {
          "title": "syncpack plugin configuration (https://knip.dev/reference/plugins/syncpack)",
          "$ref": "#/definitions/plugin"
        },
        "tailwind": {
          "title": "tailwind plugin configuration (https://knip.dev/reference/plugins/tailwind)",
          "$ref": "#/definitions/plugin"
        },
        "travis": {
          "title": "travis plugin configuration (https://knip.dev/reference/plugins/travis)",
          "$ref": "#/definitions/plugin"
        },
        "ts-node": {
          "title": "ts-node plugin configuration (https://knip.dev/reference/plugins/ts-node)",
          "$ref": "#/definitions/plugin"
        },
        "tsup": {
          "title": "tsup plugin configuration (https://knip.dev/reference/plugins/tsup)",
          "$ref": "#/definitions/plugin"
        },
        "tsx": {
          "title": "tsx plugin configuration (https://knip.dev/reference/plugins/tsx)",
          "$ref": "#/definitions/plugin"
        },
        "typedoc": {
          "title": "typedoc plugin configuration (https://knip.dev/reference/plugins/typedoc)",
          "$ref": "#/definitions/plugin"
        },
        "typescript": {
          "title": "TypeScript plugin configuration (https://knip.dev/reference/plugins/typescript)",
          "$ref": "#/definitions/plugin"
        },
        "unbuild": {
          "title": "unbuild plugin configuration (https://knip.dev/reference/plugins/unbuild)",
          "$ref": "#/definitions/plugin"
        },
        "unocss": {
          "title": "unocss plugin configuration (https://knip.dev/reference/plugins/unocss)",
          "$ref": "#/definitions/plugin"
        },
        "vercel-og": {
          "title": "vercel-og plugin configuration (https://knip.dev/reference/plugins/vercel-og)",
          "$ref": "#/definitions/plugin"
        },
        "vike": {
          "title": "vike plugin configuration (https://knip.dev/reference/plugins/vike)",
          "$ref": "#/definitions/plugin"
        },
        "vite": {
          "title": "vite plugin configuration (https://knip.dev/reference/plugins/vite)",
          "$ref": "#/definitions/plugin"
        },
        "vitest": {
          "title": "vitest plugin configuration (https://knip.dev/reference/plugins/vitest)",
          "$ref": "#/definitions/plugin"
        },
        "vue": {
          "title": "vue plugin configuration (https://knip.dev/reference/plugins/vue)",
          "$ref": "#/definitions/plugin"
        },
        "webdriver-io": {
          "title": "webdriver-io plugin configuration (https://knip.dev/reference/plugins/webdriver-io)",
          "$ref": "#/definitions/plugin"
        },
        "webpack": {
          "title": "Webpack plugin configuration (https://knip.dev/reference/plugins/webpack)",
          "$ref": "#/definitions/plugin"
        },
        "wireit": {
          "title": "Wireit plugin configuration (https://knip.dev/reference/plugins/wireit)",
          "$ref": "#/definitions/plugin"
        },
        "wrangler": {
          "title": "wrangler plugin configuration (https://knip.dev/reference/plugins/wrangler)",
          "$ref": "#/definitions/plugin"
        },
        "xo": {
          "title": "xo plugin configuration (https://knip.dev/reference/plugins/xo)",
          "$ref": "#/definitions/plugin"
        },
        "yarn": {
          "title": "yarn plugin configuration (https://knip.dev/reference/plugins/yarn)",
          "$ref": "#/definitions/plugin"
        },
        "yorkie": {
          "title": "yorkie plugin configuration (https://knip.dev/reference/plugins/yorkie)",
          "$ref": "#/definitions/plugin"
        }
      }
    },
    "paths": {
      "type": "object",
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "ruleValue": {
      "type": "string",
      "enum": ["error", "warn", "off"]
    }
  }
}