feat(examples-plugins): add knip to example plugin

code-pushup.config.ts

@@ -1,8 +1,14 @@
 import 'dotenv/config';
+import { join } from 'node:path';
 import { z } from 'zod';
 import {
+  KNIP_PLUGIN_SLUG,
+  KNIP_RAW_REPORT_NAME,
+  KNIP_REPORT_NAME,
   fileSizePlugin,
   fileSizeRecommendedRefs,
+  knipCategoryGroupRef,
+  knipPlugin,
   packageJsonDocumentationGroupRef,
   packageJsonPerformanceGroupRef,
   packageJsonPlugin,
@@ -78,6 +84,19 @@ const config: CoreConfig = {
     }),
 
     await lighthousePlugin('https://codepushup.dev/'),
+
+    await knipPlugin({
+      rawOutputFile: join(
+        '.code-pushup',
+        KNIP_PLUGIN_SLUG,
+        `${KNIP_RAW_REPORT_NAME.split('.').shift()}-${Date.now()}.json`,
+      ),
+      outputFile: join(
+        '.code-pushup',
+        KNIP_PLUGIN_SLUG,
+        `${KNIP_REPORT_NAME.split('.').shift()}-${Date.now()}.json`,
+      ),
+    }),
   ],
 
   categories: [
@@ -168,6 +187,9 @@ const config: CoreConfig = {
         ...fileSizeRecommendedRefs,
         packageJsonPerformanceGroupRef,
         packageJsonDocumentationGroupRef,
+        knipCategoryGroupRef('files'),
+        knipCategoryGroupRef('dependencies'),
+        knipCategoryGroupRef('exports'),
       ],
     },
   ],

examples/plugins/mocks/knip-raw.ts

@@ -0,0 +1,138 @@
+import {ReporterOptions} from "knip";
+
+export const rawReport: Pick<ReporterOptions, 'report' | 'issues' | 'options'> = {
+  report: {
+    files: true,
+    dependencies: true,
+    devDependencies: true,
+    optionalPeerDependencies: true,
+    unlisted: true,
+    binaries: true,
+    unresolved: true,
+    exports: true,
+    nsExports: false,
+    types: true,
+    nsTypes: false,
+    enumMembers: true,
+    classMembers: false,
+    duplicates: true,
+  },
+  issues: {
+    files: new Set(['code-pushup.json']),
+    dependencies: {
+      'package.json': {
+        'cli-table3': {
+          type: 'dependencies',
+          filePath:
+            '/Users/username/Projects/code-pushup/package.json',
+          symbol: 'cli-table3',
+          severity: 'error',
+        },
+      }
+    },
+    devDependencies: {
+      'package.json': {
+        '@trivago/prettier-plugin-sort-imports': {
+          type: 'devDependencies',
+          filePath:
+            '/Users/username/Projects/code-pushup/package.json',
+          symbol: '@trivago/prettier-plugin-sort-imports',
+          severity: 'error',
+        },
+      },
+    },
+    optionalPeerDependencies: {
+      'package.json': {
+        'ts-node': {
+          type: 'devDependencies',
+          filePath:
+            '/Users/username/Projects/code-pushup/package.json',
+          symbol: 'ts-node',
+          severity: 'error',
+        },
+      },
+    },
+    unlisted: {
+      'packages/plugin-lighthouse/.eslintrc.json': {
+        'jsonc-eslint-parser': {
+          type: 'unlisted',
+          filePath:
+            '/Users/username/Projects/code-pushup/packages/plugin-lighthouse/.eslintrc.json',
+          symbol: 'jsonc-eslint-parser',
+          severity: 'error',
+        },
+      },
+      '.eslintrc.json': {
+        'jsonc-eslint-parser': {
+          type: 'unlisted',
+          filePath:
+            '/Users/username/Projects/code-pushup/.eslintrc.json',
+          symbol: 'jsonc-eslint-parser',
+          severity: 'error',
+        },
+      }
+    },
+    binaries: {},
+    unresolved: {},
+    exports: {
+      'packages/models/src/lib/category-config.ts': {
+        duplicateErrorMsg: {
+          type: 'exports',
+          filePath:
+            '/Users/username/Projects/code-pushup/packages/models/src/lib/category-config.ts',
+          symbol: 'duplicateErrorMsg',
+          symbolType: 'function',
+          pos: 1571,
+          line: 54,
+          col: 17,
+          severity: 'error',
+        },
+      },
+    },
+    nsExports: {},
+    types: {
+      'packages/models/src/lib/group.ts': {
+        GroupMeta: {
+          type: 'types',
+          filePath:
+            '/Users/username/Projects/code-pushup/packages/models/src/lib/group.ts',
+          symbol: 'GroupMeta',
+          symbolType: 'type',
+          pos: 701,
+          line: 26,
+          col: 13,
+          severity: 'error',
+        },
+      },
+    },
+    nsTypes: {},
+    enumMembers: {},
+    classMembers: {},
+    duplicates: {
+      'packages/nx-plugin/src/generators/init/generator.ts': {
+        'initGenerator|default': {
+          type: 'duplicates',
+          filePath:
+            '/Users/username/Projects/code-pushup/packages/nx-plugin/src/generators/init/generator.ts',
+          symbol: 'initGenerator|default',
+          symbols: [
+            {
+              symbol: 'initGenerator',
+              line: 76,
+              col: 2,
+              pos: 2144,
+            },
+            {
+              symbol: 'default',
+              line: 91,
+              col: 15,
+              pos: 2479,
+            },
+          ],
+          severity: 'error',
+        },
+      },
+    },
+  },
+  options: '',
+};

examples/plugins/mocks/knip-report.ts

@@ -0,0 +1,130 @@
+export const input = {
+  files: ['src/unused.ts'],
+  issues: [
+    {
+      file: 'package.json',
+      owners: ['@org/admin'],
+      dependencies: ['jquery', 'moment'],
+      devDependencies: [],
+      unlisted: [{ name: 'react' }, { name: '@org/unresolved' }],
+      exports: [],
+      types: [],
+      duplicates: [],
+    },
+    {
+      file: 'src/Registration.tsx',
+      owners: ['@org/owner'],
+      dependencies: [],
+      devDependencies: [],
+      binaries: [],
+      unresolved: [{ name: './unresolved', line: 8, col: 23, pos: 403 }],
+      exports: [{ name: 'unusedExport', line: 1, col: 14, pos: 13 }],
+      types: [
+        { name: 'unusedEnum', line: 3, col: 13, pos: 71 },
+        { name: 'unusedType', line: 8, col: 14, pos: 145 },
+      ],
+      enumMembers: {
+        MyEnum: [
+          { name: 'unusedMember', line: 13, col: 3, pos: 167 },
+          { name: 'unusedKey', line: 15, col: 3, pos: 205 },
+        ],
+      },
+      classMembers: {
+        MyClass: [
+          { name: 'unusedMember', line: 40, col: 3, pos: 687 },
+          { name: 'unusedSetter', line: 61, col: 14, pos: 1071 },
+        ],
+      },
+      duplicates: ['Registration', 'default'],
+    },
+  ],
+};
+
+export const output = [
+  {
+    slug: 'unused-files',
+    value: 1,
+    displayValue: '1 unused files',
+    score: 0,
+    details: {
+      issues: [
+        {
+          message: 'File "src/unused.ts" unused',
+          severity: 'warning',
+          source: {
+            file: 'src/unused.ts',
+          },
+        },
+      ],
+    },
+  },
+  {
+    slug: 'unlisted',
+    value: 2,
+    displayValue: '2 unlisted',
+    score: 0,
+    details: {
+      issues: [
+        {
+          message: 'react',
+          severity: 'warning',
+          source: {
+            file: '???',
+          },
+        },
+        {
+          message: '@org/unresolved',
+          severity: 'warning',
+          source: {
+            file: '???',
+          },
+        },
+      ],
+    },
+  },
+  {
+    slug: 'dependencies',
+    value: 2,
+    displayValue: '2 dependencies',
+    score: 0,
+    details: {
+      issues: [
+        {
+          message: 'jquery',
+          severity: 'warning',
+          source: {
+            file: 'package.json',
+          },
+        },
+        {
+          message: 'moment',
+          severity: 'warning',
+          source: {
+            file: 'package.json',
+          },
+        },
+      ],
+    },
+  },
+  {
+    slug: 'unresolved',
+    value: 2,
+    displayValue: '2 unresolved',
+    score: 0,
+    details: {
+      issues: [
+        {
+          message: 'jquery',
+          severity: 'warning',
+          source: {
+            file: 'src/Registration.tsx',
+            position: {
+              startLine: 8,
+              startColumn: 23,
+            },
+          },
+        },
+      ],
+    },
+  },
+];

examples/plugins/project.json

@@ -12,6 +12,9 @@
         "main": "examples/plugins/src/index.ts",
         "tsConfig": "examples/plugins/tsconfig.lib.json",
         "assets": ["examples/plugins/*.md"],
+        "additionalEntryPoints": [
+          "examples/plugins/src/knip/src/reporter/index.ts"
+        ],
         "esbuildConfig": "esbuild.config.js"
       }
     },

examples/plugins/src/index.ts

@@ -16,3 +16,11 @@ export {
   LIGHTHOUSE_OUTPUT_FILE_DEFAULT,
   recommendedRefs as lighthouseCorePerfGroupRefs,
 } from './lighthouse/src/index';
+export {
+  knipPlugin,
+  knipCategoryAuditRef,
+  knipCategoryGroupRef,
+  KNIP_PLUGIN_SLUG,
+  KNIP_RAW_REPORT_NAME,
+  KNIP_REPORT_NAME,
+} from './knip/src/index';