knip 4.0.0 → 4.0.2

package/dist/index.js

@@ -403,9 +403,8 @@ export const main = async (unresolvedConfiguration) => {
                         continue;
                     if (exportedItem.jsDocTags.includes('@alias'))
                         continue;
-                    if (exportedItem.type !== 'enum' && exportedItem.type !== 'class' && shouldIgnore(exportedItem, tags)) {
+                    if (shouldIgnore(exportedItem, tags))
                         continue;
-                    }
                     if (isProduction && exportedItem.jsDocTags.includes('@internal'))
                         continue;
                     if (importsForExport) {
@@ -487,9 +486,8 @@ export const main = async (unresolvedConfiguration) => {
             const workspace = chief.findWorkspaceByFilePath(filePath);
             const principal = workspace && factory.getPrincipalByPackageName(workspace.pkgName);
             if (principal) {
-                principal.findUnusedMembers(filePath, exportedItem.members).forEach(member => {
-                    if (shouldIgnore(member, tags))
-                        return;
+                const members = exportedItem.members.filter(member => !shouldIgnore(member, tags));
+                principal.findUnusedMembers(filePath, members).forEach(member => {
                     collector.addIssue({
                         type: 'classMembers',
                         filePath,

package/dist/util/debug.js

@@ -8,7 +8,9 @@ const IS_TRACE_ENABLED = trace ?? false;
 const noop = () => { };
 const inspectOptions = { maxArrayLength: null, depth: null, colors: true };
 export const inspect = (obj) => console.log(util.inspect(obj, inspectOptions));
-const ctx = (text) => typeof text === 'string' ? picocolors.yellow(`[${text}]`) : `${picocolors.yellow(`[${text[0]}]`)} ${picocolors.cyan(text[1])}`;
+const ctx = (text) => typeof text === 'string'
+    ? picocolors.yellow(`[${text}]`)
+    : `${picocolors.yellow(`[${text[0]}]`)} ${picocolors.cyan(text[1])}`;
 const logArray = (collection) => {
     console.log(util.inspect(collection.sort(), inspectOptions));
 };

package/dist/util/loader.js

@@ -11,7 +11,7 @@ const load = async (filePath) => {
         return;
     try {
         const ext = extname(filePath);
-        if (/rc$/.test(filePath)) {
+        if (filePath.endsWith('rc')) {
             const contents = await loadFile(filePath);
             return parseYAML(contents).catch(() => parseJSON(filePath, contents));
         }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "4.0.0";
+export declare const version = "4.0.2";

package/dist/version.js

@@ -1 +1 @@
-export const version = '4.0.0';
+export const version = '4.0.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://knip.dev",
   "repository": {
@@ -74,7 +74,7 @@
     "strip-json-comments": "5.0.1",
     "summary": "2.1.0",
     "zod": "3.22.4",
-    "zod-validation-error": "2.1.0"
+    "zod-validation-error": "3.0.0"
   },
   "peerDependencies": {
     "@types/node": ">=18",
@@ -85,7 +85,7 @@
     "@knip/eslint-config": "0.0.0",
     "@release-it/bumper": "^6.0.1",
     "@swc/cli": "^0.1.63",
-    "@swc/core": "^1.3.103",
+    "@swc/core": "^1.3.104",
     "@types/js-yaml": "^4.0.9",
     "@types/micromatch": "^4.0.6",
     "@types/minimist": "^1.2.5",
@@ -95,8 +95,8 @@
     "@types/webpack": "^5.28.5",
     "c8": "9.1.0",
     "eslint": "^8.56.0",
-    "playwright": "^1.40.1",
-    "prettier": "^3.2.2",
+    "playwright": "^1.41.0",
+    "prettier": "^3.2.4",
     "release-it": "^17.0.1",
     "tsx": "^4.7.0",
     "type-fest": "^4.9.0",

package/schema.json

@@ -0,0 +1,493 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Knip configuration for JSON",
+  "description": "See https://github.com/webpro/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"
+    },
+    "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": {
+        "classMembers": {
+          "$ref": "#/definitions/ruleValue"
+        },
+        "dependencies": {
+          "$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 minimatch (https://github.com/micromatch/micromatch#matching-features)",
+      "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://github.com/webpro/knip#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://github.com/webpro/knip/blob/main/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"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "plugins": {
+      "properties": {
+        "angular": {
+          "title": "angular plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/angular/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "astro": {
+          "title": "astro plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/astro/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "ava": {
+          "title": "ava plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/ava/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "babel": {
+          "title": "Babel plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/babel/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "capacitor": {
+          "title": "Capacitor plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/capacitor/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "changesets": {
+          "title": "Changesets plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/changesets/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "commitizen": {
+          "title": "commitizen plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/commitizen/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "commitlint": {
+          "title": "commitlint plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/commitlint/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "cspell": {
+          "title": "cspell plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/cspell/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "cypress": {
+          "title": "Cypress plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/cypress/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "drizzle": {
+          "title": "Drizzle plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/drizzle/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "eleventy": {
+          "title": "eleventy plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/eleventy/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "eslint": {
+          "title": "ESLint plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/eslint/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "gatsby": {
+          "title": "Gatsby plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/gatsby/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "github-actions": {
+          "title": "github-actions plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/github-actions/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "graphql-codegen": {
+          "title": "graphql-codegen plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/graphql-codegen/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "husky": {
+          "title": "husky plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/husky/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "jest": {
+          "title": "Jest plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/jest/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "lefthook": {
+          "title": "lefthook plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/lefthook/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "lint-staged": {
+          "title": "lint-staged plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/lint-staged/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "linthtml": {
+          "title": "linthtml plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/linthtml/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "markdownlint": {
+          "title": "markdownlint plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/markdownlint/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "mocha": {
+          "title": "Mocha plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/mocha/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "next": {
+          "title": "Next.js plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/main/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "node-test-runner": {
+          "title": "node-test-runner plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/node-test-runner/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "npm-package-json-lint": {
+          "title": "npm-package-json-lint plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/npm-package-json-lint/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "nx": {
+          "title": "Nx plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/nx/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "nyc": {
+          "title": "nyc plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/nyc/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "playwright": {
+          "title": "Playwright plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/playwright/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "playwright-ct": {
+          "title": "Playwright for components plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/playwright-ct/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "postcss": {
+          "title": "PostCSS plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/postcss/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "prettier": {
+          "title": "Prettier plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/prettier/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "release-it": {
+          "title": "Release It plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/release-it/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "remark": {
+          "title": "Remark plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/remark/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "remix": {
+          "title": "Remix plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/remix/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "rollup": {
+          "title": "Rollup plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/rollup/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "semantic-release": {
+          "title": "semantic-release plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/semantic-release/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "sentry": {
+          "title": "Sentry plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/sentry/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "storybook": {
+          "title": "Storybook plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/storybook/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "stryker": {
+          "title": "Stryker plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/stryker/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "stylelint": {
+          "title": "stylelint plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/stylelint/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "svelte": {
+          "title": "svelte plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/svelte/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "tailwind": {
+          "title": "tailwind plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/tailwind/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "tsup": {
+          "title": "tsup plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/tsup/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "typedoc": {
+          "title": "typedoc plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/typedoc/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "typescript": {
+          "title": "TypeScript plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/typescript/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "unbuild": {
+          "title": "unbuild plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/unbuild/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "vite": {
+          "title": "vite plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/vite/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "vitest": {
+          "title": "vitest plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/vitest/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "vue": {
+          "title": "vue plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/vue/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "webpack": {
+          "title": "Webpack plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/webpack/README.md)",
+          "$ref": "#/definitions/plugin"
+        },
+        "wireit": {
+          "title": "Wireit plugin configuration (https://github.com/webpro/knip/blob/main/src/plugins/wireit/README.md)",
+          "$ref": "#/definitions/plugin"
+        }
+      }
+    },
+    "paths": {
+      "type": "object",
+      "additionalProperty": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "ruleValue": {
+      "type": "string",
+      "enum": ["error", "warn", "off"]
+    }
+  }
+}