Merge branch 'master' into beeman/typos-etc

nrwl · Oct 12, 2023 · c119e4b · c119e4b
2 parents b5748b3 + 6f245be
commit c119e4b
Show file tree

Hide file tree

Showing 371 changed files with 1,805 additions and 20,501 deletions.
diff --git a/docs/generated/devkit/NxJsonConfiguration.md b/docs/generated/devkit/NxJsonConfiguration.md
@@ -29,6 +29,7 @@ Nx.json configuration
 - [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs): Object
 - [npmScope](../../devkit/documents/NxJsonConfiguration#npmscope): string
 - [nxCloudAccessToken](../../devkit/documents/NxJsonConfiguration#nxcloudaccesstoken): string
+- [nxCloudEncryptionKey](../../devkit/documents/NxJsonConfiguration#nxcloudencryptionkey): string
 - [nxCloudUrl](../../devkit/documents/NxJsonConfiguration#nxcloudurl): string
 - [parallel](../../devkit/documents/NxJsonConfiguration#parallel): number
 - [plugins](../../devkit/documents/NxJsonConfiguration#plugins): string[]
@@ -170,6 +171,14 @@ To use a different runner that accepts an access token, define it in [tasksRunne
 
 ---
 
+### nxCloudEncryptionKey
+
+• `Optional` **nxCloudEncryptionKey**: `string`
+
+Specifies the encryption key used to encrypt artifacts data before sending it to nx cloud.
+
+---
+
 ### nxCloudUrl
 
 • `Optional` **nxCloudUrl**: `string`

diff --git a/docs/generated/devkit/ProjectGraphBuilder.md b/docs/generated/devkit/ProjectGraphBuilder.md
@@ -109,10 +109,6 @@ Adds dynamic dependency from source project to target project
 
 Add an explicit dependency from a file in source project to target project
 
-**`Deprecated`**
-
-this method will be removed in v17. Use [addStaticDependency](../../devkit/documents/ProjectGraphBuilder#addstaticdependency) or [addDynamicDependency](../../devkit/documents/ProjectGraphBuilder#adddynamicdependency) instead
-
 #### Parameters
 
 | Name                | Type     |
@@ -125,6 +121,10 @@ this method will be removed in v17. Use [addStaticDependency](../../devkit/docum
 
 `void`
 
+**`Deprecated`**
+
+this method will be removed in v17. Use [addStaticDependency](../../devkit/documents/ProjectGraphBuilder#addstaticdependency) or [addDynamicDependency](../../devkit/documents/ProjectGraphBuilder#adddynamicdependency) instead
+
 ---
 
 ### addExternalNode

diff --git a/docs/generated/devkit/ProjectTargetConfigurator.md b/docs/generated/devkit/ProjectTargetConfigurator.md
@@ -6,10 +6,6 @@
 
 ▸ (`file`): `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
 
-**`Deprecated`**
-
-Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNodes) function instead. This will be removed in Nx 18
-
 ##### Parameters
 
 | Name   | Type     |
@@ -19,3 +15,7 @@ Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNode
 ##### Returns
 
 `Record`<`string`, [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>
+
+**`Deprecated`**
+
+Add targets to the projects in a [CreateNodes](../../devkit/documents/CreateNodes) function instead. This will be removed in Nx 18
diff --git a/docs/generated/devkit/TaskHasher.md b/docs/generated/devkit/TaskHasher.md
@@ -13,10 +13,6 @@
 
 ▸ **hashTask**(`task`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
 
-**`Deprecated`**
-
-use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
-
 #### Parameters
 
 | Name   | Type                                  |
@@ -27,12 +23,12 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
 
 `Promise`<[`Hash`](../../devkit/documents/Hash)\>
 
-▸ **hashTask**(`task`, `taskGraph`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
-
 **`Deprecated`**
 
 use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
 
+▸ **hashTask**(`task`, `taskGraph`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
+
 #### Parameters
 
 | Name        | Type                                            |
@@ -44,6 +40,10 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
 
 `Promise`<[`Hash`](../../devkit/documents/Hash)\>
 
+**`Deprecated`**
+
+use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
+
 ▸ **hashTask**(`task`, `taskGraph`, `env`): `Promise`<[`Hash`](../../devkit/documents/Hash)\>
 
 #### Parameters
@@ -64,10 +64,6 @@ use hashTask(task:Task, taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. T
 
 ▸ **hashTasks**(`tasks`): `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
 
-**`Deprecated`**
-
-use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
-
 #### Parameters
 
 | Name    | Type                                    |
@@ -78,12 +74,12 @@ use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instea
 
 `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
 
-▸ **hashTasks**(`tasks`, `taskGraph`): `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
-
 **`Deprecated`**
 
 use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
 
+▸ **hashTasks**(`tasks`, `taskGraph`): `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
+
 #### Parameters
 
 | Name        | Type                                            |
@@ -95,6 +91,10 @@ use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instea
 
 `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
 
+**`Deprecated`**
+
+use hashTasks(tasks:Task[], taskGraph: TaskGraph, env: NodeJS.ProcessEnv) instead. This will be removed in v18
+
 ▸ **hashTasks**(`tasks`, `taskGraph`, `env`): `Promise`<[`Hash`](../../devkit/documents/Hash)[]\>
 
 #### Parameters

diff --git a/docs/generated/devkit/Workspace.md b/docs/generated/devkit/Workspace.md
@@ -27,6 +27,7 @@ use ProjectsConfigurations or NxJsonConfiguration
 - [namedInputs](../../devkit/documents/Workspace#namedinputs): Object
 - [npmScope](../../devkit/documents/Workspace#npmscope): string
 - [nxCloudAccessToken](../../devkit/documents/Workspace#nxcloudaccesstoken): string
+- [nxCloudEncryptionKey](../../devkit/documents/Workspace#nxcloudencryptionkey): string
 - [nxCloudUrl](../../devkit/documents/Workspace#nxcloudurl): string
 - [parallel](../../devkit/documents/Workspace#parallel): number
 - [plugins](../../devkit/documents/Workspace#plugins): string[]
@@ -214,6 +215,18 @@ To use a different runner that accepts an access token, define it in [tasksRunne
 
 ---
 
+### nxCloudEncryptionKey
+
+• `Optional` **nxCloudEncryptionKey**: `string`
+
+Specifies the encryption key used to encrypt artifacts data before sending it to nx cloud.
+
+#### Inherited from
+
+[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[nxCloudEncryptionKey](../../devkit/documents/NxJsonConfiguration#nxcloudencryptionkey)
+
+---
+
 ### nxCloudUrl
 
 • `Optional` **nxCloudUrl**: `string`

diff --git a/docs/generated/devkit/Workspaces.md b/docs/generated/devkit/Workspaces.md
@@ -32,10 +32,10 @@ This will be removed in v18. Use [readProjectsConfigurationFromProjectGraph](../
 
 ▸ **readWorkspaceConfiguration**(): [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
 
-**`Deprecated`**
-
-Use [readProjectsConfigurationFromProjectGraph](../../devkit/documents/readProjectsConfigurationFromProjectGraph) instead.
-
 #### Returns
 
 [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations) & [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)<`string`[] \| `"*"`\>
+
+**`Deprecated`**
+
+Use [readProjectsConfigurationFromProjectGraph](../../devkit/documents/readProjectsConfigurationFromProjectGraph) instead.
diff --git a/docs/generated/devkit/ensurePackage.md b/docs/generated/devkit/ensurePackage.md
@@ -2,6 +2,21 @@
 
 ▸ **ensurePackage**(`tree`, `pkg`, `requiredVersion`, `options?`): `void`
 
+#### Parameters
+
+| Name                      | Type                                  | Description                                                        |
+| :------------------------ | :------------------------------------ | :----------------------------------------------------------------- |
+| `tree`                    | [`Tree`](../../devkit/documents/Tree) | the file system tree                                               |
+| `pkg`                     | `string`                              | the package to check (e.g. @nx/jest)                               |
+| `requiredVersion`         | `string`                              | the version or semver range to check (e.g. ~1.0.0, >=1.0.0 <2.0.0) |
+| `options?`                | `Object`                              | -                                                                  |
+| `options.dev?`            | `boolean`                             | -                                                                  |
+| `options.throwOnMissing?` | `boolean`                             | -                                                                  |
+
+#### Returns
+
+`void`
+
 **`Deprecated`**
 
 Use the other function signature without a Tree
@@ -18,21 +33,6 @@ This install the @nx/jest@<nxVersion> and return the module
 When running with --dryRun, the function will throw when dependencies are missing.
 Returns null for ESM dependencies. Import them with a dynamic import instead.
 
-#### Parameters
-
-| Name                      | Type                                  | Description                                                        |
-| :------------------------ | :------------------------------------ | :----------------------------------------------------------------- |
-| `tree`                    | [`Tree`](../../devkit/documents/Tree) | the file system tree                                               |
-| `pkg`                     | `string`                              | the package to check (e.g. @nx/jest)                               |
-| `requiredVersion`         | `string`                              | the version or semver range to check (e.g. ~1.0.0, >=1.0.0 <2.0.0) |
-| `options?`                | `Object`                              | -                                                                  |
-| `options.dev?`            | `boolean`                             | -                                                                  |
-| `options.throwOnMissing?` | `boolean`                             | -                                                                  |
-
-#### Returns
-
-`void`
-
 ▸ **ensurePackage**<`T`\>(`pkg`, `version`): `T`
 
 Ensure that dependencies and devDependencies from package.json are installed at the required versions.

diff --git a/docs/generated/devkit/getWorkspacePath.md b/docs/generated/devkit/getWorkspacePath.md
@@ -2,10 +2,6 @@
 
 ▸ **getWorkspacePath**(`tree`): `"angular.json"` \| `"workspace.json"`
 
-**`Deprecated`**
-
-all projects are configured using project.json
-
 #### Parameters
 
 | Name   | Type                                  |
@@ -15,3 +11,7 @@ all projects are configured using project.json
 #### Returns
 
 `"angular.json"` \| `"workspace.json"`
+
+**`Deprecated`**
+
+all projects are configured using project.json
diff --git a/docs/generated/devkit/isStandaloneProject.md b/docs/generated/devkit/isStandaloneProject.md
@@ -4,10 +4,6 @@
 
 Returns if a project has a standalone configuration (project.json).
 
-**`Deprecated`**
-
-non-standalone projects were deprecated
-
 #### Parameters
 
 | Name      | Type                                  | Description          |
@@ -18,3 +14,7 @@ non-standalone projects were deprecated
 #### Returns
 
 `boolean`
+
+**`Deprecated`**
+
+non-standalone projects were deprecated
diff --git a/docs/generated/devkit/readCachedProjectGraph.md b/docs/generated/devkit/readCachedProjectGraph.md
@@ -4,10 +4,10 @@
 
 Synchronously reads the latest cached copy of the workspace's ProjectGraph.
 
-**`Throws`**
-
-if there is no cached ProjectGraph to read from
-
 #### Returns
 
 [`ProjectGraph`](../../devkit/documents/ProjectGraph)
+
+**`Throws`**
+
+if there is no cached ProjectGraph to read from
diff --git a/docs/generated/devkit/readNxJson.md b/docs/generated/devkit/readNxJson.md
@@ -2,14 +2,14 @@
 
 ▸ **readNxJson**(): [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) \| `null`
 
-**`Deprecated`**
-
-You must pass a [Tree](../../devkit/documents/Tree)
-
 #### Returns
 
 [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) \| `null`
 
+**`Deprecated`**
+
+You must pass a [Tree](../../devkit/documents/Tree)
+
 ▸ **readNxJson**(`tree`): [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) \| `null`
 
 Reads nx.json

diff --git a/docs/generated/devkit/readProjectConfiguration.md b/docs/generated/devkit/readProjectConfiguration.md
@@ -4,10 +4,6 @@
 
 Reads a project configuration.
 
-**`Throws`**
-
-If supplied projectName cannot be found
-
 #### Parameters
 
 | Name          | Type                                  | Description                                                             |
@@ -18,3 +14,7 @@ If supplied projectName cannot be found
 #### Returns
 
 [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)
+
+**`Throws`**
+
+If supplied projectName cannot be found
diff --git a/docs/generated/devkit/readWorkspaceConfiguration.md b/docs/generated/devkit/readWorkspaceConfiguration.md
@@ -6,10 +6,6 @@ Read general workspace configuration such as the default project or cli settings
 
 This does _not_ provide projects configuration, use [readProjectConfiguration](../../devkit/documents/readProjectConfiguration) instead.
 
-**`Deprecated`**
-
-use readNxJson
-
 #### Parameters
 
 | Name   | Type                                  |
@@ -19,3 +15,7 @@ use readNxJson
 #### Returns
 
 [`WorkspaceConfiguration`](../../devkit/documents/WorkspaceConfiguration)
+
+**`Deprecated`**
+
+use readNxJson
diff --git a/docs/generated/devkit/updateWorkspaceConfiguration.md b/docs/generated/devkit/updateWorkspaceConfiguration.md
@@ -6,10 +6,6 @@ Update general workspace configuration such as the default project or cli settin
 
 This does _not_ update projects configuration, use [updateProjectConfiguration](../../devkit/documents/updateProjectConfiguration) or [addProjectConfiguration](../../devkit/documents/addProjectConfiguration) instead.
 
-**`Deprecated`**
-
-use updateNxJson
-
 #### Parameters
 
 | Name              | Type                                                                      |
@@ -20,3 +16,7 @@ use updateNxJson
 #### Returns
 
 `void`
+
+**`Deprecated`**
+
+use updateNxJson
diff --git a/docs/generated/devkit/validateDependency.md b/docs/generated/devkit/validateDependency.md
@@ -4,10 +4,6 @@
 
 A function to validate dependencies in a [CreateDependencies](../../devkit/documents/CreateDependencies) function
 
-**`Throws`**
-
-If the dependency is invalid.
-
 #### Parameters
 
 | Name         | Type                                                                            |
@@ -18,3 +14,7 @@ If the dependency is invalid.
 #### Returns
 
 `void`
+
+**`Throws`**
+
+If the dependency is invalid.