feat(web-test-runner): add init generator

packages/web-test-runner/README.md

@@ -0,0 +1 @@
+# web-test-runner

packages/web-test-runner/generators.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema",
+  "generators": {
+    "init": {
+      "factory": "./src/generators/init",
+      "schema": "./src/generators/init.schema.json",
+      "description": "Registers @robby-rabbitman/web-test-runner/plugin in the nx.json.",
+      "hidden": true
+    }
+  }
+}

packages/web-test-runner-plugin/jest.config.ts → packages/web-test-runner/jest.config.ts

@@ -1,6 +1,6 @@
 /* eslint-disable */
 export default {
-  displayName: 'web-test-runner-plugin',
+  displayName: 'web-test-runner',
   preset: '../../jest.preset.js',
   transform: {
     '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],

packages/web-test-runner-plugin/package.json → packages/web-test-runner/package.json

@@ -1,18 +1,19 @@
 {
-  "name": "@robby-rabbitman/web-test-runner-plugin",
+  "name": "@robby-rabbitman/web-test-runner",
   "version": "0.0.0",
-  "description": "Web Test Runner Plugin for Nx workspaces.",
+  "description": "Web Test Runner Generator for Nx workspaces.",
   "repository": {
     "type": "git",
     "url": "https://github.com/RobbyRabbitman/nx-plus.git",
-    "directory": "packages/web-test-runner-plugin"
+    "directory": "packages/web-test-runner"
   },
   "keywords": [
     "Nx",
     "Web Test Runner",
+    "Plugin",
     "Monorepo",
     "Nrwl",
-    "Plugin",
+    "Generator",
     "Test",
     "Web"
   ],
@@ -26,7 +27,12 @@
     "tslib": "^2.3.0",
     "@nx/devkit": "^19.3.0"
   },
+  "generators": "./generators.json",
   "type": "commonjs",
   "main": "./src/index.js",
-  "typings": "./src/index.d.ts"
+  "typings": "./src/index.d.ts",
+  "exports": {
+    ".": "./src/index.js",
+    "./plugin": "./src/plugin.js"
+  }
 }

packages/web-test-runner-plugin/project.json → packages/web-test-runner/project.json

@@ -1,5 +1,5 @@
 {
-  "name": "web-test-runner-plugin",
+  "name": "web-test-runner",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "tags": ["scope:node", "type:plugin"],
   "targets": {
@@ -26,11 +26,6 @@
             "input": "{projectRoot}",
             "glob": "generators.json",
             "output": "."
-          },
-          {
-            "input": "{projectRoot}",
-            "glob": "executors.json",
-            "output": "."
           }
         ]
       }

packages/web-test-runner/src/generators/init.schema.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema",
+  "cli": "nx",
+  "$id": "RobbyRabbitmanWebTestRunnerInit",
+  "title": "Initializes the @robby-rabbitman/web-test-runner in a nx workspace.",
+  "description": "Registers @robby-rabbitman/web-test-runner/plugin in the nx.json.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "targetName": {
+      "description": "The name of the web-test-runner target",
+      "type": "string",
+      "default": "test"
+    },
+    "skipFormat": {
+      "type": "boolean",
+      "default": false
+    },
+    "skipAddPlugin": {
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": []
+}

packages/web-test-runner/src/generators/init.ts

@@ -0,0 +1,52 @@
+import {
+  ExpandedPluginConfiguration,
+  Generator,
+  formatFiles,
+  readNxJson,
+  updateNxJson,
+} from '@nx/devkit';
+
+export const webTestRunnerPluginPath =
+  '@robby-rabbitman/web-test-runner/plugin';
+
+export interface WebTestRunnerInitGeneratorSchema {
+  testTarget?: string;
+  skipAddPlugin?: boolean;
+  skipFormat?: boolean;
+}
+
+export const initGenerator: Generator<
+  WebTestRunnerInitGeneratorSchema
+> = async (tree, schema) => {
+  if (!schema?.skipAddPlugin) {
+    const nxJson = readNxJson(tree);
+    nxJson.plugins ??= [];
+
+    const hasPlugin = nxJson.plugins.some((pluginConfig) =>
+      typeof pluginConfig === 'string'
+        ? pluginConfig === webTestRunnerPluginPath
+        : pluginConfig.plugin === webTestRunnerPluginPath
+    );
+
+    if (!hasPlugin) {
+      nxJson.plugins.push(webTestRunnerPluginConfiguration(schema));
+      updateNxJson(tree, nxJson);
+    }
+  }
+
+  if (!schema?.skipFormat) {
+    await formatFiles(tree);
+  }
+};
+
+export default initGenerator;
+
+const webTestRunnerPluginConfiguration = (
+  schema?: WebTestRunnerInitGeneratorSchema
+) =>
+  ({
+    plugin: webTestRunnerPluginPath,
+    options: {
+      targetName: schema?.testTarget ?? 'test',
+    },
+  } as ExpandedPluginConfiguration);

packages/web-test-runner/src/index.ts

@@ -0,0 +1,2 @@
+export { initGenerator as generator } from './generators/init';
+export { createNodesV2 } from './plugin';

tsconfig.base.json

@@ -15,8 +15,11 @@
     "skipLibCheck": true,
     "skipDefaultLibCheck": true,
     "paths": {
-      "@robby-rabbitman/web-test-runner-plugin": [
-        "packages/web-test-runner-plugin/src/index.ts"
+      "@robby-rabbitman/web-test-runner": [
+        "packages/web-test-runner/src/index.ts"
+      ],
+      "@robby-rabbitman/web-test-runner/plugin": [
+        "packages/web-test-runner/src/plugin.ts"
       ]
     }
   },