nx 17.0.3 → 17.0.5

package/src/config/nx-json.d.ts

@@ -1,4 +1,4 @@
-import type { ChangelogRenderOptions } from '../../changelog-renderer';
+import type { ChangelogRenderOptions } from '../../release/changelog-renderer';
 import { PackageManager } from '../utils/package-manager';
 import { InputDefinition, TargetConfiguration, TargetDependencyConfig } from './workspace-json-project-json';
 export type ImplicitDependencyEntry<T = '*' | string[]> = {
@@ -7,6 +7,9 @@ export type ImplicitDependencyEntry<T = '*' | string[]> = {
 export interface ImplicitJsonSubsetDependency<T = '*' | string[]> {
     [key: string]: T | ImplicitJsonSubsetDependency<T>;
 }
+/**
+ * @deprecated Use {@link NxJsonConfiguration#defaultBase } instead
+ */
 export interface NxAffectedConfig {
     /**
      * Default based branch used by affected commands.
@@ -31,23 +34,28 @@ interface NxInstallationConfiguration {
      */
     plugins?: Record<string, string>;
 }
-/**
- * **ALPHA**
- */
-interface NxReleaseVersionConfiguration {
+export interface NxReleaseVersionConfiguration {
     generator?: string;
     generatorOptions?: Record<string, unknown>;
+    /**
+     * Enabling support for parsing semver bumps via conventional commits and reading the current version from
+     * git tags is so common that we have a first class shorthand for it, which is false by default.
+     *
+     * Setting this to true is the same as adding the following to version.generatorOptions:
+     * - currentVersionResolver: "git-tag"
+     * - specifierSource: "conventional-commits"
+     *
+     * If the user attempts to mix and match these options with the shorthand, we will provide a helpful error.
+     */
+    conventionalCommits?: boolean;
 }
-/**
- * **ALPHA**
- */
 export interface NxReleaseChangelogConfiguration {
     /**
      * Optionally create a release containing all relevant changes on a supported version control system, it
      * is false by default.
      *
      * NOTE: if createRelease is set on a group of projects, it will cause the default releaseTagPattern of
-     * "{projectName}@v{version}" to be used for those projects, even when versioning everything together.
+     * "{projectName}@{version}" to be used for those projects, even when versioning everything together.
      */
     createRelease?: 'github' | false;
     /**
@@ -77,21 +85,82 @@ export interface NxReleaseChangelogConfiguration {
      * A path to a valid changelog renderer function used to transform commit messages and other metadata into
      * the final changelog (usually in markdown format). Its output can be modified using the optional `renderOptions`.
      *
-     * By default, the renderer is set to "nx/changelog-renderer" which nx provides out of the box.
+     * By default, the renderer is set to "nx/release/changelog-renderer" which nx provides out of the box.
      */
     renderer?: string;
     renderOptions?: ChangelogRenderOptions;
 }
-/**
- * **ALPHA**
- */
+export interface NxReleaseGitConfiguration {
+    /**
+     * Whether or not to automatically commit the changes made by current command
+     */
+    commit?: boolean;
+    /**
+     * Custom git commit message to use when committing the changes made by this command {version} will be dynamically interpolated when performing fixed releases, interpolated tags will be appended to the commit body when performing independent releases.
+     */
+    commitMessage?: string;
+    /**
+     * 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
+     */
+    commitArgs?: string;
+    /**
+     * Whether or not to stage the changes made by this command. Always treated as true if commit is true.
+     */
+    stageChanges?: boolean;
+    /**
+     * Whether or not to automatically tag the changes made by this command
+     */
+    tag?: boolean;
+    /**
+     * 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.
+     */
+    tagMessage?: string;
+    /**
+     * Additional arguments to pass to the `git tag` command invoked behind the scenes
+     */
+    tagArgs?: string;
+}
+export interface NxReleaseConventionalCommitsConfiguration {
+    types?: Record<string, 
+    /**
+     * 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.
+     */
+    {
+        /**
+         * The semver bump to apply when a commit of this type is found.
+         * If set to "none", the commit will be ignored for versioning purposes.
+         */
+        semverBump?: 'patch' | 'minor' | 'major' | 'none';
+        /**
+         * 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.
+         */
+        changelog?: {
+            title?: string;
+            hidden?: boolean;
+        } | boolean;
+    } | boolean>;
+}
 interface NxReleaseConfiguration {
     /**
-     * @note: When no groups are configured at all (the default), all projects in the workspace are treated as
-     * if they were in a release group together.
+     * Shorthand for amending the projects which will be included in the implicit default release group (all projects by default).
+     * @note Only one of `projects` or `groups` can be specified, the cannot be used together.
+     */
+    projects?: string[] | string;
+    /**
+     * @note When no projects or groups are configured at all (the default), all projects in the workspace are treated as
+     * if they were in a release group together with a fixed relationship.
      */
     groups?: Record<string, // group name
     {
+        /**
+         * Whether to version and release projects within the group independently, or together in lock step ("fixed").
+         * If not set on the group, this will be informed by the projectsRelationship config at the top level.
+         */
+        projectsRelationship?: 'fixed' | 'independent';
         /**
          * Required list of one or more projects to include in the release group. Any single project can
          * only be used in a maximum of one release group.
@@ -99,37 +168,92 @@ interface NxReleaseConfiguration {
         projects: string[] | string;
         /**
          * Optionally override version configuration for this group.
+         *
+         * NOTE: git configuration is not supported at the group level, only the root/command level
          */
         version?: NxReleaseVersionConfiguration;
         /**
-         * Optionally override project changelog configuration for this group.
+         * Project changelogs are disabled by default.
+         *
+         * Here you can optionally override project changelog configuration for this group.
+         * Notes about boolean values:
+         *
+         * - true = enable project level changelogs using default configuration
+         * - false = explicitly disable project level changelogs
+         *
+         * NOTE: git configuration is not supported at the group level, only the root/command level
          */
-        changelog?: NxReleaseChangelogConfiguration | false;
+        changelog?: NxReleaseChangelogConfiguration | boolean;
         /**
          * Optionally override the git/release tag pattern to use for this group.
          */
         releaseTagPattern?: string;
     }>;
+    /**
+     * Configures the default value for all groups that don't explicitly state their own projectsRelationship.
+     *
+     * By default, this is set to "fixed" which means all projects in the workspace will be versioned and
+     * released together in lock step.
+     */
+    projectsRelationship?: 'fixed' | 'independent';
     changelog?: {
-        workspaceChangelog?: NxReleaseChangelogConfiguration | false;
-        projectChangelogs?: NxReleaseChangelogConfiguration | false;
+        /**
+         * Enable or override configuration for git operations as part of the changelog subcommand
+         */
+        git?: NxReleaseGitConfiguration;
+        /**
+         * Workspace changelog is enabled by default. Notes about boolean values:
+         *
+         * - true = explicitly enable workspace changelog using default configuration
+         * - false = disable workspace changelog
+         */
+        workspaceChangelog?: NxReleaseChangelogConfiguration | boolean;
+        /**
+         * Project changelogs are disabled by default. Notes about boolean values:
+         *
+         * - true = enable project level changelogs using default configuration
+         * - false = explicitly disable project level changelogs
+         */
+        projectChangelogs?: NxReleaseChangelogConfiguration | boolean;
+        /**
+         * 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.
+         */
+        automaticFromRef?: boolean;
     };
     /**
      * If no version config is provided, we will assume that @nx/js:release-version
      * is the desired generator implementation, allowing for terser config for the common case.
      */
-    version?: NxReleaseVersionConfiguration;
+    version?: NxReleaseVersionConfiguration & {
+        /**
+         * Enable or override configuration for git operations as part of the version subcommand
+         */
+        git?: NxReleaseGitConfiguration;
+        /**
+         * 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'.
+         */
+        preVersionCommand?: string;
+    };
     /**
-     * Optional override the git/release tag pattern to use. This field is the source of truth
-     * for changelog generation and release tagging, as well as for conventional-commits parsing.
+     * Optionally override the git/release tag pattern to use. This field is the source of truth
+     * for changelog generation and release tagging, as well as for conventional commits parsing.
      *
      * It supports interpolating the version as {version} and (if releasing independently or forcing
      * project level version control system releases) the project name as {projectName} within the string.
      *
-     * The default releaseTagPattern for unified releases is: "v{version}"
-     * The default releaseTagPattern for releases at the project level is: "{projectName}@v{version}"
+     * The default releaseTagPattern for fixed/unified releases is: "v{version}"
+     * The default releaseTagPattern for independent releases at the project level is: "{projectName}@{version}"
      */
     releaseTagPattern?: string;
+    /**
+     * Enable and configure automatic git operations as part of the release
+     */
+    git?: NxReleaseGitConfiguration;
+    conventionalCommits?: NxReleaseConventionalCommitsConfiguration;
 }
 /**
  * Nx.json configuration
@@ -158,8 +282,13 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
     targetDefaults?: TargetDefaults;
     /**
      * Default options for `nx affected`
+     * @deprecated use {@link defaultBase} instead. For more information see https://nx.dev/deprecated/affected-config#affected-config
      */
     affected?: NxAffectedConfig;
+    /**
+     * Default value for --base used by `nx affected` and `nx format`.
+     */
+    defaultBase?: string;
     /**
      * Where new apps + libs should be placed
      */
@@ -231,7 +360,7 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
      */
     installation?: NxInstallationConfiguration;
     /**
-     * **ALPHA**: Configuration for `nx release` (versioning and publishing of applications and libraries)
+     * Configuration for `nx release` (versioning and publishing of applications and libraries)
      */
     release?: NxReleaseConfiguration;
     /**
@@ -260,10 +389,16 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
      * Set this to false to disable the daemon.
      */
     useDaemonProcess?: boolean;
+    /**
+     * Set this to false to disable adding inference plugins when generating new projects
+     */
+    useInferencePlugins?: boolean;
 }
 export type PluginConfiguration = string | {
     plugin: string;
     options?: unknown;
+    include?: string[];
+    exclude?: string[];
 };
 export declare function readNxJson(root?: string): NxJsonConfiguration;
 export declare function hasNxJson(root: string): boolean;

package/src/config/project-graph.d.ts

@@ -24,7 +24,7 @@ export interface FileData {
  */
 export type FileDataDependency = string | [target: string, type: DependencyType] | [source: string, target: string, type: DependencyType];
 export declare function fileDataDepTarget(dep: FileDataDependency): string;
-export declare function fileDataDepType(dep: FileDataDependency): DependencyType | "static";
+export declare function fileDataDepType(dep: FileDataDependency): "static" | DependencyType;
 export interface FileMap {
     nonProjectFiles: FileData[];
     projectFileMap: ProjectFileMap;
@@ -111,7 +111,7 @@ export interface ProjectGraphDependency {
 }
 /**
  * Additional information to be used to process a project graph
- * @deprecated The {@link ProjectGraphProcessor} is deprecated. This will be removed in Nx 18.
+ * @deprecated The {@link ProjectGraphProcessor} is deprecated. This will be removed in Nx 19.
  */
 export interface ProjectGraphProcessorContext {
     /**
@@ -132,6 +132,6 @@ export interface ProjectGraphProcessorContext {
 }
 /**
  * A function that produces an updated ProjectGraph
- * @deprecated Use {@link CreateNodes} and {@link CreateDependencies} instead. This will be removed in Nx 18.
+ * @deprecated Use {@link CreateNodes} and {@link CreateDependencies} instead. This will be removed in Nx 19.
  */
 export type ProjectGraphProcessor = (currentGraph: ProjectGraph, context: ProjectGraphProcessorContext) => ProjectGraph | Promise<ProjectGraph>;

package/src/config/workspace-json-project-json.d.ts

@@ -1,4 +1,4 @@
-import type { NxJsonConfiguration } from './nx-json';
+import type { NxJsonConfiguration, NxReleaseVersionConfiguration } from './nx-json';
 /**
  * @deprecated use ProjectsConfigurations or NxJsonConfiguration
  */
@@ -93,6 +93,24 @@ export interface ProjectConfiguration {
      * List of tags used by enforce-module-boundaries / project graph
      */
     tags?: string[];
+    /**
+     * Project specific configuration for `nx release`
+     */
+    release?: {
+        version?: Pick<NxReleaseVersionConfiguration, 'generator' | 'generatorOptions'>;
+    };
+    /**
+     * Metadata about the project
+     */
+    metadata?: ProjectMetadata;
+}
+export interface ProjectMetadata {
+    technologies?: string[];
+    targetGroups?: Record<string, string[]>;
+}
+export interface TargetMetadata {
+    description?: string;
+    technologies?: string[];
 }
 export interface TargetDependencyConfig {
     /**
@@ -180,4 +198,8 @@ export interface TargetConfiguration<T = any> {
      * Determines if Nx is able to cache a given target.
      */
     cache?: boolean;
+    /**
+     * Metadata about the target
+     */
+    metadata?: TargetMetadata;
 }

package/src/config/workspaces.d.ts

@@ -1,7 +1,7 @@
 import type { NxJsonConfiguration } from './nx-json';
 import { ProjectsConfigurations } from './workspace-json-project-json';
 /**
- * @deprecated This will be removed in v18. Use {@link readProjectsConfigurationFromProjectGraph} instead.
+ * @deprecated This will be removed in v19. Use {@link readProjectsConfigurationFromProjectGraph} instead.
  */
 export declare class Workspaces {
     private root;

package/src/config/workspaces.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toProjectName = exports.Workspaces = void 0;
 const path_1 = require("path");
+const project_graph_1 = require("../project-graph/project-graph");
 const nx_json_1 = require("./nx-json");
-const retrieve_workspace_files_1 = require("../project-graph/utils/retrieve-workspace-files");
-// TODO(v18): remove this class
+// TODO(v19): remove this class
 /**
- * @deprecated This will be removed in v18. Use {@link readProjectsConfigurationFromProjectGraph} instead.
+ * @deprecated This will be removed in v19. Use {@link readProjectsConfigurationFromProjectGraph} instead.
  */
 class Workspaces {
     constructor(root) {
@@ -18,9 +18,7 @@ class Workspaces {
     readWorkspaceConfiguration() {
         const nxJson = (0, nx_json_1.readNxJson)(this.root);
         return {
-            version: 2,
-            projects: (0, retrieve_workspace_files_1.retrieveProjectConfigurationsSync)(this.root, nxJson)
-                .projectNodes,
+            ...(0, project_graph_1.readProjectsConfigurationFromProjectGraph)((0, project_graph_1.readCachedProjectGraph)()),
             ...nxJson,
         };
     }