Cleanup and test

Author: EzraBrooks

bun.lock

@@ -50,6 +50,7 @@
         "knip-bun": "bin/knip-bun.js",
       },
       "dependencies": {
+        "@actions/core": "^1.11.1",
         "@nodelib/fs.walk": "^1.2.3",
         "easy-table": "1.2.0",
         "enhanced-resolve": "^5.18.1",
@@ -87,6 +88,14 @@
     },
   },
   "packages": {
+    "@actions/core": ["@actions/[email protected]", "", { "dependencies": { "@actions/exec": "^1.1.1", "@actions/http-client": "^2.0.1" } }, "sha512-hXJCSrkwfA46Vd9Z3q4cpEpHB1rL5NG04+/rbqW9d3+CSvtB1tYe8UTpAlixa1vj0m/ULglfEK2UKxMGxCxv5A=="],
+
+    "@actions/exec": ["@actions/[email protected]", "", { "dependencies": { "@actions/io": "^1.0.1" } }, "sha512-+sCcHHbVdk93a0XT19ECtO/gIXoxvdsgQLzb2fE2/5sIZmWQuluYyjPQtrtTHdU1YzTZ7bAPN4sITq2xi1679w=="],
+
+    "@actions/http-client": ["@actions/[email protected]", "", { "dependencies": { "tunnel": "^0.0.6", "undici": "^5.25.4" } }, "sha512-mx8hyJi/hjFvbPokCg4uRd4ZX78t+YyRPtnKWwIl+RzNaVuFpQHfmlGVfsKEJN8LwTCvL+DfVgAM04XaHkm6bA=="],
+
+    "@actions/io": ["@actions/[email protected]", "", {}, "sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q=="],
+
     "@astro-community/astro-embed-youtube": ["@astro-community/[email protected]", "", { "dependencies": { "lite-youtube-embed": "^0.3.3" }, "peerDependencies": { "astro": "^2.0.0 || ^3.0.0-beta || ^4.0.0-beta || ^5.0.0-beta" } }, "sha512-/mRfCl/eTBUz0kmjD1psOy0qoDDBorVp0QumUacjFcIkBullYtbeFQ2ZGZ+3N/tA6cR/OIyzr2QA4dQXlY6USg=="],
 
     "@astrojs/check": ["@astrojs/[email protected]", "", { "dependencies": { "@astrojs/language-server": "^2.15.0", "chokidar": "^4.0.1", "kleur": "^4.1.5", "yargs": "^17.7.2" }, "peerDependencies": { "typescript": "^5.0.0" }, "bin": { "astro-check": "dist/bin.js" } }, "sha512-IOheHwCtpUfvogHHsvu0AbeRZEnjJg3MopdLddkJE70mULItS/Vh37BHcI00mcOJcH1vhD3odbpvWokpxam7xA=="],
@@ -219,6 +228,8 @@
 
     "@expressive-code/plugin-text-markers": ["@expressive-code/[email protected]", "", { "dependencies": { "@expressive-code/core": "^0.41.1" } }, "sha512-PFvk91yY+H8KVEcyZSrktLoWzBgLVpowvMxOJooFn74roGxnU4TEBJpWcRnJFtMEwTLzWNnk10MSOApOccvSKg=="],
 
+    "@fastify/busboy": ["@fastify/[email protected]", "", {}, "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA=="],
+
     "@iarna/toml": ["@iarna/[email protected]", "", {}, "sha512-td6ZUkz2oS3VeleBcN+m//Q6HlCFCPrnI0FZhrt/h4XqLEdOyYp2u21nd8MdsR+WJy5r9PTDaHTDDfhf4H4l6Q=="],
 
     "@img/sharp-darwin-arm64": ["@img/[email protected]", "", { "optionalDependencies": { "@img/sharp-libvips-darwin-arm64": "1.1.0" }, "os": "darwin", "cpu": "arm64" }, "sha512-pn44xgBtgpEbZsu+lWf2KNb6OAf70X68k+yk69Ic2Xz11zHR/w24/U49XT7AeRwJ0Px+mhALhU5LPci1Aymk7A=="],
@@ -1627,6 +1638,8 @@
 
     "tslib": ["[email protected]", "", {}, "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w=="],
 
+    "tunnel": ["[email protected]", "", {}, "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg=="],
+
     "type-fest": ["[email protected]", "", {}, "sha512-S/5/0kFftkq27FPNye0XM1e2NsnoD/3FS+pBmbjmmtLT6I+i344KoOf7pvXreaFsDamWeaJX55nczA1m5PsBDg=="],
 
     "typedarray": ["[email protected]", "", {}, "sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA=="],
@@ -1819,6 +1832,8 @@
 
     "zwitch": ["[email protected]", "", {}, "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A=="],
 
+    "@actions/http-client/undici": ["[email protected]", "", { "dependencies": { "@fastify/busboy": "^2.0.0" } }, "sha512-raqeBD6NQK4SkWhQzeYKd1KmIG6dllBOTt55Rmkt4HtI9mwdWtJljnrXjAFUBLTSN67HWrOIZ3EPF4kjUw80Bg=="],
+
     "@astrojs/starlight/remark-directive": ["[email protected]", "", { "dependencies": { "@types/mdast": "^4.0.0", "mdast-util-directive": "^3.0.0", "micromark-extension-directive": "^3.0.0", "unified": "^11.0.0" } }, "sha512-gwglrEQEZcZYgVyG1tQuA+h58EZfq5CSULw7J90AFuCTyib1thgHPoqQ+h9iFvU6R+vnZ5oNFQR5QKgGpk741A=="],
 
     "@expressive-code/plugin-shiki/shiki": ["[email protected]", "", { "dependencies": { "@shikijs/core": "3.2.2", "@shikijs/engine-javascript": "3.2.2", "@shikijs/engine-oniguruma": "3.2.2", "@shikijs/langs": "3.2.2", "@shikijs/themes": "3.2.2", "@shikijs/types": "3.2.2", "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4" } }, "sha512-0qWBkM2t/0NXPRcVgtLhtHv6Ak3Q5yI4K/ggMqcgLRKm4+pCs3namgZlhlat/7u2CuqNtlShNs9lENOG6n7UaQ=="],

packages/knip/package.json

@@ -60,6 +60,7 @@
     "schema-jsonc.json"
   ],
   "dependencies": {
+    "@actions/core": "^1.11.1",
     "@nodelib/fs.walk": "^1.2.3",
     "easy-table": "1.2.0",
     "enhanced-resolve": "^5.18.1",

packages/knip/src/reporters/githubActions.ts

@@ -1,66 +1,32 @@
 import core from '@actions/core';
+import { ISSUE_TYPES, ISSUE_TYPE_TITLE } from 'src/constants.js';
 import type { ReporterOptions } from '../types/issues.js';
 
-export const ISSUE_TYPES = [
-  // must be _files
-  '_files',
-  'dependencies',
-  'devDependencies',
-  'optionalPeerDependencies',
-  'unlisted',
-  'binaries',
-  'unresolved',
-  'exports',
-  'nsExports',
-  'types',
-  'nsTypes',
-  'enumMembers',
-  'classMembers',
-  'duplicates',
-] as const;
-
-const ISSUE_TYPE_TITLE = {
-  files: 'Unused files',
-  _files: 'Unused files',
-  dependencies: 'Unused dependencies',
-  devDependencies: 'Unused devDependencies',
-  optionalPeerDependencies: 'Referenced optional peerDependencies',
-  unlisted: 'Unlisted dependencies',
-  binaries: 'Unlisted binaries',
-  unresolved: 'Unresolved imports',
-  exports: 'Unused exports',
-  nsExports: 'Exports in used namespace',
-  types: 'Unused exported types',
-  nsTypes: 'Exported types in used namespace',
-  enumMembers: 'Unused exported enum members',
-  classMembers: 'Unused exported class members',
-  duplicates: 'Duplicate exports',
-};
-
-export default (options: ReporterOptions) => {
+export default ({ issues }: ReporterOptions) => {
   for (const issueName of ISSUE_TYPES) {
-    const issue = options.issues[issueName];
-
-    for (const file of Object.keys(issue)) {
-      const issueSet = issue[file];
+    const issue = issues[issueName];
 
-      for (const issueKey of Object.keys(issueSet)) {
-        const issueItem = issueSet[issueKey];
+    const issueSet =
+      issue instanceof Set ? Array.from(issue) : Object.values(issue).flatMap(record => Object.values(record));
 
-        if (issueItem.isFixed || issueItem.severity === 'off') {
-          continue;
-        }
+    for (const issueItem of issueSet) {
+      if (typeof issueItem === 'string') {
+        core.info(issueItem);
+        continue;
+      }
+      if (issueItem.isFixed || issueItem.severity === 'off') {
+        continue;
+      }
 
-        const log = issueItem.severity === 'error' ? core.error : core.warning;
+      const log = issueItem.severity === 'error' ? core.error : core.warning;
 
-        log(ISSUE_TYPE_TITLE[issueItem.type], {
-          file: file,
-          startLine: issueItem.line,
-          endLine: issueItem.line,
-          endColumn: issueItem.col,
-          startColumn: issueItem.col,
-        });
-      }
+      log(ISSUE_TYPE_TITLE[issueItem.type], {
+        file: issueItem.filePath,
+        startLine: issueItem.line,
+        endLine: issueItem.line,
+        endColumn: issueItem.col,
+        startColumn: issueItem.col,
+      });
     }
   }
 };

packages/knip/test/cli/cli-reporter-githubActions.test.ts

@@ -0,0 +1,16 @@
+import { test } from 'bun:test';
+import assert from 'node:assert/strict';
+import { resolve } from '../../src/util/path.js';
+import { exec } from '../helpers/exec.js';
+
+const cwd = resolve('fixtures/module-resolution-non-std');
+
+test('knip --reporter githubActions (files, unlisted & unresolved)', () => {
+  assert.equal(
+    exec('knip --reporter githubActions', { cwd }).stdout,
+    `${cwd}/src/unused.ts
+::error file=${cwd}/src/index.ts::Unlisted dependencies
+::error file=${cwd}/src/index.ts::Unlisted dependencies
+::error file=${cwd}/src/index.ts,line=8,endLine=8,col=23,endColumn=23::Unresolved imports`
+  );
+});