ci: meaningful categories configuration

Author: matejchalk

code-pushup.config.ts

@@ -6,7 +6,6 @@ import {
   packageJsonDocumentationGroupRef,
   packageJsonPerformanceGroupRef,
   packageJsonPlugin,
-  packageJsonVersionControlGroupRef,
 } from './dist/examples/plugins';
 import eslintPlugin, {
   eslintConfigFromNxProjects,
@@ -45,29 +44,25 @@ const config: CoreConfig = {
 
   plugins: [
     await eslintPlugin(await eslintConfigFromNxProjects()),
+
     fileSizePlugin({
-      directory: './dist/packages',
+      directory: './dist/examples/react-todos-app',
       pattern: /\.js$/,
-      budget: 42_000,
+      budget: 174_080, // 170 kB
     }),
+
     packageJsonPlugin({
-      directory: './packages',
+      directory: './dist/packages',
       license: 'MIT',
       type: 'module',
-      dependencies: {
-        zod: '^3.22.4',
-      },
     }),
   ],
 
   categories: [
     {
       slug: 'bug-prevention',
       title: 'Bug prevention',
-      refs: [
-        { type: 'group', plugin: 'eslint', slug: 'problems', weight: 1 },
-        packageJsonVersionControlGroupRef,
-      ],
+      refs: [{ type: 'group', plugin: 'eslint', slug: 'problems', weight: 1 }],
     },
     {
       slug: 'code-style',
@@ -77,14 +72,13 @@ const config: CoreConfig = {
       ],
     },
     {
-      slug: 'performance',
-      title: 'Performance',
-      refs: [...fileSizeRecommendedRefs, packageJsonPerformanceGroupRef],
-    },
-    {
-      slug: 'documentation',
-      title: 'Documentation',
-      refs: [packageJsonDocumentationGroupRef],
+      slug: 'custom-checks',
+      title: 'Custom checks',
+      refs: [
+        ...fileSizeRecommendedRefs,
+        packageJsonPerformanceGroupRef,
+        packageJsonDocumentationGroupRef,
+      ],
     },
   ],
 };

examples/plugins/src/package-json/README.md

@@ -9,8 +9,8 @@ The plugin crawls the file base depending on your configuration and checks the c
 You can configure the plugin with the following options:
 
 - `directory` - directory to crawl as string
-- `license` - file name pattern as string
-- `type` - size budget as number in bytes
+- `license` - expected value of [`license` property in `package.json`](https://docs.npmjs.com/cli/configuring-npm/package-json#license)
+- `type` - expected value of [`type` property in `package.json`](https://nodejs.org/api/packages.html#type)
 - `dependencies` - package dependencies as object
 - `devDependencies` - package dependencies as object
 - `optionalDependencies` - package dependencies as object

examples/plugins/src/package-json/src/integration/license.audit.ts

@@ -11,7 +11,7 @@ const licenseAuditSlug = 'package-license';
 export const licenseAuditMeta: Audit = {
   slug: licenseAuditSlug,
   title: 'License',
-  description: 'An audit to check NPM package license`.',
+  description: 'An audit to check NPM package license.',
 };
 
 export function licenseAudit(

examples/plugins/src/package-json/src/integration/type.audit.ts

@@ -12,7 +12,7 @@ const typeAuditSlug = 'package-type';
 export const typeAuditInfoMeta = {
   slug: typeAuditSlug,
   title: 'Type',
-  description: 'An audit to check NPM package type`.',
+  description: 'An audit to check NPM package type.',
 };
 
 export function typeAudit(

project.json

@@ -32,7 +32,12 @@
       "command": "npx dist/packages/cli collect --config=code-pushup.config.ts",
       "dependsOn": [
         {
-          "projects": ["cli", "plugin-eslint", "examples-plugins"],
+          "projects": [
+            "cli",
+            "plugin-eslint",
+            "examples-plugins",
+            "react-todos-app"
+          ],
           "target": "build"
         }
       ]
@@ -41,7 +46,12 @@
       "command": "npx dist/packages/cli upload --config=code-pushup.config.ts",
       "dependsOn": [
         {
-          "projects": ["cli", "plugin-eslint", "examples-plugins"],
+          "projects": [
+            "cli",
+            "plugin-eslint",
+            "examples-plugins",
+            "react-todos-app"
+          ],
           "target": "build"
         }
       ]
@@ -50,7 +60,12 @@
       "command": "npx dist/packages/cli autorun --config=code-pushup.config.ts",
       "dependsOn": [
         {
-          "projects": ["cli", "plugin-eslint", "examples-plugins"],
+          "projects": [
+            "cli",
+            "plugin-eslint",
+            "examples-plugins",
+            "react-todos-app"
+          ],
           "target": "build"
         }
       ]