wip

Author: BioPhoton

.gitignore

@@ -4,6 +4,7 @@
 dist
 tmp
 /out-tsc
+.code-pushup
 
 # dependencies
 node_modules

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "eslint.validate": ["json"]
+}

code-pushup.config.ts

@@ -0,0 +1,8 @@
+import bundleSizePlugin from './dist/packages/bundle-size';
+import {fileSizePlugin} from "./dist/packages/file-size";
+export default {
+    plugins: [
+        bundleSizePlugin(),
+        fileSizePlugin()
+        ]
+}

jest.config.ts

@@ -0,0 +1,5 @@
+import { getJestProjectsAsync } from '@nx/jest';
+
+export default async () => ({
+  projects: await getJestProjectsAsync(),
+});

jest.preset.js

@@ -0,0 +1,3 @@
+const nxPreset = require('@nx/jest/preset').default;
+
+module.exports = { ...nxPreset };

nx.json

@@ -39,6 +39,7 @@
       "options": {
         "buildTargetName": "build"
       }
-    }
+    },
+    "./tooling/plugin-factory/src/index.ts"
   ]
 }

packages/bundle-size/project.json

@@ -28,6 +28,9 @@
       "options": {
         "reportsDirectory": "../../coverage/packages/bundle-size"
       }
+    },
+    "code-pushup": {
+      "command": "npx code-pushup collect"
     }
   }
 }

packages/bundle-size/src/lib/__snapshots__/plugin.integration.test.ts.snap

@@ -0,0 +1,20 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`bundleSizePlugin > should execute correctly and return valid audit outputs 1`] = `
+{
+  "audits": [
+    {
+      "description": "Bundle size audit",
+      "displayValue": "56.17 ms",
+      "score": 0.5578038525269111,
+      "slug": "bundle-size",
+      "title": "Bundle size",
+      "value": 56.17041533525504,
+    },
+  ],
+  "description": "Bundle size plugin for Code PushUp",
+  "icon": "folder-css",
+  "slug": "bundle-size",
+  "title": "Bundle size",
+}
+`;

packages/bundle-size/src/lib/__snapshots__/plugin.unit.test.ts.snap

@@ -0,0 +1,18 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`bundleSizePlugin > should create valid bundle-size plugin configuration 1`] = `
+{
+  "audits": [
+    {
+      "description": "Bundle size audit",
+      "slug": "bundle-size",
+      "title": "Bundle size",
+    },
+  ],
+  "description": "Bundle size plugin for Code PushUp",
+  "icon": "folder-css",
+  "runner": [Function],
+  "slug": "bundle-size",
+  "title": "Bundle size",
+}
+`;

packages/bundle-size/src/lib/plugin.integration.test.ts

@@ -0,0 +1,16 @@
+import {describe, expect, it} from "vitest";
+import {pluginReportSchema} from "@code-pushup/models";
+import bundleSizePlugin from "./plugin";
+import {executePlugin} from "@code-pushup/core";
+import {omitVariablePluginData} from "testing-utils";
+
+describe('bundleSizePlugin', () => {
+
+    it('should execute correctly and return valid audit outputs', async () => {
+       const pluginReport =  await executePlugin(bundleSizePlugin())
+        expect(() => pluginReportSchema.parse(pluginReport)).not.toThrow();
+        expect(omitVariablePluginData(pluginReport)).toMatchSnapshot();
+    });
+
+});
+

packages/bundle-size/src/lib/plugin.ts

@@ -1,24 +1,17 @@
-import {PluginConfig} from "@code-pushup/models";
+import {AuditOutputs, PluginConfig, RunnerFunction} from "@code-pushup/models";
+import {bundleSizeRunner} from "./runner";
 
 export default bundleSizePlugin;
 
 export type BundleSizePluginOptions = {};
-export function bundleSizePlugin(): PluginConfig {
-    console.log('bundle-size plugin');
+
+export function bundleSizePlugin(options?: BundleSizePluginOptions): PluginConfig {
     return {
         slug: 'bundle-size',
         title: 'Bundle size',
         description: 'Bundle size plugin for Code PushUp',
         icon: "folder-css",
-        runner: () => {
-            return [
-                {
-                    slug: 'bundle-size',
-                    score: 1,
-                    value: 1
-                },
-            ];
-        },
+        runner: bundleSizeRunner(),
         audits: [
             {
                 slug: 'bundle-size',

packages/bundle-size/src/lib/plugin.unit.test.ts

@@ -0,0 +1,13 @@
+import {describe, expect, it} from "vitest";
+import {pluginConfigSchema} from "@code-pushup/models";
+import bundleSizePlugin from "./plugin";
+
+describe('bundleSizePlugin', () => {
+
+    it('should create valid bundle-size plugin configuration', async () => {
+      const bundleSizePluginConfig = bundleSizePlugin({});
+        expect(() => pluginConfigSchema.parse(bundleSizePluginConfig)).not.toThrow();
+        expect(bundleSizePluginConfig).toMatchSnapshot();
+    });
+
+});

packages/bundle-size/src/lib/runner.ts

@@ -0,0 +1,26 @@
+import {AuditOutputs, RunnerFunction} from "@code-pushup/models";
+
+export type BundleSizeRunnerOptions = {
+    timeout?: number
+};
+
+export function bundleSizeRunner(options?: BundleSizeRunnerOptions): RunnerFunction {
+    return async (): Promise<AuditOutputs> => {
+        const {time, value} = await fakePluginLogic(options?.timeout);
+
+        return [{
+            slug: 'bundle-size',
+            score: value < 1 ? value : 1,
+            value: time,
+            displayValue: `${time.toFixed(2)} ms`,
+        }];
+    }
+}
+
+export async function fakePluginLogic(time?: number): Promise<{ time: number, value: number }> {
+    const timer = time ?? Math.random() * 100
+    const value = await new Promise<number>((resolve) => setTimeout(() => {
+            resolve(Math.random());
+        }, timer))
+    return { time: timer, value };
+}

packages/bundle-size/src/lib/runner.unit.test.ts

@@ -0,0 +1,12 @@
+import {describe, expect, it} from "vitest";
+import {bundleSizeRunner} from "./runner";
+
+describe('bundleSizeRunner', () => {
+
+    it('should have slug of "bundle-size"', async () => {
+        const runnerFunction = bundleSizeRunner({timeout: 0});
+        const auditOutputs = await runnerFunction(undefined);
+        expect(auditOutputs.at(0)?.slug).toBe('bundle-size');
+    });
+
+});

testing/src/lib/testing-utils.ts

@@ -1,6 +1,6 @@
 import {readFile, rm, writeFile} from "fs/promises";
 import {join, relative, resolve} from "path";
-import {AuditReport, CoreConfig, PluginReport, Report} from "@code-pushup/models";
+import {AuditOutput, AuditReport, CoreConfig, PluginReport, Report} from "@code-pushup/models";
 import {formatFiles, generateFiles} from "@nx/devkit";
 import {ensureDirectoryExists, executeProcess, objectToCliArgs, ProcessResult, readJsonFile} from "@code-pushup/utils";
 import {createTree} from "nx/src/generators/testing-utils/create-tree";
@@ -10,7 +10,7 @@ export function omitVariableAuditData({
                                           value,
                                           displayValue,
                                           ...auditReport
-                                      }: AuditReport) {
+                                      }: AuditReport | AuditOutput) {
     return auditReport;
 }
 

tooling/plugin-factory/.eslintrc.json

@@ -0,0 +1,32 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    },
+    {
+      "files": ["./package.json", "./generators.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/nx-plugin-checks": "error"
+      }
+    }
+  ]
+}

tooling/plugin-factory/README.md

@@ -0,0 +1,11 @@
+# plugin-factory
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build plugin-factory` to build the library.
+
+## Running unit tests
+
+Run `nx test plugin-factory` to execute the unit tests via [Jest](https://jestjs.io).

tooling/plugin-factory/generators.json

@@ -0,0 +1,9 @@
+{
+  "generators": {
+    "plugin": {
+      "factory": "./src/generators/plugin/generator",
+      "schema": "./src/generators/plugin/schema.json",
+      "description": "plugin generator"
+    }
+  }
+}

tooling/plugin-factory/jest.config.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+export default {
+  displayName: 'plugin-factory',
+  preset: '../../jest.preset.js',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/tooling/plugin-factory',
+};

tooling/plugin-factory/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "plugin-factory",
+  "version": "0.0.1",
+  "dependencies": {
+    "@nx/devkit": "19.4.3",
+    "tslib": "^2.3.0"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "private": true,
+  "generators": "./generators.json"
+}

tooling/plugin-factory/project.json

@@ -0,0 +1,48 @@
+{
+  "name": "plugin-factory",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "tooling/plugin-factory/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/tooling/plugin-factory",
+        "main": "tooling/plugin-factory/src/index.ts",
+        "tsConfig": "tooling/plugin-factory/tsconfig.lib.json",
+        "assets": [
+          "tooling/plugin-factory/*.md",
+          {
+            "input": "./tooling/plugin-factory/src",
+            "glob": "**/!(*.ts)",
+            "output": "./src"
+          },
+          {
+            "input": "./tooling/plugin-factory/src",
+            "glob": "**/*.d.ts",
+            "output": "./src"
+          },
+          {
+            "input": "./tooling/plugin-factory",
+            "glob": "generators.json",
+            "output": "."
+          },
+          {
+            "input": "./tooling/plugin-factory",
+            "glob": "executors.json",
+            "output": "."
+          }
+        ]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "tooling/plugin-factory/jest.config.ts"
+      }
+    }
+  }
+}

tooling/plugin-factory/src/generators/plugin/files/code-pushup.config.ts__tmpl__

@@ -0,0 +1,21 @@
+import { <%= propertyName %>Plugin } from './src';
+
+export default {
+    plugins: [
+        <%= propertyName %>Plugin()
+    ],
+    categories: [
+    {
+            slug: '<%= categoryName %>',
+            title: '<%= categoryName %>',
+            refs: [
+                {
+                    slug: '<%= fileName %>-audit',
+                    plugin: '<%= fileName %>',
+                    type: 'audit',
+                    weight: 1
+                }
+            ]
+        }
+    ]
+}

tooling/plugin-factory/src/generators/plugin/files/src/index.ts__tmpl__

@@ -0,0 +1,5 @@
+import { <%= propertyName %>Plugin } from './lib/<%= fileName %>-plugin';
+
+export default <%= propertyName %>Plugin;
+export {<%= propertyName %>Plugin} from "./lib/<%= fileName %>-plugin";
+export type { <%= className %>PluginConfig } from './lib/<%= fileName %>-plugin';

tooling/plugin-factory/src/generators/plugin/files/src/lib/__name__-plugin.ts__tmpl__

@@ -0,0 +1,24 @@
+import {PluginConfig} from "@code-pushup/models";
+import {<%= propertyName %>Runner} from "./runner";
+
+export default <%= propertyName %>Plugin;
+
+export type <%= className %>PluginConfig = {
+  opt1?: string;
+};
+export function <%= propertyName %>Plugin(options?: <%= className %>PluginConfig): PluginConfig {
+    return {
+        slug: '<%= fileName %>',
+        title: '<%= name %>',
+        description: '<%= name %> plugin for Code PushUp',
+        icon: "folder",
+        runner: <%= propertyName %>Runner(),
+        audits: [
+            {
+                slug: '<%= fileName %>-audit',
+                title: '<%= name %> Audit',
+                description: `<%= name %> audit ${options?.opt1 ?? ''}`,
+            },
+        ],
+    };
+}