@clipboard-health/nx-plugin 0.3.0 → 0.3.1

package/README.md

@@ -18,12 +18,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 +32,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.1",
   "bugs": "https://github.com/clipboardhealth/core-utils/issues",
   "dependencies": {
     "@nx/devkit": "19.5.6",

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/generator.ts

@@ -21,6 +21,7 @@ type NormalizedSchema = NxPluginGeneratorSchema & {
   projectName: string;
   projectRoot: string;
   projectDirectory: string;
+  publishConfigAccess: string;
 };
 
 function normalizeOptions(tree: Tree, options: NxPluginGeneratorSchema): NormalizedSchema {
@@ -28,7 +29,7 @@ function normalizeOptions(tree: Tree, options: NxPluginGeneratorSchema): Normali
   const projectDirectory = name;
   return {
     ...options,
-    publishable: options.publishable ?? false,
+    publishConfigAccess: options.publishConfigPublicAccess ? "public" : "restricted",
     importPath: getImportPath(tree, projectDirectory),
     projectName: name.replaceAll("/", "-"),
     projectRoot: `${getWorkspaceLayout(tree).libsDir}/${name}`,

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

@@ -1,4 +1,4 @@
 export interface NxPluginGeneratorSchema {
   name: string;
-  publishable?: boolean;
+  publishConfigPublicAccess?: 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": {
+    "publishConfigPublicAccess": {
       "type": "boolean",
       "default": false,
-      "description": "Create a publishable library.",
+      "description": "Publish the NPM package publicly.",
       "x-priority": "important"
     }
   },