nx 17.0.2 → 17.0.4

package/schemas/nx-schema.json

@@ -18,7 +18,12 @@
           "description": "Default based branch used by affected commands."
         }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "deprecated": "Use `defaultBase` instead. Support for setting `defaultBase` in `affected` will be removed in Nx 19."
+    },
+    "defaultBase": {
+      "type": "string",
+      "description": "Default --base used by affected logic."
     },
     "tasksRunnerOptions": {
       "type": "object",
@@ -96,32 +101,76 @@
       "type": "boolean",
       "description": "Specifies whether the daemon should be used for the default tasks runner."
     },
+    "useInferencePlugins": {
+      "type": "boolean",
+      "description": "Specifies whether to add inference plugins when generating new projects."
+    },
     "release": {
       "type": "object",
       "description": "Configuration for the nx release commands.",
       "additionalProperties": false,
       "properties": {
+        "projects": {
+          "oneOf": [
+            {
+              "type": "string",
+              "description": "A project name"
+            },
+            {
+              "type": "array",
+              "description": "An array of project names",
+              "minItems": 1,
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
         "groups": {
           "type": "object",
           "additionalProperties": {
             "type": "object",
             "properties": {
+              "projectsRelationship": {
+                "type": "string",
+                "enum": ["fixed", "independent"]
+              },
               "projects": {
                 "oneOf": [
+                  {
+                    "type": "string",
+                    "description": "A project name"
+                  },
                   {
                     "type": "array",
+                    "description": "An array of project names",
+                    "minItems": 1,
                     "items": {
                       "type": "string"
-                    },
-                    "minItems": 1
-                  },
-                  {
-                    "type": "string"
+                    }
                   }
                 ]
               },
               "version": {
-                "$ref": "#/definitions/NxReleaseVersionConfiguration"
+                "allOf": [
+                  {
+                    "$ref": "#/definitions/NxReleaseVersionConfiguration"
+                  },
+                  {
+                    "allOf": [
+                      {
+                        "not": {
+                          "required": ["git"]
+                        }
+                      },
+                      {
+                        "not": {
+                          "required": ["preVersionCommand"]
+                        }
+                      }
+                    ]
+                  }
+                ]
               },
               "changelog": {
                 "oneOf": [
@@ -129,8 +178,7 @@
                     "$ref": "#/definitions/NxReleaseChangelogConfiguration"
                   },
                   {
-                    "type": "boolean",
-                    "enum": [false]
+                    "type": "boolean"
                   }
                 ]
               },
@@ -150,8 +198,7 @@
                   "$ref": "#/definitions/NxReleaseChangelogConfiguration"
                 },
                 {
-                  "type": "boolean",
-                  "enum": [false]
+                  "type": "boolean"
                 }
               ]
             },
@@ -161,13 +208,29 @@
                   "$ref": "#/definitions/NxReleaseChangelogConfiguration"
                 },
                 {
-                  "type": "boolean",
-                  "enum": [false]
+                  "type": "boolean"
                 }
               ]
+            },
+            "automaticFromRef": {
+              "type": "boolean",
+              "description": "Whether or not to automatically look up the first commit for the workspace (or package, if versioning independently) and use that as the starting point for changelog generation. If this is not enabled, changelog generation will fail if there is no previous matching git tag to use as a starting point."
+            },
+            "git": {
+              "$ref": "#/definitions/NxReleaseGitConfiguration"
             }
           }
         },
+        "conventionalCommits": {
+          "$ref": "#/definitions/NxReleaseConventionalCommitsConfiguration"
+        },
+        "projectsRelationship": {
+          "type": "string",
+          "enum": ["fixed", "independent"]
+        },
+        "git": {
+          "$ref": "#/definitions/NxReleaseGitConfiguration"
+        },
         "version": {
           "$ref": "#/definitions/NxReleaseVersionConfiguration"
         },
@@ -207,7 +270,9 @@
                   {
                     "type": "array",
                     "description": "The projects that the targets belong to.",
-                    "items": { "type": "string" }
+                    "items": {
+                      "type": "string"
+                    }
                   }
                 ]
               },
@@ -231,8 +296,12 @@
                 "required": ["input"],
                 "not": {
                   "anyOf": [
-                    { "required": ["projects"] },
-                    { "required": ["dependencies"] }
+                    {
+                      "required": ["projects"]
+                    },
+                    {
+                      "required": ["dependencies"]
+                    }
                   ]
                 }
               }
@@ -264,7 +333,9 @@
             "properties": {
               "externalDependencies": {
                 "type": "array",
-                "items": { "type": "string" },
+                "items": {
+                  "type": "string"
+                },
                 "description": "The list of external dependencies that our target depends on for `nx:run-commands` and community plugins."
               }
             },
@@ -400,6 +471,7 @@
                       {
                         "type": "array",
                         "description": "An array of project names",
+                        "minItems": 1,
                         "items": {
                           "type": "string"
                         }
@@ -431,8 +503,12 @@
                     "required": ["target"],
                     "not": {
                       "anyOf": [
-                        { "required": ["projects"] },
-                        { "required": ["dependencies"] }
+                        {
+                          "required": ["projects"]
+                        },
+                        {
+                          "required": ["dependencies"]
+                        }
                       ]
                     }
                   }
@@ -465,20 +541,79 @@
             "options": {
               "type": "object",
               "description": "The options passed to the plugin when creating nodes and dependencies"
+            },
+            "include": {
+              "type": "array",
+              "description": "File patterns which are included by the plugin",
+              "items": {
+                "type": "string"
+              }
+            },
+            "exclude": {
+              "type": "array",
+              "description": "File patterns which are excluded by the plugin",
+              "items": {
+                "type": "string"
+              }
             }
           }
         }
       ]
     },
+    "NxReleaseGitConfiguration": {
+      "type": "object",
+      "properties": {
+        "commit": {
+          "type": "boolean",
+          "description": "Whether or not to automatically commit the changes made by current command"
+        },
+        "commitMessage": {
+          "type": "string",
+          "description": "Custom git commit message to use when committing the changes made by this command"
+        },
+        "commitArgs": {
+          "type": "string",
+          "description": "Additional arguments (added after the --message argument, which may or may not be customized with --git-commit-message) to pass to the `git commit` command invoked behind the scenes"
+        },
+        "stageChanges": {
+          "type": "boolean",
+          "description": "Whether or not to stage the changes made by this command. Always treated as true if commit is true."
+        },
+        "tag": {
+          "type": "boolean",
+          "description": "Whether or not to automatically tag the changes made by this command"
+        },
+        "tagMessage": {
+          "type": "string",
+          "description": "Custom git tag message to use when tagging the changes made by this command. This defaults to be the same value as the tag itself."
+        },
+        "tagArgs": {
+          "type": "string",
+          "description": "Additional arguments to pass to the `git tag` command invoked behind the scenes"
+        }
+      }
+    },
     "NxReleaseVersionConfiguration": {
       "type": "object",
       "properties": {
+        "conventionalCommits": {
+          "type": "boolean",
+          "description": "Shorthand for enabling the current version of projects to be resolved from git tags, and the next version to be determined by analyzing commit messages according to the Conventional Commits specification.",
+          "default": false
+        },
         "generator": {
           "type": "string"
         },
         "generatorOptions": {
           "type": "object",
           "additionalProperties": true
+        },
+        "git": {
+          "$ref": "#/definitions/NxReleaseGitConfiguration"
+        },
+        "preVersionCommand": {
+          "type": "string",
+          "description": "A command to run after validation of nx release configuration, but before versioning begins. Used for preparing build artifacts. If --dry-run is passed, the command is still executed, but with the NX_DRY_RUN environment variable set to 'true'."
         }
       }
     },
@@ -530,6 +665,55 @@
     "ChangelogRenderOptions": {
       "type": "object",
       "additionalProperties": true
+    },
+    "NxReleaseConventionalCommitsConfiguration": {
+      "type": "object",
+      "properties": {
+        "types": {
+          "type": "object",
+          "description": "A map of commit types to their configuration. If a type is set to 'true', then it will be enabled with the default 'semverBump' of 'patch' and will appear in the changelog. If a type is set to 'false', then it will not trigger a version bump and will be hidden from the changelog.",
+          "additionalProperties": {
+            "oneOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "semverBump": {
+                    "type": "string",
+                    "enum": ["major", "minor", "patch", "none"],
+                    "description": "The semver bump to apply to the version of the project(s) when a commit of this type is included in the release.",
+                    "default": "patch"
+                  },
+                  "changelog": {
+                    "description": "Configuration for the changelog section for commits of this type. If set to 'true', then commits of this type will be included in the changelog with their default title for the type. If set to 'false', then commits of this type will not be included in the changelog.",
+                    "oneOf": [
+                      {
+                        "type": "boolean"
+                      },
+                      {
+                        "type": "object",
+                        "properties": {
+                          "title": {
+                            "type": "string",
+                            "description": "The title of the section in the changelog for commits of this type"
+                          },
+                          "hidden": {
+                            "type": "boolean",
+                            "description": "Whether or not to include commits of this type in the changelog",
+                            "default": false
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        }
+      }
     }
   }
 }

package/schemas/project-schema.json

@@ -127,6 +127,26 @@
       "items": {
         "type": "string"
       }
+    },
+    "release": {
+      "type": "object",
+      "description": "Configuration for the nx release commands.",
+      "properties": {
+        "version": {
+          "type": "object",
+          "description": "Configuration for the nx release version command.",
+          "properties": {
+            "generator": {
+              "type": "string",
+              "description": "The version generator to use. Defaults to @nx/js:release-version."
+            },
+            "generatorOptions": {
+              "type": "object",
+              "description": "Options for the version generator."
+            }
+          }
+        }
+      }
     }
   },
   "definitions": {

package/src/adapter/angular-json.js

@@ -49,19 +49,26 @@ function readAngularJson(angularCliWorkspaceRoot) {
     return toNewFormat((0, fileutils_1.readJsonFile)(path.join(angularCliWorkspaceRoot, 'angular.json'))).projects;
 }
 function toNewFormat(w) {
-    Object.values(w.projects || {}).forEach((projectConfig) => {
+    if (!w.projects) {
+        return w;
+    }
+    for (const name in w.projects ?? {}) {
+        const projectConfig = w.projects[name];
         if (projectConfig.architect) {
             renamePropertyWithStableKeys(projectConfig, 'architect', 'targets');
         }
         if (projectConfig.schematics) {
             renamePropertyWithStableKeys(projectConfig, 'schematics', 'generators');
         }
+        if (!projectConfig.name) {
+            projectConfig.name = name;
+        }
         Object.values(projectConfig.targets || {}).forEach((target) => {
             if (target.builder !== undefined) {
                 renamePropertyWithStableKeys(target, 'builder', 'executor');
             }
         });
-    });
+    }
     if (w.schematics) {
         renamePropertyWithStableKeys(w, 'schematics', 'generators');
     }
@@ -72,23 +79,26 @@ function toNewFormat(w) {
 }
 exports.toNewFormat = toNewFormat;
 function toOldFormat(w) {
-    Object.values(w.projects || {}).forEach((projectConfig) => {
-        if (typeof projectConfig === 'string') {
-            throw new Error("'project.json' files are incompatible with version 1 workspace schemas.");
-        }
-        if (projectConfig.targets) {
-            renamePropertyWithStableKeys(projectConfig, 'targets', 'architect');
-        }
-        if (projectConfig.generators) {
-            renamePropertyWithStableKeys(projectConfig, 'generators', 'schematics');
-        }
-        delete projectConfig.name;
-        Object.values(projectConfig.architect || {}).forEach((target) => {
-            if (target.executor !== undefined) {
-                renamePropertyWithStableKeys(target, 'executor', 'builder');
+    if (w.projects) {
+        for (const name in w.projects) {
+            const projectConfig = w.projects[name];
+            if (typeof projectConfig === 'string') {
+                throw new Error("'project.json' files are incompatible with version 1 workspace schemas.");
             }
-        });
-    });
+            if (projectConfig.targets) {
+                renamePropertyWithStableKeys(projectConfig, 'targets', 'architect');
+            }
+            if (projectConfig.generators) {
+                renamePropertyWithStableKeys(projectConfig, 'generators', 'schematics');
+            }
+            delete projectConfig.name;
+            Object.values(projectConfig.architect || {}).forEach((target) => {
+                if (target.executor !== undefined) {
+                    renamePropertyWithStableKeys(target, 'executor', 'builder');
+                }
+            });
+        }
+    }
     if (w.generators) {
         renamePropertyWithStableKeys(w, 'generators', 'schematics');
     }

package/src/adapter/compat.d.ts

@@ -1,2 +1,2 @@
-export declare const allowedProjectExtensions: readonly ["tags", "implicitDependencies", "configFilePath", "$schema", "generators", "namedInputs", "name", "files", "root", "sourceRoot", "projectType"];
-export declare const allowedWorkspaceExtensions: readonly ["implicitDependencies", "affected", "tasksRunnerOptions", "workspaceLayout", "plugins", "targetDefaults", "files", "generators", "namedInputs", "extends", "cli", "pluginsConfig", "defaultProject", "installation", "release", "nxCloudAccessToken", "nxCloudUrl", "nxCloudEncryptionKey", "parallel", "cacheDirectory", "useDaemonProcess"];
+export declare const allowedProjectExtensions: readonly ["tags", "implicitDependencies", "configFilePath", "$schema", "generators", "namedInputs", "name", "files", "root", "sourceRoot", "projectType", "release", "includedScripts", "metadata"];
+export declare const allowedWorkspaceExtensions: readonly ["implicitDependencies", "affected", "defaultBase", "tasksRunnerOptions", "workspaceLayout", "plugins", "targetDefaults", "files", "generators", "namedInputs", "extends", "cli", "pluginsConfig", "defaultProject", "installation", "release", "nxCloudAccessToken", "nxCloudUrl", "nxCloudEncryptionKey", "parallel", "cacheDirectory", "useDaemonProcess", "useInferencePlugins"];

package/src/adapter/compat.js

@@ -26,6 +26,9 @@ exports.allowedProjectExtensions = [
     'root',
     'sourceRoot',
     'projectType',
+    'release',
+    'includedScripts',
+    'metadata',
 ];
 // If we pass props on the workspace that angular doesn't know about,
 // it throws a warning that users see. We want to pass them still,
@@ -36,6 +39,7 @@ exports.allowedProjectExtensions = [
 exports.allowedWorkspaceExtensions = [
     'implicitDependencies',
     'affected',
+    'defaultBase',
     'tasksRunnerOptions',
     'workspaceLayout',
     'plugins',
@@ -55,6 +59,7 @@ exports.allowedWorkspaceExtensions = [
     'parallel',
     'cacheDirectory',
     'useDaemonProcess',
+    'useInferencePlugins',
 ];
 if (!patched) {
     Module.prototype.require = function () {
@@ -119,7 +124,7 @@ function mockReadJsonWorkspace(readJsonUtils) {
             // readJsonWorkspace actually has AST parsing + more, so we
             // still need to call it rather than just return our file
             return originalReadJsonWorkspace.apply(this, [
-                'angular.json',
+                'angular.json', // path name, doesn't matter
                 {
                     // second arg is a host, only method used is readFile
                     readFile: () => JSON.stringify(workspaceConfiguration),

package/src/adapter/ngcli-adapter.d.ts

@@ -15,6 +15,7 @@ export declare function scheduleTarget(root: string, opts: {
     target: string;
     configuration: string;
     runOptions: any;
+    projects: Record<string, ProjectConfiguration>;
 }, verbose: boolean): Promise<Observable<import('@angular-devkit/architect').BuilderOutput>>;
 type AngularProjectConfiguration = ProjectConfiguration & {
     prefix?: string;
@@ -23,15 +24,26 @@ export declare class NxScopedHost extends virtualFs.ScopedHost<any> {
     private root;
     constructor(root: string);
     read(path: Path): Observable<FileBuffer>;
-    private readMergedWorkspaceConfiguration;
+    protected readMergedWorkspaceConfiguration(): Observable<any>;
     write(path: Path, content: FileBuffer): Observable<void>;
     isFile(path: Path): Observable<boolean>;
     exists(path: Path): Observable<boolean>;
     mergeProjectConfiguration(existing: AngularProjectConfiguration, updated: AngularProjectConfiguration, projectName: string): AngularProjectConfiguration;
     readExistingAngularJson(): Observable<any>;
-    private readJson;
+    protected readJson<T = any>(path: string): Observable<T>;
+}
+/**
+ * Host used by Angular CLI builders. It reads the project configurations from
+ * the project graph to access the expanded targets.
+ */
+export declare class NxScopedHostForBuilders extends NxScopedHost {
+    protected readMergedWorkspaceConfiguration(): Observable<any>;
 }
 export declare function arrayBufferToString(buffer: any): string;
+/**
+ * Host used by Angular CLI schematics. It reads the project configurations from
+ * the project configuration files.
+ */
 export declare class NxScopeHostUsedForWrappedSchematics extends NxScopedHost {
     private readonly host;
     constructor(root: string, host: Tree);
@@ -41,8 +53,8 @@ export declare class NxScopeHostUsedForWrappedSchematics extends NxScopedHost {
     isFile(path: Path): Observable<boolean>;
     list(path: Path): Observable<PathFragment[]>;
 }
-export declare function generate(root: string, opts: GenerateOptions, verbose: boolean): Promise<number>;
-export declare function runMigration(root: string, packageName: string, migrationName: string, isVerbose: boolean): Promise<{
+export declare function generate(root: string, opts: GenerateOptions, projects: Record<string, ProjectConfiguration>, verbose: boolean): Promise<number>;
+export declare function runMigration(root: string, packageName: string, migrationName: string, projects: Record<string, ProjectConfiguration>, isVerbose: boolean): Promise<{
     loggingQueue: string[];
     madeChanges: boolean;
 }>;