Knip

Knip configuration files

Type object
File match knip.json .knip.json knip.jsonc .knip.jsonc
Schema URL https://catalog.lintel.tools/schemas/schemastore/knip/latest.json
Source https://unpkg.com/knip@5/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

See https://github.com/webpro-nl/knip

Properties

ignoreBinaries list
Examples: "rm", "docker-compose", "curl"
ignoreDependencies list
Examples: "husky", "lint-staged"
ignoreFiles globPatterns
Default:
[]
Examples: "husky", "lint-staged", "**/fixtures/**", "mocks/**"
ignoreMembers list
Examples: "render", "on.*"
ignoreUnresolved list
Examples: "#/virtual"
ignoreWorkspaces string[]
include string[]
exclude string[]
ignoreExportsUsedInFile boolean | object
Examples: {"ignoreExportsUsedInFile":true}, {"ignoreExportsUsedInFile":{"interface":true,"type":true}}
ignoreIssues Record<string, string[]>
Examples: {"src/generated/**":["exports","types"],"**/*.generated.ts":["exports","classMembers"]}
includeEntryExports boolean
tags string[]
workspaces Record<string, any>
rules object
15 nested properties
binaries string
Values: "error" "warn" "off"
catalog string
Values: "error" "warn" "off"
classMembers string
Values: "error" "warn" "off"
dependencies string
Values: "error" "warn" "off"
devDependencies string
Values: "error" "warn" "off"
optionalPeerDependencies string
Values: "error" "warn" "off"
duplicates string
Values: "error" "warn" "off"
enumMembers string
Values: "error" "warn" "off"
exports string
Values: "error" "warn" "off"
files string
Values: "error" "warn" "off"
nsExports string
Values: "error" "warn" "off"
nsTypes string
Values: "error" "warn" "off"
types string
Values: "error" "warn" "off"
unlisted string
Values: "error" "warn" "off"
unresolved string
Values: "error" "warn" "off"
treatConfigHintsAsErrors boolean

All of

1. workspace object
2. plugins
3. variant
$schema string

Pointer to the schema against which this document should be validated.

Definitions

list string[]
ignoreBinaries string[]
ignoreDependencies string[]
ignoreFiles string | string[]

Use file paths and glob patterns to match files. Knip uses fast-glob and picomatch (https://github.com/micromatch/picomatch)

ignoreUnresolved string[]
includeEntryExports boolean
ignoreMembers string[]
issueTypes string[]
globPatterns string | string[]

Use file paths and glob patterns to match files. Knip uses fast-glob and picomatch (https://github.com/micromatch/picomatch)

workspace object
entry string | string[]

Use file paths and glob patterns to match files. Knip uses fast-glob and picomatch (https://github.com/micromatch/picomatch)

project string | string[]

Use file paths and glob patterns to match files. Knip uses fast-glob and picomatch (https://github.com/micromatch/picomatch)

paths object
ignore string | string[]

Use file paths and glob patterns to match files. Knip uses fast-glob and picomatch (https://github.com/micromatch/picomatch)

ignoreFiles globPatterns
Default:
[]
Examples: "husky", "lint-staged", "**/fixtures/**", "mocks/**"
ignoreBinaries list
Examples: "rm", "docker-compose", "curl"
ignoreDependencies list
Examples: "husky", "lint-staged"
ignoreMembers list
Examples: "render", "on.*"
ignoreUnresolved list
Examples: "#/virtual"
includeEntryExports boolean
plugin boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

plugins
angular boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

astro boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

astro-db boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

ava boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

babel boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

biome boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

bumpp boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

bun boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

c8 boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

capacitor boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

changelogen boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

changelogithub boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

changesets boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

commitizen boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

commitlint boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

convex boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

create-typescript-app boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

cspell boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

cucumber boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

cypress boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

danger boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

dependency-cruiser boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

docusaurus boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

dotenv boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

drizzle boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

eleventy boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

eslint boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

execa boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

expo boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

expressive-code boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

gatsby boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

github-action boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

github-actions boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

graphql-codegen boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

hardhat boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

husky boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

i18next-parser boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

jest boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

karma boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

knex boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

ladle boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

lefthook boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

lint-staged boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

linthtml boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

lockfile-lint boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

lost-pixel boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

markdownlint boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

mdx boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

mdxlint boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

metro boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

mocha boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

moonrepo boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

msw boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

nano-staged boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

nest boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

netlify boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

next boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

next-intl boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

next-mdx boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

nitro boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

node boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

node-modules-inspector boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

node-test-runner boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

nodemon boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

npm-package-json-lint boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

nuxt boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

nx boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

nyc boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

openapi-ts boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

oclif boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

oxlint boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

oxfmt boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

payload boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

playwright boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

playwright-ct boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

playwright-test boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

pm2 boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

pnpm boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

postcss boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

preconstruct boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

prettier boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

prisma boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

qwik boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

react-cosmos boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

react-native boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

react-router boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

relay boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

release-it boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

remark boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

remix boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

rollup boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

rsbuild boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

rslib boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

rspack boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

rstest boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

sanity boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

semantic-release boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

sentry boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

simple-git-hooks boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

size-limit boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

sst boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

starlight boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

storybook boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

stryker boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

stylelint boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

svelte boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

sveltekit boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

svgo boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

svgr boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

swc boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

syncpack boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

tailwind boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

tanstack-router boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

tanstack-start boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

taskfile boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

travis boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

ts-node boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

tsdown boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

tsup boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

tsx boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

typedoc boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

typescript boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

unbuild boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

unocss boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

vercel-og boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

vike boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

vite boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

vitepress boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

vitest boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

vue boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

webdriver-io boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

webpack boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

wireit boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

wrangler boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

xo boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

yarn boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

yorkie boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

zx boolean | globPatterns | object

Knip plugin configuration. See https://knip.dev/explanations/plugins

paths object
ruleValue string