knip 0.4.1 → 0.4.2

package/README.md

@@ -22,12 +22,14 @@ This is where Knip comes in:
 - [x] Supports JavaScript-only projects using ESM (without a `tsconfig.json`)
 
 Knip really shines in larger projects where you have non-production files (such as `/docs`, `/tools` and `/scripts`).
-The `includes` setting in `tsconfig.json` is often too broad, resulting in too many false negatives. Similar projects
-either detect only unimported files, or only unused exports. Most of them don't work by configuring entry files, an
-essential feature to produce good results. This also allows to unleash knip on a specific part of your project, and work
-these separately.
+The `includes` setting in `tsconfig.json` is often too broad, resulting in too many false negatives. To produce good
+results it's essential to configure entry files. A comparison with similar toos answers the question
+[Why yet another unused file/dependency/export finder?](#why-yet-another-unused-filedependencyexport-finder)
 
-✂️ Knip is another fresh take on keeping your projects clean & tidy!
+Knip is a fresh take on keeping your projects clean & tidy!
+
+[![An orange cow with scissors, Van Gogh style](./assets/cow-with-orange-scissors-van-gogh-style.webp)](https://labs.openai.com/s/xZQACaLepaKya0PRUPtIN5dC)
+<sup>_“An orange cow with scissors, Van Gogh style” - generated with OpenAI_</sup>
 
 ## Installation
 

package/dist/cli.js

@@ -9,6 +9,7 @@ const node_util_1 = require("node:util");
 const _1 = require(".");
 const help_1 = require("./help");
 const reporters_1 = __importDefault(require("./reporters"));
+const errors_1 = require("./util/errors");
 const { values: { help, dir, config: configFilePath = 'knip.json', tsConfig: tsConfigFilePath, include = [], exclude = [], ignore = [], 'no-gitignore': isNoGitIgnore = false, dev: isDev = false, 'no-progress': noProgress = false, reporter = 'symbols', 'max-issues': maxIssues = '0', jsdoc: jsDoc = [], }, } = (0, node_util_1.parseArgs)({
     options: {
         help: { type: 'boolean' },
@@ -59,7 +60,7 @@ const run = async () => {
         }
     }
     catch (error) {
-        if (error instanceof Error) {
+        if (error instanceof errors_1.ConfigurationError) {
             console.error(error.message + '\n');
             (0, help_1.printHelp)();
             process.exit(1);

package/dist/index.js

@@ -11,6 +11,7 @@ const fs_1 = require("./util/fs");
 const path_1 = require("./util/path");
 const project_1 = require("./util/project");
 const runner_1 = require("./runner");
+const errors_1 = require("./util/errors");
 const main = async (options) => {
     const { cwd, workingDir, configFilePath = 'knip.json', tsConfigFilePath, include, exclude, ignore, gitignore, isDev, isShowProgress, jsDoc, } = options;
     const localConfigurationPath = configFilePath && (await (0, fs_1.findFile)(workingDir, configFilePath));
@@ -19,18 +20,18 @@ const main = async (options) => {
     const manifest = manifestPath && require(manifestPath);
     if (!localConfigurationPath && !manifest.knip) {
         const location = workingDir === cwd ? 'current directory' : `${node_path_1.default.relative(cwd, workingDir)} or up.`;
-        throw new Error(`Unable to find ${configFilePath} or package.json#knip in ${location}`);
+        throw new errors_1.ConfigurationError(`Unable to find ${configFilePath} or package.json#knip in ${location}`);
     }
     const dir = node_path_1.default.relative(cwd, workingDir);
     const resolvedConfig = (0, config_1.resolveConfig)(manifest.knip ?? localConfiguration, { workingDir: dir, isDev });
     if (!resolvedConfig) {
-        throw new Error('Unable to find `entryFiles` and/or `projectFiles` in configuration.');
+        throw new errors_1.ConfigurationError('Unable to find `entryFiles` and/or `projectFiles` in configuration.');
     }
     const report = (0, config_1.resolveIncludedIssueGroups)(include, exclude, resolvedConfig);
     let tsConfigPaths = [];
     const tsConfigPath = await (0, fs_1.findFile)(workingDir, tsConfigFilePath ?? 'tsconfig.json');
     if (tsConfigFilePath && !tsConfigPath) {
-        throw new Error(`Unable to find ${tsConfigFilePath}`);
+        throw new errors_1.ConfigurationError(`Unable to find ${tsConfigFilePath}`);
     }
     if (tsConfigPath) {
         const tsConfig = typescript_1.default.readConfigFile(tsConfigPath, typescript_1.default.sys.readFile);
@@ -38,10 +39,10 @@ const main = async (options) => {
             ? Object.keys(tsConfig.config.compilerOptions.paths).map(p => p.replace(/\*/g, '**'))
             : [];
         if (tsConfig.error) {
-            throw new Error(`An error occured when reading ${node_path_1.default.relative(cwd, tsConfigPath)}`);
+            throw new errors_1.ConfigurationError(`An error occured when reading ${node_path_1.default.relative(cwd, tsConfigPath)}`);
         }
     }
-    const projectOptions = tsConfigFilePath ? { tsConfigFilePath } : { compilerOptions: { allowJs: true } };
+    const projectOptions = tsConfigPath ? { tsConfigFilePath: tsConfigPath } : { compilerOptions: { allowJs: true } };
     const entryPaths = await (0, path_1.resolvePaths)({
         cwd,
         workingDir,

package/dist/util/errors.d.ts

@@ -0,0 +1,2 @@
+export declare class ConfigurationError extends Error {
+}

package/dist/util/errors.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurationError = void 0;
+class ConfigurationError extends Error {
+}
+exports.ConfigurationError = ConfigurationError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Find unused files and exports in your TypeScript project",
   "keywords": [
     "find",