diff --git a/docs/shared/features/enforce-module-boundaries.md b/docs/shared/features/enforce-module-boundaries.md index 8e8182db22058..e9142f7864156 100644 --- a/docs/shared/features/enforce-module-boundaries.md +++ b/docs/shared/features/enforce-module-boundaries.md @@ -101,7 +101,7 @@ First, use your project configuration (in `project.json` or `package.json`) to a Next, you should update your root lint configuration: -- If you are using **ESLint** you should look for an existing rule entry in your root `.eslintrc.json` called `"@nx/enforce-module-boundaries"` and you should update the `"depConstraints"`: +- If you are using **ESLint** you should look for an existing rule entry in your root `.eslintrc.json` called `@nx/enforce-module-boundaries` and you should update the `depConstraints`: ```jsonc {% fileName=".eslintrc.json" %} { diff --git a/docs/shared/features/manage-releases.md b/docs/shared/features/manage-releases.md index a736f032cff86..89a1d968d7bc2 100644 --- a/docs/shared/features/manage-releases.md +++ b/docs/shared/features/manage-releases.md @@ -43,7 +43,7 @@ If you are working with a brand new workspace, or one that has never been releas The `nx release` command is highly customizable. You can customize the versioning, changelog, and publishing phases of the release process independently through a mixture of configuration and CLI arguments. -The configuration lives in your `nx.json` file under the `"release"` section. +The configuration lives in your `nx.json` file under the `release` section. ```jsonc {% fileName="nx.json" %} { diff --git a/docs/shared/guides/setup-incremental-builds-angular.md b/docs/shared/guides/setup-incremental-builds-angular.md index b50579ff9def1..aff853c87a6df 100644 --- a/docs/shared/guides/setup-incremental-builds-angular.md +++ b/docs/shared/guides/setup-incremental-builds-angular.md @@ -192,7 +192,7 @@ serve" target executor to `@nx/angular:dev-server` as shown below. ### Add Executor to Target Defaults If you'd like to avoid adding `"dependsOn": ["^build"]` to every application in your workspace that uses one of the -required executors you can add it to the `"targetDefaults"` section of the `nx.json`: +required executors you can add it to the `targetDefaults` section of the `nx.json`: {% tabs %} {% tab label="@nx/angular:application" %} diff --git a/docs/shared/recipes/deployment/node-server-fly-io.md b/docs/shared/recipes/deployment/node-server-fly-io.md index fe21e7414ba9a..da83a947acee6 100644 --- a/docs/shared/recipes/deployment/node-server-fly-io.md +++ b/docs/shared/recipes/deployment/node-server-fly-io.md @@ -72,7 +72,7 @@ That's is! Our server is now deployed for the world to use. You can also automate the deployment by adding a target to your project. In addition, that allows us to leverage the Nx [task pipeline](/concepts/task-pipeline-configuration) to make sure we first run the `build` and then the `deploy`. -By using [Nx run-commands](/recipes/running-tasks/run-commands-executor), you can add a `deploy` target to the project. Go to the project's `project.json` file (under `"targets"`) and add the following: +By using [Nx run-commands](/recipes/running-tasks/run-commands-executor), you can add a `deploy` target to the project. Go to the project's `project.json` file (under `targets`) and add the following: ```json {% fileName="project.json" %} "deploy": { diff --git a/docs/shared/recipes/nx-release/file-based-versioning-version-plans.md b/docs/shared/recipes/nx-release/file-based-versioning-version-plans.md index 2bbe3f85cbb93..52775fe08c33a 100644 --- a/docs/shared/recipes/nx-release/file-based-versioning-version-plans.md +++ b/docs/shared/recipes/nx-release/file-based-versioning-version-plans.md @@ -151,7 +151,7 @@ You can read more about these utilities and why they are needed on their respect Nx release will compare the touched projects to the projects and release groups that are specified in the version plan files in the `.nx/version-plans/` directory. If a version plan file does not exist, the command will print an error message and return a non-zero exit code, which can be used to fail CI builds or other automation. -By default, all files that have changed are considered, but you may not want all files under a project to require a version plan be created for them. For example, you may wish to ignore test only files from consideration from this check. The way you can achieve this is by setting version plans to be a configuration object instead of a boolean, and set the `"ignorePatternsForPlanCheck"` property to an array of glob patterns that should be ignored when checking for version plans. For example: +By default, all files that have changed are considered, but you may not want all files under a project to require a version plan be created for them. For example, you may wish to ignore test only files from consideration from this check. The way you can achieve this is by setting version plans to be a configuration object instead of a boolean, and set the `ignorePatternsForPlanCheck` property to an array of glob patterns that should be ignored when checking for version plans. For example: ```jsonc { diff --git a/docs/shared/recipes/nx-release/publish-custom-dist-directory.md b/docs/shared/recipes/nx-release/publish-custom-dist-directory.md index 388a7c031886c..c3040f39c2086 100644 --- a/docs/shared/recipes/nx-release/publish-custom-dist-directory.md +++ b/docs/shared/recipes/nx-release/publish-custom-dist-directory.md @@ -54,7 +54,7 @@ and the dist package.json file, which will actually be published in the publish } ``` -Note that the version number is not present in the source package.json file. This is because the source package.json file is never updated in the versioning process; its data is instead written to the dist package.json file. To ensure the correct version number is used in the dist package.json file, `"release.version.generatorOptions.currentVersionResolver"` should be set to something other than the default value of `"disk"`. To pick the current version from git tags, set it to `"git-tag"`. To look up the current version from the remote registry, set it to `"registry"`. +Note that the version number is not present in the source package.json file. This is because the source package.json file is never updated in the versioning process; its data is instead written to the dist package.json file. To ensure the correct version number is used in the dist package.json file, `release.version.generatorOptions.currentVersionResolver` should be set to something other than the default value of `"disk"`. To pick the current version from git tags, set it to `"git-tag"`. To look up the current version from the remote registry, set it to `"registry"`. Configure this behavior by adding the following configuration to the `nx.json` file, or the `project.json` file of relevant projects: diff --git a/docs/shared/recipes/storybook/angular-storybook-compodoc.md b/docs/shared/recipes/storybook/angular-storybook-compodoc.md index df6f4e91573b3..74928fa033f32 100644 --- a/docs/shared/recipes/storybook/angular-storybook-compodoc.md +++ b/docs/shared/recipes/storybook/angular-storybook-compodoc.md @@ -144,7 +144,7 @@ In the `options` you will see `"compodoc": false`. Change that to `true`. Storybook has [preconfigured `compodoc`](https://github.com/storybookjs/storybook/blob/next/code/frameworks/angular/src/builders/utils/run-compodoc.ts#L25) to generate a `documentation.json` file at the root of your workspace by default. We want to change that, and keep the documentation file project-specific. Of course, you can change that later, or as you see fit for your use case. But let's keep it project-specific for now. -In your project's `project.json` file (eg. `apps/my-app/project.json`), find the `storybook` and the `build-storybook` targets. Below the `"compodoc"` option, create a new option called `"compodocArgs` which contains the following: `["-e", "json", "-d", "apps/my-app"]`. This means that the `exportFormat` (`-e`) will be `json` and the `output` directory (`-d`) will be `apps/my-app` (change that, of course, to the directory of your project). +In your project's `project.json` file (eg. `apps/my-app/project.json`), find the `storybook` and the `build-storybook` targets. Below the `compodoc` option, create a new option called `"compodocArgs` which contains the following: `["-e", "json", "-d", "apps/my-app"]`. This means that the `exportFormat` (`-e`) will be `json` and the `output` directory (`-d`) will be `apps/my-app` (change that, of course, to the directory of your project). Let's see the result for our `my-app` app `storybook` target, for example (in `apps/my-app/project.json`):