Features
Overview of capabilities in support of the core feature: find many types of issues.
Also see related tooling.
Overview
Section titled “Overview”| Name | Description or example |
|---|---|
| Auto-fix | Use --fix to auto-fix issues |
| Cache | Use --cache to speed up consecutive runs |
| Catalog | Report & fix unused catalog entries |
| CommonJS | CommonJS is still widely used & supported, but conditions apply |
| Compilers | Support for Astro, MDX, Svelte, Vue and custom compilers |
| Configuration hints | Display configuration hints to keep knip.json tidy |
| Debug | Use --debug for troubleshooting |
| Filters | Exclude or focus on specific issue types |
| Format | Add --format to --fix and auto-format modified files |
| JSDoc tags | Tag and exclude specific exports from the report |
| Memory usage | Use --memory for detailed memory usage insights |
| Monorepos | Workspaces are first-class citizen |
| Performance | Use --performance for detailed timing insights |
| Plugins | Over 100 plugins with custom entry paths and config parsing |
| Plugins: inputs | Inputs are an affective mechanism to add entries, dependencies & more |
| Plugins: CLI arguments | Tool-specific CLI argument parsing make plugins go the extra mile |
| Preprocessors | Preprocess issues before being reported |
| Production mode | Use --production to lint only production code |
| Reporters | Choose from many built-in reporters or use your own |
| Rules | Exclude or focus on specific issue types |
| Script parser | Shell scripts and package.json contain entry paths and dependencies |
| Source mapping | Map dist files back to src files |
| Strict mode | Use --strict to isolate workspaces and consider only dependencies |
| Trace | Trace exports to find where they are used |
| Watch mode | Use --watch for live updates of unused files and exports |
| Workspace | Use --workspace to lint a single workspace in a monorepo |
ISC License © 2024 Lars Kappert