feat: add nx plugin for ng add

nartc · nartc · commit ba85e7100c2c · 2023-01-23T21:33:42.000-06:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -37,6 +37,11 @@
                 "jest": true
             },
             "rules": {}
+        },
+        {
+            "files": "*.json",
+            "parser": "jsonc-eslint-parser",
+            "rules": {}
         }
     ]
 }
diff --git a/.release-it.json b/.release-it.json
@@ -40,7 +40,7 @@
         "releaseName": "Release ${version}"
     },
     "hooks": {
-        "before:bump": "npx nx build angular-three",
+        "before:bump": "npx nx package angular-three",
         "after:bump": ["git checkout -- package.json"]
     }
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "eslint.validate": ["json"]
+}
diff --git a/apps/plugin-e2e/jest.config.ts b/apps/plugin-e2e/jest.config.ts
@@ -0,0 +1,15 @@
+/* eslint-disable */
+export default {
+    displayName: 'plugin-e2e',
+    preset: '../../jest.preset.js',
+    globals: {
+        'ts-jest': {
+            tsconfig: '<rootDir>/tsconfig.spec.json',
+        },
+    },
+    transform: {
+        '^.+\\.[tj]s$': 'ts-jest',
+    },
+    moduleFileExtensions: ['ts', 'js', 'html'],
+    coverageDirectory: '../../coverage/apps/plugin-e2e',
+};
diff --git a/apps/plugin-e2e/project.json b/apps/plugin-e2e/project.json
@@ -0,0 +1,17 @@
+{
+    "name": "angular-three-plugin-e2e",
+    "$schema": "../../node_modules/nx/schemas/project-schema.json",
+    "projectType": "application",
+    "sourceRoot": "apps/plugin-e2e/src",
+    "targets": {
+        "e2e": {
+            "executor": "@nrwl/nx-plugin:e2e",
+            "options": {
+                "target": "plugin:build",
+                "jestConfig": "apps/plugin-e2e/jest.config.ts"
+            }
+        }
+    },
+    "tags": [],
+    "implicitDependencies": ["angular-three-plugin"]
+}
diff --git a/apps/plugin-e2e/tests/plugin.spec.ts b/apps/plugin-e2e/tests/plugin.spec.ts
@@ -0,0 +1,19 @@
+import { ensureNxProject, runNxCommandAsync } from '@nrwl/nx-plugin/testing';
+
+describe('plugin e2e', () => {
+    // Setting up individual workspaces per
+    // test can cause e2e runs to take a long time.
+    // For this reason, we recommend each suite only
+    // consumes 1 workspace. The tests should each operate
+    // on a unique project in the workspace, such that they
+    // are not dependant on one another.
+    beforeAll(() => {
+        ensureNxProject('@angular-three/plugin', 'dist/libs/plugin');
+    });
+
+    afterAll(() => {
+        // `nx reset` kills the daemon, and performs
+        // some work which can help clean up e2e leftovers
+        runNxCommandAsync('reset');
+    });
+});
diff --git a/apps/plugin-e2e/tsconfig.json b/apps/plugin-e2e/tsconfig.json
@@ -0,0 +1,10 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "files": [],
+    "include": [],
+    "references": [
+        {
+            "path": "./tsconfig.spec.json"
+        }
+    ]
+}
diff --git a/apps/plugin-e2e/tsconfig.spec.json b/apps/plugin-e2e/tsconfig.spec.json
@@ -0,0 +1,9 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "../../dist/out-tsc",
+        "module": "commonjs",
+        "types": ["jest", "node"]
+    },
+    "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
+}
diff --git a/libs/angular-three/package.json b/libs/angular-three/package.json
@@ -30,5 +30,7 @@
         "@rx-angular/state": "^1.7.0",
         "tslib": "^2.3.0"
     },
-    "sideEffects": false
+    "sideEffects": false,
+    "generators": "./plugin/generators.json",
+    "schematics": "./plugin/generators.json"
 }
diff --git a/libs/angular-three/project.json b/libs/angular-three/project.json
@@ -21,6 +21,13 @@
             },
             "defaultConfiguration": "production"
         },
+        "package": {
+            "executor": "nx:run-commands",
+            "options": {
+                "commands": ["npx nx build angular-three", "npx nx build angular-three-plugin"],
+                "parallel": false
+            }
+        },
         "test": {
             "executor": "@nrwl/jest:jest",
             "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
diff --git a/libs/plugin/.eslintrc.json b/libs/plugin/.eslintrc.json
@@ -0,0 +1,25 @@
+{
+    "extends": ["../../.eslintrc.json"],
+    "ignorePatterns": ["!**/*"],
+    "overrides": [
+        {
+            "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.ts", "*.tsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.js", "*.jsx"],
+            "rules": {}
+        },
+        {
+            "files": ["./package.json", "./generators.json", "./executors.json"],
+            "parser": "jsonc-eslint-parser",
+            "rules": {
+                "@nrwl/nx/nx-plugin-checks": "error"
+            }
+        }
+    ]
+}
diff --git a/libs/plugin/README.md b/libs/plugin/README.md
@@ -0,0 +1,11 @@
+# plugin
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build plugin` to build the library.
+
+## Running unit tests
+
+Run `nx test plugin` to execute the unit tests via [Jest](https://jestjs.io).
diff --git a/libs/plugin/generators.json b/libs/plugin/generators.json
@@ -0,0 +1,19 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "name": "angular-three-plugin",
+    "version": "0.0.1",
+    "generators": {
+        "init": {
+            "factory": "./src/generators/init/init",
+            "schema": "./src/generators/init/schema.json",
+            "description": "Init Angular Three with proper packages and config"
+        }
+    },
+    "schematics": {
+        "ng-add": {
+            "factory": "./src/generators/init/compat",
+            "schema": "./src/generators/init/schema.json",
+            "description": "Add Angular Three with proper packages and config"
+        }
+    }
+}
diff --git a/libs/plugin/jest.config.ts b/libs/plugin/jest.config.ts
@@ -0,0 +1,15 @@
+/* eslint-disable */
+export default {
+    displayName: 'plugin',
+    preset: '../../jest.preset.js',
+    globals: {
+        'ts-jest': {
+            tsconfig: '<rootDir>/tsconfig.spec.json',
+        },
+    },
+    transform: {
+        '^.+\\.[tj]s$': 'ts-jest',
+    },
+    moduleFileExtensions: ['ts', 'js', 'html'],
+    coverageDirectory: '../../coverage/libs/plugin',
+};
diff --git a/libs/plugin/package.json b/libs/plugin/package.json
@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}
diff --git a/libs/plugin/project.json b/libs/plugin/project.json
@@ -0,0 +1,62 @@
+{
+    "name": "angular-three-plugin",
+    "$schema": "../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "libs/plugin/src",
+    "projectType": "library",
+    "targets": {
+        "build": {
+            "executor": "@nrwl/js:tsc",
+            "outputs": ["{options.outputPath}"],
+            "options": {
+                "outputPath": "dist/libs/angular-three/plugin",
+                "main": "libs/plugin/src/index.ts",
+                "tsConfig": "libs/plugin/tsconfig.lib.json",
+                "assets": [
+                    "libs/plugin/*.md",
+                    {
+                        "input": "./libs/plugin/src",
+                        "glob": "**/!(*.ts)",
+                        "output": "./src"
+                    },
+                    {
+                        "input": "./libs/plugin/src",
+                        "glob": "**/*.d.ts",
+                        "output": "./src"
+                    },
+                    {
+                        "input": "./libs/plugin",
+                        "glob": "generators.json",
+                        "output": "."
+                    }
+                ]
+            }
+        },
+        "lint": {
+            "executor": "@nrwl/linter:eslint",
+            "outputs": ["{options.outputFile}"],
+            "options": {
+                "lintFilePatterns": [
+                    "libs/plugin/**/*.ts",
+                    "libs/plugin/generators.json",
+                    "libs/plugin/executors.json",
+                    "libs/plugin/package.json"
+                ]
+            }
+        },
+        "test": {
+            "executor": "@nrwl/jest:jest",
+            "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+            "options": {
+                "jestConfig": "libs/plugin/jest.config.ts",
+                "passWithNoTests": true
+            },
+            "configurations": {
+                "ci": {
+                    "ci": true,
+                    "codeCoverage": true
+                }
+            }
+        }
+    },
+    "tags": []
+}
diff --git a/libs/plugin/src/generators/init/compat.ts b/libs/plugin/src/generators/init/compat.ts
@@ -0,0 +1,4 @@
+import { convertNxGenerator } from '@nrwl/devkit';
+import init from './init';
+
+export default convertNxGenerator(init);
diff --git a/libs/plugin/src/generators/init/init.spec.ts b/libs/plugin/src/generators/init/init.spec.ts
@@ -0,0 +1,36 @@
+import { readJson, Tree } from '@nrwl/devkit';
+import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
+import init, { ANGULAR_THREE_VERSION, THREE_TYPE_VERSION, THREE_VERSION } from './init';
+
+describe('init generator', () => {
+    let appTree: Tree;
+
+    beforeEach(() => {
+        appTree = createTreeWithEmptyWorkspace();
+    });
+
+    it('should add three dependencies', async () => {
+        await init(appTree);
+
+        const packageJson = readJson(appTree, 'package.json');
+
+        expect(packageJson.dependencies['angular-three']).toEqual(ANGULAR_THREE_VERSION);
+        expect(packageJson.dependencies['three']).toEqual(THREE_VERSION);
+        expect(packageJson.devDependencies['@types/three']).toEqual(THREE_TYPE_VERSION);
+    });
+
+    it('should update skipLibCheck in tsconfig.base.json', async () => {
+        await init(appTree);
+
+        const tsConfig = readJson(appTree, 'tsconfig.base.json');
+        expect(tsConfig.compilerOptions.skipLibCheck).toEqual(true);
+    });
+
+    it('should update skipLibCheck in tsconfig.json', async () => {
+        appTree.rename('tsconfig.base.json', 'tsconfig.json');
+        await init(appTree);
+
+        const tsConfig = readJson(appTree, 'tsconfig.json');
+        expect(tsConfig.compilerOptions.skipLibCheck).toEqual(true);
+    });
+});
diff --git a/libs/plugin/src/generators/init/init.ts b/libs/plugin/src/generators/init/init.ts
@@ -0,0 +1,40 @@
+import { addDependenciesToPackageJson, installPackagesTask, logger, readJson, Tree, updateJson } from '@nrwl/devkit';
+
+export const ANGULAR_THREE_VERSION = '^1.0.0';
+export const THREE_VERSION = '^0.148.0';
+export const THREE_TYPE_VERSION = '^0.148.0';
+
+export default async function(tree: Tree) {
+    logger.log('Initializing Angular Three...');
+
+    const packageJson = readJson(tree, 'package.json');
+
+    const version =
+        packageJson['dependencies']?.['angular-three'] ||
+        packageJson['devDependencies']?.['angular-three'] ||
+        ANGULAR_THREE_VERSION;
+
+    addDependenciesToPackageJson(
+        tree,
+        {
+            'angular-three': version,
+            three: THREE_VERSION,
+        },
+        {
+            '@types/three': THREE_TYPE_VERSION,
+        }
+    );
+
+    logger.info('Turning on skipLibCheck...');
+    const tsConfigPath = tree.exists('tsconfig.base.json') ? 'tsconfig.base.json' : 'tsconfig.json';
+
+    updateJson(tree, tsConfigPath, (json) => {
+        if (!('skipLibCheck' in json.compilerOptions) || json.compilerOptions?.skipLibCheck === false) {
+            json.compilerOptions.skipLibCheck = true;
+        }
+        return json;
+    });
+    return () => {
+        installPackagesTask(tree);
+    };
+}
diff --git a/libs/plugin/src/generators/init/schema.json b/libs/plugin/src/generators/init/schema.json
@@ -0,0 +1,6 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "cli": "nx",
+    "$id": "Init",
+    "title": "Init Angular Three"
+}
diff --git a/libs/plugin/src/index.ts b/libs/plugin/src/index.ts
@@ -0,0 +1 @@
+export { default as initGenerator } from './generators/init/init';
diff --git a/libs/plugin/tsconfig.json b/libs/plugin/tsconfig.json
@@ -0,0 +1,16 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "compilerOptions": {
+        "module": "commonjs"
+    },
+    "files": [],
+    "include": [],
+    "references": [
+        {
+            "path": "./tsconfig.lib.json"
+        },
+        {
+            "path": "./tsconfig.spec.json"
+        }
+    ]
+}
diff --git a/libs/plugin/tsconfig.lib.json b/libs/plugin/tsconfig.lib.json
@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "../../dist/out-tsc",
+        "declaration": true,
+        "types": ["node"]
+    },
+    "include": ["src/**/*.ts"],
+    "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}
diff --git a/libs/plugin/tsconfig.spec.json b/libs/plugin/tsconfig.spec.json
@@ -0,0 +1,9 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "../../dist/out-tsc",
+        "module": "commonjs",
+        "types": ["jest", "node"]
+    },
+    "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
+}
diff --git a/package.json b/package.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tsconfig.base.json b/tsconfig.base.json

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,11 @@`
`37`	`37`	`"jest": true`
`38`	`38`	`},`
`39`	`39`	`"rules": {}`
	`40`	`+ },`
	`41`	`+ {`
	`42`	`+ "files": "*.json",`
	`43`	`+ "parser": "jsonc-eslint-parser",`
	`44`	`+ "rules": {}`
`40`	`45`	`}`
`41`	`46`	`]`
`42`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`"releaseName": "Release ${version}"`
`41`	`41`	`},`
`42`	`42`	`"hooks": {`
`43`		`- "before:bump": "npx nx build angular-three",`
	`43`	`+ "before:bump": "npx nx package angular-three",`
`44`	`44`	`"after:bump": ["git checkout -- package.json"]`
`45`	`45`	`}`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "eslint.validate": ["json"]`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -30,5 +30,7 @@`
`30`	`30`	`"@rx-angular/state": "^1.7.0",`
`31`	`31`	`"tslib": "^2.3.0"`
`32`	`32`	`},`
`33`		`- "sideEffects": false`
	`33`	`+ "sideEffects": false,`
	`34`	`+ "generators": "./plugin/generators.json",`
	`35`	`+ "schematics": "./plugin/generators.json"`
`34`	`36`	`}`