@clipboard-health/nx-plugin 0.3.0 → 0.3.4

package/README.md

@@ -7,8 +7,6 @@ Clipboard Health's Nx plugin contains generators to manage libraries within an N
 - [Table of Contents](#table-of-contents)
 - [Install](#install)
 - [Usage](#usage)
-  - [Adding new libraries](#adding-new-libraries)
-  - [Porting existing libraries](#porting-existing-libraries)
 
 ## Install
 
@@ -18,12 +16,10 @@ npm install @clipboard-health/nx-plugin
 
 ## Usage
 
-### Adding new libraries
-
-Libraries version and publish separately. We use [Nx Local Generators](https://nx.dev/recipes/generators/local-generators) to generate library stubs that successfully build, lint, and test. The `--publishable` flag sets up semantic versioning from commit messages, GitHub Release creation, and NPM publishing on merges to `main` (but only if the code within your library package changed, thanks to Nx's dependency graph).
+Libraries version and publish separately. We use [Nx Local Generators](https://nx.dev/recipes/generators/local-generators) to generate library stubs that successfully build, lint, and test. The `--publishConfigPublicAccess` flag publishes the NPM package publicly.
 
 ```bash
-# Optionally, include the --publishable flag to publish to NPM.
+# Optionally, include the --publishConfigPublicAccess flag.
 npx nx generate @clipboard-health/nx-plugin:node-lib [PROJECT_NAME]
 
 # Change your mind? Remove it just as easily...
@@ -34,6 +30,4 @@ npx nx generate @nx/workspace:remove --projectName [PROJECT_NAME]
 npx nx generate @nx/workspace:move --projectName [PROJECT_NAME] --destination [NEW_PROJECT_NAME]
 ```
 
-### Porting existing libraries
-
-Follow [Adding new libraries](#adding-new-libraries) to generate a new package and copy the code from the existing library into it.
+To porting an existing library, follow the above to generate a new package and copy the code from the existing library into it.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/nx-plugin",
   "description": "Clipboard Health's Nx plugin contains generators to manage applications within an Nx workspace.",
-  "version": "0.3.0",
+  "version": "0.3.4",
   "bugs": "https://github.com/clipboardhealth/core-utils/issues",
   "dependencies": {
     "@nx/devkit": "19.5.6",
@@ -28,5 +28,6 @@
     "directory": "packages/nx-plugin"
   },
   "type": "commonjs",
-  "typings": "./src/index.d.ts"
+  "typings": "./src/index.d.ts",
+  "types": "./src/index.d.ts"
 }

package/src/generators/node-lib/files/package.json__template__

@@ -10,7 +10,7 @@
   "license": "MIT",
   "main": "./src/index.js",
   "publishConfig": {
-    "access": "public"
+    "access": "<%= publishConfigAccess %>"
   },
   "repository": {
     "type": "git",

package/src/generators/node-lib/files/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/rename-me"), exports);
+//# sourceMappingURL=index.js.map

package/src/generators/node-lib/files/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../packages/nx-plugin/src/generators/node-lib/files/src/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC"}

package/src/generators/node-lib/files/src/lib/rename-me.d.ts

@@ -0,0 +1 @@
+export declare function deleteMe(): string;

package/src/generators/node-lib/files/src/lib/rename-me.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteMe = deleteMe;
+function deleteMe() {
+    return "hello";
+}
+//# sourceMappingURL=rename-me.js.map

package/src/generators/node-lib/files/src/lib/rename-me.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rename-me.js","sourceRoot":"","sources":["../../../../../../../../../packages/nx-plugin/src/generators/node-lib/files/src/lib/rename-me.ts"],"names":[],"mappings":";;AAAA,4BAEC;AAFD,SAAgB,QAAQ;IACtB,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/src/generators/node-lib/generator.d.ts

@@ -0,0 +1,3 @@
+import { type Tree } from "@nx/devkit";
+import type { NxPluginGeneratorSchema } from "./schema";
+export default function generate(tree: Tree, options: NxPluginGeneratorSchema): Promise<void>;

package/src/generators/node-lib/generator.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = generate;
+const node_path_1 = require("node:path");
+const devkit_1 = require("@nx/devkit");
+const get_import_path_1 = require("@nx/js/src/utils/get-import-path");
+const ROOT_TS_CONFIG = "tsconfig.base.json";
+function normalizeOptions(tree, options) {
+    const name = (0, devkit_1.names)(options.name).fileName;
+    const projectDirectory = name;
+    return {
+        ...options,
+        publishConfigAccess: options.publishPublicly ? "public" : "restricted",
+        importPath: (0, get_import_path_1.getImportPath)(tree, projectDirectory),
+        projectName: name.replaceAll("/", "-"),
+        projectRoot: `${(0, devkit_1.getWorkspaceLayout)(tree).libsDir}/${name}`,
+        projectDirectory,
+    };
+}
+function getRelativePathToRootTsConfig(targetPath) {
+    return `${(0, devkit_1.offsetFromRoot)(targetPath)}${ROOT_TS_CONFIG}`;
+}
+function addFiles(tree, options) {
+    (0, devkit_1.generateFiles)(tree, (0, node_path_1.join)(__dirname, "files"), options.projectRoot, {
+        ...options,
+        ...(0, devkit_1.names)(options.name),
+        offsetFromRoot: (0, devkit_1.offsetFromRoot)(options.projectRoot),
+        rootTsConfigPath: getRelativePathToRootTsConfig(options.projectRoot),
+        template: "",
+    });
+}
+function updateRootTsConfig(host, options) {
+    (0, devkit_1.updateJson)(host, ROOT_TS_CONFIG, (json) => {
+        const c = json.compilerOptions;
+        c.paths ||= {};
+        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+        delete c.paths[options.name];
+        /* istanbul ignore next */
+        if (c.paths[options.importPath]) {
+            throw new Error(`There is already a library with import path "${options.importPath}".`);
+        }
+        c.paths[options.importPath] = [(0, devkit_1.joinPathFragments)(options.projectRoot, "./src", "index.ts")];
+        return json;
+    });
+}
+async function generate(tree, options) {
+    const normalizedOptions = normalizeOptions(tree, options);
+    addFiles(tree, normalizedOptions);
+    updateRootTsConfig(tree, normalizedOptions);
+    await (0, devkit_1.formatFiles)(tree);
+}
+//# sourceMappingURL=generator.js.map

package/src/generators/node-lib/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/generators/node-lib/generator.ts"],"names":[],"mappings":";;AAkFA,2BAKC;AAvFD,yCAAiC;AAEjC,uCASoB;AACpB,sEAAiE;AAIjE,MAAM,cAAc,GAAG,oBAAoB,CAAC;AAU5C,SAAS,gBAAgB,CAAC,IAAU,EAAE,OAAgC;IACpE,MAAM,IAAI,GAAG,IAAA,cAAK,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;IAC1C,MAAM,gBAAgB,GAAG,IAAI,CAAC;IAC9B,OAAO;QACL,GAAG,OAAO;QACV,mBAAmB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY;QACtE,UAAU,EAAE,IAAA,+BAAa,EAAC,IAAI,EAAE,gBAAgB,CAAC;QACjD,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;QACtC,WAAW,EAAE,GAAG,IAAA,2BAAkB,EAAC,IAAI,CAAC,CAAC,OAAO,IAAI,IAAI,EAAE;QAC1D,gBAAgB;KACjB,CAAC;AACJ,CAAC;AAED,SAAS,6BAA6B,CAAC,UAAkB;IACvD,OAAO,GAAG,IAAA,uBAAc,EAAC,UAAU,CAAC,GAAG,cAAc,EAAE,CAAC;AAC1D,CAAC;AAED,SAAS,QAAQ,CAAC,IAAU,EAAE,OAAyB;IACrD,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAA,gBAAI,EAAC,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,EAAE;QACjE,GAAG,OAAO;QACV,GAAG,IAAA,cAAK,EAAC,OAAO,CAAC,IAAI,CAAC;QACtB,cAAc,EAAE,IAAA,uBAAc,EAAC,OAAO,CAAC,WAAW,CAAC;QACnD,gBAAgB,EAAE,6BAA6B,CAAC,OAAO,CAAC,WAAW,CAAC;QACpE,QAAQ,EAAE,EAAE;KACb,CAAC,CAAC;AACL,CAAC;AAED,SAAS,kBAAkB,CACzB,IAAU,EACV,OAIC;IAED,IAAA,mBAAU,EACR,IAAI,EACJ,cAAc,EACd,CAAC,IAAI,EAAE,EAAE;QACP,MAAM,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/B,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;QACf,gEAAgE;QAChE,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE7B,0BAA0B;QAC1B,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,gDAAgD,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC;QAC1F,CAAC;QAED,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAA,0BAAiB,EAAC,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;QAE5F,OAAO,IAAI,CAAC;IACd,CAAC,CACF,CAAC;AACJ,CAAC;AAEc,KAAK,UAAU,QAAQ,CAAC,IAAU,EAAE,OAAgC;IACjF,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1D,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAClC,kBAAkB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAC5C,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/src/generators/node-lib/schema.d.ts

@@ -1,4 +1,4 @@
 export interface NxPluginGeneratorSchema {
   name: string;
-  publishable?: boolean;
+  publishPublicly?: boolean;
 }

package/src/generators/node-lib/schema.json

@@ -14,10 +14,10 @@
       "x-prompt": "Library name?",
       "pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$"
     },
-    "publishable": {
+    "publishPublicly": {
       "type": "boolean",
       "default": false,
-      "description": "Create a publishable library.",
+      "description": "Publish the NPM package publicly.",
       "x-priority": "important"
     }
   },

package/src/{index.ts → index.js}

@@ -1 +1,3 @@
+"use strict";
 // eslint-disable-next-line unicorn/no-empty-file
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/nx-plugin/src/index.ts"],"names":[],"mappings":";AAAA,iDAAiD"}

package/.eslintrc.json

@@ -1,8 +0,0 @@
-{
-  "extends": ["../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
-  "parserOptions": {
-    "project": "tsconfig.lint.json",
-    "tsconfigRootDir": "packages/nx-plugin"
-  }
-}

package/jest.config.ts

@@ -1,19 +0,0 @@
-export default {
-  coverageDirectory: "../../coverage/packages/nx-plugin",
-  coveragePathIgnorePatterns: [],
-  coverageThreshold: {
-    global: {
-      branches: 100,
-      functions: 100,
-      lines: 100,
-      statements: 100,
-    },
-  },
-  displayName: "nx-plugin",
-  moduleFileExtensions: ["ts", "js"],
-  preset: "../../jest.preset.js",
-  testEnvironment: "node",
-  transform: {
-    "^.+\\.[tj]s$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.spec.json" }],
-  },
-};

package/project.json

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

package/src/generators/node-lib/files/src/lib/rename-me.spec.ts

@@ -1,7 +0,0 @@
-import { deleteMe } from "./rename-me";
-
-describe("deleteMe", () => {
-  it("works", () => {
-    expect(deleteMe()).toBe("hello");
-  });
-});

package/src/generators/node-lib/files/src/lib/rename-me.ts

@@ -1,3 +0,0 @@
-export function deleteMe(): string {
-  return "hello";
-}

package/src/generators/node-lib/generator.spec.ts

@@ -1,19 +0,0 @@
-import { readProjectConfiguration, type Tree } from "@nx/devkit";
-import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
-
-import generator from "./generator";
-
-describe("generator", () => {
-  let appTree: Tree;
-
-  beforeEach(() => {
-    appTree = createTreeWithEmptyWorkspace({ layout: "apps-libs" });
-  });
-
-  it("runs successfully", async () => {
-    const name = "test";
-    await generator(appTree, { name });
-    const config = readProjectConfiguration(appTree, name);
-    expect(config).toBeDefined();
-  });
-});

package/src/generators/node-lib/generator.ts

@@ -1,87 +0,0 @@
-import { join } from "node:path";
-
-import {
-  formatFiles,
-  generateFiles,
-  getWorkspaceLayout,
-  joinPathFragments,
-  names,
-  offsetFromRoot,
-  type Tree,
-  updateJson,
-} from "@nx/devkit";
-import { getImportPath } from "@nx/js/src/utils/get-import-path";
-
-import type { NxPluginGeneratorSchema } from "./schema";
-
-const ROOT_TS_CONFIG = "tsconfig.base.json";
-
-type NormalizedSchema = NxPluginGeneratorSchema & {
-  importPath: string;
-  projectName: string;
-  projectRoot: string;
-  projectDirectory: string;
-};
-
-function normalizeOptions(tree: Tree, options: NxPluginGeneratorSchema): NormalizedSchema {
-  const name = names(options.name).fileName;
-  const projectDirectory = name;
-  return {
-    ...options,
-    publishable: options.publishable ?? false,
-    importPath: getImportPath(tree, projectDirectory),
-    projectName: name.replaceAll("/", "-"),
-    projectRoot: `${getWorkspaceLayout(tree).libsDir}/${name}`,
-    projectDirectory,
-  };
-}
-
-function getRelativePathToRootTsConfig(targetPath: string): string {
-  return `${offsetFromRoot(targetPath)}${ROOT_TS_CONFIG}`;
-}
-
-function addFiles(tree: Tree, options: NormalizedSchema) {
-  generateFiles(tree, join(__dirname, "files"), options.projectRoot, {
-    ...options,
-    ...names(options.name),
-    offsetFromRoot: offsetFromRoot(options.projectRoot),
-    rootTsConfigPath: getRelativePathToRootTsConfig(options.projectRoot),
-    template: "",
-  });
-}
-
-function updateRootTsConfig(
-  host: Tree,
-  options: {
-    name: string;
-    importPath: string;
-    projectRoot: string;
-  },
-) {
-  updateJson<{ compilerOptions: { paths: Record<string, string[]> } }>(
-    host,
-    ROOT_TS_CONFIG,
-    (json) => {
-      const c = json.compilerOptions;
-      c.paths ||= {};
-      // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-      delete c.paths[options.name];
-
-      /* istanbul ignore next */
-      if (c.paths[options.importPath]) {
-        throw new Error(`There is already a library with import path "${options.importPath}".`);
-      }
-
-      c.paths[options.importPath] = [joinPathFragments(options.projectRoot, "./src", "index.ts")];
-
-      return json;
-    },
-  );
-}
-
-export default async function generate(tree: Tree, options: NxPluginGeneratorSchema) {
-  const normalizedOptions = normalizeOptions(tree, options);
-  addFiles(tree, normalizedOptions);
-  updateRootTsConfig(tree, normalizedOptions);
-  await formatFiles(tree);
-}

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc"
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.lint.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "declaration": true,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.lint.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": ["jest", "node"]
-  },
-  "include": ["."]
-}

package/tsconfig.spec.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": ["jest", "node"]
-  },
-  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
-}

package/typedoc.json

@@ -1,4 +0,0 @@
-{
-  "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"]
-}