knip 2.36.0 → 2.37.0

package/README.md

@@ -704,7 +704,7 @@ $ npx knip --help
       -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)
       --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated
       --preprocessor-options   Pass extra options to the preprocessor (as JSON string, see --reporter-options example)
-      --reporter               Select reporter: symbols, compact, codeowners, json, can be repeated (default: symbols)
+      --reporter               Select reporter: symbols, compact, codeowners, json, jsonExt, can be repeated (default: symbols)
       --reporter-options       Pass extra options to the reporter (as JSON string, see example)
       --no-config-hints        Suppress configuration hints
       --no-exit-code           Always exit with code zero (0)

package/dist/ProjectPrincipal.d.ts

@@ -58,7 +58,12 @@ export declare class ProjectPrincipal {
         external: boolean;
         internal: boolean;
     };
-    findUnusedMembers(filePath: string, members: ExportItemMember[]): string[];
+    findUnusedMembers(filePath: string, members: ExportItemMember[]): ExportItemMember[];
     private findReferences;
+    getPos(node: ts.Node, pos: number): {
+        pos: number;
+        line: number;
+        col: number;
+    };
 }
 export {};

package/dist/ProjectPrincipal.js

@@ -2,7 +2,7 @@ import { isGitIgnoredSync } from 'globby';
 import ts from 'typescript';
 import { DEFAULT_EXTENSIONS } from './constants.js';
 import { IGNORED_FILE_EXTENSIONS } from './constants.js';
-import { getJSDocTags, isInModuleBlock } from './typescript/ast-helpers.js';
+import { getJSDocTags, getLineAndCharacterOfPosition, isInModuleBlock } from './typescript/ast-helpers.js';
 import { createHosts } from './typescript/createHosts.js';
 import { getImportsAndExports } from './typescript/getImportsAndExports.js';
 import { SourceFileManager } from './typescript/SourceFileManager.js';
@@ -176,8 +176,7 @@ export class ProjectPrincipal {
         return hasReferences;
     }
     findUnusedMembers(filePath, members) {
-        return members
-            .filter(member => {
+        return members.filter(member => {
             if (getJSDocTags(member.node).has('@public'))
                 return false;
             const referencedSymbols = this.findReferences(filePath, member.pos);
@@ -188,8 +187,7 @@ export class ProjectPrincipal {
             const internalRefs = files.filter(f => f === filePath);
             const externalRefs = files.filter(f => f !== filePath);
             return externalRefs.length === 0 && internalRefs.length === 0;
-        })
-            .map(member => member.identifier);
+        });
     }
     findReferences(filePath, pos) {
         try {
@@ -199,4 +197,8 @@ export class ProjectPrincipal {
             return [];
         }
     }
+    getPos(node, pos) {
+        const { line, character } = getLineAndCharacterOfPosition(node, pos);
+        return { pos, line: line + 1, col: character + 1 };
+    }
 }

package/dist/index.js

@@ -304,12 +304,24 @@ export const main = async (unresolvedConfiguration) => {
                             if (isProduction)
                                 continue;
                             principal.findUnusedMembers(filePath, exportedItem.members).forEach(member => {
-                                collector.addIssue({ type: 'enumMembers', filePath, symbol: member, parentSymbol: symbol });
+                                collector.addIssue({
+                                    type: 'enumMembers',
+                                    filePath,
+                                    symbol: member.identifier,
+                                    parentSymbol: symbol,
+                                    ...principal.getPos(member.node, member.pos),
+                                });
                             });
                         }
                         if (report.classMembers && exportedItem.type === 'class' && exportedItem.members) {
                             principal.findUnusedMembers(filePath, exportedItem.members).forEach(member => {
-                                collector.addIssue({ type: 'classMembers', filePath, symbol: member, parentSymbol: symbol });
+                                collector.addIssue({
+                                    type: 'classMembers',
+                                    filePath,
+                                    symbol: member.identifier,
+                                    parentSymbol: symbol,
+                                    ...principal.getPos(member.node, member.pos),
+                                });
                             });
                         }
                         continue;
@@ -321,11 +333,22 @@ export const main = async (unresolvedConfiguration) => {
                             if (isProduction)
                                 continue;
                             const type = isStar ? 'nsTypes' : 'types';
-                            collector.addIssue({ type, filePath, symbol, symbolType: exportedItem.type });
+                            collector.addIssue({
+                                type,
+                                filePath,
+                                symbol,
+                                symbolType: exportedItem.type,
+                                ...principal.getPos(exportedItem.node, exportedItem.pos),
+                            });
                         }
                         else {
                             const type = isStar ? 'nsExports' : 'exports';
-                            collector.addIssue({ type, filePath, symbol });
+                            collector.addIssue({
+                                type,
+                                filePath,
+                                symbol,
+                                ...principal.getPos(exportedItem.node, exportedItem.pos),
+                            });
                         }
                     }
                 }

package/dist/reporters/index.d.ts

@@ -3,5 +3,6 @@ declare const _default: {
     compact: ({ report, issues, isShowProgress }: import("../index.js").ReporterOptions) => void;
     codeowners: ({ report, issues, isShowProgress, options }: import("../index.js").ReporterOptions) => void;
     json: ({ report, issues, options }: import("../index.js").ReporterOptions) => Promise<void>;
+    jsonExt: ({ report, issues, options }: import("../index.js").ReporterOptions) => Promise<void>;
 };
 export default _default;

package/dist/reporters/index.js

@@ -1,10 +1,12 @@
 import codeowners from './codeowners.js';
 import compact from './compact.js';
 import json from './json.js';
+import jsonExt from './jsonExt.js';
 import symbols from './symbols.js';
 export default {
     symbols,
     compact,
     codeowners,
     json,
+    jsonExt,
 };

package/dist/reporters/jsonExt.d.ts

@@ -0,0 +1,3 @@
+import type { ReporterOptions } from '../types/issues.js';
+declare const _default: ({ report, issues, options }: ReporterOptions) => Promise<void>;
+export default _default;

package/dist/reporters/jsonExt.js

@@ -0,0 +1,73 @@
+import { OwnershipEngine } from '@snyk/github-codeowners/dist/lib/ownership/index.js';
+import { isFile } from '../util/fs.js';
+import { relative, resolve } from '../util/path.js';
+const mergeTypes = (type) => type === 'exports' || type === 'nsExports' ? 'exports' : type === 'types' || type === 'nsTypes' ? 'types' : type;
+export default async ({ report, issues, options }) => {
+    let opts = {};
+    try {
+        opts = options ? JSON.parse(options) : opts;
+    }
+    catch (error) {
+        console.error(error);
+    }
+    const json = {};
+    const codeownersFilePath = resolve(opts.codeowners ?? '.github/CODEOWNERS');
+    const codeownersEngine = isFile(codeownersFilePath) && OwnershipEngine.FromCodeownersFile(codeownersFilePath);
+    const flatten = (issues) => Object.values(issues).flatMap(Object.values);
+    const initRow = (filePath) => {
+        const file = relative(filePath);
+        const row = {
+            file,
+            ...(codeownersEngine && { owners: codeownersEngine.calcFileOwnership(file) }),
+            ...(report.files && { files: false }),
+            ...(report.dependencies && { dependencies: [] }),
+            ...(report.devDependencies && { devDependencies: [] }),
+            ...(report.optionalPeerDependencies && { optionalPeerDependencies: [] }),
+            ...(report.unlisted && { unlisted: [] }),
+            ...(report.binaries && { binaries: [] }),
+            ...(report.unresolved && { unresolved: [] }),
+            ...((report.exports || report.nsExports) && { exports: [] }),
+            ...((report.types || report.nsTypes) && { types: [] }),
+            ...(report.enumMembers && { enumMembers: {} }),
+            ...(report.classMembers && { classMembers: {} }),
+            ...(report.duplicates && { duplicates: [] }),
+        };
+        return row;
+    };
+    for (const [reportType, isReportType] of Object.entries(report)) {
+        if (isReportType) {
+            if (reportType === 'files') {
+                Array.from(issues[reportType]).forEach(filePath => {
+                    json[filePath] = json[filePath] ?? initRow(filePath);
+                    json[filePath][reportType] = true;
+                });
+            }
+            else {
+                const type = mergeTypes(reportType);
+                flatten(issues[reportType]).forEach(issue => {
+                    const { filePath, symbol, symbols, parentSymbol } = issue;
+                    json[filePath] = json[filePath] ?? initRow(filePath);
+                    if (type === 'duplicates') {
+                        symbols && json[filePath][type]?.push(symbols.map(symbol => ({ name: symbol })));
+                    }
+                    else if (type === 'enumMembers' || type === 'classMembers') {
+                        const item = json[filePath][type];
+                        if (parentSymbol && item) {
+                            item[parentSymbol] = item[parentSymbol] ?? [];
+                            item[parentSymbol].push({ name: issue.symbol, line: issue.line, col: issue.col, pos: issue.pos });
+                        }
+                    }
+                    else {
+                        if (type === 'exports' || type === 'types') {
+                            json[filePath][type]?.push({ name: issue.symbol, line: issue.line, col: issue.col, pos: issue.pos });
+                        }
+                        else {
+                            json[filePath][type]?.push({ name: symbol });
+                        }
+                    }
+                });
+            }
+        }
+    }
+    console.log(JSON.stringify(Object.values(json)));
+};

package/dist/types/issues.d.ts

@@ -15,6 +15,9 @@ export type Issue = {
     symbolType?: SymbolType;
     parentSymbol?: string;
     severity?: IssueSeverity;
+    pos?: number;
+    line?: number;
+    col?: number;
 };
 export type IssueSet = Set<string>;
 export type IssueRecords = Record<string, Record<string, Issue>>;

package/dist/typescript/ast-helpers.d.ts

@@ -25,4 +25,5 @@ export declare function findDescendants<T>(node: ts.Node | undefined, callback:
 export declare const isDeclarationFileExtension: (extension: string) => boolean;
 export declare const isInModuleBlock: (node: ts.Node) => boolean;
 export declare const getJSDocTags: (node: ts.Node) => Set<string>;
+export declare const getLineAndCharacterOfPosition: (node: ts.Node, pos: number) => ts.LineAndCharacter;
 export {};

package/dist/typescript/ast-helpers.js

@@ -110,3 +110,6 @@ export const getJSDocTags = (node) => {
     }
     return tags;
 };
+export const getLineAndCharacterOfPosition = (node, pos) => {
+    return node.getSourceFile().getLineAndCharacterOfPosition(pos);
+};

package/dist/typescript/getImportsAndExports.js

@@ -95,10 +95,10 @@ export const getImportsAndExports = (sourceFile, options) => {
             const item = exports.get(identifier);
             const crew = [...item.members, ...members];
             const tags = new Set([...item.jsDocTags, ...jsDocTags]);
-            exports.set(identifier, { ...item, node, type, pos, members: crew, jsDocTags: tags });
+            exports.set(identifier, { ...item, members: crew, jsDocTags: tags });
         }
         else {
-            exports.set(identifier, { node, type, pos, members, jsDocTags });
+            exports.set(identifier, { node, type, members, jsDocTags, pos });
         }
         if (!jsDocTags.has('@alias')) {
             if (ts.isExportAssignment(node))

package/dist/util/cli-arguments.d.ts

@@ -1,4 +1,4 @@
-export declare const helpText = "\u2702\uFE0F  Find unused files, dependencies and exports in your JavaScript and TypeScript projects\n\nUsage: knip [options]\n\nOptions:\n  -c, --config [file]      Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)\n  -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)\n  --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)\n  --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)\n  --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)\n  -W, --workspace [dir]    Analyze a single workspace (default: analyze all configured workspaces)\n  --directory [dir]        Run process from a different directory (default: cwd)\n  --no-gitignore           Don't use .gitignore\n  --include                Report only provided issue type(s), can be comma-separated or repeated (1)\n  --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)\n  --dependencies           Shortcut for --include dependencies,unlisted,unresolved\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --include-entry-exports  Include entry files when reporting unused exports\n  -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)\n  --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated\n  --preprocessor-options   Pass extra options to the preprocessor (as JSON string, see --reporter-options example)\n  --reporter               Select reporter: symbols, compact, codeowners, json, can be repeated (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\n  --no-config-hints        Suppress configuration hints\n  --no-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  -d, --debug              Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure count and running time of expensive functions and display stats table\n  -h, --help               Print this help text\n  -V, --version            Print version\n\n(1) Issue types: files, dependencies, unlisted, unresolved, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates\n\nExamples:\n\n$ knip\n$ knip --production\n$ knip --workspace packages/client --include files,dependencies\n$ knip -c ./config/knip.json --reporter compact\n$ knip --reporter codeowners --reporter-options '{\"path\":\".github/CODEOWNERS\"}'\n$ knip --debug --debug-file-filter '(specific|particular)-module'\n\nMore documentation and bug reports: https://github.com/webpro/knip";
+export declare const helpText = "\u2702\uFE0F  Find unused files, dependencies and exports in your JavaScript and TypeScript projects\n\nUsage: knip [options]\n\nOptions:\n  -c, --config [file]      Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)\n  -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)\n  --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)\n  --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)\n  --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)\n  -W, --workspace [dir]    Analyze a single workspace (default: analyze all configured workspaces)\n  --directory [dir]        Run process from a different directory (default: cwd)\n  --no-gitignore           Don't use .gitignore\n  --include                Report only provided issue type(s), can be comma-separated or repeated (1)\n  --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)\n  --dependencies           Shortcut for --include dependencies,unlisted,unresolved\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --include-entry-exports  Include entry files when reporting unused exports\n  -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)\n  --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated\n  --preprocessor-options   Pass extra options to the preprocessor (as JSON string, see --reporter-options example)\n  --reporter               Select reporter: symbols, compact, codeowners, json, jsonExt, can be repeated (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\n  --no-config-hints        Suppress configuration hints\n  --no-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  -d, --debug              Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure count and running time of expensive functions and display stats table\n  -h, --help               Print this help text\n  -V, --version            Print version\n\n(1) Issue types: files, dependencies, unlisted, unresolved, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates\n\nExamples:\n\n$ knip\n$ knip --production\n$ knip --workspace packages/client --include files,dependencies\n$ knip -c ./config/knip.json --reporter compact\n$ knip --reporter codeowners --reporter-options '{\"path\":\".github/CODEOWNERS\"}'\n$ knip --debug --debug-file-filter '(specific|particular)-module'\n\nMore documentation and bug reports: https://github.com/webpro/knip";
 declare const _default: {
     config: string | undefined;
     debug: boolean | undefined;

package/dist/util/cli-arguments.js

@@ -20,7 +20,7 @@ Options:
   -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)
   --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated
   --preprocessor-options   Pass extra options to the preprocessor (as JSON string, see --reporter-options example)
-  --reporter               Select reporter: symbols, compact, codeowners, json, can be repeated (default: symbols)
+  --reporter               Select reporter: symbols, compact, codeowners, json, jsonExt, can be repeated (default: symbols)
   --reporter-options       Pass extra options to the reporter (as JSON string, see example)
   --no-config-hints        Suppress configuration hints
   --no-exit-code           Always exit with code zero (0)

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.36.0";
+export declare const version = "2.37.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.36.0';
+export const version = '2.37.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.36.0",
+  "version": "2.37.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",