fix: add initial proper structure for an Nx Plugin

benpsnyder · benpsnyder · commit 88c4ab4449e3 · 2021-12-01T15:59:53.000-05:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,5 +1,6 @@
 {
   "root": true,
+  "ignorePatterns": ["**/*"],
   "plugins": ["@nrwl/nx"],
   "overrides": [
     {
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -2,6 +2,8 @@
   "recommendations": [
     "ms-vscode.vscode-typescript-tslint-plugin",
     "esbenp.prettier-vscode",
-    "firsttris.vscode-jest-runner"
+    "firsttris.vscode-jest-runner",
+    "nrwl.angular-console",
+    "dbaeumer.vscode-eslint"
   ]
 }
diff --git a/apps/ddd-e2e/project.json b/apps/ddd-e2e/project.json
@@ -1,7 +1,7 @@
 {
   "projectType": "application",
-  "root": "apps\\ddd-e2e",
-  "sourceRoot": "apps\\ddd-e2e/src",
+  "root": "apps/ddd-e2e",
+  "sourceRoot": "apps/ddd-e2e/src",
   "targets": {
     "e2e": {
       "executor": "@nrwl/nx-plugin:e2e",
diff --git a/e2e/ddd-e2e/jest.config.js b/e2e/ddd-e2e/jest.config.js
@@ -0,0 +1,14 @@
+module.exports = {
+  displayName: 'ddd-e2e',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[tj]s$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/e2e/ddd-e2e',
+};
diff --git a/e2e/ddd-e2e/project.json b/e2e/ddd-e2e/project.json
@@ -0,0 +1,16 @@
+{
+  "root": "e2e/ddd-e2e",
+  "projectType": "application",
+  "sourceRoot": "e2e/ddd-e2e/src",
+  "targets": {
+    "e2e": {
+      "executor": "@nrwl/nx-plugin:e2e",
+      "options": {
+        "target": "ddd:build",
+        "jestConfig": "e2e/ddd-e2e/jest.config.js"
+      }
+    }
+  },
+  "tags": [],
+  "implicitDependencies": ["ddd"]
+}
diff --git a/e2e/ddd-e2e/tests/ddd.spec.ts b/e2e/ddd-e2e/tests/ddd.spec.ts
@@ -0,0 +1,42 @@
+import {
+  checkFilesExist,
+  ensureNxProject,
+  readJson,
+  runNxCommandAsync,
+  uniq,
+} from '@nrwl/nx-plugin/testing';
+describe('ddd e2e', () => {
+  it('should create ddd', async () => {
+    const plugin = uniq('ddd');
+    ensureNxProject('@angular-architects/ddd', 'dist/packages/ddd');
+    await runNxCommandAsync(`generate @angular-architects/ddd:ddd ${plugin}`);
+
+    const result = await runNxCommandAsync(`build ${plugin}`);
+    expect(result.stdout).toContain('Executor ran');
+  }, 120000);
+
+  describe('--directory', () => {
+    it('should create src in the specified directory', async () => {
+      const plugin = uniq('ddd');
+      ensureNxProject('@angular-architects/ddd', 'dist/packages/ddd');
+      await runNxCommandAsync(
+        `generate @angular-architects/ddd:ddd ${plugin} --directory subdir`
+      );
+      expect(() =>
+        checkFilesExist(`libs/subdir/${plugin}/src/index.ts`)
+      ).not.toThrow();
+    }, 120000);
+  });
+
+  describe('--tags', () => {
+    it('should add tags to the project', async () => {
+      const plugin = uniq('ddd');
+      ensureNxProject('@angular-architects/ddd', 'dist/packages/ddd');
+      await runNxCommandAsync(
+        `generate @angular-architects/ddd:ddd ${plugin} --tags e2etag,e2ePackage`
+      );
+      const project = readJson(`libs/${plugin}/project.json`);
+      expect(project.tags).toEqual(['e2etag', 'e2ePackage']);
+    }, 120000);
+  });
+});
diff --git a/e2e/ddd-e2e/tsconfig.json b/e2e/ddd-e2e/tsconfig.json
@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.e2e.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}
diff --git a/e2e/ddd-e2e/tsconfig.spec.json b/e2e/ddd-e2e/tsconfig.spec.json
@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["**/*.test.ts", "**/*.spec.ts", "**/*.d.ts"]
+}
diff --git a/jest.config.js b/jest.config.js
@@ -1,3 +1,5 @@
 const { getJestProjects } = require('@nrwl/jest');
 
-module.exports = { projects: getJestProjects() };
+module.exports = {
+  projects: getJestProjects(),
+};
diff --git a/jest.preset.js b/jest.preset.js
@@ -1,11 +1,3 @@
 const nxPreset = require('@nrwl/jest/preset');
-module.exports = {
-  ...nxPreset,
-  testMatch: ['**/+(*.)+(spec|test).+(ts|js)?(x)'],
-  transform: {
-    '^.+\\.(ts|js|html)$': 'ts-jest',
-  },
-  resolver: '@nrwl/jest/plugins/resolver',
-  moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageReporters: ['html'],
-};
+
+module.exports = { ...nxPreset };
diff --git a/libs/ddd/project.json b/libs/ddd/project.json
@@ -29,7 +29,6 @@
     "build": {
       "executor": "@nrwl/node:package",
       "options": {
-        "outputPath": "dist/libs/ddd",
         "tsConfig": "libs/ddd/tsconfig.lib.json",
         "packageJson": "libs/ddd/package.json",
         "main": "libs/ddd/src/index.ts",
diff --git a/nx.json b/nx.json
@@ -1,14 +1,16 @@
 {
   "npmScope": "angular-architects",
+  "affected": {
+    "defaultBase": "master"
+  },
+  "cli": {
+    "defaultCollection": "@nrwl/workspace"
+  },
   "implicitDependencies": {
-    "workspace.json": "*",
     "package.json": {
       "dependencies": "*",
       "devDependencies": "*"
     },
-    "tslint.json": "*",
-    "nx.json": "*",
-    "tsconfig.base.json": "*",
     ".eslintrc.json": "*"
   },
   "tasksRunnerOptions": {
@@ -19,9 +21,7 @@
       }
     }
   },
-  "affected": {
-    "defaultBase": "master"
-  },
+
   "targetDependencies": {
     "build": [
       {
@@ -30,8 +30,9 @@
       }
     ]
   },
-  "cli": {
-    "defaultCollection": "@nrwl/workspace"
+  "workspaceLayout": {
+    "appsDir": "e2e",
+    "libsDir": "packages"
   },
   "generators": {
     "@nrwl/workspace": {
diff --git a/package.json b/package.json
@@ -35,9 +35,13 @@
     }
   },
   "dependencies": {
-    "@schematics/angular": "^12.0.0"
+    "@schematics/angular": "^12.0.0",
+    "tslib": "^2.0.0"
   },
   "devDependencies": {
+    "@nrwl/devkit": "13.1.4",
+    "@nrwl/linter": "13.1.4",
+    "@nrwl/node": "13.1.4",
     "@nrwl/angular": "13.1.4",
     "@nrwl/cli": "13.1.4",
     "@nrwl/eslint-plugin-nx": "13.1.4",
diff --git a/packages/ddd/.babelrc b/packages/ddd/.babelrc
@@ -0,0 +1,3 @@
+{
+  "presets": [["@nrwl/web/babel", { "useBuiltIns": "usage" }]]
+}
diff --git a/packages/ddd/.eslintrc.json b/packages/ddd/.eslintrc.json
@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}
diff --git a/packages/ddd/README.md b/packages/ddd/README.md
@@ -0,0 +1,7 @@
+# ddd
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test ddd` to execute the unit tests via [Jest](https://jestjs.io).
diff --git a/packages/ddd/executors.json b/packages/ddd/executors.json
@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "executors": {
+    "build": {
+      "implementation": "./src/executors/build/executor",
+      "schema": "./src/executors/build/schema.json",
+      "description": "build executor"
+    }
+  }
+}
diff --git a/packages/ddd/generators.json b/packages/ddd/generators.json
@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "name": "ddd",
+  "version": "0.0.1",
+  "generators": {
+    "ddd": {
+      "factory": "./src/generators/ddd/generator",
+      "schema": "./src/generators/ddd/schema.json",
+      "description": "ddd generator"
+    }
+  }
+}
diff --git a/packages/ddd/jest.config.js b/packages/ddd/jest.config.js
@@ -0,0 +1,15 @@
+module.exports = {
+  displayName: 'ddd',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/packages/ddd',
+};
diff --git a/packages/ddd/package.json b/packages/ddd/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "@angular-architects/ddd",
+  "version": "0.0.1",
+  "main": "src/index.js",
+  "generators": "./generators.json",
+  "executors": "./executors.json"
+}
diff --git a/packages/ddd/project.json b/packages/ddd/project.json
@@ -0,0 +1,56 @@
+{
+  "root": "packages/ddd",
+  "sourceRoot": "packages/ddd/src",
+  "projectType": "library",
+  "targets": {
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["packages/ddd/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/packages/ddd"],
+      "options": {
+        "jestConfig": "packages/ddd/jest.config.js",
+        "passWithNoTests": true
+      }
+    },
+    "build": {
+      "executor": "@nrwl/node:package",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/ddd",
+        "tsConfig": "packages/ddd/tsconfig.lib.json",
+        "packageJson": "packages/ddd/package.json",
+        "main": "packages/ddd/src/index.ts",
+        "assets": [
+          "packages/ddd/*.md",
+          {
+            "input": "./packages/ddd/src",
+            "glob": "**/!(*.ts)",
+            "output": "./src"
+          },
+          {
+            "input": "./packages/ddd/src",
+            "glob": "**/*.d.ts",
+            "output": "./src"
+          },
+          {
+            "input": "./packages/ddd",
+            "glob": "generators.json",
+            "output": "."
+          },
+          {
+            "input": "./packages/ddd",
+            "glob": "executors.json",
+            "output": "."
+          }
+        ]
+      }
+    }
+  },
+  "tags": []
+}
diff --git a/packages/ddd/src/executors/build/executor.spec.ts b/packages/ddd/src/executors/build/executor.spec.ts
@@ -0,0 +1,11 @@
+import { BuildExecutorSchema } from './schema';
+import executor from './executor';
+
+const options: BuildExecutorSchema = {};
+
+describe('Build Executor', () => {
+  it('can run', async () => {
+    const output = await executor(options);
+    expect(output.success).toBe(true);
+  });
+});
diff --git a/packages/ddd/src/executors/build/executor.ts b/packages/ddd/src/executors/build/executor.ts
@@ -0,0 +1,8 @@
+import { BuildExecutorSchema } from './schema';
+
+export default async function runExecutor(options: BuildExecutorSchema) {
+  console.log('Executor ran for Build', options);
+  return {
+    success: true,
+  };
+}
diff --git a/packages/ddd/src/executors/build/schema.d.ts b/packages/ddd/src/executors/build/schema.d.ts
@@ -0,0 +1 @@
+export interface BuildExecutorSchema {} // eslint-disable-line
diff --git a/packages/ddd/src/executors/build/schema.json b/packages/ddd/src/executors/build/schema.json
@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "title": "Build executor",
+  "description": "",
+  "type": "object",
+  "properties": {},
+  "required": []
+}
diff --git a/packages/ddd/src/generators/ddd/files/src/index.ts__template__ b/packages/ddd/src/generators/ddd/files/src/index.ts__template__
@@ -0,0 +1 @@
+const variable = "<%= projectName %>";
diff --git a/packages/ddd/src/generators/ddd/generator.spec.ts b/packages/ddd/src/generators/ddd/generator.spec.ts
diff --git a/packages/ddd/src/generators/ddd/generator.ts b/packages/ddd/src/generators/ddd/generator.ts
diff --git a/packages/ddd/src/generators/ddd/schema.d.ts b/packages/ddd/src/generators/ddd/schema.d.ts
diff --git a/packages/ddd/src/generators/ddd/schema.json b/packages/ddd/src/generators/ddd/schema.json
diff --git a/packages/ddd/src/index.ts b/packages/ddd/src/index.ts
diff --git a/packages/ddd/tsconfig.json b/packages/ddd/tsconfig.json
diff --git a/packages/ddd/tsconfig.lib.json b/packages/ddd/tsconfig.lib.json
diff --git a/packages/ddd/tsconfig.spec.json b/packages/ddd/tsconfig.spec.json
diff --git a/tsconfig.base.json b/tsconfig.base.json
diff --git a/workspace.json b/workspace.json

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"root": true,`
	`3`	`+ "ignorePatterns": ["*/"],`
`3`	`4`	`"plugins": ["@nrwl/nx"],`
`4`	`5`	`"overrides": [`
`5`	`6`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`	`"recommendations": [`
`3`	`3`	`"ms-vscode.vscode-typescript-tslint-plugin",`
`4`	`4`	`"esbenp.prettier-vscode",`
`5`		`- "firsttris.vscode-jest-runner"`
	`5`	`+ "firsttris.vscode-jest-runner",`
	`6`	`+ "nrwl.angular-console",`
	`7`	`+ "dbaeumer.vscode-eslint"`
`6`	`8`	`]`
`7`	`9`	`}`