miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): restructure guides into technologies sections (#31288)

Browse Source 
Updates the docs structure, navigation etc to be easier + better suited
for showing Nx technology support beyond just TS.

**Notes:**

- API (`/nx-api`) tab is removed from the navigation (i.e. menu bar),
but pages still remain for now until we update references in `*.md`
files.
- Redirects are set up `/nx-api` to go to their respect new location
e.g. `/technologies` or `/reference/core-api`
- Old URLs still exist in the sitemap for now, but majority of them will
be redirected -- a follow-up PR can remove them.

**Preview:**
https://nx-dev-git-nx-dev-polyglot-docs-restructure-nrwl.vercel.app/docs

---------

Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
This commit is contained in:
Juri Strumpflohner 2025-05-29 20:55:34 +02:00 committed by GitHub
parent d7106f5ede
commit b51676a89a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
265 changed files with 29494 additions and 10819 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitattributes vendored
View File

@ -7,3 +7,5 @@
# These are Windows script files and should use crlf
*.bat text eol=crlf
# Exclude files from Graphite reviews
docs/generated/* linguist-generated=true

27
.gitignore vendored
View File

@ -2,7 +2,6 @@ node_modules
/.idea
/.fleet
/.vscode
/.cursor
dist
/build
/coverage
@ -75,5 +74,27 @@ storybook-static
.cursor/rules/nx-rules.mdc
.github/instructions/nx.instructions.md
.cursor/rules/nx-rules.mdc
.github/instructions/nx.instructions.md
# Added by Claude Task Master
# Logs
logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
dev-debug.log
# Dependency directories
node_modules/
# Environment variables
.env
# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
# OS specific
# Task files
tasks.json
tasks/

2
docs/blog/2021-12-17-mastering-the-project-boundaries-in-nx.md
View File

@ -54,7 +54,7 @@ The `allow` array acts as a whitelist listing the import definitions that should
The `depConstraints` section is the one you will be spending most time fine-tuning. It represents an array of constraints, each consisting of `sourceTag` and `onlyDependOnLibsWithTags` properties. The default configuration has a wildcard `*` set as a value for both of them, meaning that any project can import (depend on) any other project.
> Note, the wildcard only applies to libraries. Applications and E2E applications cannot be imported. It wouldn't make any sense. If you want to combine applications, you should use the [micro-frontends](/recipes/angular/dynamic-module-federation-with-angular) approach with the module federation.
> Note, the wildcard only applies to libraries. Applications and E2E applications cannot be imported. It wouldn't make any sense. If you want to combine applications, you should use the [micro-frontends](/technologies/angular/recipes/dynamic-module-federation-with-angular) approach with the module federation.
The circular dependency chains such as `lib A -> lib B -> lib C -> lib A` are also not allowed. The self circular dependency (when lib imports from a named alias of itself), while not recommended, can be overridden by setting the flag `allowCircularSelfDependency` to true.

2
docs/blog/2022-01-25-new-terminal-output-performance-improvements-in-nx-13-5.md
View File

@ -55,7 +55,7 @@ Thanks [Jason](https://twitter.com/FrozenPandaz) for working on this feature!
### React Native now supports Environment Variables
Whenever you set up React Native support within an Nx workspace, it should now automatically come with the [react-native-config](https://github.com/luggit/react-native-config) package installed. That allows you to have a `.env` file in the React Native app folder which can then be loaded from within your React Native application.
You can find all the details on the [Nx docs](/recipes/react/react-native).
You can find all the details on the [Nx docs](/technologies/react/recipes/react-native).
Thanks [Emily Xiong](https://twitter.com/xiongemily) for implementing this!

4
docs/blog/2022-01-28-set-up-tailwind-css-with-angular-in-an-nx-workspace.md
View File

@ -317,7 +317,7 @@ At this point, if we serve again the application, everything should still be wor
Similar to the previous section we are going to start by creating a new library to add the card component to. The only difference is that this library is going to be buildable.
> If you are not aware of what buildable libraries are or what problem do they intend to solve, please make sure to read [/ci/incremental-builds](/recipes/angular/setup-incremental-builds-angular).
> If you are not aware of what buildable libraries are or what problem do they intend to solve, please make sure to read [/technologies/angular/recipes/setup-incremental-builds-angular](/technologies/angular/recipes/setup-incremental-builds-angular).
Run the following command to generate the library:
@ -420,7 +420,7 @@ And finally, replace the existing markup for the cards in the `apps/app1/src/app
With that in place, we can serve the application and it should be working exactly as before, but our application is still not fully set up to consume the library build output. As it stands right now, when the application that's consuming it is built, the library will be built together with it and its files will be processed as part of the application build pipeline.
To finish the buildable library setup, we can follow the instructions in [/recipes/angular/setup-incremental-builds-angular](/recipes/angular/setup-incremental-builds-angular). We need to install the `@nrwl/web` package, change the application `build` target executor to `@nrwl/angular:webpack-browser`, and change the application `serve` target executor to `@nrwl/web:file-server`:
To finish the buildable library setup, we can follow the instructions in [/technologies/angular/recipes/setup-incremental-builds-angular](/technologies/angular/recipes/setup-incremental-builds-angular). We need to install the `@nrwl/web` package, change the application `build` target executor to `@nrwl/angular:webpack-browser`, and change the application `serve` target executor to `@nrwl/web:file-server`:
```shell
yarn add -D @nrwl/web@latest

2
docs/blog/2022-03-29-the-react-cli-you-always-wanted-but-didnt-know-about.md
View File

@ -152,7 +152,7 @@ Let's have a closer look.
The Nx core team strongly believes in the benefits of TypeScript (in fact, check out the [new Nx and TypeScript setup](/getting-started/intro)). As such, by default every project is automatically set up and configured to use TypeScript, making sure builds, as well as IDEs, are able to properly pick up TypeScript definitions. All without you having to worry about it.
Now, if you really want to use pure JavaScript you totally can. Just pass the `--js` when running a generator. Read [more on the docs](/recipes/tips-n-tricks/js-and-ts).
Now, if you really want to use pure JavaScript you totally can. Just pass the `--js` when running a generator. Read [more on the docs](/technologies/typescript/recipes/js-and-ts).
## ESLint preconfigured!

4
docs/blog/2022-05-02-nx-v14-is-out-here-is-all-you-need-to-know.md
View File

@ -197,14 +197,14 @@ This can be a game-changer when building huge apps. Stay tuned for more content
We recommend this approach if you want to speed up local serve and build times, but you still deploy the application as a whole.
Read more in our docs: [/concepts/module-federation/faster-builds-with-module-federation](/concepts/module-federation/faster-builds-with-module-federation)
Read more in our docs: [/technologies/module-federation/concepts/faster-builds-with-module-federation](/technologies/module-federation/concepts/faster-builds-with-module-federation)
## Micro Frontend Architecture with Nx
As mentioned in the previous section, Nx v14 comes with out-of-the-box for Webpack Module Federation. The Micro Frontend architecture builds on top of that and adds the ability for independent deployability. While Module Federation enables faster builds by vertically slicing your application into smaller ones, the MFE architecture layers _independent deployments_
on top of federation. Teams should only choose MFEs if they want to deploy their host and remotes on different cadences.
Read more in our docs: [/concepts/module-federation/micro-frontend-architecture](/concepts/module-federation/micro-frontend-architecture)
Read more in our docs: [/technologies/module-federation/concepts/micro-frontend-architecture](/technologies/module-federation/concepts/micro-frontend-architecture)
## Dark mode for Project Graph as well as path tracking

4
docs/blog/2022-10-14-whats-new-in-nx-15.md
View File

@ -215,7 +215,7 @@ Cypress v10 also comes with [Component Testing](https://docs.cypress.io/guides/c
npx nx g @nrwl/react:cypress-component-configuration --project=your-projectnpx nx g @nrwl/angular:cypress-component-configuration --project=your-project
```
Read more here: [/recipes/cypress/cypress-component-testing](/recipes/cypress/cypress-component-testing)
Read more here: [/technologies/test-tools/cypress/recipes/cypress-component-testing](/technologies/test-tools/cypress/recipes/cypress-component-testing)
## Angular: Improved Angular CLI Migrations and Standalone Components
@ -223,7 +223,7 @@ We landed generators to support Angular developers in leveraging the new standal
{% tweet url="https://twitter.com/NxDevTools/status/1567513106380894215" /%}
In addition, we improved the migration support for moving projects from the Angular CLI to an Nx workspace. Whether for a single Angular CLI project or to consolidate multiple Angular CLI projects into a single Nx workspace. Please read all about it here: [/recipes/angular/migration/angular](/recipes/angular/migration/angular)
In addition, we improved the migration support for moving projects from the Angular CLI to an Nx workspace. Whether for a single Angular CLI project or to consolidate multiple Angular CLI projects into a single Nx workspace. Please read all about it here: [/technologies/angular/migration/angular](/technologies/angular/migration/angular)
## Easily add Nx to an existing repository

2
docs/blog/2022-12-06-nx-15-3-standalone-projects-vite-task-graph-and-more.md
View File

@ -227,7 +227,7 @@ Check out our docs for all the details on
- [adding Nx to an existing monorepo](/recipes/adopting-nx/adding-to-monorepo)
- [adding Nx to any non-monorepo setup](/recipes/adopting-nx/adding-to-existing-project)
- [migrating your CRA project to Nx](/recipes/adopting-nx/adding-to-existing-project)
- [migrating your Angular CLI app to Nx](/recipes/angular/migration/angular)
- [migrating your Angular CLI app to Nx](/technologies/angular/migration/angular)
Oh..you're wondering why you would want to add Nx to an existing non-monorepo project? Then keep reading 👇

4
docs/blog/2022-12-22-nx-15-4-vite-4-support-a-new-nx-watch-command-and-more.md
View File

@ -38,7 +38,7 @@ We've also spent some effort into making the conversion of existing projects to
- enhanced `vite.config.ts` file configuration
- better DX with detailed messages during conversion
- [better documentation around converting using our generator](/nx-api/vite/generators/configuration)
- [adding a guide to our docs for converting manually](/recipes/vite/configure-vite)
- [adding a guide to our docs for converting manually](/technologies/build-tools/vite/recipes/configure-vite)
You can check out more details about our Vite plugin including how to add Vite and Vitest to your existing Nx workspace by visiting our docs at [nx.dev/nx-api/vite](/nx-api/vite)
@ -96,7 +96,7 @@ Our existing `host` and `remote` Module Federation generators have an added `--s
We've also added a new executor to allow you to serve the host server locally, along with all remote servers from a single command.
Learn more about this new feature [in our docs](/recipes/react/module-federation-with-ssr)!
Learn more about this new feature [in our docs](/technologies/react/recipes/module-federation-with-ssr)!
## Running Multiple Targets in Parallel for Multiple Projects

2
docs/blog/2023-01-10-setting-up-module-federation-with-server-side-rendering-for-angular.md
View File

@ -13,7 +13,7 @@ This technology has enabled a much cleaner approach to Micro Frontend Architectu
Nx offers great out-of-the-box support and developer experience for Module Federation for Angular and React. You can learn more about it from the resources below:
📄 [Module Federation Recipes on Nx](/recipes/module-federation)
📄 [Module Federation Recipes on Nx](/technologies/module-federation/recipes)
📺 [Speed up your Angular serve and build times with Module Federation and Nx](https://www.youtube.com/watch?v=JkcaGzhRjkc)
However, until now, it has only supported Client-Side Rendering (CSR). Essentially it worked only for Single Page Applications (SPAs). While this is still valuable, it is becoming ever more apparent that Server-Side Rendering (SSR) is becoming the de-facto standard for building web applications, due to the multitude of benefits it provides.

2
docs/blog/2023-02-16-nx-15-7-node-support-angular-lts-lockfile-pruning.md
View File

@ -151,7 +151,7 @@ Inspired by our new [Vite setup](/nx-api/vite), which allows for a more modular
![](/blog/images/2023-02-16/emRP2gF7umWc4UE-.avif)
If you want to upgrade but still retain the previous behavior, we introduced an `isolatedConfig` mode that can be set to `false`. More details in our docs: [/recipes/webpack/webpack-config-setup](/recipes/webpack/webpack-config-setup)
If you want to upgrade but still retain the previous behavior, we introduced an `isolatedConfig` mode that can be set to `false`. More details in our docs: [/technologies/build-tools/webpack/recipes/webpack-config-setup](/technologies/build-tools/webpack/recipes/webpack-config-setup)
## How to Update Nx

2
docs/blog/2023-03-08-nx-15-8-rust-hasher-nx-console-for-intellij-deno-node-and-storybook.md
View File

@ -180,7 +180,7 @@ Check out the following video walkthrough on using these features for modularizi
## Storybook
Nx now generates stories using [Component Storybook Format 3 (CSF3)](https://storybook.js.org/blog/storybook-csf3-is-here/). If you are using our `@nrwl/react:storybook-configuration`, `@nrwl/angular:storybook-configuration`, `@nrwl/react:stories` and `@nrwl/angular:stories` generators, you will notice that the stories are now generated in the new format. You can check out our documentation for [Storybook and Angular](/recipes/storybook/overview-angular) or [Storybook and React](/recipes/storybook/overview-react) to see the new syntax.
Nx now generates stories using [Component Storybook Format 3 (CSF3)](https://storybook.js.org/blog/storybook-csf3-is-here/). If you are using our `@nrwl/react:storybook-configuration`, `@nrwl/angular:storybook-configuration`, `@nrwl/react:stories` and `@nrwl/angular:stories` generators, you will notice that the stories are now generated in the new format. You can check out our documentation for [Storybook and Angular](/technologies/test-tools/storybook/recipes/overview-angular) or [Storybook and React](/technologies/test-tools/storybook/recipes/overview-react) to see the new syntax.
As the Storybook doc mentions, CSF3 _reduces boilerplate code and improves ergonomics. This makes stories more concise, faster to write and easier to maintain._

4
docs/blog/2023-05-02-nx-16-is-here.md
View File

@ -81,8 +81,8 @@ Nx has had support for developing Node-based backends for a while. It was a popu
It’s all about **Edge functions** recently (and, well, serverless in general). Especially when developing with Node it is common that you might want to deploy to the Edge or some serverless environment. Therefore, we..
- created a brand new `@nx/netlify` package (currently [in labs](https://github.com/nrwl/nx-labs/tree/main/packages/netlify)) which allows you to set up a brand new project for developing and pushing Netlify functions, or you can add serverless deployment support to an existing project, using the `@nx/netlify:setup-serverless` generator. Check out our in-depth recipe on the topic: [/recipes/node/node-serverless-functions-netlify](/recipes/node/node-serverless-functions-netlify)
- published anew `@nx/aws-lambda` for deploying [Lambda functions](https://aws.amazon.com/lambda/) to AWS. All details in our latest recipe: [/recipes/node/node-aws-lambda](/recipes/node/node-aws-lambda)
- created a brand new `@nx/netlify` package (currently [in labs](https://github.com/nrwl/nx-labs/tree/main/packages/netlify)) which allows you to set up a brand new project for developing and pushing Netlify functions, or you can add serverless deployment support to an existing project, using the `@nx/netlify:setup-serverless` generator. Check out our in-depth recipe on the topic: [/technologies/node/recipes/node-serverless-functions-netlify](/technologies/node/recipes/node-serverless-functions-netlify)
- published anew `@nx/aws-lambda` for deploying [Lambda functions](https://aws.amazon.com/lambda/) to AWS. All details in our latest recipe: [/technologies/node/recipes/node-aws-lambda](/technologies/node/recipes/node-aws-lambda)
- Improved our existing Deno package to add support for serverless deployment to both Deno Deploy as well as Netlify. Such support can be added to an existing app using the `@nx/deno:setup-serverless` generator and providing the `--platform` flag that either point to `deno-deploy` or `netlify`.
## Cypress Feature Testing

2
docs/blog/2023-05-26-determine-your-user-location-with-netlify-edge-functions.md
View File

@ -102,7 +102,7 @@ By following these steps, you've successfully used `@nx/netlify` serverless func
### Wrapping up
Never used Nx before? Learn more about Nx [here](/getting-started/why-nx).
[Official recipe from Nx](/recipes/node/node-serverless-functions-netlify)
[Official recipe from Nx](/technologies/node/recipes/node-serverless-functions-netlify)
[Github example](https://github.com/ndcunningham/nx-netlify-serverless)
### Learn more

2
docs/blog/2023-07-06-nx-16-5-release.md
View File

@ -25,7 +25,7 @@ With this new feature, you can add the `--tag` option to the [`nx affected`](/nx
## NextJS 13 Support
React Server Components and the new NextJS app router are here, and Nx is here to support them. We've added support for the latest versions of Next — complete with generators and executors. We've also made sure that our [`withNx` NextJS plugin](/recipes/next/next-config-setup), which allows you to import from your other projects in your workspace while still working with the NextJS build scripts, works both for workspaces using our executors in an Integrated Monorepo approach, as well as for those using a Package-Based approach that are simply using the `next dev` command directly to start their dev server.
React Server Components and the new NextJS app router are here, and Nx is here to support them. We've added support for the latest versions of Next — complete with generators and executors. We've also made sure that our [`withNx` NextJS plugin](/technologies/react/next/recipes/next-config-setup), which allows you to import from your other projects in your workspace while still working with the NextJS build scripts, works both for workspaces using our executors in an Integrated Monorepo approach, as well as for those using a Package-Based approach that are simply using the `next dev` command directly to start their dev server.
There's also built-in support for the new turbopack builder option via the `--turbo` command, for example: `nx serve webapp --turbo`

4
docs/blog/2023-08-03-storybook-interaction-tests-in-nx.md
View File

@ -25,7 +25,7 @@ You write a story to set up the component's initial state, simulate user behavio
## Setting Up Storybook Interaction Tests on Nx
You can read our detailed guide on how to set up Storybook interaction tests on Nx, here: [/recipes/storybook/storybook-interaction-tests](/recipes/storybook/storybook-interaction-tests).
You can read our detailed guide on how to set up Storybook interaction tests on Nx, here: [/technologies/test-tools/storybook/recipes/storybook-interaction-tests](technologies/test-tools/storybook/recipes/storybook-interaction-tests).
## Writing Interaction Tests in Storybook
@ -63,7 +63,7 @@ Moreover, since Storybook isolates each component, you can ensure that the tests
## Useful Links
- [https://storybook.js.org/docs/react/writing-tests/interaction-testing](https://storybook.js.org/docs/react/writing-tests/interaction-testing)
- [/recipes/storybook/storybook-interaction-tests](/recipes/storybook/storybook-interaction-tests)
- [/technologies/test-tools/storybook/recipes/storybook-interaction-tests](technologies/test-tools/storybook/recipes/storybook-interaction-tests)
## Learn more

6
docs/blog/2023-12-28-highlights-2023.md
View File

@ -252,7 +252,7 @@ Simply put, Module Federation allows a Javascript application running in a brows
This is an exciting development as it allows a paradigm shift in how you can architect, build, and deploy Javascript applications! And this is especially exciting for monorepo fans, as Nx has best-in-class support for module federation that makes a Module Federation approach easy to adopt and simple to understand!
Currently, our `@nx/angular` and `@nx/react` plugins both have generators to [create a "host" application](/recipes/module-federation/create-a-host) that will load and consume federated modules from ["remote" applications](/recipes/module-federation/create-a-remote), which you can also generate using Nx. Then, by running a simple command with Nx, you can serve all applications required for your host application with the command:
Currently, our `@nx/angular` and `@nx/react` plugins both have generators to [create a "host" application](/technologies/module-federation/recipes/create-a-host) that will load and consume federated modules from ["remote" applications](/technologies/module-federation/recipes/create-a-remote), which you can also generate using Nx. Then, by running a simple command with Nx, you can serve all applications required for your host application with the command:
```shell
nx serve host-application --devRemotes=remote-application
@ -260,9 +260,9 @@ nx serve host-application --devRemotes=remote-application
Where in the example above your host application is named "host-application" and a remote application that you want live updates on as you're developing is named "remote-application".
Throughout 2023, we've continued to increase Nx's support and general dev experience around Module Federation, including [adding a generator to federate an existing module](/recipes/module-federation/federate-a-module), improving the local developer experience by improving local webserver performance, and introducing the concept of [Dynamic Module Federation](/recipes/angular/dynamic-module-federation-with-angular#advanced-angular-micro-frontends-with-dynamic-module-federation) which will allow you to dynamically specify the location of your remote applications via a "module-federation.manifest.json" file!
Throughout 2023, we've continued to increase Nx's support and general dev experience around Module Federation, including [adding a generator to federate an existing module](/technologies/module-federation/recipes/federate-a-module), improving the local developer experience by improving local webserver performance, and introducing the concept of [Dynamic Module Federation](/technologies/angular/recipes/dynamic-module-federation-with-angular#advanced-angular-micro-frontends-with-dynamic-module-federation) which will allow you to dynamically specify the location of your remote applications via a "module-federation.manifest.json" file!
At Nx, we're excited about the Module Federation support we offer for our users, and think that it has many interesting applications when paired with Nx's CI capabilities, in particular allowing for [much shorter build times](/concepts/module-federation/faster-builds-with-module-federation) especially for larger Angular applications.
At Nx, we're excited about the Module Federation support we offer for our users, and think that it has many interesting applications when paired with Nx's CI capabilities, in particular allowing for [much shorter build times](/technologies/module-federation/concepts/faster-builds-with-module-federation) especially for larger Angular applications.
## Many OSS repos adopt Nx

2
docs/blog/2024-08-01-nx-19-5-update.md
View File

@ -259,7 +259,7 @@ Fetching @angular/core@18.1.2
NX The migrate command has run successfully.
```
Our `@nx/react` package will now create new React applications using version 18.3, and we now support the new experimental `reactCompiler`. Users can install the [`babel-plugin-react-compiler` package](https://www.npmjs.com/package/babel-plugin-react-compiler) and you can follow [this guide for how to enable it with Nx](/recipes/react/react-compiler#react-compiler-with-nx).
Our `@nx/react` package will now create new React applications using version 18.3, and we now support the new experimental `reactCompiler`. Users can install the [`babel-plugin-react-compiler` package](https://www.npmjs.com/package/babel-plugin-react-compiler) and you can follow [this guide for how to enable it with Nx](/technologies/react/recipes/react-compiler#react-compiler-with-nx).
Note that due to the extent of breaking changes coming with React 19, we will not be providing a automated migration to React 19 via [`nx migrate`](/nx-api/nx/documents/migrate).

6
docs/blog/2024-09-12-next-gen-module-federation-deployments.md
View File

@ -94,7 +94,7 @@ generator now to scaffold out Module Federation projects.
{% callout type="note" title="Generating host applications" %}
If you'd like a more indepth recipe for scaffolding `host` and `remote` generators you can take a look through
our [Module Federation Recipes](/recipes/module-federation).
our [Module Federation Recipes](/technologies/module-federation/recipes).
{% /callout %}
```{% command="npx nx g @nx/react:host apps/shell --remotes=remote1 --bundler=rspack" path="~/myorg" %}
@ -173,7 +173,7 @@ Nx itself has employed this strategy to solve a long-standing issue with shared
the possibility that a shared library would be served from a static remote. This in turn would prevent HMR updates to
the library from being reflected in the locally served application.
You can learn more about the
`NxRuntimeLibraryControlPlugin` [here](/concepts/module-federation/nx-module-federation-technical-overview).
`NxRuntimeLibraryControlPlugin` [here](/technologies/module-federation/concepts/nx-module-federation-technical-overview).
{% /callout %}
## Step 4: Building and Serving
@ -203,7 +203,7 @@ Serving statically means that we can reuse the build artifacts for the `remotes`
that is scalable. Combined with Nx caching, this works well to ensure a great developer experience.
You can learn more about how this works in
our [Nx Module Federation Technical Overview](/concepts/module-federation/nx-module-federation-technical-overview#what-happens-when-you-serve-your-host)
our [Nx Module Federation Technical Overview](/technologies/module-federation/concepts/nx-module-federation-technical-overview#what-happens-when-you-serve-your-host)
document.
{% /callout %}

2
docs/blog/2024-09-20-nx-19-8.md
View File

@ -62,7 +62,7 @@ With Nx 19.8, we've added a [`infer-targets`](/recipes/running-tasks/convert-to-
When creating a new workspace with the command: `npx create-nx-workspace`, those workspaces will now be created with [`eslint`](https://www.npmjs.com/package/eslint) v9, and [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint) v8 - their most recent versions respectively.
Keep in mind as well that ESLint v8 faces end-of-life on October 5th, meaning only [flat config](https://eslint.org/docs/latest/use/configure/migration-guide) is supported moving forward. Nx users should migrate to this new config format using [our flat config generator](/recipes/tips-n-tricks/flat-config#switching-to-eslints-flat-config-format).
Keep in mind as well that ESLint v8 faces end-of-life on October 5th, meaning only [flat config](https://eslint.org/docs/latest/use/configure/migration-guide) is supported moving forward. Nx users should migrate to this new config format using [our flat config generator](/technologies/eslint/recipes/flat-config#switching-to-eslints-flat-config-format).
For more on eslint's flat config, and how to use our generator to get to flat config checkout this video:

2
docs/blog/2024-10-03-nx-20-release.md
View File

@ -65,7 +65,7 @@ npx nx e2e myapp-e2e
In [Nx 19.8](/blog/nx-19-8-update#new-nx-workspaces-created-with-eslint-v9), we highlighted that workspaces will now be created with [`eslint`](https://www.npmjs.com/package/eslint) v9, and [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint) v8.
This not only brings us inline with the latest version of eslint and typescript-eslint, but also that [flat config](https://eslint.org/docs/latest/use/configure/migration-guide) is only supported moving forward. Nx users should migrate to this new config format using [our flat config generator](/recipes/tips-n-tricks/flat-config#switching-to-eslints-flat-config-format).
This not only brings us inline with the latest version of eslint and typescript-eslint, but also that [flat config](https://eslint.org/docs/latest/use/configure/migration-guide) is only supported moving forward. Nx users should migrate to this new config format using [our flat config generator](/technologies/eslint/recipes/flat-config#switching-to-eslints-flat-config-format).
For more on eslint's flat config, and how to use our generator to get to flat config checkout this video:

2
docs/blog/2024-12-22-nx-highlights-2024.md
View File

@ -147,7 +147,7 @@ We also adopted **Module Federation 2.0**, adding runtime plugins and key enhanc
To simplify setup, we launched **@nx/module-federation**, a package that streamlines configuration and management of federated apps in Nx workspaces. Nx's approach to Module Federation has been highlighted by the community and is now featured on [module-federation.io](https://module-federation.io/practice/monorepos/nx-for-module-federation.html).
For more details on how Module Federation works in Nx, check out the [technical overview](/concepts/module-federation/nx-module-federation-technical-overview) or catch one of our [live streams on Rspack and Module Federation](https://www.youtube.com/watch?v=_c4zjYm0pYE).
For more details on how Module Federation works in Nx, check out the [technical overview](/technologies/module-federation/concepts/nx-module-federation-technical-overview) or catch one of our [live streams on Rspack and Module Federation](https://www.youtube.com/watch?v=_c4zjYm0pYE).
### Nx Console

2
docs/blog/2025-01-28-managing-ts-pkgs-in-monorepos.md
View File

@ -663,7 +663,7 @@ npx create-nx-workspace mymonorepo --workspaces
Also check out our docs:
- [TypeScript Project Linking](/concepts/typescript-project-linking)
- [Switching to Workspaces and Project References](/recipes/tips-n-tricks/switch-to-workspaces-project-references)
- [Switching to Workspaces and Project References](/technologies/typescript/recipes/switch-to-workspaces-project-references)
---

2
docs/blog/2025-01-31-over-the-air-updates-with-zephyr.md
View File

@ -7,7 +7,7 @@ cover_image: /blog/images/2025-01-31/cover-image.jpg
description: 'Deploy React Native app updates instantly with Module Federation and Zephyr Cloud, skipping app store review processes.'
---
Module Federation is an exciting and continually evolving technology. The use cases for Module Federation have expanded from [Micro Frontends](/concepts/module-federation/micro-frontend-architecture) and [Faster Builds](/concepts/module-federation/faster-builds-with-module-federation) to also include something that should be extremely interesting for React Native users.
Module Federation is an exciting and continually evolving technology. The use cases for Module Federation have expanded from [Micro Frontends](/technologies/module-federation/concepts/micro-frontend-architecture) and [Faster Builds](/technologies/module-federation/concepts/faster-builds-with-module-federation) to also include something that should be extremely interesting for React Native users.
Thanks to the wonderful work from the [Re.Pack](https://re-pack.dev/) team at [Callstack](https://www.callstack.com/) and [Zephyr Cloud](https://www.zephyr-cloud.io/) now you can provide over-the-air (OTA) updates to your deployed native mobile apps by running a build from your laptop - without having to deal with the difficulties or time-consuming process of deploying a new binary to each of the app stores your application is deployed to.

14
docs/blog/2025-03-07-nx-update-20-5.md
View File

@ -8,13 +8,13 @@ description: Discover the latest in Nx 20.5, featuring TypeScript project refere
youtubeUrl: https://youtu.be/IujhR3-Iidk
---
Time moves fast, and so do Nx releases. Let’s catch up with the latest development on Nx since our [last release post for 20.3](/blog/nx-update-20-3#rfc-for-infinite-tasks).
Time moves fast, and so do Nx releases. Let's catch up with the latest development on Nx since our [last release post for 20.3](/blog/nx-update-20-3#rfc-for-infinite-tasks).
{% toc /%}
## LLM improvements galore
We think that monorepos are the solution to better AI-assisted development, and we’re doing the work to support that. We’ve recently released updates that enhance the LLM experience for both [Copilot](/blog/nx-just-made-your-llm-smarter) and [Cursor](/blog/nx-made-cursor-smarter).
We think that monorepos are the solution to better AI-assisted development, and we're doing the work to support that. We've recently released updates that enhance the LLM experience for both [Copilot](/blog/nx-just-made-your-llm-smarter) and [Cursor](/blog/nx-made-cursor-smarter).
AI-powered coding assistants can edit files, but they're blind to the bigger picture – they don't understand how your entire codebase fits together. Nx changes that. With full visibility into your monorepo's project relationships, dependencies, and ownership, Nx enables your LLM to move beyond local file changes by providing this essential monorepo context.
@ -24,7 +24,7 @@ Take each of these for a spin and then [sign up for our webinar](/blog/are-monor
## TypeScript project references improvements
ICYMI, we announced a [new experience for TypeScript monorepos](/blog/new-nx-experience-for-typescript-monorepos) in January. The new setup is [faster, more efficient in memory use](/blog/new-nx-experience-for-typescript-monorepos#key-highlight-performance), and fixes common issues with TypeScript editor support for large monorepos. Since then, we’ve steadily improved this experience with many performance and quality-of-life improvements.
ICYMI, we announced a [new experience for TypeScript monorepos](/blog/new-nx-experience-for-typescript-monorepos) in January. The new setup is [faster, more efficient in memory use](/blog/new-nx-experience-for-typescript-monorepos#key-highlight-performance), and fixes common issues with TypeScript editor support for large monorepos. Since then, we've steadily improved this experience with many performance and quality-of-life improvements.
One of the significant improvements is that you can now run tasks with a partial match of the project name rather than needing to use the full name every time. Say you have these projects:
@ -60,15 +60,15 @@ Additionally, when running migrations, the terminal will provide links for each
## ESM support for eslint config
`@nx/eslint` now uses ESM for configuration by default. This means that new workspaces will use ESM. Existing workspaces will continue to use CommonJS. We don’t currently have a migration path between CommonJS and ESM because of the possibility to break something in your lint rules. Both CommonJS and ESM will be supported for the near future.
`@nx/eslint` now uses ESM for configuration by default. This means that new workspaces will use ESM. Existing workspaces will continue to use CommonJS. We don't currently have a migration path between CommonJS and ESM because of the possibility to break something in your lint rules. Both CommonJS and ESM will be supported for the near future.
## React 19 support for new workspaces
New Nx workspaces now default to React 19. Note that due to the extent of breaking changes coming with React 19, we will not be providing an automated migration to React 19 via [**`nx migrate`**](/nx-api/nx/documents/migrate). If you’re ready to make this migration on your own, [see our docs about using the new `reactCompiler`](/recipes/react/react-compiler#react-compiler-with-nx)
New Nx workspaces now default to React 19. Note that due to the extent of breaking changes coming with React 19, we will not be providing an automated migration to React 19 via [**`nx migrate`**](/nx-api/nx/documents/migrate). If you're ready to make this migration on your own, [see our docs about using the new `reactCompiler`](/technologies/react/recipes/react-compiler#react-compiler-with-nx)
## Angular 19.2 support
`@nx/angular` now supports up to Angular 19.2 Time to give their new experimental [Resources API](https://angular.dev/guide/signals/resource) a try! If you’re not quite ready to upgrade your version of Angular, remember that you can migrate to the latest Nx while keeping your current version of Angular using the `--interactive` flag during migration. [See our docs for more details](/recipes/tips-n-tricks/advanced-update#choosing-optional-package-updates-to-apply).
`@nx/angular` now supports up to Angular 19.2 Time to give their new experimental [Resources API](https://angular.dev/guide/signals/resource) a try! If you're not quite ready to upgrade your version of Angular, remember that you can migrate to the latest Nx while keeping your current version of Angular using the `--interactive` flag during migration. [See our docs for more details](/recipes/tips-n-tricks/advanced-update#choosing-optional-package-updates-to-apply).
## Vite 6 + Vitest 3 support
@ -76,7 +76,7 @@ New Nx workspaces now default to React 19. Note that due to the extent of breaki
## Update on Infinite Tasks/Continuous Tasks
In our [20.3 release post](/blog/nx-update-20-3#rfc-for-infinite-tasks), we introduced an RFC for “Infinite Tasks” (now called [Continuous Tasks](https://github.com/nrwl/nx/discussions/29025)). Nx will add the concept of **Continuous tasks** which Nx will orchestrate as part of the task graph. This will allow for tasks to depend on other running tasks in addition how it already allows depending on other completed tasks. This will allow for better support of long-running tasks like backend servers for frontend applications that depend on them, or tools that run in a watch mode. We’ve been hard at work implementing this feature, and you can look forward to a beta version before the release of Nx 21.
In our [20.3 release post](/blog/nx-update-20-3#rfc-for-infinite-tasks), we introduced an RFC for "Infinite Tasks" (now called [Continuous Tasks](https://github.com/nrwl/nx/discussions/29025)). Nx will add the concept of **Continuous tasks** which Nx will orchestrate as part of the task graph. This will allow for tasks to depend on other running tasks in addition how it already allows depending on other completed tasks. This will allow for better support of long-running tasks like backend servers for frontend applications that depend on them, or tools that run in a watch mode. We've been hard at work implementing this feature, and you can look forward to a beta version before the release of Nx 21.
## Fixes and improvements

2
docs/blog/2025-03-18-architecting-angular-applications.md
View File

@ -158,7 +158,7 @@ It uses Nx for running and building your project. Nx relies on the Angular Devki
}
```
If you have an existing Angular CLI project, you can also [add Nx support to it](/recipes/angular/migration/angular) by running:
If you have an existing Angular CLI project, you can also [add Nx support to it](/technologies/angular/migration/angular) by running:
```shell
npx nx init

4
docs/blog/2025-03-19-using-angular-with-rspack.md
View File

@ -71,7 +71,7 @@ The steps are very simple:
1. Run `nx migrate latest` to update your workspace to the latest version of Nx.
2. Run `nx g @nx/angular:convert-to-rspack` to migrate your Angular application to Rspack.
There is also a [guide in our documentation](/recipes/angular/rspack/migrate-from-webpack) that walks you through the process step-by-step.
There is also a [guide in our documentation](/technologies/angular/angular-rspack/recipes/migrate-from-webpack) that walks you through the process step-by-step.
Even if you're currently using the Angular CLI, it's as simple as first running `npx nx init` in your workspace and then running `npx nx g convert-to-rspack`.
## Using Angular Rspack
@ -226,7 +226,7 @@ Exciting times ahead! You can follow our progress by starring the [Angular Rspac
## Further Reading
- [Nx Angular Rspack](/recipes/angular/rspack/introduction)
- [Nx Angular Rspack](/technologies/angular/angular-rspack/introduction)
- [Angular](https://angular.dev)
- [Rspack](https://rspack.dev)
- 🧠 [Nx Docs](/getting-started/intro)

8
docs/blog/2025-04-14-scaffold-angular-rspack-applications.md
View File

@ -34,7 +34,7 @@ Docusaurus has even [reported that switching to Rspack has resulted in a 2x-4x f
However, Angular’s Webpack build pipeline proved to be an issue. It had not been possible to use Rspack as a drop-in replacement for Angular applications.
Which is why [Angular Rspack](/recipes/angular/rspack/introduction) was created.
Which is why [Angular Rspack](/technologies/angular/angular-rspack/introduction) was created.
## Angular Rspack
@ -46,7 +46,7 @@ Angular Rspack provides Rspack Plugins and Loaders that makes it possible to bui
You can learn more about Angular Rspack from the resources below:
- [Angular Rspack - Introduction](/recipes/angular/rspack/introduction)
- [Angular Rspack - Introduction](/technologies/angular/angular-rspack/introduction)
- [Using Rspack with Angular](/blog/using-rspack-with-angular)
{% /callout %}
@ -64,7 +64,7 @@ From the benchmark results below, you can see the vast improvement using Angular
You can see that the results from Rspack are comparable to the results provided by Angular’s Esbuild build pipeline.
That said, it is worth noting that there are still currently some [known limitations and missing features](/recipes/angular/rspack/introduction#known-limitations-and-missing-features).
That said, it is worth noting that there are still currently some [known limitations and missing features](/technologies/angular/angular-rspack/introduction#known-limitations-and-missing-features).
## Why Choose Rspack for New Projects?
@ -121,7 +121,7 @@ npx nx g @nx/angular:app myapp --bundler=rspack
### Converting an Existing Angular Webpack Application
If you have an existing Angular Webpack application you can easily migrate it to use Angular Rspack by using the `@nx/angular:convert-to-rspack` generator. The [Migrate Angular with Webpack to Rspack](/recipes/angular/rspack/migrate-from-webpack) guide explains more on this.
If you have an existing Angular Webpack application you can easily migrate it to use Angular Rspack by using the `@nx/angular:convert-to-rspack` generator. The [Migrate Angular with Webpack to Rspack](/technologies/angular/angular-rspack/recipes/migrate-from-webpack) guide explains more on this.
## Future Work

2
docs/blog/2025-05-05-nx-21-release.md
View File

@ -146,7 +146,7 @@ This is another item we're excited to talk about more later this week.
If you're using React Router in declarative or data mode, you can continue using the existing workflows that build your React app.
However, if you're ready to start a new app using the framework mode in React Router or need to migrate a Remix app to React Router, we've got you covered. Our new [inferred task plugin](/recipes/react/react-router) will handle running the React Router CLI based on projects with a React Router config file. If you're migrating from Remix, follow the React Router team's [migration guidance](https://reactrouter.com/upgrading/remix). Once migrated, you can remove the Remix plugin and use the React Router plugin.
However, if you're ready to start a new app using the framework mode in React Router or need to migrate a Remix app to React Router, we've got you covered. Our new [inferred task plugin](/technologies/react/recipes/react-router) will handle running the React Router CLI based on projects with a React Router config file. If you're migrating from Remix, follow the React Router team's [migration guidance](https://reactrouter.com/upgrading/remix). Once migrated, you can remove the Remix plugin and use the React Router plugin.
## Updated release versioning

4
docs/blog/2025-05-08-improved-module-federation.md
View File

@ -133,8 +133,8 @@ With the new [Terminal UI](/recipes/running-tasks/terminal-ui) you can very easi
## Further Reading
- [Module Federation and Nx](/concepts/module-federation/module-federation-and-nx)
- [Nx Module Federation Technical Overview](/concepts/module-federation/nx-module-federation-technical-overview)
- [Module Federation and Nx](/technologies/module-federation/concepts/module-federation-and-nx)
- [Nx Module Federation Technical Overview](/technologies/module-federation/concepts/nx-module-federation-technical-overview)
- 🧠 [**Nx Docs**](/getting-started/intro)
- 👩‍💻 [**Nx GitHub**](https://github.com/nrwl/nx)
- 💬 [**Nx Official Discord Server**](https://go.nx.dev/community)

2
docs/changelog/17_0_0.md
View File

@ -11,7 +11,7 @@ title="Nx 17.0 Has Landed!!!"
{% cards cols="2" %}
{% card title="Official @nx/vue plugin" type="document" url="/nx-api/vue" /%}
{% card title="Module Federation Improvements" type="document" url="/concepts/module-federation/module-federation-and-nx" /%}
{% card title="Module Federation Improvements" type="document" url="/technologies/module-federation/concepts/module-federation-and-nx" /%}
{% card title="Show Task Inputs in the Task Graph Visualizer" type="external" url="https://github.com/nrwl/nx/pull/19597" /%}
{% card title="Move properties from tasksRunnerOptions up to the root of nx.json" type="external" url="https://github.com/nrwl/nx/pull/19243" /%}
{% card title="Each task has its own cache property" type="document" url="/reference/project-configuration#cache" /%}

2
docs/changelog/20_0_0.md
View File

@ -17,7 +17,7 @@ width="100%" /%}
{% cards cols="2" %}
{% card title="Generators use `as-provided`" type="document" url="/deprecated/as-provided-vs-derived" /%}
{% card title="Storybook generators use Storybook Component tests instead of Cypress tests" type="document" url="/recipes/storybook/storybook-interaction-tests" /%}
{% card title="Storybook generators use Storybook Component tests instead of Cypress tests" type="document" url="/technologies/test-tools/storybook/recipes/storybook-interaction-tests" /%}
{% card title="@nrwl/* packages are no longer published" type="document" url="/deprecated/rescope" /%}
{% card title="Nx Release programatic API changes" type="external" url="https://github.com/nrwl/nx/pull/28224" /%}
{% /cards %}

36
docs/generated/devkit/AggregateCreateNodesError.md
View File

@ -13,42 +13,42 @@ It allows Nx to recieve partial results and continue processing for better UX.
### Constructors
- [constructor](../../devkit/documents/AggregateCreateNodesError#constructor)
- [constructor](/reference/core-api/devkit/documents/AggregateCreateNodesError#constructor)
### Properties
- [cause](../../devkit/documents/AggregateCreateNodesError#cause): unknown
- [errors](../../devkit/documents/AggregateCreateNodesError#errors): [file: string, error: Error][]
- [message](../../devkit/documents/AggregateCreateNodesError#message): string
- [name](../../devkit/documents/AggregateCreateNodesError#name): string
- [partialResults](../../devkit/documents/AggregateCreateNodesError#partialresults): CreateNodesResultV2
- [pluginIndex](../../devkit/documents/AggregateCreateNodesError#pluginindex): number
- [stack](../../devkit/documents/AggregateCreateNodesError#stack): string
- [prepareStackTrace](../../devkit/documents/AggregateCreateNodesError#preparestacktrace): Function
- [stackTraceLimit](../../devkit/documents/AggregateCreateNodesError#stacktracelimit): number
- [cause](/reference/core-api/devkit/documents/AggregateCreateNodesError#cause): unknown
- [errors](/reference/core-api/devkit/documents/AggregateCreateNodesError#errors): [file: string, error: Error][]
- [message](/reference/core-api/devkit/documents/AggregateCreateNodesError#message): string
- [name](/reference/core-api/devkit/documents/AggregateCreateNodesError#name): string
- [partialResults](/reference/core-api/devkit/documents/AggregateCreateNodesError#partialresults): CreateNodesResultV2
- [pluginIndex](/reference/core-api/devkit/documents/AggregateCreateNodesError#pluginindex): number
- [stack](/reference/core-api/devkit/documents/AggregateCreateNodesError#stack): string
- [prepareStackTrace](/reference/core-api/devkit/documents/AggregateCreateNodesError#preparestacktrace): Function
- [stackTraceLimit](/reference/core-api/devkit/documents/AggregateCreateNodesError#stacktracelimit): number
### Methods
- [captureStackTrace](../../devkit/documents/AggregateCreateNodesError#capturestacktrace)
- [captureStackTrace](/reference/core-api/devkit/documents/AggregateCreateNodesError#capturestacktrace)
## Constructors
### constructor
• **new AggregateCreateNodesError**(`errors`, `partialResults`): [`AggregateCreateNodesError`](../../devkit/documents/AggregateCreateNodesError)
• **new AggregateCreateNodesError**(`errors`, `partialResults`): [`AggregateCreateNodesError`](/reference/core-api/devkit/documents/AggregateCreateNodesError)
Throwing this error from a `createNodesV2` function will allow Nx to continue processing and recieve partial results from your plugin.
#### Parameters
| Name | Type | Description |
| :--------------- | :------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `errors` | [file: string, error: Error][] | An array of tuples that represent errors encountered when processing a given file. An example entry might look like ['path/to/project.json', [Error: 'Invalid JSON. Unexpected token 'a' in JSON at position 0]] |
| `partialResults` | [`CreateNodesResultV2`](../../devkit/documents/CreateNodesResultV2) | The partial results of the `createNodesV2` function. This should be the results for each file that didn't encounter an issue. |
| Name | Type | Description |
| :--------------- | :-------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `errors` | [file: string, error: Error][] | An array of tuples that represent errors encountered when processing a given file. An example entry might look like ['path/to/project.json', [Error: 'Invalid JSON. Unexpected token 'a' in JSON at position 0]] |
| `partialResults` | [`CreateNodesResultV2`](/reference/core-api/devkit/documents/CreateNodesResultV2) | The partial results of the `createNodesV2` function. This should be the results for each file that didn't encounter an issue. |
#### Returns
[`AggregateCreateNodesError`](../../devkit/documents/AggregateCreateNodesError)
[`AggregateCreateNodesError`](/reference/core-api/devkit/documents/AggregateCreateNodesError)
**`Example`**
@ -119,7 +119,7 @@ Error.name
### partialResults
• `Readonly` **partialResults**: [`CreateNodesResultV2`](../../devkit/documents/CreateNodesResultV2)
• `Readonly` **partialResults**: [`CreateNodesResultV2`](/reference/core-api/devkit/documents/CreateNodesResultV2)
The partial results of the `createNodesV2` function. This should be the results for each file that didn't encounter an issue.

10
docs/generated/devkit/AsyncIteratorExecutor.md
View File

@ -1,6 +1,6 @@
# Type alias: AsyncIteratorExecutor\<T\>
Ƭ **AsyncIteratorExecutor**\<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/ExecutorContext)) => `AsyncIterableIterator`\<\{ `success`: `boolean` }\>
Ƭ **AsyncIteratorExecutor**\<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](/reference/core-api/devkit/documents/ExecutorContext)) => `AsyncIterableIterator`\<\{ `success`: `boolean` }\>
An executor implementation that returns an async iterator
@ -16,10 +16,10 @@ An executor implementation that returns an async iterator
##### Parameters
| Name | Type |
| :-------- | :---------------------------------------------------------- |
| `options` | `T` |
| `context` | [`ExecutorContext`](../../devkit/documents/ExecutorContext) |
| Name | Type |
| :-------- | :------------------------------------------------------------------------ |
| `options` | `T` |
| `context` | [`ExecutorContext`](/reference/core-api/devkit/documents/ExecutorContext) |
##### Returns

4
docs/generated/devkit/ChangeType.md
View File

@ -4,8 +4,8 @@
### Enumeration Members
- [Delete](../../devkit/documents/ChangeType#delete)
- [Insert](../../devkit/documents/ChangeType#insert)
- [Delete](/reference/core-api/devkit/documents/ChangeType#delete)
- [Insert](/reference/core-api/devkit/documents/ChangeType#insert)
## Enumeration Members

18
docs/generated/devkit/CreateDependencies.md
View File

@ -1,9 +1,9 @@
# Type alias: CreateDependencies\<T\>
Ƭ **CreateDependencies**\<`T`\>: (`options`: `T` \| `undefined`, `context`: [`CreateDependenciesContext`](../../devkit/documents/CreateDependenciesContext)) => [`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
Ƭ **CreateDependencies**\<`T`\>: (`options`: `T` \| `undefined`, `context`: [`CreateDependenciesContext`](/reference/core-api/devkit/documents/CreateDependenciesContext)) => [`RawProjectGraphDependency`](/reference/core-api/devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](/reference/core-api/devkit/documents/RawProjectGraphDependency)[]\>
A function which parses files in the workspace to create dependencies in the [ProjectGraph](../../devkit/documents/ProjectGraph)
Use [validateDependency](../../devkit/documents/validateDependency) to validate dependencies
A function which parses files in the workspace to create dependencies in the [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph)
Use [validateDependency](/reference/core-api/devkit/documents/validateDependency) to validate dependencies
#### Type parameters
@ -13,15 +13,15 @@ Use [validateDependency](../../devkit/documents/validateDependency) to validate
#### Type declaration
▸ (`options`, `context`): [`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
▸ (`options`, `context`): [`RawProjectGraphDependency`](/reference/core-api/devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](/reference/core-api/devkit/documents/RawProjectGraphDependency)[]\>
##### Parameters
| Name | Type |
| :-------- | :------------------------------------------------------------------------------ |
| `options` | `T` \| `undefined` |
| `context` | [`CreateDependenciesContext`](../../devkit/documents/CreateDependenciesContext) |
| Name | Type |
| :-------- | :-------------------------------------------------------------------------------------------- |
| `options` | `T` \| `undefined` |
| `context` | [`CreateDependenciesContext`](/reference/core-api/devkit/documents/CreateDependenciesContext) |
##### Returns
[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](../../devkit/documents/RawProjectGraphDependency)[]\>
[`RawProjectGraphDependency`](/reference/core-api/devkit/documents/RawProjectGraphDependency)[] \| `Promise`\<[`RawProjectGraphDependency`](/reference/core-api/devkit/documents/RawProjectGraphDependency)[]\>

24
docs/generated/devkit/CreateDependenciesContext.md
View File

@ -1,23 +1,23 @@
# Interface: CreateDependenciesContext
Context for [CreateDependencies](../../devkit/documents/CreateDependencies)
Context for [CreateDependencies](/reference/core-api/devkit/documents/CreateDependencies)
## Table of contents
### Properties
- [externalNodes](../../devkit/documents/CreateDependenciesContext#externalnodes): Record<string, ProjectGraphExternalNode>
- [fileMap](../../devkit/documents/CreateDependenciesContext#filemap): FileMap
- [filesToProcess](../../devkit/documents/CreateDependenciesContext#filestoprocess): FileMap
- [nxJsonConfiguration](../../devkit/documents/CreateDependenciesContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projects](../../devkit/documents/CreateDependenciesContext#projects): Record<string, ProjectConfiguration>
- [workspaceRoot](../../devkit/documents/CreateDependenciesContext#workspaceroot): string
- [externalNodes](/reference/core-api/devkit/documents/CreateDependenciesContext#externalnodes): Record<string, ProjectGraphExternalNode>
- [fileMap](/reference/core-api/devkit/documents/CreateDependenciesContext#filemap): FileMap
- [filesToProcess](/reference/core-api/devkit/documents/CreateDependenciesContext#filestoprocess): FileMap
- [nxJsonConfiguration](/reference/core-api/devkit/documents/CreateDependenciesContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projects](/reference/core-api/devkit/documents/CreateDependenciesContext#projects): Record<string, ProjectConfiguration>
- [workspaceRoot](/reference/core-api/devkit/documents/CreateDependenciesContext#workspaceroot): string
## Properties
### externalNodes
• `Readonly` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
• `Readonly` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](/reference/core-api/devkit/documents/ProjectGraphExternalNode)\>
The external nodes that have been added to the graph.
@ -25,7 +25,7 @@ The external nodes that have been added to the graph.
### fileMap
• `Readonly` **fileMap**: [`FileMap`](../../devkit/documents/FileMap)
• `Readonly` **fileMap**: [`FileMap`](/reference/core-api/devkit/documents/FileMap)
All files in the workspace
@ -33,7 +33,7 @@ All files in the workspace
### filesToProcess
• `Readonly` **filesToProcess**: [`FileMap`](../../devkit/documents/FileMap)
• `Readonly` **filesToProcess**: [`FileMap`](/reference/core-api/devkit/documents/FileMap)
Files changes since last invocation
@ -41,7 +41,7 @@ Files changes since last invocation
### nxJsonConfiguration
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](/reference/core-api/devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
The `nx.json` configuration from the workspace
@ -49,7 +49,7 @@ The `nx.json` configuration from the workspace
### projects
• `Readonly` **projects**: `Record`\<`string`, [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)\>
• `Readonly` **projects**: `Record`\<`string`, [`ProjectConfiguration`](/reference/core-api/devkit/documents/ProjectConfiguration)\>
The configuration of each project in the workspace keyed by project name.

16
docs/generated/devkit/CreateMetadata.md
View File

@ -1,6 +1,6 @@
# Type alias: CreateMetadata\<T\>
Ƭ **CreateMetadata**\<`T`\>: (`graph`: [`ProjectGraph`](../../devkit/documents/ProjectGraph), `options`: `T` \| `undefined`, `context`: [`CreateMetadataContext`](../../devkit/documents/CreateMetadataContext)) => [`ProjectsMetadata`](../../devkit/documents/ProjectsMetadata) \| `Promise`\<[`ProjectsMetadata`](../../devkit/documents/ProjectsMetadata)\>
Ƭ **CreateMetadata**\<`T`\>: (`graph`: [`ProjectGraph`](/reference/core-api/devkit/documents/ProjectGraph), `options`: `T` \| `undefined`, `context`: [`CreateMetadataContext`](/reference/core-api/devkit/documents/CreateMetadataContext)) => [`ProjectsMetadata`](/reference/core-api/devkit/documents/ProjectsMetadata) \| `Promise`\<[`ProjectsMetadata`](/reference/core-api/devkit/documents/ProjectsMetadata)\>
#### Type parameters
@ -10,16 +10,16 @@
#### Type declaration
▸ (`graph`, `options`, `context`): [`ProjectsMetadata`](../../devkit/documents/ProjectsMetadata) \| `Promise`\<[`ProjectsMetadata`](../../devkit/documents/ProjectsMetadata)\>
▸ (`graph`, `options`, `context`): [`ProjectsMetadata`](/reference/core-api/devkit/documents/ProjectsMetadata) \| `Promise`\<[`ProjectsMetadata`](/reference/core-api/devkit/documents/ProjectsMetadata)\>
##### Parameters
| Name | Type |
| :-------- | :---------------------------------------------------------------------- |
| `graph` | [`ProjectGraph`](../../devkit/documents/ProjectGraph) |
| `options` | `T` \| `undefined` |
| `context` | [`CreateMetadataContext`](../../devkit/documents/CreateMetadataContext) |
| Name | Type |
| :-------- | :------------------------------------------------------------------------------------ |
| `graph` | [`ProjectGraph`](/reference/core-api/devkit/documents/ProjectGraph) |
| `options` | `T` \| `undefined` |
| `context` | [`CreateMetadataContext`](/reference/core-api/devkit/documents/CreateMetadataContext) |
##### Returns
[`ProjectsMetadata`](../../devkit/documents/ProjectsMetadata) \| `Promise`\<[`ProjectsMetadata`](../../devkit/documents/ProjectsMetadata)\>
[`ProjectsMetadata`](/reference/core-api/devkit/documents/ProjectsMetadata) \| `Promise`\<[`ProjectsMetadata`](/reference/core-api/devkit/documents/ProjectsMetadata)\>

8
docs/generated/devkit/CreateMetadataContext.md
View File

@ -4,7 +4,7 @@
#### Type declaration
| Name | Type |
| :-------------------- | :------------------------------------------------------------------ |
| `nxJsonConfiguration` | [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) |
| `workspaceRoot` | `string` |
| Name | Type |
| :-------------------- | :-------------------------------------------------------------------------------- |
| `nxJsonConfiguration` | [`NxJsonConfiguration`](/reference/core-api/devkit/documents/NxJsonConfiguration) |
| `workspaceRoot` | `string` |

4
docs/generated/devkit/CreateNodes.md
View File

@ -2,7 +2,7 @@
Ƭ **CreateNodes**\<`T`\>: readonly [projectFilePattern: string, createNodesFunction: CreateNodesFunction\<T\>]
A pair of file patterns and [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)
A pair of file patterns and [CreateNodesFunction](/reference/core-api/devkit/documents/CreateNodesFunction)
Nx 19.2+: Both original `CreateNodes` and `CreateNodesV2` are supported. Nx will only invoke `CreateNodesV2` if it is present.
Nx 21.X : The `CreateNodesV2` will be the only supported API. This typing will still exist, but be identical to `CreateNodesV2`.
@ -14,7 +14,7 @@ Nx 22.X : The `CreateNodesV2` typing will be removed, as it has replaced `Create
**`Deprecated`**
Use [CreateNodesV2](../../devkit/documents/CreateNodesV2) instead. CreateNodesV2 will replace this API. Read more about the transition above.
Use [CreateNodesV2](/reference/core-api/devkit/documents/CreateNodesV2) instead. CreateNodesV2 will replace this API. Read more about the transition above.
#### Type parameters

16
docs/generated/devkit/CreateNodesContext.md
View File

@ -1,10 +1,10 @@
# Interface: CreateNodesContext
Context for [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)
Context for [CreateNodesFunction](/reference/core-api/devkit/documents/CreateNodesFunction)
## Hierarchy
- [`CreateNodesContextV2`](../../devkit/documents/CreateNodesContextV2)
- [`CreateNodesContextV2`](/reference/core-api/devkit/documents/CreateNodesContextV2)
↳ **`CreateNodesContext`**
@ -12,9 +12,9 @@ Context for [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)
### Properties
- [configFiles](../../devkit/documents/CreateNodesContext#configfiles): readonly string[]
- [nxJsonConfiguration](../../devkit/documents/CreateNodesContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [workspaceRoot](../../devkit/documents/CreateNodesContext#workspaceroot): string
- [configFiles](/reference/core-api/devkit/documents/CreateNodesContext#configfiles): readonly string[]
- [nxJsonConfiguration](/reference/core-api/devkit/documents/CreateNodesContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [workspaceRoot](/reference/core-api/devkit/documents/CreateNodesContext#workspaceroot): string
## Properties
@ -28,11 +28,11 @@ The subset of configuration files which match the createNodes pattern
### nxJsonConfiguration
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](/reference/core-api/devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
#### Inherited from
[CreateNodesContextV2](../../devkit/documents/CreateNodesContextV2).[nxJsonConfiguration](../../devkit/documents/CreateNodesContextV2#nxjsonconfiguration)
[CreateNodesContextV2](/reference/core-api/devkit/documents/CreateNodesContextV2).[nxJsonConfiguration](/reference/core-api/devkit/documents/CreateNodesContextV2#nxjsonconfiguration)
---
@ -42,4 +42,4 @@ The subset of configuration files which match the createNodes pattern
#### Inherited from
[CreateNodesContextV2](../../devkit/documents/CreateNodesContextV2).[workspaceRoot](../../devkit/documents/CreateNodesContextV2#workspaceroot)
[CreateNodesContextV2](/reference/core-api/devkit/documents/CreateNodesContextV2).[workspaceRoot](/reference/core-api/devkit/documents/CreateNodesContextV2#workspaceroot)

8
docs/generated/devkit/CreateNodesContextV2.md
View File

@ -4,20 +4,20 @@
- **`CreateNodesContextV2`**
↳ [`CreateNodesContext`](../../devkit/documents/CreateNodesContext)
↳ [`CreateNodesContext`](/reference/core-api/devkit/documents/CreateNodesContext)
## Table of contents
### Properties
- [nxJsonConfiguration](../../devkit/documents/CreateNodesContextV2#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [workspaceRoot](../../devkit/documents/CreateNodesContextV2#workspaceroot): string
- [nxJsonConfiguration](/reference/core-api/devkit/documents/CreateNodesContextV2#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [workspaceRoot](/reference/core-api/devkit/documents/CreateNodesContextV2#workspaceroot): string
## Properties
### nxJsonConfiguration
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
• `Readonly` **nxJsonConfiguration**: [`NxJsonConfiguration`](/reference/core-api/devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
---

18
docs/generated/devkit/CreateNodesFunction.md
View File

@ -1,9 +1,9 @@
# Type alias: CreateNodesFunction\<T\>
Ƭ **CreateNodesFunction**\<`T`\>: (`projectConfigurationFile`: `string`, `options`: `T` \| `undefined`, `context`: [`CreateNodesContext`](../../devkit/documents/CreateNodesContext)) => [`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
Ƭ **CreateNodesFunction**\<`T`\>: (`projectConfigurationFile`: `string`, `options`: `T` \| `undefined`, `context`: [`CreateNodesContext`](/reference/core-api/devkit/documents/CreateNodesContext)) => [`CreateNodesResult`](/reference/core-api/devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](/reference/core-api/devkit/documents/CreateNodesResult)\>
A function which parses a configuration file into a set of nodes.
Used for creating nodes for the [ProjectGraph](../../devkit/documents/ProjectGraph)
Used for creating nodes for the [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph)
#### Type parameters
@ -13,16 +13,16 @@ Used for creating nodes for the [ProjectGraph](../../devkit/documents/ProjectGra
#### Type declaration
▸ (`projectConfigurationFile`, `options`, `context`): [`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
▸ (`projectConfigurationFile`, `options`, `context`): [`CreateNodesResult`](/reference/core-api/devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](/reference/core-api/devkit/documents/CreateNodesResult)\>
##### Parameters
| Name | Type |
| :------------------------- | :---------------------------------------------------------------- |
| `projectConfigurationFile` | `string` |
| `options` | `T` \| `undefined` |
| `context` | [`CreateNodesContext`](../../devkit/documents/CreateNodesContext) |
| Name | Type |
| :------------------------- | :------------------------------------------------------------------------------ |
| `projectConfigurationFile` | `string` |
| `options` | `T` \| `undefined` |
| `context` | [`CreateNodesContext`](/reference/core-api/devkit/documents/CreateNodesContext) |
##### Returns
[`CreateNodesResult`](../../devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](../../devkit/documents/CreateNodesResult)\>
[`CreateNodesResult`](/reference/core-api/devkit/documents/CreateNodesResult) \| `Promise`\<[`CreateNodesResult`](/reference/core-api/devkit/documents/CreateNodesResult)\>

16
docs/generated/devkit/CreateNodesFunctionV2.md
View File

@ -1,6 +1,6 @@
# Type alias: CreateNodesFunctionV2\<T\>
Ƭ **CreateNodesFunctionV2**\<`T`\>: (`projectConfigurationFiles`: readonly `string`[], `options`: `T` \| `undefined`, `context`: [`CreateNodesContextV2`](../../devkit/documents/CreateNodesContextV2)) => [`CreateNodesResultV2`](../../devkit/documents/CreateNodesResultV2) \| `Promise`\<[`CreateNodesResultV2`](../../devkit/documents/CreateNodesResultV2)\>
Ƭ **CreateNodesFunctionV2**\<`T`\>: (`projectConfigurationFiles`: readonly `string`[], `options`: `T` \| `undefined`, `context`: [`CreateNodesContextV2`](/reference/core-api/devkit/documents/CreateNodesContextV2)) => [`CreateNodesResultV2`](/reference/core-api/devkit/documents/CreateNodesResultV2) \| `Promise`\<[`CreateNodesResultV2`](/reference/core-api/devkit/documents/CreateNodesResultV2)\>
#### Type parameters
@ -10,16 +10,16 @@
#### Type declaration
▸ (`projectConfigurationFiles`, `options`, `context`): [`CreateNodesResultV2`](../../devkit/documents/CreateNodesResultV2) \| `Promise`\<[`CreateNodesResultV2`](../../devkit/documents/CreateNodesResultV2)\>
▸ (`projectConfigurationFiles`, `options`, `context`): [`CreateNodesResultV2`](/reference/core-api/devkit/documents/CreateNodesResultV2) \| `Promise`\<[`CreateNodesResultV2`](/reference/core-api/devkit/documents/CreateNodesResultV2)\>
##### Parameters
| Name | Type |
| :-------------------------- | :-------------------------------------------------------------------- |
| `projectConfigurationFiles` | readonly `string`[] |
| `options` | `T` \| `undefined` |
| `context` | [`CreateNodesContextV2`](../../devkit/documents/CreateNodesContextV2) |
| Name | Type |
| :-------------------------- | :---------------------------------------------------------------------------------- |
| `projectConfigurationFiles` | readonly `string`[] |
| `options` | `T` \| `undefined` |
| `context` | [`CreateNodesContextV2`](/reference/core-api/devkit/documents/CreateNodesContextV2) |
##### Returns
[`CreateNodesResultV2`](../../devkit/documents/CreateNodesResultV2) \| `Promise`\<[`CreateNodesResultV2`](../../devkit/documents/CreateNodesResultV2)\>
[`CreateNodesResultV2`](/reference/core-api/devkit/documents/CreateNodesResultV2) \| `Promise`\<[`CreateNodesResultV2`](/reference/core-api/devkit/documents/CreateNodesResultV2)\>

8
docs/generated/devkit/CreateNodesResult.md
View File

@ -4,14 +4,14 @@
### Properties
- [externalNodes](../../devkit/documents/CreateNodesResult#externalnodes): Record<string, ProjectGraphExternalNode>
- [projects](../../devkit/documents/CreateNodesResult#projects): Record<string, Optional<ProjectConfiguration, "root">>
- [externalNodes](/reference/core-api/devkit/documents/CreateNodesResult#externalnodes): Record<string, ProjectGraphExternalNode>
- [projects](/reference/core-api/devkit/documents/CreateNodesResult#projects): Record<string, Optional<ProjectConfiguration, "root">>
## Properties
### externalNodes
• `Optional` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
• `Optional` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](/reference/core-api/devkit/documents/ProjectGraphExternalNode)\>
A map of external node name -> external node. External nodes do not have a root, so the key is their name.
@ -19,6 +19,6 @@ A map of external node name -> external node. External nodes do not have a root,
### projects
• `Optional` **projects**: `Record`\<`string`, `Optional`\<[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration), `"root"`\>\>
• `Optional` **projects**: `Record`\<`string`, `Optional`\<[`ProjectConfiguration`](/reference/core-api/devkit/documents/ProjectConfiguration), `"root"`\>\>
A map of project root -> project configuration

4
docs/generated/devkit/CreateNodesV2.md
View File

@ -2,8 +2,8 @@
Ƭ **CreateNodesV2**\<`T`\>: readonly [projectFilePattern: string, createNodesFunction: CreateNodesFunctionV2\<T\>]
A pair of file patterns and [CreateNodesFunctionV2](../../devkit/documents/CreateNodesFunctionV2)
In Nx 21 [CreateNodes](../../devkit/documents/CreateNodes) will be replaced with this type. In Nx 22, this type will be removed.
A pair of file patterns and [CreateNodesFunctionV2](/reference/core-api/devkit/documents/CreateNodesFunctionV2)
In Nx 21 [CreateNodes](/reference/core-api/devkit/documents/CreateNodes) will be replaced with this type. In Nx 22, this type will be removed.
#### Type parameters

14
docs/generated/devkit/CustomHasher.md
View File

@ -1,18 +1,18 @@
# Type alias: CustomHasher
Ƭ **CustomHasher**: (`task`: [`Task`](../../devkit/documents/Task), `context`: [`HasherContext`](../../devkit/documents/HasherContext)) => `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
Ƭ **CustomHasher**: (`task`: [`Task`](/reference/core-api/devkit/documents/Task), `context`: [`HasherContext`](/reference/core-api/devkit/documents/HasherContext)) => `Promise`\<[`Hash`](/reference/core-api/devkit/documents/Hash)\>
#### Type declaration
▸ (`task`, `context`): `Promise`\<[`Hash`](../../devkit/documents/Hash)\>
▸ (`task`, `context`): `Promise`\<[`Hash`](/reference/core-api/devkit/documents/Hash)\>
##### Parameters
| Name | Type |
| :-------- | :------------------------------------------------------ |
| `task` | [`Task`](../../devkit/documents/Task) |
| `context` | [`HasherContext`](../../devkit/documents/HasherContext) |
| Name | Type |
| :-------- | :-------------------------------------------------------------------- |
| `task` | [`Task`](/reference/core-api/devkit/documents/Task) |
| `context` | [`HasherContext`](/reference/core-api/devkit/documents/HasherContext) |
##### Returns
`Promise`\<[`Hash`](../../devkit/documents/Hash)\>
`Promise`\<[`Hash`](/reference/core-api/devkit/documents/Hash)\>

24
docs/generated/devkit/DefaultTasksRunnerOptions.md
View File

@ -4,17 +4,17 @@
### Properties
- [batch](../../devkit/documents/DefaultTasksRunnerOptions#batch): boolean
- [cacheDirectory](../../devkit/documents/DefaultTasksRunnerOptions#cachedirectory): string
- [cacheableOperations](../../devkit/documents/DefaultTasksRunnerOptions#cacheableoperations): string[]
- [cacheableTargets](../../devkit/documents/DefaultTasksRunnerOptions#cacheabletargets): string[]
- [captureStderr](../../devkit/documents/DefaultTasksRunnerOptions#capturestderr): boolean
- [lifeCycle](../../devkit/documents/DefaultTasksRunnerOptions#lifecycle): LifeCycle
- [parallel](../../devkit/documents/DefaultTasksRunnerOptions#parallel): number
- [remoteCache](../../devkit/documents/DefaultTasksRunnerOptions#remotecache): RemoteCache
- [runtimeCacheInputs](../../devkit/documents/DefaultTasksRunnerOptions#runtimecacheinputs): string[]
- [skipNxCache](../../devkit/documents/DefaultTasksRunnerOptions#skipnxcache): boolean
- [skipRemoteCache](../../devkit/documents/DefaultTasksRunnerOptions#skipremotecache): boolean
- [batch](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#batch): boolean
- [cacheDirectory](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#cachedirectory): string
- [cacheableOperations](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#cacheableoperations): string[]
- [cacheableTargets](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#cacheabletargets): string[]
- [captureStderr](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#capturestderr): boolean
- [lifeCycle](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#lifecycle): LifeCycle
- [parallel](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#parallel): number
- [remoteCache](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#remotecache): RemoteCache
- [runtimeCacheInputs](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#runtimecacheinputs): string[]
- [skipNxCache](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#skipnxcache): boolean
- [skipRemoteCache](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions#skipremotecache): boolean
## Properties
@ -62,7 +62,7 @@
### remoteCache
• `Optional` **remoteCache**: [`RemoteCache`](../../devkit/documents/RemoteCache)
• `Optional` **remoteCache**: [`RemoteCache`](/reference/core-api/devkit/documents/RemoteCache)
---

6
docs/generated/devkit/DependencyType.md
View File

@ -6,9 +6,9 @@ Type of dependency between projects
### Enumeration Members
- [dynamic](../../devkit/documents/DependencyType#dynamic)
- [implicit](../../devkit/documents/DependencyType#implicit)
- [static](../../devkit/documents/DependencyType#static)
- [dynamic](/reference/core-api/devkit/documents/DependencyType#dynamic)
- [implicit](/reference/core-api/devkit/documents/DependencyType#implicit)
- [static](/reference/core-api/devkit/documents/DependencyType#static)
## Enumeration Members

14
docs/generated/devkit/DynamicDependency.md
View File

@ -2,15 +2,15 @@
Ƭ **DynamicDependency**: `Object`
A dynamic [ProjectGraph](../../devkit/documents/ProjectGraph) dependency between 2 projects
A dynamic [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph) dependency between 2 projects
This type of dependency indicates the source project MAY OR MAY NOT load the target project.
#### Type declaration
| Name | Type | Description |
| :----------- | :---------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------- |
| `source` | `string` | The name of a [ProjectGraphProjectNode](../../devkit/documents/ProjectGraphProjectNode) depending on the target project |
| `sourceFile` | `string` | The path of a file (relative from the workspace root) where the dependency is made |
| `target` | `string` | The name of a [ProjectGraphProjectNode](../../devkit/documents/ProjectGraphProjectNode) that the source project depends on |
| `type` | typeof [`dynamic`](../../devkit/documents/DependencyType#dynamic) | - |
| Name | Type | Description |
| :----------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- |
| `source` | `string` | The name of a [ProjectGraphProjectNode](/reference/core-api/devkit/documents/ProjectGraphProjectNode) depending on the target project |
| `sourceFile` | `string` | The path of a file (relative from the workspace root) where the dependency is made |
| `target` | `string` | The name of a [ProjectGraphProjectNode](/reference/core-api/devkit/documents/ProjectGraphProjectNode) that the source project depends on |
| `type` | typeof [`dynamic`](/reference/core-api/devkit/documents/DependencyType#dynamic) | - |

2
docs/generated/devkit/Executor.md
View File

@ -1,6 +1,6 @@
# Type alias: Executor\<T\>
Ƭ **Executor**\<`T`\>: [`PromiseExecutor`](../../devkit/documents/PromiseExecutor)\<`T`\> \| [`AsyncIteratorExecutor`](../../devkit/documents/AsyncIteratorExecutor)\<`T`\>
Ƭ **Executor**\<`T`\>: [`PromiseExecutor`](/reference/core-api/devkit/documents/PromiseExecutor)\<`T`\> \| [`AsyncIteratorExecutor`](/reference/core-api/devkit/documents/AsyncIteratorExecutor)\<`T`\>
Implementation of a target of a project

32
docs/generated/devkit/ExecutorContext.md
View File

@ -6,17 +6,17 @@ Context that is passed into an executor
### Properties
- [configurationName](../../devkit/documents/ExecutorContext#configurationname): string
- [cwd](../../devkit/documents/ExecutorContext#cwd): string
- [isVerbose](../../devkit/documents/ExecutorContext#isverbose): boolean
- [nxJsonConfiguration](../../devkit/documents/ExecutorContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectGraph](../../devkit/documents/ExecutorContext#projectgraph): ProjectGraph
- [projectName](../../devkit/documents/ExecutorContext#projectname): string
- [projectsConfigurations](../../devkit/documents/ExecutorContext#projectsconfigurations): ProjectsConfigurations
- [root](../../devkit/documents/ExecutorContext#root): string
- [target](../../devkit/documents/ExecutorContext#target): TargetConfiguration<any>
- [targetName](../../devkit/documents/ExecutorContext#targetname): string
- [taskGraph](../../devkit/documents/ExecutorContext#taskgraph): TaskGraph
- [configurationName](/reference/core-api/devkit/documents/ExecutorContext#configurationname): string
- [cwd](/reference/core-api/devkit/documents/ExecutorContext#cwd): string
- [isVerbose](/reference/core-api/devkit/documents/ExecutorContext#isverbose): boolean
- [nxJsonConfiguration](/reference/core-api/devkit/documents/ExecutorContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectGraph](/reference/core-api/devkit/documents/ExecutorContext#projectgraph): ProjectGraph
- [projectName](/reference/core-api/devkit/documents/ExecutorContext#projectname): string
- [projectsConfigurations](/reference/core-api/devkit/documents/ExecutorContext#projectsconfigurations): ProjectsConfigurations
- [root](/reference/core-api/devkit/documents/ExecutorContext#root): string
- [target](/reference/core-api/devkit/documents/ExecutorContext#target): TargetConfiguration<any>
- [targetName](/reference/core-api/devkit/documents/ExecutorContext#targetname): string
- [taskGraph](/reference/core-api/devkit/documents/ExecutorContext#taskgraph): TaskGraph
## Properties
@ -46,7 +46,7 @@ Enable verbose logging
### nxJsonConfiguration
• **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
• **nxJsonConfiguration**: [`NxJsonConfiguration`](/reference/core-api/devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
The contents of nx.json.
@ -54,7 +54,7 @@ The contents of nx.json.
### projectGraph
• **projectGraph**: [`ProjectGraph`](../../devkit/documents/ProjectGraph)
• **projectGraph**: [`ProjectGraph`](/reference/core-api/devkit/documents/ProjectGraph)
A snapshot of the project graph as
it existed when the Nx command was kicked off
@ -71,7 +71,7 @@ The name of the project being executed on
### projectsConfigurations
• **projectsConfigurations**: [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations)
• **projectsConfigurations**: [`ProjectsConfigurations`](/reference/core-api/devkit/documents/ProjectsConfigurations)
Projects config
@ -87,7 +87,7 @@ The root of the workspace
### target
• `Optional` **target**: [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\<`any`\>
• `Optional` **target**: [`TargetConfiguration`](/reference/core-api/devkit/documents/TargetConfiguration)\<`any`\>
The configuration of the target being executed
@ -103,7 +103,7 @@ The name of the target being executed
### taskGraph
• `Optional` **taskGraph**: [`TaskGraph`](../../devkit/documents/TaskGraph)
• `Optional` **taskGraph**: [`TaskGraph`](/reference/core-api/devkit/documents/TaskGraph)
A snapshot of the task graph as
it existed when the Nx command was kicked off

4
docs/generated/devkit/ExecutorsJson.md
View File

@ -4,8 +4,8 @@
### Properties
- [builders](../../devkit/documents/ExecutorsJson#builders): Record<string, ExecutorsJsonEntry>
- [executors](../../devkit/documents/ExecutorsJson#executors): Record<string, ExecutorsJsonEntry>
- [builders](/reference/core-api/devkit/documents/ExecutorsJson#builders): Record<string, ExecutorsJsonEntry>
- [executors](/reference/core-api/devkit/documents/ExecutorsJson#executors): Record<string, ExecutorsJsonEntry>
## Properties

8
docs/generated/devkit/FileChange.md
View File

@ -6,10 +6,10 @@ Description of a file change in the Nx virtual file system/
### Properties
- [content](../../devkit/documents/FileChange#content): Buffer<ArrayBufferLike>
- [options](../../devkit/documents/FileChange#options): TreeWriteOptions
- [path](../../devkit/documents/FileChange#path): string
- [type](../../devkit/documents/FileChange#type): "CREATE" | "DELETE" | "UPDATE"
- [content](/reference/core-api/devkit/documents/FileChange#content): Buffer<ArrayBufferLike>
- [options](/reference/core-api/devkit/documents/FileChange#options): TreeWriteOptions
- [path](/reference/core-api/devkit/documents/FileChange#path): string
- [type](/reference/core-api/devkit/documents/FileChange#type): "CREATE" | "DELETE" | "UPDATE"
## Properties

6
docs/generated/devkit/FileData.md
View File

@ -6,9 +6,9 @@ Some metadata about a file
### Properties
- [deps](../../devkit/documents/FileData#deps): FileDataDependency[]
- [file](../../devkit/documents/FileData#file): string
- [hash](../../devkit/documents/FileData#hash): string
- [deps](/reference/core-api/devkit/documents/FileData#deps): FileDataDependency[]
- [file](/reference/core-api/devkit/documents/FileData#file): string
- [hash](/reference/core-api/devkit/documents/FileData#hash): string
## Properties

8
docs/generated/devkit/FileMap.md
View File

@ -4,17 +4,17 @@
### Properties
- [nonProjectFiles](../../devkit/documents/FileMap#nonprojectfiles): FileData[]
- [projectFileMap](../../devkit/documents/FileMap#projectfilemap): ProjectFileMap
- [nonProjectFiles](/reference/core-api/devkit/documents/FileMap#nonprojectfiles): FileData[]
- [projectFileMap](/reference/core-api/devkit/documents/FileMap#projectfilemap): ProjectFileMap
## Properties
### nonProjectFiles
• **nonProjectFiles**: [`FileData`](../../devkit/documents/FileData)[]
• **nonProjectFiles**: [`FileData`](/reference/core-api/devkit/documents/FileData)[]
---
### projectFileMap
• **projectFileMap**: [`ProjectFileMap`](../../devkit/documents/ProjectFileMap)
• **projectFileMap**: [`ProjectFileMap`](/reference/core-api/devkit/documents/ProjectFileMap)

6
docs/generated/devkit/Generator.md
View File

@ -1,6 +1,6 @@
# Type alias: Generator\<T\>
Ƭ **Generator**\<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
Ƭ **Generator**\<`T`\>: (`tree`: `any`, `schema`: `T`) => `void` \| [`GeneratorCallback`](/reference/core-api/devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](/reference/core-api/devkit/documents/GeneratorCallback)\>
A function that schedules updates to the filesystem to be done atomically
@ -12,7 +12,7 @@ A function that schedules updates to the filesystem to be done atomically
#### Type declaration
▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
▸ (`tree`, `schema`): `void` \| [`GeneratorCallback`](/reference/core-api/devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](/reference/core-api/devkit/documents/GeneratorCallback)\>
##### Parameters
@ -23,4 +23,4 @@ A function that schedules updates to the filesystem to be done atomically
##### Returns
`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](../../devkit/documents/GeneratorCallback)\>
`void` \| [`GeneratorCallback`](/reference/core-api/devkit/documents/GeneratorCallback) \| `Promise`\<`void` \| [`GeneratorCallback`](/reference/core-api/devkit/documents/GeneratorCallback)\>

6
docs/generated/devkit/GeneratorsJson.md
View File

@ -4,9 +4,9 @@
### Properties
- [extends](../../devkit/documents/GeneratorsJson#extends): string
- [generators](../../devkit/documents/GeneratorsJson#generators): Record<string, GeneratorsJsonEntry>
- [schematics](../../devkit/documents/GeneratorsJson#schematics): Record<string, GeneratorsJsonEntry>
- [extends](/reference/core-api/devkit/documents/GeneratorsJson#extends): string
- [generators](/reference/core-api/devkit/documents/GeneratorsJson#generators): Record<string, GeneratorsJsonEntry>
- [schematics](/reference/core-api/devkit/documents/GeneratorsJson#schematics): Record<string, GeneratorsJsonEntry>
## Properties

10
docs/generated/devkit/GraphJson.md
View File

@ -6,15 +6,15 @@ The data type that `nx graph --file graph.json` or `nx build --graph graph.json`
### Properties
- [graph](../../devkit/documents/GraphJson#graph): ProjectGraph
- [taskPlans](../../devkit/documents/GraphJson#taskplans): Record<string, string[]>
- [tasks](../../devkit/documents/GraphJson#tasks): TaskGraph
- [graph](/reference/core-api/devkit/documents/GraphJson#graph): ProjectGraph
- [taskPlans](/reference/core-api/devkit/documents/GraphJson#taskplans): Record<string, string[]>
- [tasks](/reference/core-api/devkit/documents/GraphJson#tasks): TaskGraph
## Properties
### graph
• **graph**: [`ProjectGraph`](../../devkit/documents/ProjectGraph)
• **graph**: [`ProjectGraph`](/reference/core-api/devkit/documents/ProjectGraph)
The project graph
@ -30,6 +30,6 @@ The plans for hashing a task in the task graph
### tasks
• `Optional` **tasks**: [`TaskGraph`](../../devkit/documents/TaskGraph)
• `Optional` **tasks**: [`TaskGraph`](/reference/core-api/devkit/documents/TaskGraph)
A graph of tasks populated with `nx build --graph`

4
docs/generated/devkit/Hash.md
View File

@ -6,8 +6,8 @@ A data structure returned by the default hasher.
### Properties
- [details](../../devkit/documents/Hash#details): Object
- [value](../../devkit/documents/Hash#value): string
- [details](/reference/core-api/devkit/documents/Hash#details): Object
- [value](/reference/core-api/devkit/documents/Hash#value): string
## Properties

2
docs/generated/devkit/Hasher.md
View File

@ -1,3 +1,3 @@
# Type alias: Hasher
Ƭ **Hasher**: [`TaskHasher`](../../devkit/documents/TaskHasher)
Ƭ **Hasher**: [`TaskHasher`](/reference/core-api/devkit/documents/TaskHasher)

20
docs/generated/devkit/HasherContext.md
View File

@ -4,38 +4,38 @@
### Properties
- [hasher](../../devkit/documents/HasherContext#hasher): TaskHasher
- [nxJsonConfiguration](../../devkit/documents/HasherContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectGraph](../../devkit/documents/HasherContext#projectgraph): ProjectGraph
- [projectsConfigurations](../../devkit/documents/HasherContext#projectsconfigurations): ProjectsConfigurations
- [taskGraph](../../devkit/documents/HasherContext#taskgraph): TaskGraph
- [hasher](/reference/core-api/devkit/documents/HasherContext#hasher): TaskHasher
- [nxJsonConfiguration](/reference/core-api/devkit/documents/HasherContext#nxjsonconfiguration): NxJsonConfiguration<string[] | "\*">
- [projectGraph](/reference/core-api/devkit/documents/HasherContext#projectgraph): ProjectGraph
- [projectsConfigurations](/reference/core-api/devkit/documents/HasherContext#projectsconfigurations): ProjectsConfigurations
- [taskGraph](/reference/core-api/devkit/documents/HasherContext#taskgraph): TaskGraph
## Properties
### hasher
• **hasher**: [`TaskHasher`](../../devkit/documents/TaskHasher)
• **hasher**: [`TaskHasher`](/reference/core-api/devkit/documents/TaskHasher)
---
### nxJsonConfiguration
• **nxJsonConfiguration**: [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
• **nxJsonConfiguration**: [`NxJsonConfiguration`](/reference/core-api/devkit/documents/NxJsonConfiguration)\<`string`[] \| `"*"`\>
---
### projectGraph
• **projectGraph**: [`ProjectGraph`](../../devkit/documents/ProjectGraph)
• **projectGraph**: [`ProjectGraph`](/reference/core-api/devkit/documents/ProjectGraph)
---
### projectsConfigurations
• **projectsConfigurations**: [`ProjectsConfigurations`](../../devkit/documents/ProjectsConfigurations)
• **projectsConfigurations**: [`ProjectsConfigurations`](/reference/core-api/devkit/documents/ProjectsConfigurations)
---
### taskGraph
• **taskGraph**: [`TaskGraph`](../../devkit/documents/TaskGraph)
• **taskGraph**: [`TaskGraph`](/reference/core-api/devkit/documents/TaskGraph)

12
docs/generated/devkit/ImplicitDependency.md
View File

@ -2,14 +2,14 @@
Ƭ **ImplicitDependency**: `Object`
An implicit [ProjectGraph](../../devkit/documents/ProjectGraph) dependency between 2 projects
An implicit [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph) dependency between 2 projects
This type of dependency indicates a connection without an explicit reference in code
#### Type declaration
| Name | Type | Description |
| :------- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------- |
| `source` | `string` | The name of a [ProjectGraphProjectNode](../../devkit/documents/ProjectGraphProjectNode) depending on the target project |
| `target` | `string` | The name of a [ProjectGraphProjectNode](../../devkit/documents/ProjectGraphProjectNode) that the source project depends on |
| `type` | typeof [`implicit`](../../devkit/documents/DependencyType#implicit) | - |
| Name | Type | Description |
| :------- | :-------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
| `source` | `string` | The name of a [ProjectGraphProjectNode](/reference/core-api/devkit/documents/ProjectGraphProjectNode) depending on the target project |
| `target` | `string` | The name of a [ProjectGraphProjectNode](/reference/core-api/devkit/documents/ProjectGraphProjectNode) that the source project depends on |
| `type` | typeof [`implicit`](/reference/core-api/devkit/documents/DependencyType#implicit) | - |

2
docs/generated/devkit/ImplicitDependencyEntry.md
View File

@ -10,4 +10,4 @@
#### Index signature
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/ImplicitJsonSubsetDependency)\<`T`\>
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](/reference/core-api/devkit/documents/ImplicitJsonSubsetDependency)\<`T`\>

2
docs/generated/devkit/ImplicitJsonSubsetDependency.md
View File

@ -8,4 +8,4 @@
## Indexable
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](../../devkit/documents/ImplicitJsonSubsetDependency)\<`T`\>
▪ [key: `string`]: `T` \| [`ImplicitJsonSubsetDependency`](/reference/core-api/devkit/documents/ImplicitJsonSubsetDependency)\<`T`\>

8
docs/generated/devkit/JsonParseOptions.md
View File

@ -10,10 +10,10 @@
### Properties
- [allowEmptyContent](../../devkit/documents/JsonParseOptions#allowemptycontent): boolean
- [allowTrailingComma](../../devkit/documents/JsonParseOptions#allowtrailingcomma): boolean
- [disallowComments](../../devkit/documents/JsonParseOptions#disallowcomments): boolean
- [expectComments](../../devkit/documents/JsonParseOptions#expectcomments): boolean
- [allowEmptyContent](/reference/core-api/devkit/documents/JsonParseOptions#allowemptycontent): boolean
- [allowTrailingComma](/reference/core-api/devkit/documents/JsonParseOptions#allowtrailingcomma): boolean
- [disallowComments](/reference/core-api/devkit/documents/JsonParseOptions#disallowcomments): boolean
- [expectComments](/reference/core-api/devkit/documents/JsonParseOptions#expectcomments): boolean
## Properties

2
docs/generated/devkit/JsonSerializeOptions.md
View File

@ -4,7 +4,7 @@
### Properties
- [spaces](../../devkit/documents/JsonSerializeOptions#spaces): number
- [spaces](/reference/core-api/devkit/documents/JsonSerializeOptions#spaces): number
## Properties

8
docs/generated/devkit/Migration.md
View File

@ -1,6 +1,6 @@
# Type alias: Migration
Ƭ **Migration**: (`tree`: [`Tree`](../../devkit/documents/Tree)) => `void` \| `Promise`\<`void`\> \| `string`[] \| `Promise`\<`string`[]\>
Ƭ **Migration**: (`tree`: [`Tree`](/reference/core-api/devkit/documents/Tree)) => `void` \| `Promise`\<`void`\> \| `string`[] \| `Promise`\<`string`[]\>
Represents a migration that is executed when running `nx migrate`.
@ -13,9 +13,9 @@ a list of next steps to be displayed to the user.
##### Parameters
| Name | Type |
| :----- | :------------------------------------ |
| `tree` | [`Tree`](../../devkit/documents/Tree) |
| Name | Type |
| :----- | :-------------------------------------------------- |
| `tree` | [`Tree`](/reference/core-api/devkit/documents/Tree) |
##### Returns

12
docs/generated/devkit/MigrationsJson.md
View File

@ -4,12 +4,12 @@
### Properties
- [collection](../../devkit/documents/MigrationsJson#collection): string
- [generators](../../devkit/documents/MigrationsJson#generators): Object
- [name](../../devkit/documents/MigrationsJson#name): string
- [packageJsonUpdates](../../devkit/documents/MigrationsJson#packagejsonupdates): PackageJsonUpdates
- [schematics](../../devkit/documents/MigrationsJson#schematics): Object
- [version](../../devkit/documents/MigrationsJson#version): string
- [collection](/reference/core-api/devkit/documents/MigrationsJson#collection): string
- [generators](/reference/core-api/devkit/documents/MigrationsJson#generators): Object
- [name](/reference/core-api/devkit/documents/MigrationsJson#name): string
- [packageJsonUpdates](/reference/core-api/devkit/documents/MigrationsJson#packagejsonupdates): PackageJsonUpdates
- [schematics](/reference/core-api/devkit/documents/MigrationsJson#schematics): Object
- [version](/reference/core-api/devkit/documents/MigrationsJson#version): string
## Properties

4
docs/generated/devkit/NxAffectedConfig.md
View File

@ -2,13 +2,13 @@
**`Deprecated`**
Use [NxJsonConfiguration#defaultBase](../../devkit/documents/NxJsonConfiguration#defaultbase) instead
Use [NxJsonConfiguration#defaultBase](/reference/core-api/devkit/documents/NxJsonConfiguration#defaultbase) instead
## Table of contents
### Properties
- [defaultBase](../../devkit/documents/NxAffectedConfig#defaultbase): string
- [defaultBase](/reference/core-api/devkit/documents/NxAffectedConfig#defaultbase): string
## Properties

82
docs/generated/devkit/NxJsonConfiguration.md
View File

@ -12,40 +12,40 @@ Nx.json configuration
- **`NxJsonConfiguration`**
↳ [`Workspace`](../../devkit/documents/Workspace)
↳ [`Workspace`](/reference/core-api/devkit/documents/Workspace)
## Table of contents
### Properties
- [$schema](../../devkit/documents/NxJsonConfiguration#$schema): string
- [affected](../../devkit/documents/NxJsonConfiguration#affected): NxAffectedConfig
- [cacheDirectory](../../devkit/documents/NxJsonConfiguration#cachedirectory): string
- [cli](../../devkit/documents/NxJsonConfiguration#cli): Object
- [defaultBase](../../devkit/documents/NxJsonConfiguration#defaultbase): string
- [defaultProject](../../devkit/documents/NxJsonConfiguration#defaultproject): string
- [extends](../../devkit/documents/NxJsonConfiguration#extends): string
- [generators](../../devkit/documents/NxJsonConfiguration#generators): Object
- [implicitDependencies](../../devkit/documents/NxJsonConfiguration#implicitdependencies): ImplicitDependencyEntry<T>
- [installation](../../devkit/documents/NxJsonConfiguration#installation): NxInstallationConfiguration
- [maxCacheSize](../../devkit/documents/NxJsonConfiguration#maxcachesize): string
- [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs): Object
- [neverConnectToCloud](../../devkit/documents/NxJsonConfiguration#neverconnecttocloud): boolean
- [nxCloudAccessToken](../../devkit/documents/NxJsonConfiguration#nxcloudaccesstoken): string
- [nxCloudEncryptionKey](../../devkit/documents/NxJsonConfiguration#nxcloudencryptionkey): string
- [nxCloudId](../../devkit/documents/NxJsonConfiguration#nxcloudid): string
- [nxCloudUrl](../../devkit/documents/NxJsonConfiguration#nxcloudurl): string
- [parallel](../../devkit/documents/NxJsonConfiguration#parallel): number
- [plugins](../../devkit/documents/NxJsonConfiguration#plugins): PluginConfiguration[]
- [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig): Record<string, Record<string, unknown>>
- [release](../../devkit/documents/NxJsonConfiguration#release): NxReleaseConfiguration
- [sync](../../devkit/documents/NxJsonConfiguration#sync): NxSyncConfiguration
- [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults): TargetDefaults
- [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
- [tui](../../devkit/documents/NxJsonConfiguration#tui): Object
- [useDaemonProcess](../../devkit/documents/NxJsonConfiguration#usedaemonprocess): boolean
- [useInferencePlugins](../../devkit/documents/NxJsonConfiguration#useinferenceplugins): boolean
- [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout): Object
- [$schema](/reference/core-api/devkit/documents/NxJsonConfiguration#$schema): string
- [affected](/reference/core-api/devkit/documents/NxJsonConfiguration#affected): NxAffectedConfig
- [cacheDirectory](/reference/core-api/devkit/documents/NxJsonConfiguration#cachedirectory): string
- [cli](/reference/core-api/devkit/documents/NxJsonConfiguration#cli): Object
- [defaultBase](/reference/core-api/devkit/documents/NxJsonConfiguration#defaultbase): string
- [defaultProject](/reference/core-api/devkit/documents/NxJsonConfiguration#defaultproject): string
- [extends](/reference/core-api/devkit/documents/NxJsonConfiguration#extends): string
- [generators](/reference/core-api/devkit/documents/NxJsonConfiguration#generators): Object
- [implicitDependencies](/reference/core-api/devkit/documents/NxJsonConfiguration#implicitdependencies): ImplicitDependencyEntry<T>
- [installation](/reference/core-api/devkit/documents/NxJsonConfiguration#installation): NxInstallationConfiguration
- [maxCacheSize](/reference/core-api/devkit/documents/NxJsonConfiguration#maxcachesize): string
- [namedInputs](/reference/core-api/devkit/documents/NxJsonConfiguration#namedinputs): Object
- [neverConnectToCloud](/reference/core-api/devkit/documents/NxJsonConfiguration#neverconnecttocloud): boolean
- [nxCloudAccessToken](/reference/core-api/devkit/documents/NxJsonConfiguration#nxcloudaccesstoken): string
- [nxCloudEncryptionKey](/reference/core-api/devkit/documents/NxJsonConfiguration#nxcloudencryptionkey): string
- [nxCloudId](/reference/core-api/devkit/documents/NxJsonConfiguration#nxcloudid): string
- [nxCloudUrl](/reference/core-api/devkit/documents/NxJsonConfiguration#nxcloudurl): string
- [parallel](/reference/core-api/devkit/documents/NxJsonConfiguration#parallel): number
- [plugins](/reference/core-api/devkit/documents/NxJsonConfiguration#plugins): PluginConfiguration[]
- [pluginsConfig](/reference/core-api/devkit/documents/NxJsonConfiguration#pluginsconfig): Record<string, Record<string, unknown>>
- [release](/reference/core-api/devkit/documents/NxJsonConfiguration#release): NxReleaseConfiguration
- [sync](/reference/core-api/devkit/documents/NxJsonConfiguration#sync): NxSyncConfiguration
- [targetDefaults](/reference/core-api/devkit/documents/NxJsonConfiguration#targetdefaults): TargetDefaults
- [tasksRunnerOptions](/reference/core-api/devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
- [tui](/reference/core-api/devkit/documents/NxJsonConfiguration#tui): Object
- [useDaemonProcess](/reference/core-api/devkit/documents/NxJsonConfiguration#usedaemonprocess): boolean
- [useInferencePlugins](/reference/core-api/devkit/documents/NxJsonConfiguration#useinferenceplugins): boolean
- [workspaceLayout](/reference/core-api/devkit/documents/NxJsonConfiguration#workspacelayout): Object
## Properties
@ -57,13 +57,13 @@ Nx.json configuration
### affected
• `Optional` **affected**: [`NxAffectedConfig`](../../devkit/documents/NxAffectedConfig)
• `Optional` **affected**: [`NxAffectedConfig`](/reference/core-api/devkit/documents/NxAffectedConfig)
Default options for `nx affected`
**`Deprecated`**
use [defaultBase](../../devkit/documents/NxJsonConfiguration#defaultbase) instead. For more information see https://nx.dev/deprecated/affected-config#affected-config
use [defaultBase](/reference/core-api/devkit/documents/NxJsonConfiguration#defaultbase) instead. For more information see https://nx.dev/deprecated/affected-config#affected-config
---
@ -83,10 +83,10 @@ Default generator collection. It is used when no collection is provided.
#### Type declaration
| Name | Type |
| :-------------------- | :-------------------------------------------------------- |
| `defaultProjectName?` | `string` |
| `packageManager?` | [`PackageManager`](../../devkit/documents/PackageManager) |
| Name | Type |
| :-------------------- | :---------------------------------------------------------------------- |
| `defaultProjectName?` | `string` |
| `packageManager?` | [`PackageManager`](/reference/core-api/devkit/documents/PackageManager) |
---
@ -143,13 +143,13 @@ Example:
### implicitDependencies
• `Optional` **implicitDependencies**: [`ImplicitDependencyEntry`](../../devkit/documents/ImplicitDependencyEntry)\<`T`\>
• `Optional` **implicitDependencies**: [`ImplicitDependencyEntry`](/reference/core-api/devkit/documents/ImplicitDependencyEntry)\<`T`\>
Map of files to projects that implicitly depend on them
**`Deprecated`**
use [namedInputs](../../devkit/documents/NxJsonConfiguration#namedinputs) instead. For more information see https://nx.dev/deprecated/global-implicit-dependencies#global-implicit-dependencies
use [namedInputs](/reference/core-api/devkit/documents/NxJsonConfiguration#namedinputs) instead. For more information see https://nx.dev/deprecated/global-implicit-dependencies#global-implicit-dependencies
---
@ -196,7 +196,7 @@ Set this to true to disable connection to Nx Cloud
• `Optional` **nxCloudAccessToken**: `string`
If specified Nx will use nx-cloud by default with the given token.
To use a different runner that accepts an access token, define it in [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions)
To use a different runner that accepts an access token, define it in [tasksRunnerOptions](/reference/core-api/devkit/documents/NxJsonConfiguration#tasksrunneroptions)
---
@ -213,7 +213,7 @@ Specifies the encryption key used to encrypt artifacts data before sending it to
• `Optional` **nxCloudId**: `string`
If specified Nx will use nx-cloud by default with the given cloud id.
To use a different runner that accepts a cloud id, define it in [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions)
To use a different runner that accepts a cloud id, define it in [tasksRunnerOptions](/reference/core-api/devkit/documents/NxJsonConfiguration#tasksrunneroptions)
---
@ -236,7 +236,7 @@ Specifies how many tasks can be run in parallel.
### plugins
• `Optional` **plugins**: [`PluginConfiguration`](../../devkit/documents/PluginConfiguration)[]
• `Optional` **plugins**: [`PluginConfiguration`](/reference/core-api/devkit/documents/PluginConfiguration)[]
Plugins for extending the project graph
@ -268,7 +268,7 @@ Configuration for the `nx sync` command.
### targetDefaults
• `Optional` **targetDefaults**: [`TargetDefaults`](../../devkit/documents/TargetDefaults)
• `Optional` **targetDefaults**: [`TargetDefaults`](/reference/core-api/devkit/documents/TargetDefaults)
Dependencies between different target names across all projects

2
docs/generated/devkit/NxPlugin.md
View File

@ -1,5 +1,5 @@
# Type alias: NxPlugin
Ƭ **NxPlugin**: [`NxPluginV2`](../../devkit/documents/NxPluginV2)
Ƭ **NxPlugin**: [`NxPluginV2`](/reference/core-api/devkit/documents/NxPluginV2)
A plugin which enhances the behavior of Nx

18
docs/generated/devkit/NxPluginV2.md
View File

@ -12,12 +12,12 @@ A plugin which enhances the behavior of Nx
#### Type declaration
| Name | Type | Description |
| :-------------------- | :------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `createDependencies?` | [`CreateDependencies`](../../devkit/documents/CreateDependencies)\<`TOptions`\> | Provides a function to analyze files to create dependencies for the [ProjectGraph](../../devkit/documents/ProjectGraph) |
| `createMetadata?` | [`CreateMetadata`](../../devkit/documents/CreateMetadata)\<`TOptions`\> | Provides a function to create metadata for the [ProjectGraph](../../devkit/documents/ProjectGraph) |
| `createNodes?` | [`CreateNodes`](../../devkit/documents/CreateNodes)\<`TOptions`\> | Provides a file pattern and function that retrieves configuration info from those files. e.g. { '**/\*.csproj': buildProjectsFromCsProjFile } **`Deprecated`\*\* Use createNodesV2 instead. In Nx 21 support for calling createNodes with a single file for the first argument will be removed. |
| `createNodesV2?` | [`CreateNodesV2`](../../devkit/documents/CreateNodesV2)\<`TOptions`\> | Provides a file pattern and function that retrieves configuration info from those files. e.g. { '\*_/_.csproj': buildProjectsFromCsProjFiles } In Nx 21 createNodes will be replaced with this property. In Nx 22, this property will be removed. |
| `name` | `string` | - |
| `postTasksExecution?` | [`PostTasksExecution`](../../devkit/documents/PostTasksExecution)\<`TOptions`\> | Provides a function to run after the Nx runs tasks |
| `preTasksExecution?` | [`PreTasksExecution`](../../devkit/documents/PreTasksExecution)\<`TOptions`\> | Provides a function to run before the Nx runs tasks |
| Name | Type | Description |
| :-------------------- | :-------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `createDependencies?` | [`CreateDependencies`](/reference/core-api/devkit/documents/CreateDependencies)\<`TOptions`\> | Provides a function to analyze files to create dependencies for the [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph) |
| `createMetadata?` | [`CreateMetadata`](/reference/core-api/devkit/documents/CreateMetadata)\<`TOptions`\> | Provides a function to create metadata for the [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph) |
| `createNodes?` | [`CreateNodes`](/reference/core-api/devkit/documents/CreateNodes)\<`TOptions`\> | Provides a file pattern and function that retrieves configuration info from those files. e.g. { '**/\*.csproj': buildProjectsFromCsProjFile } **`Deprecated`\*\* Use createNodesV2 instead. In Nx 21 support for calling createNodes with a single file for the first argument will be removed. |
| `createNodesV2?` | [`CreateNodesV2`](/reference/core-api/devkit/documents/CreateNodesV2)\<`TOptions`\> | Provides a file pattern and function that retrieves configuration info from those files. e.g. { '\*_/_.csproj': buildProjectsFromCsProjFiles } In Nx 21 createNodes will be replaced with this property. In Nx 22, this property will be removed. |
| `name` | `string` | - |
| `postTasksExecution?` | [`PostTasksExecution`](/reference/core-api/devkit/documents/PostTasksExecution)\<`TOptions`\> | Provides a function to run after the Nx runs tasks |
| `preTasksExecution?` | [`PreTasksExecution`](/reference/core-api/devkit/documents/PreTasksExecution)\<`TOptions`\> | Provides a function to run before the Nx runs tasks |

6
docs/generated/devkit/OverwriteStrategy.md
View File

@ -6,9 +6,9 @@ Specify what should be done when a file is generated but already exists on the s
### Enumeration Members
- [KeepExisting](../../devkit/documents/OverwriteStrategy#keepexisting)
- [Overwrite](../../devkit/documents/OverwriteStrategy#overwrite)
- [ThrowIfExisting](../../devkit/documents/OverwriteStrategy#throwifexisting)
- [KeepExisting](/reference/core-api/devkit/documents/OverwriteStrategy#keepexisting)
- [Overwrite](/reference/core-api/devkit/documents/OverwriteStrategy#overwrite)
- [ThrowIfExisting](/reference/core-api/devkit/documents/OverwriteStrategy#throwifexisting)
## Enumeration Members

2
docs/generated/devkit/PluginConfiguration.md
View File

@ -1,3 +1,3 @@
# Type alias: PluginConfiguration
Ƭ **PluginConfiguration**: `string` \| [`ExpandedPluginConfiguration`](../../devkit/documents/ExpandedPluginConfiguration)
Ƭ **PluginConfiguration**: `string` \| [`ExpandedPluginConfiguration`](/reference/core-api/devkit/documents/ExpandedPluginConfiguration)

10
docs/generated/devkit/PostTasksExecution.md
View File

@ -1,6 +1,6 @@
# Type alias: PostTasksExecution\<TOptions\>
Ƭ **PostTasksExecution**\<`TOptions`\>: (`options`: `TOptions` \| `undefined`, `context`: [`PostTasksExecutionContext`](../../devkit/documents/PostTasksExecutionContext)) => `void` \| `Promise`\<`void`\>
Ƭ **PostTasksExecution**\<`TOptions`\>: (`options`: `TOptions` \| `undefined`, `context`: [`PostTasksExecutionContext`](/reference/core-api/devkit/documents/PostTasksExecutionContext)) => `void` \| `Promise`\<`void`\>
#### Type parameters
@ -14,10 +14,10 @@
##### Parameters
| Name | Type |
| :-------- | :------------------------------------------------------------------------------ |
| `options` | `TOptions` \| `undefined` |
| `context` | [`PostTasksExecutionContext`](../../devkit/documents/PostTasksExecutionContext) |
| Name | Type |
| :-------- | :-------------------------------------------------------------------------------------------- |
| `options` | `TOptions` \| `undefined` |
| `context` | [`PostTasksExecutionContext`](/reference/core-api/devkit/documents/PostTasksExecutionContext) |
##### Returns

10
docs/generated/devkit/PostTasksExecutionContext.md
View File

@ -4,8 +4,8 @@
#### Type declaration
| Name | Type |
| :-------------------- | :------------------------------------------------------------------ |
| `nxJsonConfiguration` | [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) |
| `taskResults` | [`TaskResults`](../../devkit/documents/TaskResults) |
| `workspaceRoot` | `string` |
| Name | Type |
| :-------------------- | :-------------------------------------------------------------------------------- |
| `nxJsonConfiguration` | [`NxJsonConfiguration`](/reference/core-api/devkit/documents/NxJsonConfiguration) |
| `taskResults` | [`TaskResults`](/reference/core-api/devkit/documents/TaskResults) |
| `workspaceRoot` | `string` |

10
docs/generated/devkit/PreTasksExecution.md
View File

@ -1,6 +1,6 @@
# Type alias: PreTasksExecution\<TOptions\>
Ƭ **PreTasksExecution**\<`TOptions`\>: (`options`: `TOptions` \| `undefined`, `context`: [`PreTasksExecutionContext`](../../devkit/documents/PreTasksExecutionContext)) => `void` \| `Promise`\<`void`\>
Ƭ **PreTasksExecution**\<`TOptions`\>: (`options`: `TOptions` \| `undefined`, `context`: [`PreTasksExecutionContext`](/reference/core-api/devkit/documents/PreTasksExecutionContext)) => `void` \| `Promise`\<`void`\>
#### Type parameters
@ -14,10 +14,10 @@
##### Parameters
| Name | Type |
| :-------- | :---------------------------------------------------------------------------- |
| `options` | `TOptions` \| `undefined` |
| `context` | [`PreTasksExecutionContext`](../../devkit/documents/PreTasksExecutionContext) |
| Name | Type |
| :-------- | :------------------------------------------------------------------------------------------ |
| `options` | `TOptions` \| `undefined` |
| `context` | [`PreTasksExecutionContext`](/reference/core-api/devkit/documents/PreTasksExecutionContext) |
##### Returns

8
docs/generated/devkit/PreTasksExecutionContext.md
View File

@ -4,7 +4,7 @@
#### Type declaration
| Name | Type |
| :-------------------- | :------------------------------------------------------------------ |
| `nxJsonConfiguration` | [`NxJsonConfiguration`](../../devkit/documents/NxJsonConfiguration) |
| `workspaceRoot` | `string` |
| Name | Type |
| :-------------------- | :-------------------------------------------------------------------------------- |
| `nxJsonConfiguration` | [`NxJsonConfiguration`](/reference/core-api/devkit/documents/NxJsonConfiguration) |
| `workspaceRoot` | `string` |

26
docs/generated/devkit/ProjectConfiguration.md
View File

@ -6,17 +6,17 @@ Project configuration
### Properties
- [generators](../../devkit/documents/ProjectConfiguration#generators): Object
- [implicitDependencies](../../devkit/documents/ProjectConfiguration#implicitdependencies): string[]
- [metadata](../../devkit/documents/ProjectConfiguration#metadata): ProjectMetadata
- [name](../../devkit/documents/ProjectConfiguration#name): string
- [namedInputs](../../devkit/documents/ProjectConfiguration#namedinputs): Object
- [projectType](../../devkit/documents/ProjectConfiguration#projecttype): ProjectType
- [release](../../devkit/documents/ProjectConfiguration#release): Object
- [root](../../devkit/documents/ProjectConfiguration#root): string
- [sourceRoot](../../devkit/documents/ProjectConfiguration#sourceroot): string
- [tags](../../devkit/documents/ProjectConfiguration#tags): string[]
- [targets](../../devkit/documents/ProjectConfiguration#targets): Object
- [generators](/reference/core-api/devkit/documents/ProjectConfiguration#generators): Object
- [implicitDependencies](/reference/core-api/devkit/documents/ProjectConfiguration#implicitdependencies): string[]
- [metadata](/reference/core-api/devkit/documents/ProjectConfiguration#metadata): ProjectMetadata
- [name](/reference/core-api/devkit/documents/ProjectConfiguration#name): string
- [namedInputs](/reference/core-api/devkit/documents/ProjectConfiguration#namedinputs): Object
- [projectType](/reference/core-api/devkit/documents/ProjectConfiguration#projecttype): ProjectType
- [release](/reference/core-api/devkit/documents/ProjectConfiguration#release): Object
- [root](/reference/core-api/devkit/documents/ProjectConfiguration#root): string
- [sourceRoot](/reference/core-api/devkit/documents/ProjectConfiguration#sourceroot): string
- [tags](/reference/core-api/devkit/documents/ProjectConfiguration#tags): string[]
- [targets](/reference/core-api/devkit/documents/ProjectConfiguration#targets): Object
## Properties
@ -84,7 +84,7 @@ Named inputs targets can refer to reduce duplication
### projectType
• `Optional` **projectType**: [`ProjectType`](../../devkit/documents/ProjectType)
• `Optional` **projectType**: [`ProjectType`](/reference/core-api/devkit/documents/ProjectType)
Project type
@ -136,4 +136,4 @@ Project's targets
#### Index signature
▪ [targetName: `string`]: [`TargetConfiguration`](../../devkit/documents/TargetConfiguration)
▪ [targetName: `string`]: [`TargetConfiguration`](/reference/core-api/devkit/documents/TargetConfiguration)

2
docs/generated/devkit/ProjectFileMap.md
View File

@ -4,4 +4,4 @@ A list of files separated by the project they belong to
## Indexable
▪ [projectName: `string`]: [`FileData`](../../devkit/documents/FileData)[]
▪ [projectName: `string`]: [`FileData`](/reference/core-api/devkit/documents/FileData)[]

14
docs/generated/devkit/ProjectGraph.md
View File

@ -6,28 +6,28 @@ A Graph of projects in the workspace and dependencies between them
### Properties
- [dependencies](../../devkit/documents/ProjectGraph#dependencies): Record<string, ProjectGraphDependency[]>
- [externalNodes](../../devkit/documents/ProjectGraph#externalnodes): Record<string, ProjectGraphExternalNode>
- [nodes](../../devkit/documents/ProjectGraph#nodes): Record<string, ProjectGraphProjectNode>
- [version](../../devkit/documents/ProjectGraph#version): string
- [dependencies](/reference/core-api/devkit/documents/ProjectGraph#dependencies): Record<string, ProjectGraphDependency[]>
- [externalNodes](/reference/core-api/devkit/documents/ProjectGraph#externalnodes): Record<string, ProjectGraphExternalNode>
- [nodes](/reference/core-api/devkit/documents/ProjectGraph#nodes): Record<string, ProjectGraphProjectNode>
- [version](/reference/core-api/devkit/documents/ProjectGraph#version): string
## Properties
### dependencies
• **dependencies**: `Record`\<`string`, [`ProjectGraphDependency`](../../devkit/documents/ProjectGraphDependency)[]\>
• **dependencies**: `Record`\<`string`, [`ProjectGraphDependency`](/reference/core-api/devkit/documents/ProjectGraphDependency)[]\>
---
### externalNodes
• `Optional` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](../../devkit/documents/ProjectGraphExternalNode)\>
• `Optional` **externalNodes**: `Record`\<`string`, [`ProjectGraphExternalNode`](/reference/core-api/devkit/documents/ProjectGraphExternalNode)\>
---
### nodes
• **nodes**: `Record`\<`string`, [`ProjectGraphProjectNode`](../../devkit/documents/ProjectGraphProjectNode)\>
• **nodes**: `Record`\<`string`, [`ProjectGraphProjectNode`](/reference/core-api/devkit/documents/ProjectGraphProjectNode)\>
---

6
docs/generated/devkit/ProjectGraphDependency.md
View File

@ -6,9 +6,9 @@ A dependency between two projects
### Properties
- [source](../../devkit/documents/ProjectGraphDependency#source): string
- [target](../../devkit/documents/ProjectGraphDependency#target): string
- [type](../../devkit/documents/ProjectGraphDependency#type): string
- [source](/reference/core-api/devkit/documents/ProjectGraphDependency#source): string
- [target](/reference/core-api/devkit/documents/ProjectGraphDependency#target): string
- [type](/reference/core-api/devkit/documents/ProjectGraphDependency#type): string
## Properties

6
docs/generated/devkit/ProjectGraphExternalNode.md
View File

@ -13,9 +13,9 @@ while allowing tracking of the full tree of different nested versions
### Properties
- [data](../../devkit/documents/ProjectGraphExternalNode#data): Object
- [name](../../devkit/documents/ProjectGraphExternalNode#name): string
- [type](../../devkit/documents/ProjectGraphExternalNode#type): string
- [data](/reference/core-api/devkit/documents/ProjectGraphExternalNode#data): Object
- [name](/reference/core-api/devkit/documents/ProjectGraphExternalNode#name): string
- [type](/reference/core-api/devkit/documents/ProjectGraphExternalNode#type): string
## Properties

8
docs/generated/devkit/ProjectGraphProjectNode.md
View File

@ -6,15 +6,15 @@ A node describing a project in a workspace
### Properties
- [data](../../devkit/documents/ProjectGraphProjectNode#data): ProjectConfiguration & Object
- [name](../../devkit/documents/ProjectGraphProjectNode#name): string
- [type](../../devkit/documents/ProjectGraphProjectNode#type): "lib" | "app" | "e2e"
- [data](/reference/core-api/devkit/documents/ProjectGraphProjectNode#data): ProjectConfiguration & Object
- [name](/reference/core-api/devkit/documents/ProjectGraphProjectNode#name): string
- [type](/reference/core-api/devkit/documents/ProjectGraphProjectNode#type): "lib" | "app" | "e2e"
## Properties
### data
• **data**: [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration) & \{ `description?`: `string` }
• **data**: [`ProjectConfiguration`](/reference/core-api/devkit/documents/ProjectConfiguration) & \{ `description?`: `string` }
Additional metadata about a project

8
docs/generated/devkit/ProjectsConfigurations.md
View File

@ -6,14 +6,14 @@ Projects Configurations
- **`ProjectsConfigurations`**
↳ [`Workspace`](../../devkit/documents/Workspace)
↳ [`Workspace`](/reference/core-api/devkit/documents/Workspace)
## Table of contents
### Properties
- [projects](../../devkit/documents/ProjectsConfigurations#projects): Object
- [version](../../devkit/documents/ProjectsConfigurations#version): number
- [projects](/reference/core-api/devkit/documents/ProjectsConfigurations#projects): Object
- [version](/reference/core-api/devkit/documents/ProjectsConfigurations#version): number
## Properties
@ -25,7 +25,7 @@ Projects' projects
#### Index signature
▪ [projectName: `string`]: [`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration)
▪ [projectName: `string`]: [`ProjectConfiguration`](/reference/core-api/devkit/documents/ProjectConfiguration)
---

2
docs/generated/devkit/ProjectsMetadata.md
View File

@ -1,3 +1,3 @@
# Type alias: ProjectsMetadata
Ƭ **ProjectsMetadata**: `Record`\<`string`, `Pick`\<[`ProjectConfiguration`](../../devkit/documents/ProjectConfiguration), `"metadata"`\>\>
Ƭ **ProjectsMetadata**: `Record`\<`string`, `Pick`\<[`ProjectConfiguration`](/reference/core-api/devkit/documents/ProjectConfiguration), `"metadata"`\>\>

10
docs/generated/devkit/PromiseExecutor.md
View File

@ -1,6 +1,6 @@
# Type alias: PromiseExecutor\<T\>
Ƭ **PromiseExecutor**\<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](../../devkit/documents/ExecutorContext)) => `Promise`\<\{ `success`: `boolean` }\>
Ƭ **PromiseExecutor**\<`T`\>: (`options`: `T`, `context`: [`ExecutorContext`](/reference/core-api/devkit/documents/ExecutorContext)) => `Promise`\<\{ `success`: `boolean` }\>
An executor implementation that returns a promise
@ -16,10 +16,10 @@ An executor implementation that returns a promise
##### Parameters
| Name | Type |
| :-------- | :---------------------------------------------------------- |
| `options` | `T` |
| `context` | [`ExecutorContext`](../../devkit/documents/ExecutorContext) |
| Name | Type |
| :-------- | :------------------------------------------------------------------------ |
| `options` | `T` |
| `context` | [`ExecutorContext`](/reference/core-api/devkit/documents/ExecutorContext) |
##### Returns

290
docs/generated/devkit/README.md
View File

@ -13,163 +13,163 @@ It only uses language primitives and immutable objects
### Enumerations
- [ChangeType](../../devkit/documents/ChangeType)
- [DependencyType](../../devkit/documents/DependencyType)
- [OverwriteStrategy](../../devkit/documents/OverwriteStrategy)
- [ChangeType](/reference/core-api/devkit/documents/ChangeType)
- [DependencyType](/reference/core-api/devkit/documents/DependencyType)
- [OverwriteStrategy](/reference/core-api/devkit/documents/OverwriteStrategy)
### Classes
- [AggregateCreateNodesError](../../devkit/documents/AggregateCreateNodesError)
- [StaleProjectGraphCacheError](../../devkit/documents/StaleProjectGraphCacheError)
- [AggregateCreateNodesError](/reference/core-api/devkit/documents/AggregateCreateNodesError)
- [StaleProjectGraphCacheError](/reference/core-api/devkit/documents/StaleProjectGraphCacheError)
### Interfaces
- [CreateDependenciesContext](../../devkit/documents/CreateDependenciesContext)
- [CreateNodesContext](../../devkit/documents/CreateNodesContext)
- [CreateNodesContextV2](../../devkit/documents/CreateNodesContextV2)
- [CreateNodesResult](../../devkit/documents/CreateNodesResult)
- [DefaultTasksRunnerOptions](../../devkit/documents/DefaultTasksRunnerOptions)
- [ExecutorContext](../../devkit/documents/ExecutorContext)
- [ExecutorsJson](../../devkit/documents/ExecutorsJson)
- [FileChange](../../devkit/documents/FileChange)
- [FileData](../../devkit/documents/FileData)
- [FileMap](../../devkit/documents/FileMap)
- [GeneratorsJson](../../devkit/documents/GeneratorsJson)
- [GraphJson](../../devkit/documents/GraphJson)
- [Hash](../../devkit/documents/Hash)
- [HasherContext](../../devkit/documents/HasherContext)
- [ImplicitJsonSubsetDependency](../../devkit/documents/ImplicitJsonSubsetDependency)
- [JsonParseOptions](../../devkit/documents/JsonParseOptions)
- [JsonSerializeOptions](../../devkit/documents/JsonSerializeOptions)
- [MigrationsJson](../../devkit/documents/MigrationsJson)
- [NxAffectedConfig](../../devkit/documents/NxAffectedConfig)
- [NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration)
- [ProjectConfiguration](../../devkit/documents/ProjectConfiguration)
- [ProjectFileMap](../../devkit/documents/ProjectFileMap)
- [ProjectGraph](../../devkit/documents/ProjectGraph)
- [ProjectGraphDependency](../../devkit/documents/ProjectGraphDependency)
- [ProjectGraphExternalNode](../../devkit/documents/ProjectGraphExternalNode)
- [ProjectGraphProjectNode](../../devkit/documents/ProjectGraphProjectNode)
- [ProjectsConfigurations](../../devkit/documents/ProjectsConfigurations)
- [RemoteCache](../../devkit/documents/RemoteCache)
- [StringDeletion](../../devkit/documents/StringDeletion)
- [StringInsertion](../../devkit/documents/StringInsertion)
- [Target](../../devkit/documents/Target)
- [TargetConfiguration](../../devkit/documents/TargetConfiguration)
- [TargetDependencyConfig](../../devkit/documents/TargetDependencyConfig)
- [Task](../../devkit/documents/Task)
- [TaskGraph](../../devkit/documents/TaskGraph)
- [TaskHasher](../../devkit/documents/TaskHasher)
- [TaskResult](../../devkit/documents/TaskResult)
- [Tree](../../devkit/documents/Tree)
- [Workspace](../../devkit/documents/Workspace)
- [CreateDependenciesContext](/reference/core-api/devkit/documents/CreateDependenciesContext)
- [CreateNodesContext](/reference/core-api/devkit/documents/CreateNodesContext)
- [CreateNodesContextV2](/reference/core-api/devkit/documents/CreateNodesContextV2)
- [CreateNodesResult](/reference/core-api/devkit/documents/CreateNodesResult)
- [DefaultTasksRunnerOptions](/reference/core-api/devkit/documents/DefaultTasksRunnerOptions)
- [ExecutorContext](/reference/core-api/devkit/documents/ExecutorContext)
- [ExecutorsJson](/reference/core-api/devkit/documents/ExecutorsJson)
- [FileChange](/reference/core-api/devkit/documents/FileChange)
- [FileData](/reference/core-api/devkit/documents/FileData)
- [FileMap](/reference/core-api/devkit/documents/FileMap)
- [GeneratorsJson](/reference/core-api/devkit/documents/GeneratorsJson)
- [GraphJson](/reference/core-api/devkit/documents/GraphJson)
- [Hash](/reference/core-api/devkit/documents/Hash)
- [HasherContext](/reference/core-api/devkit/documents/HasherContext)
- [ImplicitJsonSubsetDependency](/reference/core-api/devkit/documents/ImplicitJsonSubsetDependency)
- [JsonParseOptions](/reference/core-api/devkit/documents/JsonParseOptions)
- [JsonSerializeOptions](/reference/core-api/devkit/documents/JsonSerializeOptions)
- [MigrationsJson](/reference/core-api/devkit/documents/MigrationsJson)
- [NxAffectedConfig](/reference/core-api/devkit/documents/NxAffectedConfig)
- [NxJsonConfiguration](/reference/core-api/devkit/documents/NxJsonConfiguration)
- [ProjectConfiguration](/reference/core-api/devkit/documents/ProjectConfiguration)
- [ProjectFileMap](/reference/core-api/devkit/documents/ProjectFileMap)
- [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph)
- [ProjectGraphDependency](/reference/core-api/devkit/documents/ProjectGraphDependency)
- [ProjectGraphExternalNode](/reference/core-api/devkit/documents/ProjectGraphExternalNode)
- [ProjectGraphProjectNode](/reference/core-api/devkit/documents/ProjectGraphProjectNode)
- [ProjectsConfigurations](/reference/core-api/devkit/documents/ProjectsConfigurations)
- [RemoteCache](/reference/core-api/devkit/documents/RemoteCache)
- [StringDeletion](/reference/core-api/devkit/documents/StringDeletion)
- [StringInsertion](/reference/core-api/devkit/documents/StringInsertion)
- [Target](/reference/core-api/devkit/documents/Target)
- [TargetConfiguration](/reference/core-api/devkit/documents/TargetConfiguration)
- [TargetDependencyConfig](/reference/core-api/devkit/documents/TargetDependencyConfig)
- [Task](/reference/core-api/devkit/documents/Task)
- [TaskGraph](/reference/core-api/devkit/documents/TaskGraph)
- [TaskHasher](/reference/core-api/devkit/documents/TaskHasher)
- [TaskResult](/reference/core-api/devkit/documents/TaskResult)
- [Tree](/reference/core-api/devkit/documents/Tree)
- [Workspace](/reference/core-api/devkit/documents/Workspace)
### Type Aliases
- [AsyncIteratorExecutor](../../devkit/documents/AsyncIteratorExecutor)
- [CreateDependencies](../../devkit/documents/CreateDependencies)
- [CreateMetadata](../../devkit/documents/CreateMetadata)
- [CreateMetadataContext](../../devkit/documents/CreateMetadataContext)
- [CreateNodes](../../devkit/documents/CreateNodes)
- [CreateNodesFunction](../../devkit/documents/CreateNodesFunction)
- [CreateNodesFunctionV2](../../devkit/documents/CreateNodesFunctionV2)
- [CreateNodesResultV2](../../devkit/documents/CreateNodesResultV2)
- [CreateNodesV2](../../devkit/documents/CreateNodesV2)
- [CustomHasher](../../devkit/documents/CustomHasher)
- [DynamicDependency](../../devkit/documents/DynamicDependency)
- [Executor](../../devkit/documents/Executor)
- [ExpandedPluginConfiguration](../../devkit/documents/ExpandedPluginConfiguration)
- [Generator](../../devkit/documents/Generator)
- [GeneratorCallback](../../devkit/documents/GeneratorCallback)
- [Hasher](../../devkit/documents/Hasher)
- [ImplicitDependency](../../devkit/documents/ImplicitDependency)
- [ImplicitDependencyEntry](../../devkit/documents/ImplicitDependencyEntry)
- [Migration](../../devkit/documents/Migration)
- [NxPlugin](../../devkit/documents/NxPlugin)
- [NxPluginV2](../../devkit/documents/NxPluginV2)
- [PackageManager](../../devkit/documents/PackageManager)
- [PluginConfiguration](../../devkit/documents/PluginConfiguration)
- [PostTasksExecution](../../devkit/documents/PostTasksExecution)
- [PostTasksExecutionContext](../../devkit/documents/PostTasksExecutionContext)
- [PreTasksExecution](../../devkit/documents/PreTasksExecution)
- [PreTasksExecutionContext](../../devkit/documents/PreTasksExecutionContext)
- [ProjectType](../../devkit/documents/ProjectType)
- [ProjectsMetadata](../../devkit/documents/ProjectsMetadata)
- [PromiseExecutor](../../devkit/documents/PromiseExecutor)
- [RawProjectGraphDependency](../../devkit/documents/RawProjectGraphDependency)
- [StaticDependency](../../devkit/documents/StaticDependency)
- [StringChange](../../devkit/documents/StringChange)
- [TargetDefaults](../../devkit/documents/TargetDefaults)
- [TaskGraphExecutor](../../devkit/documents/TaskGraphExecutor)
- [TaskResults](../../devkit/documents/TaskResults)
- [ToJSOptions](../../devkit/documents/ToJSOptions)
- [WorkspaceJsonConfiguration](../../devkit/documents/WorkspaceJsonConfiguration)
- [AsyncIteratorExecutor](/reference/core-api/devkit/documents/AsyncIteratorExecutor)
- [CreateDependencies](/reference/core-api/devkit/documents/CreateDependencies)
- [CreateMetadata](/reference/core-api/devkit/documents/CreateMetadata)
- [CreateMetadataContext](/reference/core-api/devkit/documents/CreateMetadataContext)
- [CreateNodes](/reference/core-api/devkit/documents/CreateNodes)
- [CreateNodesFunction](/reference/core-api/devkit/documents/CreateNodesFunction)
- [CreateNodesFunctionV2](/reference/core-api/devkit/documents/CreateNodesFunctionV2)
- [CreateNodesResultV2](/reference/core-api/devkit/documents/CreateNodesResultV2)
- [CreateNodesV2](/reference/core-api/devkit/documents/CreateNodesV2)
- [CustomHasher](/reference/core-api/devkit/documents/CustomHasher)
- [DynamicDependency](/reference/core-api/devkit/documents/DynamicDependency)
- [Executor](/reference/core-api/devkit/documents/Executor)
- [ExpandedPluginConfiguration](/reference/core-api/devkit/documents/ExpandedPluginConfiguration)
- [Generator](/reference/core-api/devkit/documents/Generator)
- [GeneratorCallback](/reference/core-api/devkit/documents/GeneratorCallback)
- [Hasher](/reference/core-api/devkit/documents/Hasher)
- [ImplicitDependency](/reference/core-api/devkit/documents/ImplicitDependency)
- [ImplicitDependencyEntry](/reference/core-api/devkit/documents/ImplicitDependencyEntry)
- [Migration](/reference/core-api/devkit/documents/Migration)
- [NxPlugin](/reference/core-api/devkit/documents/NxPlugin)
- [NxPluginV2](/reference/core-api/devkit/documents/NxPluginV2)
- [PackageManager](/reference/core-api/devkit/documents/PackageManager)
- [PluginConfiguration](/reference/core-api/devkit/documents/PluginConfiguration)
- [PostTasksExecution](/reference/core-api/devkit/documents/PostTasksExecution)
- [PostTasksExecutionContext](/reference/core-api/devkit/documents/PostTasksExecutionContext)
- [PreTasksExecution](/reference/core-api/devkit/documents/PreTasksExecution)
- [PreTasksExecutionContext](/reference/core-api/devkit/documents/PreTasksExecutionContext)
- [ProjectType](/reference/core-api/devkit/documents/ProjectType)
- [ProjectsMetadata](/reference/core-api/devkit/documents/ProjectsMetadata)
- [PromiseExecutor](/reference/core-api/devkit/documents/PromiseExecutor)
- [RawProjectGraphDependency](/reference/core-api/devkit/documents/RawProjectGraphDependency)
- [StaticDependency](/reference/core-api/devkit/documents/StaticDependency)
- [StringChange](/reference/core-api/devkit/documents/StringChange)
- [TargetDefaults](/reference/core-api/devkit/documents/TargetDefaults)
- [TaskGraphExecutor](/reference/core-api/devkit/documents/TaskGraphExecutor)
- [TaskResults](/reference/core-api/devkit/documents/TaskResults)
- [ToJSOptions](/reference/core-api/devkit/documents/ToJSOptions)
- [WorkspaceJsonConfiguration](/reference/core-api/devkit/documents/WorkspaceJsonConfiguration)
### Variables
- [NX_VERSION](../../devkit/documents/NX_VERSION): string
- [cacheDir](../../devkit/documents/cacheDir): string
- [logger](../../devkit/documents/logger): Object
- [output](../../devkit/documents/output): CLIOutput
- [workspaceRoot](../../devkit/documents/workspaceRoot): string
- [NX_VERSION](/reference/core-api/devkit/documents/NX_VERSION): string
- [cacheDir](/reference/core-api/devkit/documents/cacheDir): string
- [logger](/reference/core-api/devkit/documents/logger): Object
- [output](/reference/core-api/devkit/documents/output): CLIOutput
- [workspaceRoot](/reference/core-api/devkit/documents/workspaceRoot): string
### Functions
- [addDependenciesToPackageJson](../../devkit/documents/addDependenciesToPackageJson)
- [addProjectConfiguration](../../devkit/documents/addProjectConfiguration)
- [applyChangesToString](../../devkit/documents/applyChangesToString)
- [convertNxExecutor](../../devkit/documents/convertNxExecutor)
- [convertNxGenerator](../../devkit/documents/convertNxGenerator)
- [createNodesFromFiles](../../devkit/documents/createNodesFromFiles)
- [createProjectFileMapUsingProjectGraph](../../devkit/documents/createProjectFileMapUsingProjectGraph)
- [createProjectGraphAsync](../../devkit/documents/createProjectGraphAsync)
- [defaultTasksRunner](../../devkit/documents/defaultTasksRunner)
- [detectPackageManager](../../devkit/documents/detectPackageManager)
- [ensurePackage](../../devkit/documents/ensurePackage)
- [extractLayoutDirectory](../../devkit/documents/extractLayoutDirectory)
- [formatFiles](../../devkit/documents/formatFiles)
- [generateFiles](../../devkit/documents/generateFiles)
- [getOutputsForTargetAndConfiguration](../../devkit/documents/getOutputsForTargetAndConfiguration)
- [getPackageManagerCommand](../../devkit/documents/getPackageManagerCommand)
- [getPackageManagerVersion](../../devkit/documents/getPackageManagerVersion)
- [getProjects](../../devkit/documents/getProjects)
- [getWorkspaceLayout](../../devkit/documents/getWorkspaceLayout)
- [glob](../../devkit/documents/glob)
- [globAsync](../../devkit/documents/globAsync)
- [hashArray](../../devkit/documents/hashArray)
- [installPackagesTask](../../devkit/documents/installPackagesTask)
- [isDaemonEnabled](../../devkit/documents/isDaemonEnabled)
- [isWorkspacesEnabled](../../devkit/documents/isWorkspacesEnabled)
- [joinPathFragments](../../devkit/documents/joinPathFragments)
- [moveFilesToNewDirectory](../../devkit/documents/moveFilesToNewDirectory)
- [names](../../devkit/documents/names)
- [normalizePath](../../devkit/documents/normalizePath)
- [offsetFromRoot](../../devkit/documents/offsetFromRoot)
- [parseJson](../../devkit/documents/parseJson)
- [parseTargetString](../../devkit/documents/parseTargetString)
- [readCachedProjectGraph](../../devkit/documents/readCachedProjectGraph)
- [readJson](../../devkit/documents/readJson)
- [readJsonFile](../../devkit/documents/readJsonFile)
- [readNxJson](../../devkit/documents/readNxJson)
- [readProjectConfiguration](../../devkit/documents/readProjectConfiguration)
- [readProjectsConfigurationFromProjectGraph](../../devkit/documents/readProjectsConfigurationFromProjectGraph)
- [readTargetOptions](../../devkit/documents/readTargetOptions)
- [removeDependenciesFromPackageJson](../../devkit/documents/removeDependenciesFromPackageJson)
- [removeProjectConfiguration](../../devkit/documents/removeProjectConfiguration)
- [reverse](../../devkit/documents/reverse)
- [runExecutor](../../devkit/documents/runExecutor)
- [runTasksInSerial](../../devkit/documents/runTasksInSerial)
- [serializeJson](../../devkit/documents/serializeJson)
- [stripIndents](../../devkit/documents/stripIndents)
- [stripJsonComments](../../devkit/documents/stripJsonComments)
- [targetToTargetString](../../devkit/documents/targetToTargetString)
- [toJS](../../devkit/documents/toJS)
- [updateJson](../../devkit/documents/updateJson)
- [updateNxJson](../../devkit/documents/updateNxJson)
- [updateProjectConfiguration](../../devkit/documents/updateProjectConfiguration)
- [updateTsConfigsToJs](../../devkit/documents/updateTsConfigsToJs)
- [validateDependency](../../devkit/documents/validateDependency)
- [visitNotIgnoredFiles](../../devkit/documents/visitNotIgnoredFiles)
- [workspaceLayout](../../devkit/documents/workspaceLayout)
- [writeJson](../../devkit/documents/writeJson)
- [writeJsonFile](../../devkit/documents/writeJsonFile)
- [addDependenciesToPackageJson](/reference/core-api/devkit/documents/addDependenciesToPackageJson)
- [addProjectConfiguration](/reference/core-api/devkit/documents/addProjectConfiguration)
- [applyChangesToString](/reference/core-api/devkit/documents/applyChangesToString)
- [convertNxExecutor](/reference/core-api/devkit/documents/convertNxExecutor)
- [convertNxGenerator](/reference/core-api/devkit/documents/convertNxGenerator)
- [createNodesFromFiles](/reference/core-api/devkit/documents/createNodesFromFiles)
- [createProjectFileMapUsingProjectGraph](/reference/core-api/devkit/documents/createProjectFileMapUsingProjectGraph)
- [createProjectGraphAsync](/reference/core-api/devkit/documents/createProjectGraphAsync)
- [defaultTasksRunner](/reference/core-api/devkit/documents/defaultTasksRunner)
- [detectPackageManager](/reference/core-api/devkit/documents/detectPackageManager)
- [ensurePackage](/reference/core-api/devkit/documents/ensurePackage)
- [extractLayoutDirectory](/reference/core-api/devkit/documents/extractLayoutDirectory)
- [formatFiles](/reference/core-api/devkit/documents/formatFiles)
- [generateFiles](/reference/core-api/devkit/documents/generateFiles)
- [getOutputsForTargetAndConfiguration](/reference/core-api/devkit/documents/getOutputsForTargetAndConfiguration)
- [getPackageManagerCommand](/reference/core-api/devkit/documents/getPackageManagerCommand)
- [getPackageManagerVersion](/reference/core-api/devkit/documents/getPackageManagerVersion)
- [getProjects](/reference/core-api/devkit/documents/getProjects)
- [getWorkspaceLayout](/reference/core-api/devkit/documents/getWorkspaceLayout)
- [glob](/reference/core-api/devkit/documents/glob)
- [globAsync](/reference/core-api/devkit/documents/globAsync)
- [hashArray](/reference/core-api/devkit/documents/hashArray)
- [installPackagesTask](/reference/core-api/devkit/documents/installPackagesTask)
- [isDaemonEnabled](/reference/core-api/devkit/documents/isDaemonEnabled)
- [isWorkspacesEnabled](/reference/core-api/devkit/documents/isWorkspacesEnabled)
- [joinPathFragments](/reference/core-api/devkit/documents/joinPathFragments)
- [moveFilesToNewDirectory](/reference/core-api/devkit/documents/moveFilesToNewDirectory)
- [names](/reference/core-api/devkit/documents/names)
- [normalizePath](/reference/core-api/devkit/documents/normalizePath)
- [offsetFromRoot](/reference/core-api/devkit/documents/offsetFromRoot)
- [parseJson](/reference/core-api/devkit/documents/parseJson)
- [parseTargetString](/reference/core-api/devkit/documents/parseTargetString)
- [readCachedProjectGraph](/reference/core-api/devkit/documents/readCachedProjectGraph)
- [readJson](/reference/core-api/devkit/documents/readJson)
- [readJsonFile](/reference/core-api/devkit/documents/readJsonFile)
- [readNxJson](/reference/core-api/devkit/documents/readNxJson)
- [readProjectConfiguration](/reference/core-api/devkit/documents/readProjectConfiguration)
- [readProjectsConfigurationFromProjectGraph](/reference/core-api/devkit/documents/readProjectsConfigurationFromProjectGraph)
- [readTargetOptions](/reference/core-api/devkit/documents/readTargetOptions)
- [removeDependenciesFromPackageJson](/reference/core-api/devkit/documents/removeDependenciesFromPackageJson)
- [removeProjectConfiguration](/reference/core-api/devkit/documents/removeProjectConfiguration)
- [reverse](/reference/core-api/devkit/documents/reverse)
- [runExecutor](/reference/core-api/devkit/documents/runExecutor)
- [runTasksInSerial](/reference/core-api/devkit/documents/runTasksInSerial)
- [serializeJson](/reference/core-api/devkit/documents/serializeJson)
- [stripIndents](/reference/core-api/devkit/documents/stripIndents)
- [stripJsonComments](/reference/core-api/devkit/documents/stripJsonComments)
- [targetToTargetString](/reference/core-api/devkit/documents/targetToTargetString)
- [toJS](/reference/core-api/devkit/documents/toJS)
- [updateJson](/reference/core-api/devkit/documents/updateJson)
- [updateNxJson](/reference/core-api/devkit/documents/updateNxJson)
- [updateProjectConfiguration](/reference/core-api/devkit/documents/updateProjectConfiguration)
- [updateTsConfigsToJs](/reference/core-api/devkit/documents/updateTsConfigsToJs)
- [validateDependency](/reference/core-api/devkit/documents/validateDependency)
- [visitNotIgnoredFiles](/reference/core-api/devkit/documents/visitNotIgnoredFiles)
- [workspaceLayout](/reference/core-api/devkit/documents/workspaceLayout)
- [writeJson](/reference/core-api/devkit/documents/writeJson)
- [writeJsonFile](/reference/core-api/devkit/documents/writeJsonFile)

6
docs/generated/devkit/RawProjectGraphDependency.md
View File

@ -1,7 +1,7 @@
# Type alias: RawProjectGraphDependency
Ƭ **RawProjectGraphDependency**: [`ImplicitDependency`](../../devkit/documents/ImplicitDependency) \| [`StaticDependency`](../../devkit/documents/StaticDependency) \| [`DynamicDependency`](../../devkit/documents/DynamicDependency)
Ƭ **RawProjectGraphDependency**: [`ImplicitDependency`](/reference/core-api/devkit/documents/ImplicitDependency) \| [`StaticDependency`](/reference/core-api/devkit/documents/StaticDependency) \| [`DynamicDependency`](/reference/core-api/devkit/documents/DynamicDependency)
A [ProjectGraph](../../devkit/documents/ProjectGraph) dependency between 2 projects
A [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph) dependency between 2 projects
See [DynamicDependency](../../devkit/documents/DynamicDependency), [ImplicitDependency](../../devkit/documents/ImplicitDependency), or [StaticDependency](../../devkit/documents/StaticDependency)
See [DynamicDependency](/reference/core-api/devkit/documents/DynamicDependency), [ImplicitDependency](/reference/core-api/devkit/documents/ImplicitDependency), or [StaticDependency](/reference/core-api/devkit/documents/StaticDependency)

4
docs/generated/devkit/RemoteCache.md
View File

@ -4,8 +4,8 @@
### Properties
- [retrieve](../../devkit/documents/RemoteCache#retrieve): Function
- [store](../../devkit/documents/RemoteCache#store): Function
- [retrieve](/reference/core-api/devkit/documents/RemoteCache#retrieve): Function
- [store](/reference/core-api/devkit/documents/RemoteCache#store): Function
## Properties

20
docs/generated/devkit/StaleProjectGraphCacheError.md
View File

@ -10,30 +10,30 @@
### Constructors
- [constructor](../../devkit/documents/StaleProjectGraphCacheError#constructor)
- [constructor](/reference/core-api/devkit/documents/StaleProjectGraphCacheError#constructor)
### Properties
- [cause](../../devkit/documents/StaleProjectGraphCacheError#cause): unknown
- [message](../../devkit/documents/StaleProjectGraphCacheError#message): string
- [name](../../devkit/documents/StaleProjectGraphCacheError#name): string
- [stack](../../devkit/documents/StaleProjectGraphCacheError#stack): string
- [prepareStackTrace](../../devkit/documents/StaleProjectGraphCacheError#preparestacktrace): Function
- [stackTraceLimit](../../devkit/documents/StaleProjectGraphCacheError#stacktracelimit): number
- [cause](/reference/core-api/devkit/documents/StaleProjectGraphCacheError#cause): unknown
- [message](/reference/core-api/devkit/documents/StaleProjectGraphCacheError#message): string
- [name](/reference/core-api/devkit/documents/StaleProjectGraphCacheError#name): string
- [stack](/reference/core-api/devkit/documents/StaleProjectGraphCacheError#stack): string
- [prepareStackTrace](/reference/core-api/devkit/documents/StaleProjectGraphCacheError#preparestacktrace): Function
- [stackTraceLimit](/reference/core-api/devkit/documents/StaleProjectGraphCacheError#stacktracelimit): number
### Methods
- [captureStackTrace](../../devkit/documents/StaleProjectGraphCacheError#capturestacktrace)
- [captureStackTrace](/reference/core-api/devkit/documents/StaleProjectGraphCacheError#capturestacktrace)
## Constructors
### constructor
• **new StaleProjectGraphCacheError**(): [`StaleProjectGraphCacheError`](../../devkit/documents/StaleProjectGraphCacheError)
• **new StaleProjectGraphCacheError**(): [`StaleProjectGraphCacheError`](/reference/core-api/devkit/documents/StaleProjectGraphCacheError)
#### Returns
[`StaleProjectGraphCacheError`](../../devkit/documents/StaleProjectGraphCacheError)
[`StaleProjectGraphCacheError`](/reference/core-api/devkit/documents/StaleProjectGraphCacheError)
#### Overrides

16
docs/generated/devkit/StaticDependency.md
View File

@ -2,17 +2,17 @@
Ƭ **StaticDependency**: `Object`
A static [ProjectGraph](../../devkit/documents/ProjectGraph) dependency between 2 projects
A static [ProjectGraph](/reference/core-api/devkit/documents/ProjectGraph) dependency between 2 projects
This type of dependency indicates the source project ALWAYS load the target project.
NOTE: StaticDependency#sourceFile MUST be present unless the source is the name of a [ProjectGraphExternalNode](../../devkit/documents/ProjectGraphExternalNode)
NOTE: StaticDependency#sourceFile MUST be present unless the source is the name of a [ProjectGraphExternalNode](/reference/core-api/devkit/documents/ProjectGraphExternalNode)
#### Type declaration
| Name | Type | Description |
| :------------ | :-------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `source` | `string` | The name of a [ProjectGraphProjectNode](../../devkit/documents/ProjectGraphProjectNode) or [ProjectGraphExternalNode](../../devkit/documents/ProjectGraphExternalNode) depending on the target project |
| `sourceFile?` | `string` | The path of a file (relative from the workspace root) where the dependency is made |
| `target` | `string` | The name of a [ProjectGraphProjectNode](../../devkit/documents/ProjectGraphProjectNode) or [ProjectGraphExternalNode](../../devkit/documents/ProjectGraphExternalNode) that the source project depends on |
| `type` | typeof [`static`](../../devkit/documents/DependencyType#static) | - |
| Name | Type | Description |
| :------------ | :---------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `source` | `string` | The name of a [ProjectGraphProjectNode](/reference/core-api/devkit/documents/ProjectGraphProjectNode) or [ProjectGraphExternalNode](/reference/core-api/devkit/documents/ProjectGraphExternalNode) depending on the target project |
| `sourceFile?` | `string` | The path of a file (relative from the workspace root) where the dependency is made |
| `target` | `string` | The name of a [ProjectGraphProjectNode](/reference/core-api/devkit/documents/ProjectGraphProjectNode) or [ProjectGraphExternalNode](/reference/core-api/devkit/documents/ProjectGraphExternalNode) that the source project depends on |
| `type` | typeof [`static`](/reference/core-api/devkit/documents/DependencyType#static) | - |

2
docs/generated/devkit/StringChange.md
View File

@ -1,5 +1,5 @@
# Type alias: StringChange
Ƭ **StringChange**: [`StringInsertion`](../../devkit/documents/StringInsertion) \| [`StringDeletion`](../../devkit/documents/StringDeletion)
Ƭ **StringChange**: [`StringInsertion`](/reference/core-api/devkit/documents/StringInsertion) \| [`StringDeletion`](/reference/core-api/devkit/documents/StringDeletion)
A change to be made to a string

8
docs/generated/devkit/StringDeletion.md
View File

@ -4,9 +4,9 @@
### Properties
- [length](../../devkit/documents/StringDeletion#length): number
- [start](../../devkit/documents/StringDeletion#start): number
- [type](../../devkit/documents/StringDeletion#type): Delete
- [length](/reference/core-api/devkit/documents/StringDeletion#length): number
- [start](/reference/core-api/devkit/documents/StringDeletion#start): number
- [type](/reference/core-api/devkit/documents/StringDeletion#type): Delete
## Properties
@ -28,4 +28,4 @@ Place in the original text to start deleting characters
### type
• **type**: [`Delete`](../../devkit/documents/ChangeType#delete)
• **type**: [`Delete`](/reference/core-api/devkit/documents/ChangeType#delete)

8
docs/generated/devkit/StringInsertion.md
View File

@ -4,9 +4,9 @@
### Properties
- [index](../../devkit/documents/StringInsertion#index): number
- [text](../../devkit/documents/StringInsertion#text): string
- [type](../../devkit/documents/StringInsertion#type): Insert
- [index](/reference/core-api/devkit/documents/StringInsertion#index): number
- [text](/reference/core-api/devkit/documents/StringInsertion#text): string
- [type](/reference/core-api/devkit/documents/StringInsertion#type): Insert
## Properties
@ -28,4 +28,4 @@ Text to insert into the original text
### type
• **type**: [`Insert`](../../devkit/documents/ChangeType#insert)
• **type**: [`Insert`](/reference/core-api/devkit/documents/ChangeType#insert)

6
docs/generated/devkit/Target.md
View File

@ -4,9 +4,9 @@
### Properties
- [configuration](../../devkit/documents/Target#configuration): string
- [project](../../devkit/documents/Target#project): string
- [target](../../devkit/documents/Target#target): string
- [configuration](/reference/core-api/devkit/documents/Target#configuration): string
- [project](/reference/core-api/devkit/documents/Target#project): string
- [target](/reference/core-api/devkit/documents/Target#target): string
## Properties

28
docs/generated/devkit/TargetConfiguration.md
View File

@ -12,19 +12,19 @@ Target's configuration
### Properties
- [cache](../../devkit/documents/TargetConfiguration#cache): boolean
- [command](../../devkit/documents/TargetConfiguration#command): string
- [configurations](../../devkit/documents/TargetConfiguration#configurations): Object
- [continuous](../../devkit/documents/TargetConfiguration#continuous): boolean
- [defaultConfiguration](../../devkit/documents/TargetConfiguration#defaultconfiguration): string
- [dependsOn](../../devkit/documents/TargetConfiguration#dependson): (string | TargetDependencyConfig)[]
- [executor](../../devkit/documents/TargetConfiguration#executor): string
- [inputs](../../devkit/documents/TargetConfiguration#inputs): (string | InputDefinition)[]
- [metadata](../../devkit/documents/TargetConfiguration#metadata): TargetMetadata
- [options](../../devkit/documents/TargetConfiguration#options): T
- [outputs](../../devkit/documents/TargetConfiguration#outputs): string[]
- [parallelism](../../devkit/documents/TargetConfiguration#parallelism): boolean
- [syncGenerators](../../devkit/documents/TargetConfiguration#syncgenerators): string[]
- [cache](/reference/core-api/devkit/documents/TargetConfiguration#cache): boolean
- [command](/reference/core-api/devkit/documents/TargetConfiguration#command): string
- [configurations](/reference/core-api/devkit/documents/TargetConfiguration#configurations): Object
- [continuous](/reference/core-api/devkit/documents/TargetConfiguration#continuous): boolean
- [defaultConfiguration](/reference/core-api/devkit/documents/TargetConfiguration#defaultconfiguration): string
- [dependsOn](/reference/core-api/devkit/documents/TargetConfiguration#dependson): (string | TargetDependencyConfig)[]
- [executor](/reference/core-api/devkit/documents/TargetConfiguration#executor): string
- [inputs](/reference/core-api/devkit/documents/TargetConfiguration#inputs): (string | InputDefinition)[]
- [metadata](/reference/core-api/devkit/documents/TargetConfiguration#metadata): TargetMetadata
- [options](/reference/core-api/devkit/documents/TargetConfiguration#options): T
- [outputs](/reference/core-api/devkit/documents/TargetConfiguration#outputs): string[]
- [parallelism](/reference/core-api/devkit/documents/TargetConfiguration#parallelism): boolean
- [syncGenerators](/reference/core-api/devkit/documents/TargetConfiguration#syncgenerators): string[]
## Properties
@ -74,7 +74,7 @@ A default named configuration to use when a target configuration is not provided
### dependsOn
• `Optional` **dependsOn**: (`string` \| [`TargetDependencyConfig`](../../devkit/documents/TargetDependencyConfig))[]
• `Optional` **dependsOn**: (`string` \| [`TargetDependencyConfig`](/reference/core-api/devkit/documents/TargetDependencyConfig))[]
This describes other targets that a target depends on.

2
docs/generated/devkit/TargetDefaults.md
View File

@ -1,3 +1,3 @@
# Type alias: TargetDefaults
Ƭ **TargetDefaults**: `Record`\<`string`, `Partial`\<[`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>\>
Ƭ **TargetDefaults**: `Record`\<`string`, `Partial`\<[`TargetConfiguration`](/reference/core-api/devkit/documents/TargetConfiguration)\>\>

Some files were not shown because too many files have changed in this diff Show More