@nx/docker 0.0.0-pr-31634-cb74636 → 0.0.0-pr-31634-ece4eca

package/README.md

@@ -26,6 +26,8 @@ An AI-first build platform that connects everything from your editor to CI. Help
 
 This package is a [Docker plugin for Nx](https://nx.dev/nx-api/docker).
 
+**Experimental**: Support for Docker is currently experimental. Breaking changes may occur and not adhere to semver versioning.
+
 ## Getting Started
 
 ### Creating an Nx Workspace

package/generators.json

@@ -0,0 +1,13 @@
+{
+  "name": "Nx Docker",
+  "version": "0.1",
+  "generators": {
+    "init": {
+      "factory": "./src/generators/init/init#initGeneratorInternal",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Initialize the `@nx/docker` plugin. **Experimental**: Docker support is experimental. Breaking changes may occur and not adhere to semver versioning.",
+      "aliases": ["ng-add"],
+      "hidden": true
+    }
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nx/docker",
   "description": "The Nx Plugin for Docker to aid in containerizing projects.",
-  "version": "0.0.0-pr-31634-cb74636",
+  "version": "0.0.0-pr-31634-ece4eca",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -37,8 +37,10 @@
     }
   },
   "executors": "./executors.json",
+  "generators": "./generators.json",
   "dependencies": {
-    "@nx/devkit": "0.0.0-pr-31634-cb74636",
+    "@nx/devkit": "0.0.0-pr-31634-ece4eca",
+    "enquirer": "~2.3.6",
     "tslib": "^2.3.0"
   },
   "types": "./index.d.ts"

package/src/executors/release-publish/release-publish.impl.js

@@ -6,6 +6,7 @@ const child_process_1 = require("child_process");
 const path_1 = require("path");
 const fs_1 = require("fs");
 async function dockerReleasePublish(schema, context) {
+    devkit_1.logger.warn(`Docker support is experimental. Breaking changes may occur and not adhere to semver versioning.`);
     const projectConfig = context.projectGraph.nodes[context.projectName];
     const options = normalizeOptions(projectConfig, schema);
     if (!options.dryRun) {

package/src/generators/init/init.d.ts

@@ -0,0 +1,6 @@
+import { type Tree, type GeneratorCallback } from '@nx/devkit';
+import { InitGeneratorSchema } from './schema';
+export declare function updateDependencies(tree: Tree, schema: InitGeneratorSchema): GeneratorCallback;
+export declare function initGenerator(tree: Tree, schema: InitGeneratorSchema): Promise<GeneratorCallback>;
+export declare function initGeneratorInternal(tree: Tree, schema: InitGeneratorSchema): Promise<GeneratorCallback>;
+export default initGenerator;

package/src/generators/init/init.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateDependencies = updateDependencies;
+exports.initGenerator = initGenerator;
+exports.initGeneratorInternal = initGeneratorInternal;
+const devkit_1 = require("@nx/devkit");
+const add_plugin_1 = require("@nx/devkit/src/utils/add-plugin");
+const plugin_1 = require("../../plugins/plugin");
+const versions_1 = require("../../utils/versions");
+function updateDependencies(tree, schema) {
+    return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+        '@nx/docker': versions_1.nxVersion,
+    }, undefined, schema.keepExistingVersions);
+}
+function initGenerator(tree, schema) {
+    return initGeneratorInternal(tree, { addPlugin: false, ...schema });
+}
+async function initGeneratorInternal(tree, schema) {
+    devkit_1.logger.warn(`Docker support is experimental. Breaking changes may occur and not adhere to semver versioning.`);
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    schema.addPlugin ??= addPluginDefault;
+    if (schema.addPlugin) {
+        await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/docker', plugin_1.createNodesV2, {
+            buildTarget: ['docker:build', 'docker-build', 'build-docker'],
+            runTarget: ['docker:run', 'docker-run', 'run-docker'],
+        }, schema.updatePackageScripts);
+    }
+    const tasks = [];
+    if (!schema.skipPackageJson) {
+        tasks.push(updateDependencies(tree, schema));
+    }
+    if (!schema.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+    return (0, devkit_1.runTasksInSerial)(...tasks);
+}
+exports.default = initGenerator;

package/src/generators/init/schema.d.ts

@@ -0,0 +1,8 @@
+export interface InitGeneratorSchema {
+  rootProject?: boolean;
+  keepExistingVersions?: boolean;
+  updatePackageScripts?: boolean;
+  skipFormat?: boolean;
+  skipPackageJson?: boolean;
+  addPlugin?: boolean;
+}

package/src/generators/init/schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "Init",
+  "title": "Nx Docker Init Generator",
+  "type": "object",
+  "description": "Docker init generator.",
+  "properties": {
+    "rootProject": {
+      "type": "boolean",
+      "x-priority": "internal"
+    },
+    "keepExistingVersions": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
+      "default": false
+    },
+    "updatePackageScripts": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Update package scripts",
+      "default": false
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false
+    },
+    "skipPackageJson": {
+      "description": "Do not add dependencies to `package.json`.",
+      "type": "boolean",
+      "default": false
+    },
+    "addPlugin": {
+      "type": "boolean",
+      "description": "Add the plugin to the nx.json file.",
+      "default": true
+    }
+  },
+  "required": []
+}

package/src/release/version-utils.js

@@ -51,7 +51,7 @@ function updateProjectVersion(newVersion, projectRoot, repositoryName, registry)
     if (!isDryRun) {
         (0, child_process_1.execSync)(`docker tag ${imageRef} ${fullImageRef}`);
     }
-    const logs = [`Image ${imageRef} tagged with ${fullImageRef}.`];
+    const logs = [`Image tagged with ${fullImageRef}.`];
     if (isDryRun) {
         logs.push(`No changes were applied as --dry-run is enabled.`);
     }

package/src/utils/versions.d.ts

@@ -0,0 +1 @@
+export declare const nxVersion: any;

package/src/utils/versions.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nxVersion = void 0;
+exports.nxVersion = require('../../../package.json').version;