knip 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -61,14 +61,14 @@ Create a configuration file, let's give it the default name `knip.json` with the
 
 ```json
 {
-  "$schema": "https://unpkg.com/knip@alpha/schema.json",
+  "$schema": "https://unpkg.com/knip@next/schema.json",
   "entry": ["src/index.ts"],
   "project": ["src/**/*.ts"]
 }
 ```
 
-The `entry` files target the starting point(s) to resolve code dependencies. The `project` files should contain all
-files it should match them against, including potentially unused files.
+The `entry` files target the starting point(s) to resolve the rest of the imported code. The `project` files should
+contain all files to match against the files resolved from the entry files, including potentially unused files.
 
 Then run the checks:
 
@@ -184,7 +184,7 @@ be part of the analysis. Here's a simple example:
 ```jsonc
 {
   "ignore": "**/fixtures/**",
-  "ignoreBinaries": ["deno", "git"],
+  "ignoreBinaries": ["rm", "docker-compose"],
   "ignoreWorkspaces": ["packages/ignore-me"],
   "workspaces": {
     "packages/*": {
@@ -262,7 +262,7 @@ idea of how they work and why they are needed:
 - Static configuration files such as JSON and YAML always require a custom dependency resolver.
 
 Custom dependency resolvers return all referenced dependencies for the configuration files it is given. Knip handles the
-rest.
+rest to find which of those dependencies are unused or missing.
 
 ### `entry`
 

package/dist/configuration-chief.d.ts

@@ -15,6 +15,7 @@ export default class ConfigurationChief {
     config: Configuration;
     manifestPath: undefined | string;
     manifest: undefined | PackageJson;
+    manifestWorkspaces: undefined | string[];
     constructor({ cwd, isStrict, isProduction }: ConfigurationManagerOptions);
     loadLocalConfig(): Promise<void>;
     normalize(rawLocalConfig: z.infer<typeof ConfigurationValidator>): {
@@ -35,7 +36,8 @@ export default class ConfigurationChief {
         config: WorkspaceConfiguration;
         ancestors: string[];
     }[]>;
-    getNegatedWorkspacePatterns(): Promise<string[]>;
+    getDescendentWorkspaces(name: string): Promise<string[]>;
+    getNegatedWorkspacePatterns(name: string): Promise<string[]>;
     private getConfigKeyForWorkspace;
     private hasConfigForWorkspace;
     getConfigForWorkspace(workspaceName: string): WorkspaceConfiguration;

package/dist/configuration-chief.js

@@ -8,12 +8,12 @@ import { arrayify } from './util/array.js';
 import { ConfigurationError } from './util/errors.js';
 import { findFile, loadJSON } from './util/fs.js';
 import parsedArgs from './util/parseArgs.js';
-import { resolveIncludedIssueTypes } from './util/resolveIncludedIssueTypes.js';
+import { resolveIncludedIssueTypes } from './util/resolve-included-issue-types.js';
 import { byPathDepth } from './util/workspace.js';
 const { values: { config: rawConfigArg, workspace: rawWorkspaceArg, include = [], exclude = [] }, } = parsedArgs;
 const defaultWorkspaceConfig = {
-    entry: ['index.{js,ts,tsx}', 'src/index.{js,ts,tsx}'],
-    project: ['**/*.{js,ts,tsx}'],
+    entry: ['index.{js,ts,tsx}!', 'src/index.{js,ts,tsx}!'],
+    project: ['**/*.{js,ts,tsx}!'],
     ignore: [],
 };
 const defaultConfig = {
@@ -35,6 +35,7 @@ export default class ConfigurationChief {
     config;
     manifestPath;
     manifest;
+    manifestWorkspaces;
     constructor({ cwd, isStrict, isProduction }) {
         this.cwd = cwd ?? this.cwd;
         this.isStrict = isStrict;
@@ -99,8 +100,8 @@ export default class ConfigurationChief {
                         }
                         else {
                             const isObject = typeof pluginConfig !== 'string' && !Array.isArray(pluginConfig);
-                            const config = isObject ? arrayify(pluginConfig.config) : arrayify(pluginConfig);
-                            const entry = isObject && 'entry' in pluginConfig ? arrayify(pluginConfig.entry) : [];
+                            const config = typeof pluginConfig === 'string' ? [pluginConfig] : isObject ? arrayify(pluginConfig.config) : null;
+                            const entry = isObject && 'entry' in pluginConfig ? arrayify(pluginConfig.entry) : null;
                             const project = isObject && 'project' in pluginConfig ? arrayify(pluginConfig.project) : entry;
                             workspaces[workspaceName][pluginName] = {
                                 config,
@@ -115,6 +116,8 @@ export default class ConfigurationChief {
         };
     }
     async getManifestWorkspaces() {
+        if (this.manifestWorkspaces)
+            return this.manifestWorkspaces;
         if (this.manifest) {
             const workspaces = await mapWorkspaces({
                 pkg: this.manifest,
@@ -122,7 +125,8 @@ export default class ConfigurationChief {
                 ignore: this.config.ignoreWorkspaces,
                 absolute: false,
             });
-            return Array.from(workspaces.values()).map(workspaceDir => path.relative(this.cwd, workspaceDir));
+            this.manifestWorkspaces = Array.from(workspaces.values()).map(dir => path.relative(this.cwd, dir));
+            return this.manifestWorkspaces;
         }
         return [];
     }
@@ -172,11 +176,17 @@ export default class ConfigurationChief {
             }, []),
         }));
     }
-    async getNegatedWorkspacePatterns() {
+    async getDescendentWorkspaces(name) {
         const manifestWorkspaces = await this.getManifestWorkspaces();
         const additionalWorkspaces = this.getAdditionalWorkspaces(manifestWorkspaces);
         return [...manifestWorkspaces, ...additionalWorkspaces]
-            .filter(workspaceName => workspaceName !== ROOT_WORKSPACE_NAME)
+            .filter(workspaceName => workspaceName !== name)
+            .filter(workspaceName => name === ROOT_WORKSPACE_NAME || workspaceName.startsWith(name));
+    }
+    async getNegatedWorkspacePatterns(name) {
+        const descendentWorkspaces = await this.getDescendentWorkspaces(name);
+        return descendentWorkspaces
+            .map(workspaceName => path.relative(path.join(this.cwd, name), workspaceName))
             .map(workspaceName => `!${workspaceName}`);
     }
     getConfigKeyForWorkspace(workspaceName) {
@@ -191,9 +201,8 @@ export default class ConfigurationChief {
     }
     getConfigForWorkspace(workspaceName) {
         const key = this.getConfigKeyForWorkspace(workspaceName);
-        if (key) {
-            return this.config?.workspaces?.[key] ?? { entry: [], project: [], ignore: [] };
-        }
+        if (key && this.config?.workspaces?.[key])
+            return this.config.workspaces[key];
         return { entry: [], project: [], ignore: [] };
     }
     resolveIncludedIssueTypes() {

package/dist/index.js

@@ -7,7 +7,7 @@ import ProjectPrincipal from './project-principal.js';
 import SourceLab from './source-lab.js';
 import { compact } from './util/array.js';
 import { debugLogObject, debugLogFiles } from './util/debug.js';
-import { _findImportModuleSpecifiers } from './util/externalImports.js';
+import { _findImportModuleSpecifiers } from './util/find-import-specifiers.js';
 import { findFile, loadJSON } from './util/fs.js';
 import { _glob } from './util/glob.js';
 import { getPackageNameFromModuleSpecifier } from './util/modules.js';
@@ -24,7 +24,6 @@ export const main = async (unresolvedConfiguration) => {
     await chief.loadLocalConfig();
     const deputy = new DependencyDeputy({ ignoreDependencies: chief.config.ignoreDependencies });
     const workspaces = await chief.getActiveWorkspaces();
-    const negatedWorkspacePatterns = await chief.getNegatedWorkspacePatterns();
     debugLogObject('Included workspaces', workspaces);
     const report = chief.resolveIncludedIssueTypes();
     const workspaceDirs = Object.values(workspaces)
@@ -54,6 +53,7 @@ export const main = async (unresolvedConfiguration) => {
         const workspaceManifest = deputy.getWorkspaceManifest(name);
         if (!workspaceManifest)
             continue;
+        const negatedWorkspacePatterns = await chief.getNegatedWorkspacePatterns(name);
         const worker = new WorkspaceWorker({
             name,
             dir,

package/dist/plugins/_template/index.d.ts

@@ -0,0 +1,7 @@
+import type { IsPluginEnabledCallback, GenericPluginCallback } from '../../types/plugins.js';
+export declare const CONFIG_FILE_PATTERNS: never[];
+export declare const ENTRY_FILE_PATTERNS: never[];
+export declare const PRODUCTION_ENTRY_FILE_PATTERNS: never[];
+export declare const PROJECT_FILE_PATTERNS: never[];
+export declare const isEnabled: IsPluginEnabledCallback;
+export declare const findDependencies: GenericPluginCallback;

package/dist/plugins/_template/index.js

@@ -0,0 +1,14 @@
+import { _load } from '../../util/loader.js';
+import { timerify } from '../../util/performance.js';
+export const CONFIG_FILE_PATTERNS = [];
+export const ENTRY_FILE_PATTERNS = [];
+export const PRODUCTION_ENTRY_FILE_PATTERNS = [];
+export const PROJECT_FILE_PATTERNS = [];
+export const isEnabled = ({ dependencies }) => {
+    return dependencies.has('[pkg]');
+};
+const findPluginDependencies = async (configFilePath, { manifest }) => {
+    const config = configFilePath.endsWith('package.json') ? manifest.plugin : await _load(configFilePath);
+    return config?.plugins ?? [];
+};
+export const findDependencies = timerify(findPluginDependencies);

package/dist/plugins/_template/types.d.ts

@@ -0,0 +1,3 @@
+export type PluginConfig = {
+    plugins?: string[];
+};

package/dist/plugins/_template/types.js

@@ -0,0 +1 @@
+export {};

package/dist/plugins/postcss/index.d.ts

@@ -1,4 +1,5 @@
 import type { IsPluginEnabledCallback, GenericPluginCallback } from '../../types/plugins.js';
 export declare const isEnabled: IsPluginEnabledCallback;
 export declare const CONFIG_FILE_PATTERNS: string[];
+export declare const ENTRY_FILE_PATTERNS: string[];
 export declare const findDependencies: GenericPluginCallback;

package/dist/plugins/postcss/index.js

@@ -3,12 +3,15 @@ import { getPackageName } from '../../util/modules.js';
 import { timerify } from '../../util/performance.js';
 export const isEnabled = ({ dependencies }) => dependencies.has('postcss');
 export const CONFIG_FILE_PATTERNS = ['postcss.config.js', 'package.json'];
+export const ENTRY_FILE_PATTERNS = ['postcss.config.js'];
 const findPostCSSDependencies = async (configFilePath, { manifest }) => {
     const config = configFilePath.endsWith('package.json')
         ? manifest?.postcss
         : await _load(configFilePath);
     return config?.plugins
-        ? (Array.isArray(config.plugins) ? config.plugins : Object.keys(config.plugins)).map(getPackageName)
+        ? (Array.isArray(config.plugins) ? config.plugins : Object.keys(config.plugins))
+            .filter(plugin => typeof plugin === 'string')
+            .map(getPackageName)
         : [];
 };
 export const findDependencies = timerify(findPostCSSDependencies);

package/dist/types/config.d.ts

@@ -1,34 +1,12 @@
+import * as Plugins from '../plugins/index.js';
 type NormalizedGlob = string[];
+export type PluginName = keyof typeof Plugins;
 export type PluginConfiguration = {
-    config: NormalizedGlob;
-    entry: NormalizedGlob;
-    project: NormalizedGlob;
+    config: NormalizedGlob | null;
+    entry: NormalizedGlob | null;
+    project: NormalizedGlob | null;
 } | false;
-interface PluginsConfiguration {
-    babel: PluginConfiguration;
-    capacitor: PluginConfiguration;
-    changesets: PluginConfiguration;
-    commitlint: PluginConfiguration;
-    cypress: PluginConfiguration;
-    eslint: PluginConfiguration;
-    gatsby: PluginConfiguration;
-    jest: PluginConfiguration;
-    mocha: PluginConfiguration;
-    next: PluginConfiguration;
-    nx: PluginConfiguration;
-    nyc: PluginConfiguration;
-    playwright: PluginConfiguration;
-    postcss: PluginConfiguration;
-    prettier: PluginConfiguration;
-    remark: PluginConfiguration;
-    remix: PluginConfiguration;
-    rollup: PluginConfiguration;
-    sentry: PluginConfiguration;
-    storybook: PluginConfiguration;
-    stryker: PluginConfiguration;
-    typescript: PluginConfiguration;
-    webpack: PluginConfiguration;
-}
+type PluginsConfiguration = Record<PluginName, PluginConfiguration>;
 interface BaseWorkspaceConfiguration {
     entry: NormalizedGlob;
     project: NormalizedGlob;
@@ -36,7 +14,6 @@ interface BaseWorkspaceConfiguration {
 }
 export interface WorkspaceConfiguration extends BaseWorkspaceConfiguration, Partial<PluginsConfiguration> {
 }
-export type PluginName = keyof PluginsConfiguration;
 export interface Configuration {
     include: string[];
     exclude: string[];

package/dist/util/{externalImports.js → find-import-specifiers.js}

@@ -30,8 +30,12 @@ const findImportModuleSpecifiers = (sourceFile, options = { skipInternal: false
     const moduleSpecifiers = compact([...importLiterals, ...requireCallExpressions].map(importLiteral => {
         if (!importLiteral)
             return;
-        if (importLiteral.isKind(ts.SyntaxKind.TemplateExpression))
-            return importLiteral.getFullText().slice(1, -1);
+        if (importLiteral.isKind(ts.SyntaxKind.TemplateExpression)) {
+            const literalText = importLiteral.getFullText();
+            if (literalText.includes('${'))
+                return;
+            return literalText.slice(1, -1);
+        }
         return importLiteral?.getLiteralText();
     }));
     const internalModuleSpecifiers = options.skipInternal ? [] : resolveInternal(filePath, moduleSpecifiers);

package/dist/workspace-worker.js

@@ -37,7 +37,7 @@ export default class WorkspaceWorker {
         this.enabled = Object.keys(plugins).reduce((enabled, pluginName) => ({ ...enabled, [pluginName]: false }), {});
     }
     getConfigForPlugin(pluginName) {
-        return this.config[pluginName] ?? { config: [], entry: [], project: [] };
+        return this.config[pluginName] ?? { config: null, entry: null, project: null };
     }
     async init() {
         this.setEnabledPlugins();
@@ -76,7 +76,7 @@ export default class WorkspaceWorker {
         const { entry } = this.config;
         if (entry.length === 0)
             return [];
-        return [entry, TEST_FILE_PATTERNS, this.isRoot ? this.negatedWorkspacePatterns : []].flat();
+        return [entry, TEST_FILE_PATTERNS, this.negatedWorkspacePatterns].flat();
     }
     getProjectFilePatterns() {
         const { project } = this.config;
@@ -91,7 +91,7 @@ export default class WorkspaceWorker {
             negatedPluginEntryFilePatterns,
             negatedPluginProjectFilePatterns,
             TEST_FILE_PATTERNS,
-            this.isRoot ? this.negatedWorkspacePatterns : [],
+            this.negatedWorkspacePatterns,
         ].flat();
     }
     getPluginEntryFilePatterns(isIncludeProductionEntryFiles = true) {
@@ -101,14 +101,14 @@ export default class WorkspaceWorker {
             if (this.enabled[pluginName] && pluginConfig) {
                 const { entry } = pluginConfig;
                 const defaultEntryFiles = 'ENTRY_FILE_PATTERNS' in plugin ? plugin.ENTRY_FILE_PATTERNS : [];
-                patterns.push(...(entry.length > 0 ? entry : defaultEntryFiles));
+                patterns.push(...(entry ?? defaultEntryFiles));
                 if (isIncludeProductionEntryFiles) {
                     const entry = 'PRODUCTION_ENTRY_FILE_PATTERNS' in plugin ? plugin.PRODUCTION_ENTRY_FILE_PATTERNS : [];
                     patterns.push(...entry);
                 }
             }
         }
-        return [patterns, this.isRoot ? this.negatedWorkspacePatterns : []].flat();
+        return [patterns, this.negatedWorkspacePatterns].flat();
     }
     getPluginProjectFilePatterns() {
         const patterns = [];
@@ -116,18 +116,16 @@ export default class WorkspaceWorker {
             const pluginConfig = this.getConfigForPlugin(pluginName);
             if (this.enabled[pluginName] && pluginConfig) {
                 const { entry, project } = pluginConfig;
-                const defaultEntryFiles = 'ENTRY_FILE_PATTERNS' in plugin ? plugin.ENTRY_FILE_PATTERNS : [];
-                const defaultProjectFiles = 'PROJECT_FILE_PATTERNS' in plugin ? plugin.PROJECT_FILE_PATTERNS : defaultEntryFiles;
-                patterns.push(...(project.length > 0
-                    ? project
-                    : defaultProjectFiles.length > 0
-                        ? defaultProjectFiles
-                        : entry.length > 0
-                            ? entry
-                            : defaultEntryFiles));
+                patterns.push(...(project ??
+                    entry ??
+                    ('PROJECT_FILE_PATTERNS' in plugin
+                        ? plugin.PROJECT_FILE_PATTERNS
+                        : 'ENTRY_FILE_PATTERNS' in plugin
+                            ? plugin.ENTRY_FILE_PATTERNS
+                            : [])));
             }
         }
-        return [patterns, this.isRoot ? this.negatedWorkspacePatterns : []].flat();
+        return [patterns, this.negatedWorkspacePatterns].flat();
     }
     getPluginConfigPatterns() {
         const patterns = [];
@@ -136,7 +134,7 @@ export default class WorkspaceWorker {
             if (this.enabled[pluginName] && pluginConfig) {
                 const { config } = pluginConfig;
                 const defaultConfigFiles = 'CONFIG_FILE_PATTERNS' in plugin ? plugin.CONFIG_FILE_PATTERNS : [];
-                patterns.push(...(config.length > 0 ? config : defaultConfigFiles));
+                patterns.push(...(config ?? defaultConfigFiles));
             }
         }
         return patterns;
@@ -146,7 +144,7 @@ export default class WorkspaceWorker {
         if (entry.length === 0)
             return [];
         const negatedEntryFiles = this.config.entry.filter(hasNoProductionSuffix).map(negate);
-        return [entry, negatedEntryFiles, negatedTestFilePatterns, this.isRoot ? this.negatedWorkspacePatterns : []].flat();
+        return [entry, negatedEntryFiles, negatedTestFilePatterns, this.negatedWorkspacePatterns].flat();
     }
     getProductionProjectFilePatterns() {
         const project = this.config.project;
@@ -168,7 +166,7 @@ export default class WorkspaceWorker {
             negatedPluginEntryFilePatterns,
             negatedPluginProjectFilePatterns,
             negatedTestFilePatterns,
-            this.isRoot ? this.negatedWorkspacePatterns : [],
+            this.negatedWorkspacePatterns,
         ].flat();
     }
     getProductionPluginEntryFilePatterns() {
@@ -177,9 +175,7 @@ export default class WorkspaceWorker {
             const pluginConfig = this.getConfigForPlugin(pluginName);
             if (this.enabled[pluginName] && pluginConfig) {
                 if ('PRODUCTION_ENTRY_FILE_PATTERNS' in plugin) {
-                    const { entry } = pluginConfig;
-                    const defaultEntryFiles = plugin.PRODUCTION_ENTRY_FILE_PATTERNS;
-                    patterns.push(...(entry.length > 0 ? entry : defaultEntryFiles));
+                    patterns.push(...(pluginConfig.entry ?? plugin.PRODUCTION_ENTRY_FILE_PATTERNS));
                 }
             }
         }
@@ -191,9 +187,8 @@ export default class WorkspaceWorker {
         const plugin = plugins[pluginName];
         const pluginConfig = this.getConfigForPlugin(pluginName);
         if (pluginConfig) {
-            const { config } = pluginConfig;
             const defaultConfig = 'CONFIG_FILE_PATTERNS' in plugin ? plugin.CONFIG_FILE_PATTERNS : [];
-            return config.length > 0 ? config : defaultConfig;
+            return pluginConfig.config ?? defaultConfig;
         }
         return [];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript project",
   "keywords": [
     "find",
@@ -42,7 +42,9 @@
     "prepublishOnly": "npm test && npm run build && npm run knip",
     "format": "remark README.md -o",
     "release": "release-it",
-    "postinstall": "patch-package"
+    "postinstall": "patch-package",
+    "add-plugin:help": "echo 'Usage: npm run add-plugin --name=[name] (and update README.md and schema.json)'",
+    "add-plugin": "cp -R src/plugins/_template src/plugins/$npm_config_name && echo \"export * as $npm_config_name from \\\"./$npm_config_name/index.js\\\";\" >> src/plugins/index.ts"
   },
   "files": [
     "dist",
@@ -59,7 +61,7 @@
     "@snyk/github-codeowners": "1.1.0",
     "chalk": "5.2.0",
     "easy-table": "1.2.0",
-    "esbuild": "0.16.10",
+    "esbuild": "0.16.11",
     "esbuild-register": "3.4.2",
     "eslint": "8.30.0",
     "fast-glob": "3.2.12",
@@ -81,11 +83,11 @@
     "@types/eslint": "8.4.10",
     "@types/js-yaml": "4.0.5",
     "@types/micromatch": "4.0.2",
-    "@types/node": "18.11.17",
+    "@types/node": "18.11.18",
     "@types/npmcli__map-workspaces": "3.0.0",
     "@types/webpack": "5.28.0",
-    "@typescript-eslint/eslint-plugin": "5.47.0",
-    "@typescript-eslint/parser": "5.47.0",
+    "@typescript-eslint/eslint-plugin": "5.47.1",
+    "@typescript-eslint/parser": "5.47.1",
     "eslint-import-resolver-typescript": "3.5.2",
     "eslint-plugin-import": "2.26.0",
     "globstar": "1.0.0",
@@ -93,7 +95,7 @@
     "remark-cli": "11.0.0",
     "remark-preset-webpro": "0.0.1",
     "tsx": "3.12.1",
-    "type-fest": "3.4.0",
+    "type-fest": "3.5.0",
     "typescript": "4.9.4"
   },
   "release-it": {

package/schema.json

@@ -1,5 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Knip configuration",
+  "description": "See https://github.com/webpro/knip",
   "type": "object",
   "allOf": [
     {
@@ -7,25 +9,45 @@
     },
     {
       "$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",
+      "examples": ["rm", "docker-compose", "eslint"],
       "$ref": "#/definitions/list"
     },
     "ignoreDependencies": {
+      "title": "Dependencies from package.json to ignore",
+      "examples": ["husky", "lint-staged"],
       "$ref": "#/definitions/list"
     },
     "ignoreWorkspaces": {
+      "title": "Workspaces to ignore",
+      "examples": ["packages/ignore-me"],
       "$ref": "#/definitions/list"
     },
     "include": {
-      "$ref": "#/definitions/list"
+      "title": "Include issue types in the report",
+      "examples": ["files", "dependencies"],
+      "$ref": "#/definitions/issueTypes"
     },
     "exclude": {
-      "$ref": "#/definitions/list"
+      "title": "Exclude issue types from the report",
+      "examples": ["classMembers", "enumMembers"],
+      "$ref": "#/definitions/issueTypes"
     },
     "workspaces": {
+      "title": "Configuration for workspaces",
       "type": "object",
       "additionalProperties": {
         "allOf": [
@@ -48,7 +70,26 @@
         "type": "string"
       }
     },
+    "issueTypes": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "files",
+          "dependencies",
+          "unlisted",
+          "exports",
+          "nsExports",
+          "classMembers",
+          "types",
+          "nsTypes",
+          "enumMembers",
+          "duplicates"
+        ]
+      }
+    },
     "globPatterns": {
+      "description": "Use file paths and glob patterns to match files. Knip uses fast-glob and and minimatch (https://github.com/micromatch/micromatch#matching-features)",
       "anyOf": [
         {
           "type": "string"
@@ -62,22 +103,30 @@
       ]
     },
     "workspace": {
-      "description": "Workspace configuration.",
       "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"
         },
         "ignore": {
+          "title": "Files to ignore in the analysis.",
+          "example": ["**/fixtures", "mocks"],
+          "default": [],
           "$ref": "#/definitions/globPatterns"
         }
       }
     },
     "plugin": {
-      "description": "Knip plugin configuration. See https://github.com/webpro/knip#plugins",
+      "description": "Knip plugin configuration. See https://github.com/webpro/knip/blob/next/README.md#plugins",
       "anyOf": [
         { "const": false },
         {
@@ -87,12 +136,17 @@
           "type": "object",
           "properties": {
             "config": {
+              "title": "The custom dependency resolver of this plugin is applied to the files listed here. Also see https://github.com/webpro/knip/blob/next/README.md#config",
+              "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"
             }
           },
@@ -103,72 +157,95 @@
     "plugins": {
       "properties": {
         "babel": {
+          "title": "Babel plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/babel/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "capacitor": {
+          "title": "Capacitor plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/capacitor/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "changesets": {
+          "title": "Changesets plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/changesets/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "commitlint": {
+          "title": "commitlint plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/commitlint/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "cypress": {
+          "title": "Cypress plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/cypress/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "eslint": {
+          "title": "ESLint plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/eslint/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "gatsby": {
+          "title": "Gatsby plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/gatsby/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "jest": {
+          "title": "Jest plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/jest/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "mocha": {
+          "title": "Mocha plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/mocha/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "next": {
+          "title": "Next.js plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/next/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "nx": {
+          "title": "Nx plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/nx/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "nyc": {
+          "title": "nyc plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/nyc/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "playwright": {
+          "title": "Playwright plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/playwright/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "postcss": {
+          "title": "PostCSS plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/postcss/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "prettier": {
+          "title": "Prettier plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/prettier/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "remark": {
+          "title": "Remark plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/remark/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "remix": {
+          "title": "Remix plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/remix/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "rollup": {
+          "title": "Rollup plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/rollup/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "sentry": {
+          "title": "Sentry plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/sentry/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "storybook": {
+          "title": "Storybook plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/storybook/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "stryker": {
+          "title": "Stryker plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/stryker/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "typescript": {
+          "title": "TypeScript plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/typescript/README.md)",
           "$ref": "#/definitions/plugin"
         },
         "webpack": {
+          "title": "Webpack plugin configuration (https://github.com/webpro/knip/blob/next/src/plugins/webpack/README.md)",
           "$ref": "#/definitions/plugin"
         }
       }