From d1fe398ea0fa5b1a503bfcb62ee05afe6f1ef213 Mon Sep 17 00:00:00 2001 From: Isaac Mann Date: Fri, 22 Sep 2023 14:24:35 -0400 Subject: [PATCH] docs(core): packages to api (#19281) --- .../PULL_REQUEST_TEMPLATE/COMMUNITY_PLUGIN.MD | 2 +- docs/generated/manifests/extending-nx.json | 20 - docs/generated/manifests/menus.json | 738 ++++++----- .../manifests/{packages.json => nx-api.json} | 1112 ++++++++--------- docs/generated/manifests/nx.json | 6 +- docs/generated/manifests/tags.json | 34 +- .../packages/cypress/documents/overview.md | 4 +- .../packages/esbuild/documents/overview.md | 4 +- .../eslint-plugin/documents/overview.md | 4 +- .../packages/expo/documents/overview.md | 4 +- .../packages/jest/documents/overview.md | 4 +- .../packages/linter/documents/overview.md | 6 +- .../packages/nest/documents/overview.md | 2 +- .../packages/node/documents/overview.md | 4 +- .../react-native/documents/overview.md | 6 +- .../packages/react/documents/overview.md | 4 +- .../storybook/documents/best-practices.md | 18 +- .../packages/storybook/documents/overview.md | 8 +- .../storybook/documents/storybook-7-setup.md | 8 +- .../packages/vite/documents/overview.md | 4 +- .../packages/web/documents/overview.md | 8 +- .../packages/webpack/documents/overview.md | 2 +- .../packages/workspace/documents/overview.md | 10 +- docs/map.json | 60 +- .../1-code-generation.md | 2 +- .../4-task-pipelines.md | 2 +- .../angular-tutorial/angular-monorepo.md | 2 +- .../automate-updating-dependencies.md | 4 +- .../core-features/cache-task-results.md | 2 +- docs/shared/core-features/run-tasks.md | 4 +- docs/shared/core-tutorial/02-create-cli.md | 2 +- .../storybook/angular-browser-target.md | 4 +- .../storybook/angular-storybook-targets.md | 2 +- docs/shared/deprecated/workspace-json.md | 2 +- docs/shared/deprecated/workspace-lint.md | 2 +- docs/shared/getting-started/intro.md | 24 +- docs/shared/getting-started/why-nx.md | 2 +- .../guides/define-environment-variables.md | 2 +- docs/shared/guides/js-and-ts.md | 2 +- docs/shared/guides/nx-and-angular-cli.md | 10 +- .../shared/guides/nx-devkit-angular-devkit.md | 2 +- docs/shared/guides/react-native.md | 2 +- ...sing-tailwind-css-with-angular-projects.md | 2 +- docs/shared/guides/why-monorepos.md | 2 +- docs/shared/migration/angular-manual.md | 8 +- docs/shared/migration/from-turborepo.md | 68 +- docs/shared/migration/manual.md | 8 +- docs/shared/migration/migration-angular.md | 4 +- docs/shared/monorepo-ci-azure.md | 2 +- docs/shared/monorepo-ci-circle-ci.md | 2 +- docs/shared/monorepo-ci-github-actions.md | 2 +- docs/shared/monorepo-nx-enterprise.md | 2 +- .../node-server-tutorial/4-task-pipelines.md | 2 +- .../cypress/cypress-component-testing.md | 8 +- .../shared/packages/cypress/cypress-plugin.md | 4 +- .../shared/packages/esbuild/esbuild-plugin.md | 4 +- docs/shared/packages/expo/expo-plugin.md | 4 +- docs/shared/packages/jest/jest-plugin.md | 4 +- docs/shared/packages/linter/eslint-plugin.md | 4 +- docs/shared/packages/linter/linter-plugin.md | 6 +- docs/shared/packages/nest/nest-plugin.md | 2 +- .../shared/packages/next/next-config-setup.md | 2 +- docs/shared/packages/node/node-plugin.md | 4 +- .../react-native/react-native-plugin.md | 6 +- docs/shared/packages/react/react-plugin.md | 4 +- .../packages/storybook/best-practices.md | 18 +- .../packages/storybook/plugin-overview.md | 8 +- .../packages/storybook/storybook-7-setup.md | 8 +- .../packages/vite/set-up-vite-manually.md | 8 +- docs/shared/packages/vite/vite-plugin.md | 4 +- docs/shared/packages/web/web-plugin.md | 8 +- .../packages/webpack/plugin-overview.md | 2 +- .../packages/workspace/workspace-plugin.md | 10 +- .../plugin-features/use-code-generators.md | 2 +- .../plugin-features/use-task-executors.md | 4 +- docs/shared/plugins/intro.md | 2 +- docs/shared/react-tutorial/react-monorepo.md | 2 +- docs/shared/recipes/add-stack/add-astro.md | 4 +- docs/shared/recipes/add-stack/add-express.md | 4 +- docs/shared/recipes/add-stack/add-fastify.md | 2 +- docs/shared/recipes/add-stack/add-lit.md | 4 +- docs/shared/recipes/add-stack/add-solid.md | 6 +- docs/shared/recipes/add-stack/add-svelte.md | 2 +- docs/shared/recipes/add-stack/add-vue.md | 4 +- .../recipes/generators/local-generators.md | 2 +- docs/shared/recipes/node/wait-for-tasks.md | 2 +- .../recipes/plugins/compose-executors.md | 2 +- .../recipes/plugins/create-install-package.md | 2 +- docs/shared/recipes/plugins/create-preset.md | 2 +- .../recipes/plugins/project-graph-plugins.md | 4 +- docs/shared/recipes/root-level-scripts.md | 2 +- .../storybook/angular-configuring-styles.md | 2 +- .../storybook/angular-storybook-compodoc.md | 4 +- .../storybook/configuring-storybook.md | 6 +- .../recipes/storybook/interaction-tests.md | 4 +- .../storybook/one-storybook-for-all.md | 4 +- .../storybook/one-storybook-per-scope.md | 2 +- .../one-storybook-with-composition.md | 2 +- .../recipes/storybook/plugin-angular.md | 18 +- docs/shared/recipes/storybook/plugin-react.md | 20 +- .../storybook/storybook-composition-setup.md | 4 +- .../tips-n-tricks/migrating-to-flat-eslint.md | 2 +- docs/shared/reference/nx-json.md | 2 +- docs/shared/reference/sitemap.md | 719 ++++++----- docs/shared/running-custom-commands.md | 2 +- .../buildable-and-publishable-libraries.md | 2 +- docs/shared/workspace/grouping-libraries.md | 6 +- .../src/lib/documents.api.ts | 2 +- .../feature-doc-viewer/src/lib/doc-viewer.tsx | 2 +- nx-dev/nx-dev/lib/packages.api.ts | 4 +- nx-dev/nx-dev/lib/rspack/content/overview.ts | 4 +- .../lib/rspack/content/rspack-config-setup.ts | 2 +- .../lib/rspack/content/rspack-plugin.ts | 2 +- nx-dev/nx-dev/lib/rspack/pkg.ts | 43 +- .../lib/rspack/schema/executors/dev-server.ts | 2 +- .../lib/rspack/schema/executors/rspack.ts | 2 +- .../rspack/schema/generators/application.ts | 2 +- .../rspack/schema/generators/configuration.ts | 2 +- .../lib/rspack/schema/generators/init.ts | 2 +- nx-dev/nx-dev/pages/[...segments].tsx | 2 +- .../pages/extending-nx/[...segments].tsx | 4 +- .../[name]/documents/[...segments].tsx | 4 +- .../[name]/documents/index.tsx | 2 +- .../[name]/executors/[...segments].tsx | 4 +- .../[name]/executors/index.tsx | 2 +- .../[name]/generators/[...segments].tsx | 4 +- .../[name]/generators/index.tsx | 2 +- .../{packages => nx-api}/[name]/index.tsx | 4 +- .../pages/{packages => nx-api}/index.tsx | 2 +- .../rspack/documents/index.tsx | 2 +- .../rspack/documents/overview.tsx | 2 +- .../rspack/documents/rspack-config-setup.tsx | 2 +- .../rspack/documents/rspack-plugins.tsx | 2 +- .../rspack/executors/dev-server.tsx | 2 +- .../rspack/executors/index.tsx | 2 +- .../rspack/executors/rspack.tsx | 2 +- .../rspack/generators/application.tsx | 2 +- .../rspack/generators/configuration.tsx | 2 +- .../rspack/generators/index.tsx | 2 +- .../rspack/generators/init.tsx | 2 +- .../{packages => nx-api}/rspack/index.tsx | 2 +- .../registry.tsx => plugin-registry.tsx} | 14 +- .../quality-indicators.json | 0 nx-dev/nx-dev/redirect-rules.js | 2 + .../src/lib/documentation-header.tsx | 24 +- .../ui-common/src/lib/sidebar-container.tsx | 24 +- nx-dev/ui-common/src/lib/sidebar.tsx | 10 +- .../generators/generate-manifests.ts | 24 +- .../documentation/internal-link-checker.ts | 6 +- .../plugin-quality-indicators.ts | 4 +- .../create-embeddings/src/main.mts | 2 +- 151 files changed, 1702 insertions(+), 1746 deletions(-) rename docs/generated/manifests/{packages.json => nx-api.json} (79%) rename nx-dev/nx-dev/pages/{packages => nx-api}/[name]/documents/[...segments].tsx (97%) rename nx-dev/nx-dev/pages/{packages => nx-api}/[name]/documents/index.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/[name]/executors/[...segments].tsx (96%) rename nx-dev/nx-dev/pages/{packages => nx-api}/[name]/executors/index.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/[name]/generators/[...segments].tsx (96%) rename nx-dev/nx-dev/pages/{packages => nx-api}/[name]/generators/index.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/[name]/index.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/index.tsx (99%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/documents/index.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/documents/overview.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/documents/rspack-config-setup.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/documents/rspack-plugins.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/executors/dev-server.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/executors/index.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/executors/rspack.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/generators/application.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/generators/configuration.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/generators/index.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/generators/init.tsx (98%) rename nx-dev/nx-dev/pages/{packages => nx-api}/rspack/index.tsx (98%) rename nx-dev/nx-dev/pages/{extending-nx/registry.tsx => plugin-registry.tsx} (91%) rename nx-dev/nx-dev/pages/{extending-nx => }/quality-indicators.json (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/COMMUNITY_PLUGIN.MD b/.github/PULL_REQUEST_TEMPLATE/COMMUNITY_PLUGIN.MD index bb74db7c12361..c725f5c1668aa 100644 --- a/.github/PULL_REQUEST_TEMPLATE/COMMUNITY_PLUGIN.MD +++ b/.github/PULL_REQUEST_TEMPLATE/COMMUNITY_PLUGIN.MD @@ -42,7 +42,7 @@ Example: }] ``` -Once merged, your plugin will be available when running the `nx list` command, and will also be available in the Plugin Registry on [nx.dev](https://nx.dev/extending-nx/registry) +Once merged, your plugin will be available when running the `nx list` command, and will also be available in the Plugin Registry on [nx.dev](https://nx.dev/plugin-registry) --> # Community Plugin Submission diff --git a/docs/generated/manifests/extending-nx.json b/docs/generated/manifests/extending-nx.json index 394afd4a82f26..b3197c0a9fe80 100644 --- a/docs/generated/manifests/extending-nx.json +++ b/docs/generated/manifests/extending-nx.json @@ -14,16 +14,6 @@ "isExternal": false, "path": "/extending-nx/intro/getting-started", "tags": [] - }, - { - "id": "registry", - "name": "Plugin Registry", - "description": "Browse official and community plugins", - "file": "", - "itemList": [], - "isExternal": false, - "path": "/extending-nx/registry", - "tags": [] } ], "isExternal": false, @@ -40,16 +30,6 @@ "path": "/extending-nx/intro/getting-started", "tags": [] }, - "/extending-nx/registry": { - "id": "registry", - "name": "Plugin Registry", - "description": "Browse official and community plugins", - "file": "", - "itemList": [], - "isExternal": false, - "path": "/extending-nx/registry", - "tags": [] - }, "/extending-nx/tutorials": { "id": "tutorials", "name": "5 Min Tutorials", diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index 793b7006a943f..b86887fac6c8b 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -5011,7 +5011,7 @@ }, { "name": "--skip-nx-cache flag", - "path": "/packages/nx/documents/affected#skip-nx-cache", + "path": "/nx-api/nx/documents/affected#skip-nx-cache", "id": "skip-nx-cache-flag", "isExternal": true, "children": [], @@ -5078,7 +5078,7 @@ }, { "name": "--skip-nx-cache flag", - "path": "/packages/nx/documents/affected#skip-nx-cache", + "path": "/nx-api/nx/documents/affected#skip-nx-cache", "id": "skip-nx-cache-flag", "isExternal": true, "children": [], @@ -5150,14 +5150,6 @@ "isExternal": false, "children": [], "disableCollapsible": false - }, - { - "name": "Plugin Registry", - "path": "/extending-nx/registry", - "id": "registry", - "isExternal": false, - "children": [], - "disableCollapsible": false } ], "disableCollapsible": false @@ -5170,14 +5162,6 @@ "children": [], "disableCollapsible": false }, - { - "name": "Plugin Registry", - "path": "/extending-nx/registry", - "id": "registry", - "isExternal": false, - "children": [], - "disableCollapsible": false - }, { "name": "5 Min Tutorials", "path": "/extending-nx/tutorials", @@ -5841,21 +5825,21 @@ ] }, { - "id": "packages", + "id": "nx-api", "menu": [ { "id": "angular", - "path": "/packages/angular", + "path": "/nx-api/angular", "name": "angular", "children": [ { "id": "documents", - "path": "/packages/angular/documents", + "path": "/nx-api/angular/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/angular/documents/overview", + "path": "/nx-api/angular/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -5863,7 +5847,7 @@ }, { "name": "Angular and Nx Version Matrix", - "path": "/packages/angular/documents/angular-nx-version-matrix", + "path": "/nx-api/angular/documents/angular-nx-version-matrix", "id": "angular-nx-version-matrix", "isExternal": false, "children": [], @@ -5875,12 +5859,12 @@ }, { "id": "executors", - "path": "/packages/angular/executors", + "path": "/nx-api/angular/executors", "name": "executors", "children": [ { "id": "delegate-build", - "path": "/packages/angular/executors/delegate-build", + "path": "/nx-api/angular/executors/delegate-build", "name": "delegate-build", "children": [], "isExternal": false, @@ -5888,7 +5872,7 @@ }, { "id": "ng-packagr-lite", - "path": "/packages/angular/executors/ng-packagr-lite", + "path": "/nx-api/angular/executors/ng-packagr-lite", "name": "ng-packagr-lite", "children": [], "isExternal": false, @@ -5896,7 +5880,7 @@ }, { "id": "package", - "path": "/packages/angular/executors/package", + "path": "/nx-api/angular/executors/package", "name": "package", "children": [], "isExternal": false, @@ -5904,7 +5888,7 @@ }, { "id": "browser-esbuild", - "path": "/packages/angular/executors/browser-esbuild", + "path": "/nx-api/angular/executors/browser-esbuild", "name": "browser-esbuild", "children": [], "isExternal": false, @@ -5912,7 +5896,7 @@ }, { "id": "webpack-browser", - "path": "/packages/angular/executors/webpack-browser", + "path": "/nx-api/angular/executors/webpack-browser", "name": "webpack-browser", "children": [], "isExternal": false, @@ -5920,7 +5904,7 @@ }, { "id": "webpack-dev-server", - "path": "/packages/angular/executors/webpack-dev-server", + "path": "/nx-api/angular/executors/webpack-dev-server", "name": "webpack-dev-server", "children": [], "isExternal": false, @@ -5928,7 +5912,7 @@ }, { "id": "webpack-server", - "path": "/packages/angular/executors/webpack-server", + "path": "/nx-api/angular/executors/webpack-server", "name": "webpack-server", "children": [], "isExternal": false, @@ -5936,7 +5920,7 @@ }, { "id": "module-federation-dev-server", - "path": "/packages/angular/executors/module-federation-dev-server", + "path": "/nx-api/angular/executors/module-federation-dev-server", "name": "module-federation-dev-server", "children": [], "isExternal": false, @@ -5944,7 +5928,7 @@ }, { "id": "module-federation-dev-ssr", - "path": "/packages/angular/executors/module-federation-dev-ssr", + "path": "/nx-api/angular/executors/module-federation-dev-ssr", "name": "module-federation-dev-ssr", "children": [], "isExternal": false, @@ -5956,12 +5940,12 @@ }, { "id": "generators", - "path": "/packages/angular/generators", + "path": "/nx-api/angular/generators", "name": "generators", "children": [ { "id": "add-linting", - "path": "/packages/angular/generators/add-linting", + "path": "/nx-api/angular/generators/add-linting", "name": "add-linting", "children": [], "isExternal": false, @@ -5969,7 +5953,7 @@ }, { "id": "application", - "path": "/packages/angular/generators/application", + "path": "/nx-api/angular/generators/application", "name": "application", "children": [], "isExternal": false, @@ -5977,7 +5961,7 @@ }, { "id": "component", - "path": "/packages/angular/generators/component", + "path": "/nx-api/angular/generators/component", "name": "component", "children": [], "isExternal": false, @@ -5985,7 +5969,7 @@ }, { "id": "component-cypress-spec", - "path": "/packages/angular/generators/component-cypress-spec", + "path": "/nx-api/angular/generators/component-cypress-spec", "name": "component-cypress-spec", "children": [], "isExternal": false, @@ -5993,7 +5977,7 @@ }, { "id": "component-story", - "path": "/packages/angular/generators/component-story", + "path": "/nx-api/angular/generators/component-story", "name": "component-story", "children": [], "isExternal": false, @@ -6001,7 +5985,7 @@ }, { "id": "component-test", - "path": "/packages/angular/generators/component-test", + "path": "/nx-api/angular/generators/component-test", "name": "component-test", "children": [], "isExternal": false, @@ -6009,7 +5993,7 @@ }, { "id": "convert-tslint-to-eslint", - "path": "/packages/angular/generators/convert-tslint-to-eslint", + "path": "/nx-api/angular/generators/convert-tslint-to-eslint", "name": "convert-tslint-to-eslint", "children": [], "isExternal": false, @@ -6017,7 +6001,7 @@ }, { "id": "directive", - "path": "/packages/angular/generators/directive", + "path": "/nx-api/angular/generators/directive", "name": "directive", "children": [], "isExternal": false, @@ -6025,7 +6009,7 @@ }, { "id": "init", - "path": "/packages/angular/generators/init", + "path": "/nx-api/angular/generators/init", "name": "init", "children": [], "isExternal": false, @@ -6033,7 +6017,7 @@ }, { "id": "library", - "path": "/packages/angular/generators/library", + "path": "/nx-api/angular/generators/library", "name": "library", "children": [], "isExternal": false, @@ -6041,7 +6025,7 @@ }, { "id": "library-secondary-entry-point", - "path": "/packages/angular/generators/library-secondary-entry-point", + "path": "/nx-api/angular/generators/library-secondary-entry-point", "name": "library-secondary-entry-point", "children": [], "isExternal": false, @@ -6049,7 +6033,7 @@ }, { "id": "remote", - "path": "/packages/angular/generators/remote", + "path": "/nx-api/angular/generators/remote", "name": "remote", "children": [], "isExternal": false, @@ -6057,7 +6041,7 @@ }, { "id": "move", - "path": "/packages/angular/generators/move", + "path": "/nx-api/angular/generators/move", "name": "move", "children": [], "isExternal": false, @@ -6065,7 +6049,7 @@ }, { "id": "convert-to-with-mf", - "path": "/packages/angular/generators/convert-to-with-mf", + "path": "/nx-api/angular/generators/convert-to-with-mf", "name": "convert-to-with-mf", "children": [], "isExternal": false, @@ -6073,7 +6057,7 @@ }, { "id": "host", - "path": "/packages/angular/generators/host", + "path": "/nx-api/angular/generators/host", "name": "host", "children": [], "isExternal": false, @@ -6081,7 +6065,7 @@ }, { "id": "ng-add", - "path": "/packages/angular/generators/ng-add", + "path": "/nx-api/angular/generators/ng-add", "name": "ng-add", "children": [], "isExternal": false, @@ -6089,7 +6073,7 @@ }, { "id": "ngrx", - "path": "/packages/angular/generators/ngrx", + "path": "/nx-api/angular/generators/ngrx", "name": "ngrx", "children": [], "isExternal": false, @@ -6097,7 +6081,7 @@ }, { "id": "ngrx-feature-store", - "path": "/packages/angular/generators/ngrx-feature-store", + "path": "/nx-api/angular/generators/ngrx-feature-store", "name": "ngrx-feature-store", "children": [], "isExternal": false, @@ -6105,7 +6089,7 @@ }, { "id": "ngrx-root-store", - "path": "/packages/angular/generators/ngrx-root-store", + "path": "/nx-api/angular/generators/ngrx-root-store", "name": "ngrx-root-store", "children": [], "isExternal": false, @@ -6113,7 +6097,7 @@ }, { "id": "pipe", - "path": "/packages/angular/generators/pipe", + "path": "/nx-api/angular/generators/pipe", "name": "pipe", "children": [], "isExternal": false, @@ -6121,7 +6105,7 @@ }, { "id": "scam-to-standalone", - "path": "/packages/angular/generators/scam-to-standalone", + "path": "/nx-api/angular/generators/scam-to-standalone", "name": "scam-to-standalone", "children": [], "isExternal": false, @@ -6129,7 +6113,7 @@ }, { "id": "scam", - "path": "/packages/angular/generators/scam", + "path": "/nx-api/angular/generators/scam", "name": "scam", "children": [], "isExternal": false, @@ -6137,7 +6121,7 @@ }, { "id": "scam-directive", - "path": "/packages/angular/generators/scam-directive", + "path": "/nx-api/angular/generators/scam-directive", "name": "scam-directive", "children": [], "isExternal": false, @@ -6145,7 +6129,7 @@ }, { "id": "scam-pipe", - "path": "/packages/angular/generators/scam-pipe", + "path": "/nx-api/angular/generators/scam-pipe", "name": "scam-pipe", "children": [], "isExternal": false, @@ -6153,7 +6137,7 @@ }, { "id": "setup-mf", - "path": "/packages/angular/generators/setup-mf", + "path": "/nx-api/angular/generators/setup-mf", "name": "setup-mf", "children": [], "isExternal": false, @@ -6161,7 +6145,7 @@ }, { "id": "setup-ssr", - "path": "/packages/angular/generators/setup-ssr", + "path": "/nx-api/angular/generators/setup-ssr", "name": "setup-ssr", "children": [], "isExternal": false, @@ -6169,7 +6153,7 @@ }, { "id": "setup-tailwind", - "path": "/packages/angular/generators/setup-tailwind", + "path": "/nx-api/angular/generators/setup-tailwind", "name": "setup-tailwind", "children": [], "isExternal": false, @@ -6177,7 +6161,7 @@ }, { "id": "stories", - "path": "/packages/angular/generators/stories", + "path": "/nx-api/angular/generators/stories", "name": "stories", "children": [], "isExternal": false, @@ -6185,7 +6169,7 @@ }, { "id": "storybook-configuration", - "path": "/packages/angular/generators/storybook-configuration", + "path": "/nx-api/angular/generators/storybook-configuration", "name": "storybook-configuration", "children": [], "isExternal": false, @@ -6193,7 +6177,7 @@ }, { "id": "cypress-component-configuration", - "path": "/packages/angular/generators/cypress-component-configuration", + "path": "/nx-api/angular/generators/cypress-component-configuration", "name": "cypress-component-configuration", "children": [], "isExternal": false, @@ -6201,7 +6185,7 @@ }, { "id": "web-worker", - "path": "/packages/angular/generators/web-worker", + "path": "/nx-api/angular/generators/web-worker", "name": "web-worker", "children": [], "isExternal": false, @@ -6217,7 +6201,7 @@ }, { "id": "create-nx-plugin", - "path": "/packages/create-nx-plugin", + "path": "/nx-api/create-nx-plugin", "name": "create-nx-plugin", "children": [], "isExternal": false, @@ -6225,7 +6209,7 @@ }, { "id": "create-nx-workspace", - "path": "/packages/create-nx-workspace", + "path": "/nx-api/create-nx-workspace", "name": "create-nx-workspace", "children": [], "isExternal": false, @@ -6233,17 +6217,17 @@ }, { "id": "cypress", - "path": "/packages/cypress", + "path": "/nx-api/cypress", "name": "cypress", "children": [ { "id": "documents", - "path": "/packages/cypress/documents", + "path": "/nx-api/cypress/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/cypress/documents/overview", + "path": "/nx-api/cypress/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6255,12 +6239,12 @@ }, { "id": "executors", - "path": "/packages/cypress/executors", + "path": "/nx-api/cypress/executors", "name": "executors", "children": [ { "id": "cypress", - "path": "/packages/cypress/executors/cypress", + "path": "/nx-api/cypress/executors/cypress", "name": "cypress", "children": [], "isExternal": false, @@ -6272,12 +6256,12 @@ }, { "id": "generators", - "path": "/packages/cypress/generators", + "path": "/nx-api/cypress/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/cypress/generators/init", + "path": "/nx-api/cypress/generators/init", "name": "init", "children": [], "isExternal": false, @@ -6285,7 +6269,7 @@ }, { "id": "cypress-project", - "path": "/packages/cypress/generators/cypress-project", + "path": "/nx-api/cypress/generators/cypress-project", "name": "cypress-project", "children": [], "isExternal": false, @@ -6293,7 +6277,7 @@ }, { "id": "configuration", - "path": "/packages/cypress/generators/configuration", + "path": "/nx-api/cypress/generators/configuration", "name": "configuration", "children": [], "isExternal": false, @@ -6301,7 +6285,7 @@ }, { "id": "component-configuration", - "path": "/packages/cypress/generators/component-configuration", + "path": "/nx-api/cypress/generators/component-configuration", "name": "component-configuration", "children": [], "isExternal": false, @@ -6309,7 +6293,7 @@ }, { "id": "migrate-to-cypress-11", - "path": "/packages/cypress/generators/migrate-to-cypress-11", + "path": "/nx-api/cypress/generators/migrate-to-cypress-11", "name": "migrate-to-cypress-11", "children": [], "isExternal": false, @@ -6325,17 +6309,17 @@ }, { "id": "detox", - "path": "/packages/detox", + "path": "/nx-api/detox", "name": "detox", "children": [ { "id": "documents", - "path": "/packages/detox/documents", + "path": "/nx-api/detox/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/detox/documents/overview", + "path": "/nx-api/detox/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6347,12 +6331,12 @@ }, { "id": "executors", - "path": "/packages/detox/executors", + "path": "/nx-api/detox/executors", "name": "executors", "children": [ { "id": "build", - "path": "/packages/detox/executors/build", + "path": "/nx-api/detox/executors/build", "name": "build", "children": [], "isExternal": false, @@ -6360,7 +6344,7 @@ }, { "id": "test", - "path": "/packages/detox/executors/test", + "path": "/nx-api/detox/executors/test", "name": "test", "children": [], "isExternal": false, @@ -6372,12 +6356,12 @@ }, { "id": "generators", - "path": "/packages/detox/generators", + "path": "/nx-api/detox/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/detox/generators/init", + "path": "/nx-api/detox/generators/init", "name": "init", "children": [], "isExternal": false, @@ -6385,7 +6369,7 @@ }, { "id": "application", - "path": "/packages/detox/generators/application", + "path": "/nx-api/detox/generators/application", "name": "application", "children": [], "isExternal": false, @@ -6401,17 +6385,17 @@ }, { "id": "devkit", - "path": "/packages/devkit", + "path": "/nx-api/devkit", "name": "devkit", "children": [ { "id": "documents", - "path": "/packages/devkit/documents", + "path": "/nx-api/devkit/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/devkit/documents/nx_devkit", + "path": "/nx-api/devkit/documents/nx_devkit", "id": "nx_devkit", "isExternal": false, "children": [], @@ -6419,7 +6403,7 @@ }, { "name": "Ng CLI Adapter", - "path": "/packages/devkit/documents/ngcli_adapter", + "path": "/nx-api/devkit/documents/ngcli_adapter", "id": "ngcli_adapter", "isExternal": false, "children": [], @@ -6435,17 +6419,17 @@ }, { "id": "esbuild", - "path": "/packages/esbuild", + "path": "/nx-api/esbuild", "name": "esbuild", "children": [ { "id": "documents", - "path": "/packages/esbuild/documents", + "path": "/nx-api/esbuild/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/esbuild/documents/overview", + "path": "/nx-api/esbuild/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6457,12 +6441,12 @@ }, { "id": "executors", - "path": "/packages/esbuild/executors", + "path": "/nx-api/esbuild/executors", "name": "executors", "children": [ { "id": "esbuild", - "path": "/packages/esbuild/executors/esbuild", + "path": "/nx-api/esbuild/executors/esbuild", "name": "esbuild", "children": [], "isExternal": false, @@ -6474,12 +6458,12 @@ }, { "id": "generators", - "path": "/packages/esbuild/generators", + "path": "/nx-api/esbuild/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/esbuild/generators/init", + "path": "/nx-api/esbuild/generators/init", "name": "init", "children": [], "isExternal": false, @@ -6487,7 +6471,7 @@ }, { "id": "configuration", - "path": "/packages/esbuild/generators/configuration", + "path": "/nx-api/esbuild/generators/configuration", "name": "configuration", "children": [], "isExternal": false, @@ -6503,17 +6487,17 @@ }, { "id": "eslint-plugin", - "path": "/packages/eslint-plugin", + "path": "/nx-api/eslint-plugin", "name": "eslint-plugin", "children": [ { "id": "documents", - "path": "/packages/eslint-plugin/documents", + "path": "/nx-api/eslint-plugin/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/eslint-plugin/documents/overview", + "path": "/nx-api/eslint-plugin/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6521,7 +6505,7 @@ }, { "name": "The `enforce-module-boundaries` rule", - "path": "/packages/eslint-plugin/documents/enforce-module-boundaries", + "path": "/nx-api/eslint-plugin/documents/enforce-module-boundaries", "id": "enforce-module-boundaries", "isExternal": false, "children": [], @@ -6529,7 +6513,7 @@ }, { "name": "The `dependency-checks` rule", - "path": "/packages/eslint-plugin/documents/dependency-checks", + "path": "/nx-api/eslint-plugin/documents/dependency-checks", "id": "dependency-checks", "isExternal": false, "children": [], @@ -6545,17 +6529,17 @@ }, { "id": "expo", - "path": "/packages/expo", + "path": "/nx-api/expo", "name": "expo", "children": [ { "id": "documents", - "path": "/packages/expo/documents", + "path": "/nx-api/expo/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/expo/documents/overview", + "path": "/nx-api/expo/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6567,12 +6551,12 @@ }, { "id": "executors", - "path": "/packages/expo/executors", + "path": "/nx-api/expo/executors", "name": "executors", "children": [ { "id": "update", - "path": "/packages/expo/executors/update", + "path": "/nx-api/expo/executors/update", "name": "update", "children": [], "isExternal": false, @@ -6580,7 +6564,7 @@ }, { "id": "build", - "path": "/packages/expo/executors/build", + "path": "/nx-api/expo/executors/build", "name": "build", "children": [], "isExternal": false, @@ -6588,7 +6572,7 @@ }, { "id": "build-list", - "path": "/packages/expo/executors/build-list", + "path": "/nx-api/expo/executors/build-list", "name": "build-list", "children": [], "isExternal": false, @@ -6596,7 +6580,7 @@ }, { "id": "download", - "path": "/packages/expo/executors/download", + "path": "/nx-api/expo/executors/download", "name": "download", "children": [], "isExternal": false, @@ -6604,7 +6588,7 @@ }, { "id": "run", - "path": "/packages/expo/executors/run", + "path": "/nx-api/expo/executors/run", "name": "run", "children": [], "isExternal": false, @@ -6612,7 +6596,7 @@ }, { "id": "start", - "path": "/packages/expo/executors/start", + "path": "/nx-api/expo/executors/start", "name": "start", "children": [], "isExternal": false, @@ -6620,7 +6604,7 @@ }, { "id": "sync-deps", - "path": "/packages/expo/executors/sync-deps", + "path": "/nx-api/expo/executors/sync-deps", "name": "sync-deps", "children": [], "isExternal": false, @@ -6628,7 +6612,7 @@ }, { "id": "ensure-symlink", - "path": "/packages/expo/executors/ensure-symlink", + "path": "/nx-api/expo/executors/ensure-symlink", "name": "ensure-symlink", "children": [], "isExternal": false, @@ -6636,7 +6620,7 @@ }, { "id": "prebuild", - "path": "/packages/expo/executors/prebuild", + "path": "/nx-api/expo/executors/prebuild", "name": "prebuild", "children": [], "isExternal": false, @@ -6644,7 +6628,7 @@ }, { "id": "install", - "path": "/packages/expo/executors/install", + "path": "/nx-api/expo/executors/install", "name": "install", "children": [], "isExternal": false, @@ -6652,7 +6636,7 @@ }, { "id": "export", - "path": "/packages/expo/executors/export", + "path": "/nx-api/expo/executors/export", "name": "export", "children": [], "isExternal": false, @@ -6660,7 +6644,7 @@ }, { "id": "submit", - "path": "/packages/expo/executors/submit", + "path": "/nx-api/expo/executors/submit", "name": "submit", "children": [], "isExternal": false, @@ -6672,12 +6656,12 @@ }, { "id": "generators", - "path": "/packages/expo/generators", + "path": "/nx-api/expo/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/expo/generators/init", + "path": "/nx-api/expo/generators/init", "name": "init", "children": [], "isExternal": false, @@ -6685,7 +6669,7 @@ }, { "id": "application", - "path": "/packages/expo/generators/application", + "path": "/nx-api/expo/generators/application", "name": "application", "children": [], "isExternal": false, @@ -6693,7 +6677,7 @@ }, { "id": "library", - "path": "/packages/expo/generators/library", + "path": "/nx-api/expo/generators/library", "name": "library", "children": [], "isExternal": false, @@ -6701,7 +6685,7 @@ }, { "id": "component", - "path": "/packages/expo/generators/component", + "path": "/nx-api/expo/generators/component", "name": "component", "children": [], "isExternal": false, @@ -6717,17 +6701,17 @@ }, { "id": "express", - "path": "/packages/express", + "path": "/nx-api/express", "name": "express", "children": [ { "id": "documents", - "path": "/packages/express/documents", + "path": "/nx-api/express/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/express/documents/overview", + "path": "/nx-api/express/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6739,12 +6723,12 @@ }, { "id": "generators", - "path": "/packages/express/generators", + "path": "/nx-api/express/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/express/generators/init", + "path": "/nx-api/express/generators/init", "name": "init", "children": [], "isExternal": false, @@ -6752,7 +6736,7 @@ }, { "id": "application", - "path": "/packages/express/generators/application", + "path": "/nx-api/express/generators/application", "name": "application", "children": [], "isExternal": false, @@ -6768,17 +6752,17 @@ }, { "id": "jest", - "path": "/packages/jest", + "path": "/nx-api/jest", "name": "jest", "children": [ { "id": "documents", - "path": "/packages/jest/documents", + "path": "/nx-api/jest/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/jest/documents/overview", + "path": "/nx-api/jest/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6790,12 +6774,12 @@ }, { "id": "executors", - "path": "/packages/jest/executors", + "path": "/nx-api/jest/executors", "name": "executors", "children": [ { "id": "jest", - "path": "/packages/jest/executors/jest", + "path": "/nx-api/jest/executors/jest", "name": "jest", "children": [], "isExternal": false, @@ -6807,12 +6791,12 @@ }, { "id": "generators", - "path": "/packages/jest/generators", + "path": "/nx-api/jest/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/jest/generators/init", + "path": "/nx-api/jest/generators/init", "name": "init", "children": [], "isExternal": false, @@ -6820,7 +6804,7 @@ }, { "id": "configuration", - "path": "/packages/jest/generators/configuration", + "path": "/nx-api/jest/generators/configuration", "name": "configuration", "children": [], "isExternal": false, @@ -6836,17 +6820,17 @@ }, { "id": "js", - "path": "/packages/js", + "path": "/nx-api/js", "name": "js", "children": [ { "id": "documents", - "path": "/packages/js/documents", + "path": "/nx-api/js/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/js/documents/overview", + "path": "/nx-api/js/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6858,12 +6842,12 @@ }, { "id": "executors", - "path": "/packages/js/executors", + "path": "/nx-api/js/executors", "name": "executors", "children": [ { "id": "tsc", - "path": "/packages/js/executors/tsc", + "path": "/nx-api/js/executors/tsc", "name": "tsc", "children": [], "isExternal": false, @@ -6871,7 +6855,7 @@ }, { "id": "swc", - "path": "/packages/js/executors/swc", + "path": "/nx-api/js/executors/swc", "name": "swc", "children": [], "isExternal": false, @@ -6879,7 +6863,7 @@ }, { "id": "node", - "path": "/packages/js/executors/node", + "path": "/nx-api/js/executors/node", "name": "node", "children": [], "isExternal": false, @@ -6887,7 +6871,7 @@ }, { "id": "release-publish", - "path": "/packages/js/executors/release-publish", + "path": "/nx-api/js/executors/release-publish", "name": "release-publish", "children": [], "isExternal": false, @@ -6895,7 +6879,7 @@ }, { "id": "verdaccio", - "path": "/packages/js/executors/verdaccio", + "path": "/nx-api/js/executors/verdaccio", "name": "verdaccio", "children": [], "isExternal": false, @@ -6907,12 +6891,12 @@ }, { "id": "generators", - "path": "/packages/js/generators", + "path": "/nx-api/js/generators", "name": "generators", "children": [ { "id": "library", - "path": "/packages/js/generators/library", + "path": "/nx-api/js/generators/library", "name": "library", "children": [], "isExternal": false, @@ -6920,7 +6904,7 @@ }, { "id": "init", - "path": "/packages/js/generators/init", + "path": "/nx-api/js/generators/init", "name": "init", "children": [], "isExternal": false, @@ -6928,7 +6912,7 @@ }, { "id": "convert-to-swc", - "path": "/packages/js/generators/convert-to-swc", + "path": "/nx-api/js/generators/convert-to-swc", "name": "convert-to-swc", "children": [], "isExternal": false, @@ -6936,7 +6920,7 @@ }, { "id": "release-version", - "path": "/packages/js/generators/release-version", + "path": "/nx-api/js/generators/release-version", "name": "release-version", "children": [], "isExternal": false, @@ -6944,7 +6928,7 @@ }, { "id": "setup-verdaccio", - "path": "/packages/js/generators/setup-verdaccio", + "path": "/nx-api/js/generators/setup-verdaccio", "name": "setup-verdaccio", "children": [], "isExternal": false, @@ -6952,7 +6936,7 @@ }, { "id": "setup-build", - "path": "/packages/js/generators/setup-build", + "path": "/nx-api/js/generators/setup-build", "name": "setup-build", "children": [], "isExternal": false, @@ -6968,17 +6952,17 @@ }, { "id": "linter", - "path": "/packages/linter", + "path": "/nx-api/linter", "name": "linter", "children": [ { "id": "documents", - "path": "/packages/linter/documents", + "path": "/nx-api/linter/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/linter/documents/overview", + "path": "/nx-api/linter/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -6990,12 +6974,12 @@ }, { "id": "executors", - "path": "/packages/linter/executors", + "path": "/nx-api/linter/executors", "name": "executors", "children": [ { "id": "eslint", - "path": "/packages/linter/executors/eslint", + "path": "/nx-api/linter/executors/eslint", "name": "eslint", "children": [], "isExternal": false, @@ -7007,12 +6991,12 @@ }, { "id": "generators", - "path": "/packages/linter/generators", + "path": "/nx-api/linter/generators", "name": "generators", "children": [ { "id": "workspace-rules-project", - "path": "/packages/linter/generators/workspace-rules-project", + "path": "/nx-api/linter/generators/workspace-rules-project", "name": "workspace-rules-project", "children": [], "isExternal": false, @@ -7020,7 +7004,7 @@ }, { "id": "workspace-rule", - "path": "/packages/linter/generators/workspace-rule", + "path": "/nx-api/linter/generators/workspace-rule", "name": "workspace-rule", "children": [], "isExternal": false, @@ -7028,7 +7012,7 @@ }, { "id": "convert-to-flat-config", - "path": "/packages/linter/generators/convert-to-flat-config", + "path": "/nx-api/linter/generators/convert-to-flat-config", "name": "convert-to-flat-config", "children": [], "isExternal": false, @@ -7044,17 +7028,17 @@ }, { "id": "nest", - "path": "/packages/nest", + "path": "/nx-api/nest", "name": "nest", "children": [ { "id": "documents", - "path": "/packages/nest/documents", + "path": "/nx-api/nest/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/nest/documents/overview", + "path": "/nx-api/nest/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -7066,12 +7050,12 @@ }, { "id": "generators", - "path": "/packages/nest/generators", + "path": "/nx-api/nest/generators", "name": "generators", "children": [ { "id": "application", - "path": "/packages/nest/generators/application", + "path": "/nx-api/nest/generators/application", "name": "application", "children": [], "isExternal": false, @@ -7079,7 +7063,7 @@ }, { "id": "convert-tslint-to-eslint", - "path": "/packages/nest/generators/convert-tslint-to-eslint", + "path": "/nx-api/nest/generators/convert-tslint-to-eslint", "name": "convert-tslint-to-eslint", "children": [], "isExternal": false, @@ -7087,7 +7071,7 @@ }, { "id": "init", - "path": "/packages/nest/generators/init", + "path": "/nx-api/nest/generators/init", "name": "init", "children": [], "isExternal": false, @@ -7095,7 +7079,7 @@ }, { "id": "library", - "path": "/packages/nest/generators/library", + "path": "/nx-api/nest/generators/library", "name": "library", "children": [], "isExternal": false, @@ -7103,7 +7087,7 @@ }, { "id": "class", - "path": "/packages/nest/generators/class", + "path": "/nx-api/nest/generators/class", "name": "class", "children": [], "isExternal": false, @@ -7111,7 +7095,7 @@ }, { "id": "controller", - "path": "/packages/nest/generators/controller", + "path": "/nx-api/nest/generators/controller", "name": "controller", "children": [], "isExternal": false, @@ -7119,7 +7103,7 @@ }, { "id": "decorator", - "path": "/packages/nest/generators/decorator", + "path": "/nx-api/nest/generators/decorator", "name": "decorator", "children": [], "isExternal": false, @@ -7127,7 +7111,7 @@ }, { "id": "filter", - "path": "/packages/nest/generators/filter", + "path": "/nx-api/nest/generators/filter", "name": "filter", "children": [], "isExternal": false, @@ -7135,7 +7119,7 @@ }, { "id": "gateway", - "path": "/packages/nest/generators/gateway", + "path": "/nx-api/nest/generators/gateway", "name": "gateway", "children": [], "isExternal": false, @@ -7143,7 +7127,7 @@ }, { "id": "guard", - "path": "/packages/nest/generators/guard", + "path": "/nx-api/nest/generators/guard", "name": "guard", "children": [], "isExternal": false, @@ -7151,7 +7135,7 @@ }, { "id": "interceptor", - "path": "/packages/nest/generators/interceptor", + "path": "/nx-api/nest/generators/interceptor", "name": "interceptor", "children": [], "isExternal": false, @@ -7159,7 +7143,7 @@ }, { "id": "interface", - "path": "/packages/nest/generators/interface", + "path": "/nx-api/nest/generators/interface", "name": "interface", "children": [], "isExternal": false, @@ -7167,7 +7151,7 @@ }, { "id": "middleware", - "path": "/packages/nest/generators/middleware", + "path": "/nx-api/nest/generators/middleware", "name": "middleware", "children": [], "isExternal": false, @@ -7175,7 +7159,7 @@ }, { "id": "module", - "path": "/packages/nest/generators/module", + "path": "/nx-api/nest/generators/module", "name": "module", "children": [], "isExternal": false, @@ -7183,7 +7167,7 @@ }, { "id": "pipe", - "path": "/packages/nest/generators/pipe", + "path": "/nx-api/nest/generators/pipe", "name": "pipe", "children": [], "isExternal": false, @@ -7191,7 +7175,7 @@ }, { "id": "provider", - "path": "/packages/nest/generators/provider", + "path": "/nx-api/nest/generators/provider", "name": "provider", "children": [], "isExternal": false, @@ -7199,7 +7183,7 @@ }, { "id": "resolver", - "path": "/packages/nest/generators/resolver", + "path": "/nx-api/nest/generators/resolver", "name": "resolver", "children": [], "isExternal": false, @@ -7207,7 +7191,7 @@ }, { "id": "resource", - "path": "/packages/nest/generators/resource", + "path": "/nx-api/nest/generators/resource", "name": "resource", "children": [], "isExternal": false, @@ -7215,7 +7199,7 @@ }, { "id": "service", - "path": "/packages/nest/generators/service", + "path": "/nx-api/nest/generators/service", "name": "service", "children": [], "isExternal": false, @@ -7231,17 +7215,17 @@ }, { "id": "next", - "path": "/packages/next", + "path": "/nx-api/next", "name": "next", "children": [ { "id": "documents", - "path": "/packages/next/documents", + "path": "/nx-api/next/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/next/documents/overview", + "path": "/nx-api/next/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -7253,12 +7237,12 @@ }, { "id": "executors", - "path": "/packages/next/executors", + "path": "/nx-api/next/executors", "name": "executors", "children": [ { "id": "build", - "path": "/packages/next/executors/build", + "path": "/nx-api/next/executors/build", "name": "build", "children": [], "isExternal": false, @@ -7266,7 +7250,7 @@ }, { "id": "server", - "path": "/packages/next/executors/server", + "path": "/nx-api/next/executors/server", "name": "server", "children": [], "isExternal": false, @@ -7274,7 +7258,7 @@ }, { "id": "export", - "path": "/packages/next/executors/export", + "path": "/nx-api/next/executors/export", "name": "export", "children": [], "isExternal": false, @@ -7286,12 +7270,12 @@ }, { "id": "generators", - "path": "/packages/next/generators", + "path": "/nx-api/next/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/next/generators/init", + "path": "/nx-api/next/generators/init", "name": "init", "children": [], "isExternal": false, @@ -7299,7 +7283,7 @@ }, { "id": "application", - "path": "/packages/next/generators/application", + "path": "/nx-api/next/generators/application", "name": "application", "children": [], "isExternal": false, @@ -7307,7 +7291,7 @@ }, { "id": "page", - "path": "/packages/next/generators/page", + "path": "/nx-api/next/generators/page", "name": "page", "children": [], "isExternal": false, @@ -7315,7 +7299,7 @@ }, { "id": "component", - "path": "/packages/next/generators/component", + "path": "/nx-api/next/generators/component", "name": "component", "children": [], "isExternal": false, @@ -7323,7 +7307,7 @@ }, { "id": "library", - "path": "/packages/next/generators/library", + "path": "/nx-api/next/generators/library", "name": "library", "children": [], "isExternal": false, @@ -7331,7 +7315,7 @@ }, { "id": "custom-server", - "path": "/packages/next/generators/custom-server", + "path": "/nx-api/next/generators/custom-server", "name": "custom-server", "children": [], "isExternal": false, @@ -7339,7 +7323,7 @@ }, { "id": "cypress-component-configuration", - "path": "/packages/next/generators/cypress-component-configuration", + "path": "/nx-api/next/generators/cypress-component-configuration", "name": "cypress-component-configuration", "children": [], "isExternal": false, @@ -7355,17 +7339,17 @@ }, { "id": "node", - "path": "/packages/node", + "path": "/nx-api/node", "name": "node", "children": [ { "id": "documents", - "path": "/packages/node/documents", + "path": "/nx-api/node/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/node/documents/overview", + "path": "/nx-api/node/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -7377,12 +7361,12 @@ }, { "id": "generators", - "path": "/packages/node/generators", + "path": "/nx-api/node/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/node/generators/init", + "path": "/nx-api/node/generators/init", "name": "init", "children": [], "isExternal": false, @@ -7390,7 +7374,7 @@ }, { "id": "application", - "path": "/packages/node/generators/application", + "path": "/nx-api/node/generators/application", "name": "application", "children": [], "isExternal": false, @@ -7398,7 +7382,7 @@ }, { "id": "library", - "path": "/packages/node/generators/library", + "path": "/nx-api/node/generators/library", "name": "library", "children": [], "isExternal": false, @@ -7406,7 +7390,7 @@ }, { "id": "setup-docker", - "path": "/packages/node/generators/setup-docker", + "path": "/nx-api/node/generators/setup-docker", "name": "setup-docker", "children": [], "isExternal": false, @@ -7422,17 +7406,17 @@ }, { "id": "nx", - "path": "/packages/nx", + "path": "/nx-api/nx", "name": "nx", "children": [ { "id": "documents", - "path": "/packages/nx/documents", + "path": "/nx-api/nx/documents", "name": "documents", "children": [ { "name": "create-nx-workspace", - "path": "/packages/nx/documents/create-nx-workspace", + "path": "/nx-api/nx/documents/create-nx-workspace", "id": "create-nx-workspace", "isExternal": false, "children": [], @@ -7440,7 +7424,7 @@ }, { "name": "init", - "path": "/packages/nx/documents/init", + "path": "/nx-api/nx/documents/init", "id": "init", "isExternal": false, "children": [], @@ -7448,7 +7432,7 @@ }, { "name": "generate", - "path": "/packages/nx/documents/generate", + "path": "/nx-api/nx/documents/generate", "id": "generate", "isExternal": false, "children": [], @@ -7456,7 +7440,7 @@ }, { "name": "run", - "path": "/packages/nx/documents/run", + "path": "/nx-api/nx/documents/run", "id": "run", "isExternal": false, "children": [], @@ -7464,7 +7448,7 @@ }, { "name": "daemon", - "path": "/packages/nx/documents/daemon", + "path": "/nx-api/nx/documents/daemon", "id": "daemon", "isExternal": false, "children": [], @@ -7472,7 +7456,7 @@ }, { "name": "graph", - "path": "/packages/nx/documents/dep-graph", + "path": "/nx-api/nx/documents/dep-graph", "id": "dep-graph", "isExternal": false, "children": [], @@ -7480,7 +7464,7 @@ }, { "name": "run-many", - "path": "/packages/nx/documents/run-many", + "path": "/nx-api/nx/documents/run-many", "id": "run-many", "isExternal": false, "children": [], @@ -7488,7 +7472,7 @@ }, { "name": "affected", - "path": "/packages/nx/documents/affected", + "path": "/nx-api/nx/documents/affected", "id": "affected", "isExternal": false, "children": [], @@ -7496,7 +7480,7 @@ }, { "name": "affected:graph", - "path": "/packages/nx/documents/affected-dep-graph", + "path": "/nx-api/nx/documents/affected-dep-graph", "id": "affected-dep-graph", "isExternal": false, "children": [], @@ -7504,7 +7488,7 @@ }, { "name": "print-affected", - "path": "/packages/nx/documents/print-affected", + "path": "/nx-api/nx/documents/print-affected", "id": "print-affected", "isExternal": false, "children": [], @@ -7512,7 +7496,7 @@ }, { "name": "format:check", - "path": "/packages/nx/documents/format-check", + "path": "/nx-api/nx/documents/format-check", "id": "format-check", "isExternal": false, "children": [], @@ -7520,7 +7504,7 @@ }, { "name": "format:write", - "path": "/packages/nx/documents/format-write", + "path": "/nx-api/nx/documents/format-write", "id": "format-write", "isExternal": false, "children": [], @@ -7528,7 +7512,7 @@ }, { "name": "migrate", - "path": "/packages/nx/documents/migrate", + "path": "/nx-api/nx/documents/migrate", "id": "migrate", "isExternal": false, "children": [], @@ -7536,7 +7520,7 @@ }, { "name": "report", - "path": "/packages/nx/documents/report", + "path": "/nx-api/nx/documents/report", "id": "report", "isExternal": false, "children": [], @@ -7544,7 +7528,7 @@ }, { "name": "list", - "path": "/packages/nx/documents/list", + "path": "/nx-api/nx/documents/list", "id": "list", "isExternal": false, "children": [], @@ -7552,7 +7536,7 @@ }, { "name": "workspace-lint", - "path": "/packages/nx/documents/workspace-lint", + "path": "/nx-api/nx/documents/workspace-lint", "id": "workspace-lint", "isExternal": false, "children": [], @@ -7560,7 +7544,7 @@ }, { "name": "workspace-generator", - "path": "/packages/nx/documents/workspace-generator", + "path": "/nx-api/nx/documents/workspace-generator", "id": "workspace-generator", "isExternal": false, "children": [], @@ -7568,7 +7552,7 @@ }, { "name": "connect-to-nx-cloud", - "path": "/packages/nx/documents/connect-to-nx-cloud", + "path": "/nx-api/nx/documents/connect-to-nx-cloud", "id": "connect-to-nx-cloud", "isExternal": false, "children": [], @@ -7576,7 +7560,7 @@ }, { "name": "reset", - "path": "/packages/nx/documents/reset", + "path": "/nx-api/nx/documents/reset", "id": "reset", "isExternal": false, "children": [], @@ -7584,7 +7568,7 @@ }, { "name": "repair", - "path": "/packages/nx/documents/repair", + "path": "/nx-api/nx/documents/repair", "id": "repair", "isExternal": false, "children": [], @@ -7592,7 +7576,7 @@ }, { "name": "exec", - "path": "/packages/nx/documents/exec", + "path": "/nx-api/nx/documents/exec", "id": "exec", "isExternal": false, "children": [], @@ -7600,7 +7584,7 @@ }, { "name": "watch", - "path": "/packages/nx/documents/watch", + "path": "/nx-api/nx/documents/watch", "id": "watch", "isExternal": false, "children": [], @@ -7608,7 +7592,7 @@ }, { "name": "show", - "path": "/packages/nx/documents/show", + "path": "/nx-api/nx/documents/show", "id": "show", "isExternal": false, "children": [], @@ -7616,7 +7600,7 @@ }, { "name": "view-logs", - "path": "/packages/nx/documents/view-logs", + "path": "/nx-api/nx/documents/view-logs", "id": "view-logs", "isExternal": false, "children": [], @@ -7624,7 +7608,7 @@ }, { "name": "release", - "path": "/packages/nx/documents/release", + "path": "/nx-api/nx/documents/release", "id": "release", "isExternal": false, "children": [], @@ -7636,12 +7620,12 @@ }, { "id": "executors", - "path": "/packages/nx/executors", + "path": "/nx-api/nx/executors", "name": "executors", "children": [ { "id": "noop", - "path": "/packages/nx/executors/noop", + "path": "/nx-api/nx/executors/noop", "name": "noop", "children": [], "isExternal": false, @@ -7649,7 +7633,7 @@ }, { "id": "run-commands", - "path": "/packages/nx/executors/run-commands", + "path": "/nx-api/nx/executors/run-commands", "name": "run-commands", "children": [], "isExternal": false, @@ -7657,7 +7641,7 @@ }, { "id": "run-script", - "path": "/packages/nx/executors/run-script", + "path": "/nx-api/nx/executors/run-script", "name": "run-script", "children": [], "isExternal": false, @@ -7673,17 +7657,17 @@ }, { "id": "playwright", - "path": "/packages/playwright", + "path": "/nx-api/playwright", "name": "playwright", "children": [ { "id": "documents", - "path": "/packages/playwright/documents", + "path": "/nx-api/playwright/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/playwright/documents/overview", + "path": "/nx-api/playwright/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -7695,12 +7679,12 @@ }, { "id": "executors", - "path": "/packages/playwright/executors", + "path": "/nx-api/playwright/executors", "name": "executors", "children": [ { "id": "playwright", - "path": "/packages/playwright/executors/playwright", + "path": "/nx-api/playwright/executors/playwright", "name": "playwright", "children": [], "isExternal": false, @@ -7712,12 +7696,12 @@ }, { "id": "generators", - "path": "/packages/playwright/generators", + "path": "/nx-api/playwright/generators", "name": "generators", "children": [ { "id": "configuration", - "path": "/packages/playwright/generators/configuration", + "path": "/nx-api/playwright/generators/configuration", "name": "configuration", "children": [], "isExternal": false, @@ -7725,7 +7709,7 @@ }, { "id": "init", - "path": "/packages/playwright/generators/init", + "path": "/nx-api/playwright/generators/init", "name": "init", "children": [], "isExternal": false, @@ -7741,17 +7725,17 @@ }, { "id": "plugin", - "path": "/packages/plugin", + "path": "/nx-api/plugin", "name": "plugin", "children": [ { "id": "documents", - "path": "/packages/plugin/documents", + "path": "/nx-api/plugin/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/plugin/documents/overview", + "path": "/nx-api/plugin/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -7763,12 +7747,12 @@ }, { "id": "executors", - "path": "/packages/plugin/executors", + "path": "/nx-api/plugin/executors", "name": "executors", "children": [ { "id": "e2e", - "path": "/packages/plugin/executors/e2e", + "path": "/nx-api/plugin/executors/e2e", "name": "e2e", "children": [], "isExternal": false, @@ -7780,12 +7764,12 @@ }, { "id": "generators", - "path": "/packages/plugin/generators", + "path": "/nx-api/plugin/generators", "name": "generators", "children": [ { "id": "plugin", - "path": "/packages/plugin/generators/plugin", + "path": "/nx-api/plugin/generators/plugin", "name": "plugin", "children": [], "isExternal": false, @@ -7793,7 +7777,7 @@ }, { "id": "create-package", - "path": "/packages/plugin/generators/create-package", + "path": "/nx-api/plugin/generators/create-package", "name": "create-package", "children": [], "isExternal": false, @@ -7801,7 +7785,7 @@ }, { "id": "e2e-project", - "path": "/packages/plugin/generators/e2e-project", + "path": "/nx-api/plugin/generators/e2e-project", "name": "e2e-project", "children": [], "isExternal": false, @@ -7809,7 +7793,7 @@ }, { "id": "migration", - "path": "/packages/plugin/generators/migration", + "path": "/nx-api/plugin/generators/migration", "name": "migration", "children": [], "isExternal": false, @@ -7817,7 +7801,7 @@ }, { "id": "generator", - "path": "/packages/plugin/generators/generator", + "path": "/nx-api/plugin/generators/generator", "name": "generator", "children": [], "isExternal": false, @@ -7825,7 +7809,7 @@ }, { "id": "executor", - "path": "/packages/plugin/generators/executor", + "path": "/nx-api/plugin/generators/executor", "name": "executor", "children": [], "isExternal": false, @@ -7833,7 +7817,7 @@ }, { "id": "plugin-lint-checks", - "path": "/packages/plugin/generators/plugin-lint-checks", + "path": "/nx-api/plugin/generators/plugin-lint-checks", "name": "plugin-lint-checks", "children": [], "isExternal": false, @@ -7841,7 +7825,7 @@ }, { "id": "preset", - "path": "/packages/plugin/generators/preset", + "path": "/nx-api/plugin/generators/preset", "name": "preset", "children": [], "isExternal": false, @@ -7857,17 +7841,17 @@ }, { "id": "react", - "path": "/packages/react", + "path": "/nx-api/react", "name": "react", "children": [ { "id": "documents", - "path": "/packages/react/documents", + "path": "/nx-api/react/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/react/documents/overview", + "path": "/nx-api/react/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -7879,12 +7863,12 @@ }, { "id": "executors", - "path": "/packages/react/executors", + "path": "/nx-api/react/executors", "name": "executors", "children": [ { "id": "module-federation-dev-server", - "path": "/packages/react/executors/module-federation-dev-server", + "path": "/nx-api/react/executors/module-federation-dev-server", "name": "module-federation-dev-server", "children": [], "isExternal": false, @@ -7892,7 +7876,7 @@ }, { "id": "module-federation-ssr-dev-server", - "path": "/packages/react/executors/module-federation-ssr-dev-server", + "path": "/nx-api/react/executors/module-federation-ssr-dev-server", "name": "module-federation-ssr-dev-server", "children": [], "isExternal": false, @@ -7904,12 +7888,12 @@ }, { "id": "generators", - "path": "/packages/react/generators", + "path": "/nx-api/react/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/react/generators/init", + "path": "/nx-api/react/generators/init", "name": "init", "children": [], "isExternal": false, @@ -7917,7 +7901,7 @@ }, { "id": "application", - "path": "/packages/react/generators/application", + "path": "/nx-api/react/generators/application", "name": "application", "children": [], "isExternal": false, @@ -7925,7 +7909,7 @@ }, { "id": "library", - "path": "/packages/react/generators/library", + "path": "/nx-api/react/generators/library", "name": "library", "children": [], "isExternal": false, @@ -7933,7 +7917,7 @@ }, { "id": "component", - "path": "/packages/react/generators/component", + "path": "/nx-api/react/generators/component", "name": "component", "children": [], "isExternal": false, @@ -7941,7 +7925,7 @@ }, { "id": "redux", - "path": "/packages/react/generators/redux", + "path": "/nx-api/react/generators/redux", "name": "redux", "children": [], "isExternal": false, @@ -7949,7 +7933,7 @@ }, { "id": "storybook-configuration", - "path": "/packages/react/generators/storybook-configuration", + "path": "/nx-api/react/generators/storybook-configuration", "name": "storybook-configuration", "children": [], "isExternal": false, @@ -7957,7 +7941,7 @@ }, { "id": "component-story", - "path": "/packages/react/generators/component-story", + "path": "/nx-api/react/generators/component-story", "name": "component-story", "children": [], "isExternal": false, @@ -7965,7 +7949,7 @@ }, { "id": "stories", - "path": "/packages/react/generators/stories", + "path": "/nx-api/react/generators/stories", "name": "stories", "children": [], "isExternal": false, @@ -7973,7 +7957,7 @@ }, { "id": "component-cypress-spec", - "path": "/packages/react/generators/component-cypress-spec", + "path": "/nx-api/react/generators/component-cypress-spec", "name": "component-cypress-spec", "children": [], "isExternal": false, @@ -7981,7 +7965,7 @@ }, { "id": "hook", - "path": "/packages/react/generators/hook", + "path": "/nx-api/react/generators/hook", "name": "hook", "children": [], "isExternal": false, @@ -7989,7 +7973,7 @@ }, { "id": "host", - "path": "/packages/react/generators/host", + "path": "/nx-api/react/generators/host", "name": "host", "children": [], "isExternal": false, @@ -7997,7 +7981,7 @@ }, { "id": "remote", - "path": "/packages/react/generators/remote", + "path": "/nx-api/react/generators/remote", "name": "remote", "children": [], "isExternal": false, @@ -8005,7 +7989,7 @@ }, { "id": "cypress-component-configuration", - "path": "/packages/react/generators/cypress-component-configuration", + "path": "/nx-api/react/generators/cypress-component-configuration", "name": "cypress-component-configuration", "children": [], "isExternal": false, @@ -8013,7 +7997,7 @@ }, { "id": "component-test", - "path": "/packages/react/generators/component-test", + "path": "/nx-api/react/generators/component-test", "name": "component-test", "children": [], "isExternal": false, @@ -8021,7 +8005,7 @@ }, { "id": "setup-tailwind", - "path": "/packages/react/generators/setup-tailwind", + "path": "/nx-api/react/generators/setup-tailwind", "name": "setup-tailwind", "children": [], "isExternal": false, @@ -8029,7 +8013,7 @@ }, { "id": "setup-ssr", - "path": "/packages/react/generators/setup-ssr", + "path": "/nx-api/react/generators/setup-ssr", "name": "setup-ssr", "children": [], "isExternal": false, @@ -8045,17 +8029,17 @@ }, { "id": "react-native", - "path": "/packages/react-native", + "path": "/nx-api/react-native", "name": "react-native", "children": [ { "id": "documents", - "path": "/packages/react-native/documents", + "path": "/nx-api/react-native/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/react-native/documents/overview", + "path": "/nx-api/react-native/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -8067,12 +8051,12 @@ }, { "id": "executors", - "path": "/packages/react-native/executors", + "path": "/nx-api/react-native/executors", "name": "executors", "children": [ { "id": "run-android", - "path": "/packages/react-native/executors/run-android", + "path": "/nx-api/react-native/executors/run-android", "name": "run-android", "children": [], "isExternal": false, @@ -8080,7 +8064,7 @@ }, { "id": "run-ios", - "path": "/packages/react-native/executors/run-ios", + "path": "/nx-api/react-native/executors/run-ios", "name": "run-ios", "children": [], "isExternal": false, @@ -8088,7 +8072,7 @@ }, { "id": "bundle", - "path": "/packages/react-native/executors/bundle", + "path": "/nx-api/react-native/executors/bundle", "name": "bundle", "children": [], "isExternal": false, @@ -8096,7 +8080,7 @@ }, { "id": "build-android", - "path": "/packages/react-native/executors/build-android", + "path": "/nx-api/react-native/executors/build-android", "name": "build-android", "children": [], "isExternal": false, @@ -8104,7 +8088,7 @@ }, { "id": "build-ios", - "path": "/packages/react-native/executors/build-ios", + "path": "/nx-api/react-native/executors/build-ios", "name": "build-ios", "children": [], "isExternal": false, @@ -8112,7 +8096,7 @@ }, { "id": "start", - "path": "/packages/react-native/executors/start", + "path": "/nx-api/react-native/executors/start", "name": "start", "children": [], "isExternal": false, @@ -8120,7 +8104,7 @@ }, { "id": "sync-deps", - "path": "/packages/react-native/executors/sync-deps", + "path": "/nx-api/react-native/executors/sync-deps", "name": "sync-deps", "children": [], "isExternal": false, @@ -8128,7 +8112,7 @@ }, { "id": "ensure-symlink", - "path": "/packages/react-native/executors/ensure-symlink", + "path": "/nx-api/react-native/executors/ensure-symlink", "name": "ensure-symlink", "children": [], "isExternal": false, @@ -8136,7 +8120,7 @@ }, { "id": "storybook", - "path": "/packages/react-native/executors/storybook", + "path": "/nx-api/react-native/executors/storybook", "name": "storybook", "children": [], "isExternal": false, @@ -8144,7 +8128,7 @@ }, { "id": "pod-install", - "path": "/packages/react-native/executors/pod-install", + "path": "/nx-api/react-native/executors/pod-install", "name": "pod-install", "children": [], "isExternal": false, @@ -8156,12 +8140,12 @@ }, { "id": "generators", - "path": "/packages/react-native/generators", + "path": "/nx-api/react-native/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/react-native/generators/init", + "path": "/nx-api/react-native/generators/init", "name": "init", "children": [], "isExternal": false, @@ -8169,7 +8153,7 @@ }, { "id": "application", - "path": "/packages/react-native/generators/application", + "path": "/nx-api/react-native/generators/application", "name": "application", "children": [], "isExternal": false, @@ -8177,7 +8161,7 @@ }, { "id": "library", - "path": "/packages/react-native/generators/library", + "path": "/nx-api/react-native/generators/library", "name": "library", "children": [], "isExternal": false, @@ -8185,7 +8169,7 @@ }, { "id": "component", - "path": "/packages/react-native/generators/component", + "path": "/nx-api/react-native/generators/component", "name": "component", "children": [], "isExternal": false, @@ -8193,7 +8177,7 @@ }, { "id": "storybook-configuration", - "path": "/packages/react-native/generators/storybook-configuration", + "path": "/nx-api/react-native/generators/storybook-configuration", "name": "storybook-configuration", "children": [], "isExternal": false, @@ -8201,7 +8185,7 @@ }, { "id": "component-story", - "path": "/packages/react-native/generators/component-story", + "path": "/nx-api/react-native/generators/component-story", "name": "component-story", "children": [], "isExternal": false, @@ -8209,7 +8193,7 @@ }, { "id": "stories", - "path": "/packages/react-native/generators/stories", + "path": "/nx-api/react-native/generators/stories", "name": "stories", "children": [], "isExternal": false, @@ -8217,7 +8201,7 @@ }, { "id": "upgrade-native", - "path": "/packages/react-native/generators/upgrade-native", + "path": "/nx-api/react-native/generators/upgrade-native", "name": "upgrade-native", "children": [], "isExternal": false, @@ -8233,17 +8217,17 @@ }, { "id": "rollup", - "path": "/packages/rollup", + "path": "/nx-api/rollup", "name": "rollup", "children": [ { "id": "executors", - "path": "/packages/rollup/executors", + "path": "/nx-api/rollup/executors", "name": "executors", "children": [ { "id": "rollup", - "path": "/packages/rollup/executors/rollup", + "path": "/nx-api/rollup/executors/rollup", "name": "rollup", "children": [], "isExternal": false, @@ -8255,12 +8239,12 @@ }, { "id": "generators", - "path": "/packages/rollup/generators", + "path": "/nx-api/rollup/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/rollup/generators/init", + "path": "/nx-api/rollup/generators/init", "name": "init", "children": [], "isExternal": false, @@ -8268,7 +8252,7 @@ }, { "id": "configuration", - "path": "/packages/rollup/generators/configuration", + "path": "/nx-api/rollup/generators/configuration", "name": "configuration", "children": [], "isExternal": false, @@ -8284,17 +8268,17 @@ }, { "id": "storybook", - "path": "/packages/storybook", + "path": "/nx-api/storybook", "name": "storybook", "children": [ { "id": "documents", - "path": "/packages/storybook/documents", + "path": "/nx-api/storybook/documents", "name": "documents", "children": [ { "name": "Nx Storybook Plugin Overview", - "path": "/packages/storybook/documents/overview", + "path": "/nx-api/storybook/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -8302,7 +8286,7 @@ }, { "name": "Storybook best practices for making the most out of Nx", - "path": "/packages/storybook/documents/best-practices", + "path": "/nx-api/storybook/documents/best-practices", "id": "best-practices", "isExternal": false, "children": [], @@ -8310,7 +8294,7 @@ }, { "name": "Storybook 7 overview", - "path": "/packages/storybook/documents/storybook-7-setup", + "path": "/nx-api/storybook/documents/storybook-7-setup", "id": "storybook-7-setup", "isExternal": false, "children": [], @@ -8322,12 +8306,12 @@ }, { "id": "executors", - "path": "/packages/storybook/executors", + "path": "/nx-api/storybook/executors", "name": "executors", "children": [ { "id": "storybook", - "path": "/packages/storybook/executors/storybook", + "path": "/nx-api/storybook/executors/storybook", "name": "storybook", "children": [], "isExternal": false, @@ -8335,7 +8319,7 @@ }, { "id": "build", - "path": "/packages/storybook/executors/build", + "path": "/nx-api/storybook/executors/build", "name": "build", "children": [], "isExternal": false, @@ -8347,12 +8331,12 @@ }, { "id": "generators", - "path": "/packages/storybook/generators", + "path": "/nx-api/storybook/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/storybook/generators/init", + "path": "/nx-api/storybook/generators/init", "name": "init", "children": [], "isExternal": false, @@ -8360,7 +8344,7 @@ }, { "id": "configuration", - "path": "/packages/storybook/generators/configuration", + "path": "/nx-api/storybook/generators/configuration", "name": "configuration", "children": [], "isExternal": false, @@ -8368,7 +8352,7 @@ }, { "id": "cypress-project", - "path": "/packages/storybook/generators/cypress-project", + "path": "/nx-api/storybook/generators/cypress-project", "name": "cypress-project", "children": [], "isExternal": false, @@ -8376,7 +8360,7 @@ }, { "id": "migrate-7", - "path": "/packages/storybook/generators/migrate-7", + "path": "/nx-api/storybook/generators/migrate-7", "name": "migrate-7", "children": [], "isExternal": false, @@ -8392,7 +8376,7 @@ }, { "id": "tao", - "path": "/packages/tao", + "path": "/nx-api/tao", "name": "tao", "children": [], "isExternal": false, @@ -8400,17 +8384,17 @@ }, { "id": "vite", - "path": "/packages/vite", + "path": "/nx-api/vite", "name": "vite", "children": [ { "id": "documents", - "path": "/packages/vite/documents", + "path": "/nx-api/vite/documents", "name": "documents", "children": [ { "name": "Overview of the Nx Vite Plugin", - "path": "/packages/vite/documents/overview", + "path": "/nx-api/vite/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -8422,12 +8406,12 @@ }, { "id": "executors", - "path": "/packages/vite/executors", + "path": "/nx-api/vite/executors", "name": "executors", "children": [ { "id": "dev-server", - "path": "/packages/vite/executors/dev-server", + "path": "/nx-api/vite/executors/dev-server", "name": "dev-server", "children": [], "isExternal": false, @@ -8435,7 +8419,7 @@ }, { "id": "build", - "path": "/packages/vite/executors/build", + "path": "/nx-api/vite/executors/build", "name": "build", "children": [], "isExternal": false, @@ -8443,7 +8427,7 @@ }, { "id": "test", - "path": "/packages/vite/executors/test", + "path": "/nx-api/vite/executors/test", "name": "test", "children": [], "isExternal": false, @@ -8451,7 +8435,7 @@ }, { "id": "preview-server", - "path": "/packages/vite/executors/preview-server", + "path": "/nx-api/vite/executors/preview-server", "name": "preview-server", "children": [], "isExternal": false, @@ -8463,12 +8447,12 @@ }, { "id": "generators", - "path": "/packages/vite/generators", + "path": "/nx-api/vite/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/vite/generators/init", + "path": "/nx-api/vite/generators/init", "name": "init", "children": [], "isExternal": false, @@ -8476,7 +8460,7 @@ }, { "id": "configuration", - "path": "/packages/vite/generators/configuration", + "path": "/nx-api/vite/generators/configuration", "name": "configuration", "children": [], "isExternal": false, @@ -8484,7 +8468,7 @@ }, { "id": "vitest", - "path": "/packages/vite/generators/vitest", + "path": "/nx-api/vite/generators/vitest", "name": "vitest", "children": [], "isExternal": false, @@ -8500,17 +8484,17 @@ }, { "id": "web", - "path": "/packages/web", + "path": "/nx-api/web", "name": "web", "children": [ { "id": "documents", - "path": "/packages/web/documents", + "path": "/nx-api/web/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/web/documents/overview", + "path": "/nx-api/web/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -8522,12 +8506,12 @@ }, { "id": "executors", - "path": "/packages/web/executors", + "path": "/nx-api/web/executors", "name": "executors", "children": [ { "id": "file-server", - "path": "/packages/web/executors/file-server", + "path": "/nx-api/web/executors/file-server", "name": "file-server", "children": [], "isExternal": false, @@ -8539,12 +8523,12 @@ }, { "id": "generators", - "path": "/packages/web/generators", + "path": "/nx-api/web/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/web/generators/init", + "path": "/nx-api/web/generators/init", "name": "init", "children": [], "isExternal": false, @@ -8552,7 +8536,7 @@ }, { "id": "application", - "path": "/packages/web/generators/application", + "path": "/nx-api/web/generators/application", "name": "application", "children": [], "isExternal": false, @@ -8560,7 +8544,7 @@ }, { "id": "static-config", - "path": "/packages/web/generators/static-config", + "path": "/nx-api/web/generators/static-config", "name": "static-config", "children": [], "isExternal": false, @@ -8576,17 +8560,17 @@ }, { "id": "webpack", - "path": "/packages/webpack", + "path": "/nx-api/webpack", "name": "webpack", "children": [ { "id": "documents", - "path": "/packages/webpack/documents", + "path": "/nx-api/webpack/documents", "name": "documents", "children": [ { "name": "Overview of the Nx Webpack Plugin", - "path": "/packages/webpack/documents/overview", + "path": "/nx-api/webpack/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -8598,12 +8582,12 @@ }, { "id": "executors", - "path": "/packages/webpack/executors", + "path": "/nx-api/webpack/executors", "name": "executors", "children": [ { "id": "webpack", - "path": "/packages/webpack/executors/webpack", + "path": "/nx-api/webpack/executors/webpack", "name": "webpack", "children": [], "isExternal": false, @@ -8611,7 +8595,7 @@ }, { "id": "dev-server", - "path": "/packages/webpack/executors/dev-server", + "path": "/nx-api/webpack/executors/dev-server", "name": "dev-server", "children": [], "isExternal": false, @@ -8619,7 +8603,7 @@ }, { "id": "ssr-dev-server", - "path": "/packages/webpack/executors/ssr-dev-server", + "path": "/nx-api/webpack/executors/ssr-dev-server", "name": "ssr-dev-server", "children": [], "isExternal": false, @@ -8631,12 +8615,12 @@ }, { "id": "generators", - "path": "/packages/webpack/generators", + "path": "/nx-api/webpack/generators", "name": "generators", "children": [ { "id": "init", - "path": "/packages/webpack/generators/init", + "path": "/nx-api/webpack/generators/init", "name": "init", "children": [], "isExternal": false, @@ -8644,7 +8628,7 @@ }, { "id": "configuration", - "path": "/packages/webpack/generators/configuration", + "path": "/nx-api/webpack/generators/configuration", "name": "configuration", "children": [], "isExternal": false, @@ -8660,17 +8644,17 @@ }, { "id": "workspace", - "path": "/packages/workspace", + "path": "/nx-api/workspace", "name": "workspace", "children": [ { "id": "documents", - "path": "/packages/workspace/documents", + "path": "/nx-api/workspace/documents", "name": "documents", "children": [ { "name": "Overview", - "path": "/packages/workspace/documents/overview", + "path": "/nx-api/workspace/documents/overview", "id": "overview", "isExternal": false, "children": [], @@ -8678,7 +8662,7 @@ }, { "name": "Nx, NodeJS and Typescript Versions", - "path": "/packages/workspace/documents/nx-nodejs-typescript-version-matrix", + "path": "/nx-api/workspace/documents/nx-nodejs-typescript-version-matrix", "id": "nx-nodejs-typescript-version-matrix", "isExternal": false, "children": [], @@ -8690,12 +8674,12 @@ }, { "id": "executors", - "path": "/packages/workspace/executors", + "path": "/nx-api/workspace/executors", "name": "executors", "children": [ { "id": "counter", - "path": "/packages/workspace/executors/counter", + "path": "/nx-api/workspace/executors/counter", "name": "counter", "children": [], "isExternal": false, @@ -8707,12 +8691,12 @@ }, { "id": "generators", - "path": "/packages/workspace/generators", + "path": "/nx-api/workspace/generators", "name": "generators", "children": [ { "id": "preset", - "path": "/packages/workspace/generators/preset", + "path": "/nx-api/workspace/generators/preset", "name": "preset", "children": [], "isExternal": false, @@ -8720,7 +8704,7 @@ }, { "id": "move", - "path": "/packages/workspace/generators/move", + "path": "/nx-api/workspace/generators/move", "name": "move", "children": [], "isExternal": false, @@ -8728,7 +8712,7 @@ }, { "id": "remove", - "path": "/packages/workspace/generators/remove", + "path": "/nx-api/workspace/generators/remove", "name": "remove", "children": [], "isExternal": false, @@ -8736,7 +8720,7 @@ }, { "id": "convert-to-monorepo", - "path": "/packages/workspace/generators/convert-to-monorepo", + "path": "/nx-api/workspace/generators/convert-to-monorepo", "name": "convert-to-monorepo", "children": [], "isExternal": false, @@ -8744,7 +8728,7 @@ }, { "id": "new", - "path": "/packages/workspace/generators/new", + "path": "/nx-api/workspace/generators/new", "name": "new", "children": [], "isExternal": false, @@ -8752,7 +8736,7 @@ }, { "id": "workspace-generator", - "path": "/packages/workspace/generators/workspace-generator", + "path": "/nx-api/workspace/generators/workspace-generator", "name": "workspace-generator", "children": [], "isExternal": false, @@ -8760,7 +8744,7 @@ }, { "id": "run-commands", - "path": "/packages/workspace/generators/run-commands", + "path": "/nx-api/workspace/generators/run-commands", "name": "run-commands", "children": [], "isExternal": false, @@ -8768,7 +8752,7 @@ }, { "id": "fix-configuration", - "path": "/packages/workspace/generators/fix-configuration", + "path": "/nx-api/workspace/generators/fix-configuration", "name": "fix-configuration", "children": [], "isExternal": false, @@ -8776,7 +8760,7 @@ }, { "id": "npm-package", - "path": "/packages/workspace/generators/npm-package", + "path": "/nx-api/workspace/generators/npm-package", "name": "npm-package", "children": [], "isExternal": false, @@ -8784,7 +8768,7 @@ }, { "id": "ci-workflow", - "path": "/packages/workspace/generators/ci-workflow", + "path": "/nx-api/workspace/generators/ci-workflow", "name": "ci-workflow", "children": [], "isExternal": false, diff --git a/docs/generated/manifests/packages.json b/docs/generated/manifests/nx-api.json similarity index 79% rename from docs/generated/manifests/packages.json rename to docs/generated/manifests/nx-api.json index 7722b0c0e2a7b..65548e9928ede 100644 --- a/docs/generated/manifests/packages.json +++ b/docs/generated/manifests/nx-api.json @@ -5,25 +5,25 @@ "packageName": "@nx/angular", "description": "The Nx Plugin for Angular contains executors, generators, and utilities for managing Angular applications and libraries within an Nx workspace. It provides: \n\n- Integration with libraries such as Storybook, Jest, ESLint, Tailwind CSS, and Cypress. \n\n- Generators to help scaffold code quickly (like: Micro Frontends, Libraries, both internal to your codebase and publishable to npm) \n\n- Upgrading AngularJS applications \n\n- Single Component Application Modules (SCAMs) \n\n- NgRx helpers. \n\n- Utilities for automatic workspace refactoring.", "documents": { - "/packages/angular/documents/overview": { + "/nx-api/angular/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for Angular contains executors, generators, and utilities for managing Angular applications and libraries within an Nx workspace. It provides: \n\n- Integration with libraries such as Storybook, Jest, ESLint, Tailwind CSS, and Cypress. \n\n- Generators to help scaffold code quickly (like: Micro Frontends, Libraries, both internal to your codebase and publishable to npm) \n\n- Upgrading AngularJS applications \n\n- Single Component Application Modules (SCAMs) \n\n- NgRx helpers. \n\n- Utilities for automatic workspace refactoring.", "file": "generated/packages/angular/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/angular/documents/overview", + "path": "/nx-api/angular/documents/overview", "tags": [], "originalFilePath": "shared/packages/angular/angular-plugin" }, - "/packages/angular/documents/angular-nx-version-matrix": { + "/nx-api/angular/documents/angular-nx-version-matrix": { "id": "angular-nx-version-matrix", "name": "Angular and Nx Version Matrix", "description": "The Nx Plugin for Angular contains executors, generators, and utilities for managing Angular applications and libraries within an Nx workspace. It provides: \n\n- Integration with libraries such as Storybook, Jest, ESLint, Tailwind CSS, and Cypress. \n\n- Generators to help scaffold code quickly (like: Micro Frontends, Libraries, both internal to your codebase and publishable to npm) \n\n- Upgrading AngularJS applications \n\n- Single Component Application Modules (SCAMs) \n\n- NgRx helpers. \n\n- Utilities for automatic workspace refactoring.", "file": "generated/packages/angular/documents/angular-nx-version-matrix", "itemList": [], "isExternal": false, - "path": "/packages/angular/documents/angular-nx-version-matrix", + "path": "/nx-api/angular/documents/angular-nx-version-matrix", "tags": [], "originalFilePath": "shared/packages/angular/angular-nx-version-matrix" } @@ -31,370 +31,370 @@ "root": "/packages/angular", "source": "/packages/angular/src", "executors": { - "/packages/angular/executors/delegate-build": { + "/nx-api/angular/executors/delegate-build": { "description": "Delegates the build to a different target while supporting incremental builds.", "file": "generated/packages/angular/executors/delegate-build.json", "hidden": false, "name": "delegate-build", "originalFilePath": "/packages/angular/src/executors/delegate-build/schema.json", - "path": "/packages/angular/executors/delegate-build", + "path": "/nx-api/angular/executors/delegate-build", "type": "executor" }, - "/packages/angular/executors/ng-packagr-lite": { + "/nx-api/angular/executors/ng-packagr-lite": { "description": "Builds a library with support for incremental builds.\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`.", "file": "generated/packages/angular/executors/ng-packagr-lite.json", "hidden": false, "name": "ng-packagr-lite", "originalFilePath": "/packages/angular/src/executors/ng-packagr-lite/schema.json", - "path": "/packages/angular/executors/ng-packagr-lite", + "path": "/nx-api/angular/executors/ng-packagr-lite", "type": "executor" }, - "/packages/angular/executors/package": { + "/nx-api/angular/executors/package": { "description": "Builds and packages an Angular library producing an output following the Angular Package Format (APF) to be distributed as an NPM package.\nThis executor is similar to the `@angular-devkit/build-angular:ng-packagr` with additional support for incremental builds.", "file": "generated/packages/angular/executors/package.json", "hidden": false, "name": "package", "originalFilePath": "/packages/angular/src/executors/package/schema.json", - "path": "/packages/angular/executors/package", + "path": "/nx-api/angular/executors/package", "type": "executor" }, - "/packages/angular/executors/browser-esbuild": { + "/nx-api/angular/executors/browser-esbuild": { "description": "Builds your application with esbuild and adds support for incremental builds.", "file": "generated/packages/angular/executors/browser-esbuild.json", "hidden": false, "name": "browser-esbuild", "originalFilePath": "/packages/angular/src/executors/browser-esbuild/schema.json", - "path": "/packages/angular/executors/browser-esbuild", + "path": "/nx-api/angular/executors/browser-esbuild", "type": "executor" }, - "/packages/angular/executors/webpack-browser": { + "/nx-api/angular/executors/webpack-browser": { "description": "The `webpack-browser` executor is very similar to the standard `browser` builder provided by the Angular Devkit. It allows you to build your Angular application to a build artifact that can be hosted online. There are some key differences: \n- Supports Custom Webpack Configurations \n- Supports Incremental Building", "file": "generated/packages/angular/executors/webpack-browser.json", "hidden": false, "name": "webpack-browser", "originalFilePath": "/packages/angular/src/builders/webpack-browser/schema.json", - "path": "/packages/angular/executors/webpack-browser", + "path": "/nx-api/angular/executors/webpack-browser", "type": "executor" }, - "/packages/angular/executors/webpack-dev-server": { + "/nx-api/angular/executors/webpack-dev-server": { "description": "The `webpack-dev-server` executor is very similar to the standard `dev-server` builder provided by the Angular Devkit. It is usually used in tandem with `@nrwl/angular:webpack-browser` when your Angular application uses a custom webpack configuration.", "file": "generated/packages/angular/executors/webpack-dev-server.json", "hidden": false, "name": "webpack-dev-server", "originalFilePath": "/packages/angular/src/builders/webpack-dev-server/schema.json", - "path": "/packages/angular/executors/webpack-dev-server", + "path": "/nx-api/angular/executors/webpack-dev-server", "type": "executor" }, - "/packages/angular/executors/webpack-server": { + "/nx-api/angular/executors/webpack-server": { "description": "The `webpack-server` executor is very similar to the standard `server` builder provided by the Angular Devkit. It is usually used in tandem with `@nrwl/angular:webpack-browser` when your Angular application uses a custom webpack configuration and NgUniversal for SSR.", "file": "generated/packages/angular/executors/webpack-server.json", "hidden": false, "name": "webpack-server", "originalFilePath": "/packages/angular/src/builders/webpack-server/schema.json", - "path": "/packages/angular/executors/webpack-server", + "path": "/nx-api/angular/executors/webpack-server", "type": "executor" }, - "/packages/angular/executors/module-federation-dev-server": { + "/nx-api/angular/executors/module-federation-dev-server": { "description": "The module-federation-dev-server executor is reserved exclusively for use with host Module Federation applications. It allows the user to specify which remote applications should be served with the host.", "file": "generated/packages/angular/executors/module-federation-dev-server.json", "hidden": false, "name": "module-federation-dev-server", "originalFilePath": "/packages/angular/src/builders/module-federation-dev-server/schema.json", - "path": "/packages/angular/executors/module-federation-dev-server", + "path": "/nx-api/angular/executors/module-federation-dev-server", "type": "executor" }, - "/packages/angular/executors/module-federation-dev-ssr": { + "/nx-api/angular/executors/module-federation-dev-ssr": { "description": "The module-federation-dev-ssr executor is reserved exclusively for use with host Module Federation applications that use SSR. It allows the user to specify which remote applications should be served with the host.", "file": "generated/packages/angular/executors/module-federation-dev-ssr.json", "hidden": false, "name": "module-federation-dev-ssr", "originalFilePath": "/packages/angular/src/builders/module-federation-dev-ssr/schema.json", - "path": "/packages/angular/executors/module-federation-dev-ssr", + "path": "/nx-api/angular/executors/module-federation-dev-ssr", "type": "executor" } }, "generators": { - "/packages/angular/generators/add-linting": { + "/nx-api/angular/generators/add-linting": { "description": "Adds linting configuration to an Angular project.", "file": "generated/packages/angular/generators/add-linting.json", "hidden": true, "name": "add-linting", "originalFilePath": "/packages/angular/src/generators/add-linting/schema.json", - "path": "/packages/angular/generators/add-linting", + "path": "/nx-api/angular/generators/add-linting", "type": "generator" }, - "/packages/angular/generators/application": { + "/nx-api/angular/generators/application": { "description": "Creates an Angular application.", "file": "generated/packages/angular/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/angular/src/generators/application/schema.json", - "path": "/packages/angular/generators/application", + "path": "/nx-api/angular/generators/application", "type": "generator" }, - "/packages/angular/generators/component": { + "/nx-api/angular/generators/component": { "description": "Generate an Angular Component.", "file": "generated/packages/angular/generators/component.json", "hidden": false, "name": "component", "originalFilePath": "/packages/angular/src/generators/component/schema.json", - "path": "/packages/angular/generators/component", + "path": "/nx-api/angular/generators/component", "type": "generator" }, - "/packages/angular/generators/component-cypress-spec": { + "/nx-api/angular/generators/component-cypress-spec": { "description": "Creates a Cypress spec for a UI component that has a story.", "file": "generated/packages/angular/generators/component-cypress-spec.json", "hidden": true, "name": "component-cypress-spec", "originalFilePath": "/packages/angular/src/generators/component-cypress-spec/schema.json", - "path": "/packages/angular/generators/component-cypress-spec", + "path": "/nx-api/angular/generators/component-cypress-spec", "type": "generator" }, - "/packages/angular/generators/component-story": { + "/nx-api/angular/generators/component-story": { "description": "Creates a stories.ts file for a component.", "file": "generated/packages/angular/generators/component-story.json", "hidden": true, "name": "component-story", "originalFilePath": "/packages/angular/src/generators/component-story/schema.json", - "path": "/packages/angular/generators/component-story", + "path": "/nx-api/angular/generators/component-story", "type": "generator" }, - "/packages/angular/generators/component-test": { + "/nx-api/angular/generators/component-test": { "description": "Creates a cypress component test file for a component.", "file": "generated/packages/angular/generators/component-test.json", "hidden": false, "name": "component-test", "originalFilePath": "/packages/angular/src/generators/component-test/schema.json", - "path": "/packages/angular/generators/component-test", + "path": "/nx-api/angular/generators/component-test", "type": "generator" }, - "/packages/angular/generators/convert-tslint-to-eslint": { + "/nx-api/angular/generators/convert-tslint-to-eslint": { "description": "Converts a project from TSLint to ESLint.", "file": "generated/packages/angular/generators/convert-tslint-to-eslint.json", "hidden": false, "name": "convert-tslint-to-eslint", "originalFilePath": "/packages/angular/src/generators/convert-tslint-to-eslint/schema.json", - "path": "/packages/angular/generators/convert-tslint-to-eslint", + "path": "/nx-api/angular/generators/convert-tslint-to-eslint", "type": "generator" }, - "/packages/angular/generators/directive": { + "/nx-api/angular/generators/directive": { "description": "Generate an Angular directive.", "file": "generated/packages/angular/generators/directive.json", "hidden": false, "name": "directive", "originalFilePath": "/packages/angular/src/generators/directive/schema.json", - "path": "/packages/angular/generators/directive", + "path": "/nx-api/angular/generators/directive", "type": "generator" }, - "/packages/angular/generators/init": { + "/nx-api/angular/generators/init": { "description": "Initializes the `@nrwl/angular` plugin.", "file": "generated/packages/angular/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/angular/src/generators/init/schema.json", - "path": "/packages/angular/generators/init", + "path": "/nx-api/angular/generators/init", "type": "generator" }, - "/packages/angular/generators/library": { + "/nx-api/angular/generators/library": { "description": "Creates an Angular library.", "file": "generated/packages/angular/generators/library.json", "hidden": false, "name": "library", "originalFilePath": "/packages/angular/src/generators/library/schema.json", - "path": "/packages/angular/generators/library", + "path": "/nx-api/angular/generators/library", "type": "generator" }, - "/packages/angular/generators/library-secondary-entry-point": { + "/nx-api/angular/generators/library-secondary-entry-point": { "description": "Creates a secondary entry point for an Angular publishable library.", "file": "generated/packages/angular/generators/library-secondary-entry-point.json", "hidden": false, "name": "library-secondary-entry-point", "originalFilePath": "/packages/angular/src/generators/library-secondary-entry-point/schema.json", - "path": "/packages/angular/generators/library-secondary-entry-point", + "path": "/nx-api/angular/generators/library-secondary-entry-point", "type": "generator" }, - "/packages/angular/generators/remote": { + "/nx-api/angular/generators/remote": { "description": "Generate a Remote Angular Module Federation Application.", "file": "generated/packages/angular/generators/remote.json", "hidden": false, "name": "remote", "originalFilePath": "/packages/angular/src/generators/remote/schema.json", - "path": "/packages/angular/generators/remote", + "path": "/nx-api/angular/generators/remote", "type": "generator" }, - "/packages/angular/generators/move": { + "/nx-api/angular/generators/move": { "description": "Moves an Angular application or library to another folder within the workspace and updates the project configuration.", "file": "generated/packages/angular/generators/move.json", "hidden": false, "name": "move", "originalFilePath": "/packages/angular/src/generators/move/schema.json", - "path": "/packages/angular/generators/move", + "path": "/nx-api/angular/generators/move", "type": "generator" }, - "/packages/angular/generators/convert-to-with-mf": { + "/nx-api/angular/generators/convert-to-with-mf": { "description": "Converts an old micro frontend configuration to use the new withModuleFederation helper. It will run successfully if the following conditions are met: \n - Is either a host or remote application \n - Shared npm package configurations have not been modified \n - Name used to identify the Micro Frontend application matches the project name \n\n{% callout type=\"warning\" title=\"Overrides\" %}This generator will overwrite your webpack config. If you have additional custom configuration in your config file, it will be lost!{% /callout %}", "file": "generated/packages/angular/generators/convert-to-with-mf.json", "hidden": false, "name": "convert-to-with-mf", "originalFilePath": "/packages/angular/src/generators/convert-to-with-mf/schema.json", - "path": "/packages/angular/generators/convert-to-with-mf", + "path": "/nx-api/angular/generators/convert-to-with-mf", "type": "generator" }, - "/packages/angular/generators/host": { + "/nx-api/angular/generators/host": { "description": "Generate a Host Angular Module Federation Application.", "file": "generated/packages/angular/generators/host.json", "hidden": false, "name": "host", "originalFilePath": "/packages/angular/src/generators/host/schema.json", - "path": "/packages/angular/generators/host", + "path": "/nx-api/angular/generators/host", "type": "generator" }, - "/packages/angular/generators/ng-add": { + "/nx-api/angular/generators/ng-add": { "description": "Migrates an Angular CLI workspace to Nx or adds the Angular plugin to an Nx workspace.", "file": "generated/packages/angular/generators/ng-add.json", "hidden": true, "name": "ng-add", "originalFilePath": "/packages/angular/src/generators/ng-add/schema.json", - "path": "/packages/angular/generators/ng-add", + "path": "/nx-api/angular/generators/ng-add", "type": "generator" }, - "/packages/angular/generators/ngrx": { + "/nx-api/angular/generators/ngrx": { "description": "Adds NgRx support to an application or library.", "file": "generated/packages/angular/generators/ngrx.json", "hidden": false, "name": "ngrx", "originalFilePath": "/packages/angular/src/generators/ngrx/schema.json", - "path": "/packages/angular/generators/ngrx", + "path": "/nx-api/angular/generators/ngrx", "type": "generator" }, - "/packages/angular/generators/ngrx-feature-store": { + "/nx-api/angular/generators/ngrx-feature-store": { "description": "Adds an NgRx Feature Store to an application or library.", "file": "generated/packages/angular/generators/ngrx-feature-store.json", "hidden": false, "name": "ngrx-feature-store", "originalFilePath": "/packages/angular/src/generators/ngrx-feature-store/schema.json", - "path": "/packages/angular/generators/ngrx-feature-store", + "path": "/nx-api/angular/generators/ngrx-feature-store", "type": "generator" }, - "/packages/angular/generators/ngrx-root-store": { + "/nx-api/angular/generators/ngrx-root-store": { "description": "Adds an NgRx Root Store to an application.", "file": "generated/packages/angular/generators/ngrx-root-store.json", "hidden": false, "name": "ngrx-root-store", "originalFilePath": "/packages/angular/src/generators/ngrx-root-store/schema.json", - "path": "/packages/angular/generators/ngrx-root-store", + "path": "/nx-api/angular/generators/ngrx-root-store", "type": "generator" }, - "/packages/angular/generators/pipe": { + "/nx-api/angular/generators/pipe": { "description": "Generate an Angular Pipe", "file": "generated/packages/angular/generators/pipe.json", "hidden": false, "name": "pipe", "originalFilePath": "/packages/angular/src/generators/pipe/schema.json", - "path": "/packages/angular/generators/pipe", + "path": "/nx-api/angular/generators/pipe", "type": "generator" }, - "/packages/angular/generators/scam-to-standalone": { + "/nx-api/angular/generators/scam-to-standalone": { "description": "Convert an existing Single Component Angular Module (SCAM) to a Standalone Component.", "file": "generated/packages/angular/generators/scam-to-standalone.json", "hidden": false, "name": "scam-to-standalone", "originalFilePath": "/packages/angular/src/generators/scam-to-standalone/schema.json", - "path": "/packages/angular/generators/scam-to-standalone", + "path": "/nx-api/angular/generators/scam-to-standalone", "type": "generator" }, - "/packages/angular/generators/scam": { + "/nx-api/angular/generators/scam": { "description": "Generate a component with an accompanying Single Component Angular Module (SCAM).", "file": "generated/packages/angular/generators/scam.json", "hidden": false, "name": "scam", "originalFilePath": "/packages/angular/src/generators/scam/schema.json", - "path": "/packages/angular/generators/scam", + "path": "/nx-api/angular/generators/scam", "type": "generator" }, - "/packages/angular/generators/scam-directive": { + "/nx-api/angular/generators/scam-directive": { "description": "Generate a directive with an accompanying Single Component Angular Module (SCAM).", "file": "generated/packages/angular/generators/scam-directive.json", "hidden": false, "name": "scam-directive", "originalFilePath": "/packages/angular/src/generators/scam-directive/schema.json", - "path": "/packages/angular/generators/scam-directive", + "path": "/nx-api/angular/generators/scam-directive", "type": "generator" }, - "/packages/angular/generators/scam-pipe": { + "/nx-api/angular/generators/scam-pipe": { "description": "Generate a pipe with an accompanying Single Component Angular Module (SCAM).", "file": "generated/packages/angular/generators/scam-pipe.json", "hidden": false, "name": "scam-pipe", "originalFilePath": "/packages/angular/src/generators/scam-pipe/schema.json", - "path": "/packages/angular/generators/scam-pipe", + "path": "/nx-api/angular/generators/scam-pipe", "type": "generator" }, - "/packages/angular/generators/setup-mf": { + "/nx-api/angular/generators/setup-mf": { "description": "Generate a Module Federation configuration for a given Angular application.", "file": "generated/packages/angular/generators/setup-mf.json", "hidden": false, "name": "setup-mf", "originalFilePath": "/packages/angular/src/generators/setup-mf/schema.json", - "path": "/packages/angular/generators/setup-mf", + "path": "/nx-api/angular/generators/setup-mf", "type": "generator" }, - "/packages/angular/generators/setup-ssr": { + "/nx-api/angular/generators/setup-ssr": { "description": "Generate Angular Universal (SSR) setup for an Angular application.", "file": "generated/packages/angular/generators/setup-ssr.json", "hidden": false, "name": "setup-ssr", "originalFilePath": "/packages/angular/src/generators/setup-ssr/schema.json", - "path": "/packages/angular/generators/setup-ssr", + "path": "/nx-api/angular/generators/setup-ssr", "type": "generator" }, - "/packages/angular/generators/setup-tailwind": { + "/nx-api/angular/generators/setup-tailwind": { "description": "Configures Tailwind CSS for an application or a buildable/publishable library.", "file": "generated/packages/angular/generators/setup-tailwind.json", "hidden": false, "name": "setup-tailwind", "originalFilePath": "/packages/angular/src/generators/setup-tailwind/schema.json", - "path": "/packages/angular/generators/setup-tailwind", + "path": "/nx-api/angular/generators/setup-tailwind", "type": "generator" }, - "/packages/angular/generators/stories": { + "/nx-api/angular/generators/stories": { "description": "Creates stories/specs for all components declared in a project.", "file": "generated/packages/angular/generators/stories.json", "hidden": false, "name": "stories", "originalFilePath": "/packages/angular/src/generators/stories/schema.json", - "path": "/packages/angular/generators/stories", + "path": "/nx-api/angular/generators/stories", "type": "generator" }, - "/packages/angular/generators/storybook-configuration": { + "/nx-api/angular/generators/storybook-configuration": { "description": "Adds Storybook configuration to a project.", "file": "generated/packages/angular/generators/storybook-configuration.json", "hidden": false, "name": "storybook-configuration", "originalFilePath": "/packages/angular/src/generators/storybook-configuration/schema.json", - "path": "/packages/angular/generators/storybook-configuration", + "path": "/nx-api/angular/generators/storybook-configuration", "type": "generator" }, - "/packages/angular/generators/cypress-component-configuration": { + "/nx-api/angular/generators/cypress-component-configuration": { "description": "Setup Cypress component testing for a project.", "file": "generated/packages/angular/generators/cypress-component-configuration.json", "hidden": false, "name": "cypress-component-configuration", "originalFilePath": "/packages/angular/src/generators/cypress-component-configuration/schema.json", - "path": "/packages/angular/generators/cypress-component-configuration", + "path": "/nx-api/angular/generators/cypress-component-configuration", "type": "generator" }, - "/packages/angular/generators/web-worker": { + "/nx-api/angular/generators/web-worker": { "description": "Creates a Web Worker.", "file": "generated/packages/angular/generators/web-worker.json", "hidden": false, "name": "web-worker", "originalFilePath": "/packages/angular/src/generators/web-worker/schema.json", - "path": "/packages/angular/generators/web-worker", + "path": "/nx-api/angular/generators/web-worker", "type": "generator" } }, - "path": "/packages/angular" + "path": "/nx-api/angular" }, "create-nx-plugin": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -406,7 +406,7 @@ "source": "/packages/create-nx-plugin/src", "executors": {}, "generators": {}, - "path": "/packages/create-nx-plugin" + "path": "/nx-api/create-nx-plugin" }, "create-nx-workspace": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -418,7 +418,7 @@ "source": "/packages/create-nx-workspace/src", "executors": {}, "generators": {}, - "path": "/packages/create-nx-workspace" + "path": "/nx-api/create-nx-workspace" }, "cypress": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -426,14 +426,14 @@ "packageName": "@nx/cypress", "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.", "documents": { - "/packages/cypress/documents/overview": { + "/nx-api/cypress/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.", "file": "generated/packages/cypress/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/cypress/documents/overview", + "path": "/nx-api/cypress/documents/overview", "tags": [], "originalFilePath": "shared/packages/cypress/cypress-plugin" } @@ -441,64 +441,64 @@ "root": "/packages/cypress", "source": "/packages/cypress/src", "executors": { - "/packages/cypress/executors/cypress": { + "/nx-api/cypress/executors/cypress": { "description": "Run Cypress E2E tests.", "file": "generated/packages/cypress/executors/cypress.json", "hidden": false, "name": "cypress", "originalFilePath": "/packages/cypress/src/executors/cypress/schema.json", - "path": "/packages/cypress/executors/cypress", + "path": "/nx-api/cypress/executors/cypress", "type": "executor" } }, "generators": { - "/packages/cypress/generators/init": { + "/nx-api/cypress/generators/init": { "description": "Initialize the `@nrwl/cypress` plugin.", "file": "generated/packages/cypress/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/cypress/src/generators/init/schema.json", - "path": "/packages/cypress/generators/init", + "path": "/nx-api/cypress/generators/init", "type": "generator" }, - "/packages/cypress/generators/cypress-project": { + "/nx-api/cypress/generators/cypress-project": { "description": "Add a Cypress E2E Project.", "file": "generated/packages/cypress/generators/cypress-project.json", "hidden": true, "name": "cypress-project", "originalFilePath": "/packages/cypress/src/generators/cypress-project/schema.json", - "path": "/packages/cypress/generators/cypress-project", + "path": "/nx-api/cypress/generators/cypress-project", "type": "generator" }, - "/packages/cypress/generators/configuration": { + "/nx-api/cypress/generators/configuration": { "description": "Add a Cypress E2E Configuration to an existing project.", "file": "generated/packages/cypress/generators/configuration.json", "hidden": false, "name": "configuration", "originalFilePath": "/packages/cypress/src/generators/configuration/schema.json", - "path": "/packages/cypress/generators/configuration", + "path": "/nx-api/cypress/generators/configuration", "type": "generator" }, - "/packages/cypress/generators/component-configuration": { + "/nx-api/cypress/generators/component-configuration": { "description": "Set up Cypress Component Test for a project", "file": "generated/packages/cypress/generators/component-configuration.json", "hidden": true, "name": "component-configuration", "originalFilePath": "/packages/cypress/src/generators/component-configuration/schema.json", - "path": "/packages/cypress/generators/component-configuration", + "path": "/nx-api/cypress/generators/component-configuration", "type": "generator" }, - "/packages/cypress/generators/migrate-to-cypress-11": { + "/nx-api/cypress/generators/migrate-to-cypress-11": { "description": "Migrate existing Cypress e2e projects to Cypress v11", "file": "generated/packages/cypress/generators/migrate-to-cypress-11.json", "hidden": false, "name": "migrate-to-cypress-11", "originalFilePath": "/packages/cypress/src/generators/migrate-to-cypress-11/schema.json", - "path": "/packages/cypress/generators/migrate-to-cypress-11", + "path": "/nx-api/cypress/generators/migrate-to-cypress-11", "type": "generator" } }, - "path": "/packages/cypress" + "path": "/nx-api/cypress" }, "detox": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -506,14 +506,14 @@ "packageName": "@nx/detox", "description": "The Nx Plugin for Detox contains executors and generators for allowing your workspace to use the powerful Detox integration testing capabilities.", "documents": { - "/packages/detox/documents/overview": { + "/nx-api/detox/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for Detox contains executors and generators for allowing your workspace to use the powerful Detox integration testing capabilities.", "file": "generated/packages/detox/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/detox/documents/overview", + "path": "/nx-api/detox/documents/overview", "tags": [], "originalFilePath": "shared/packages/detox/detox-plugin" } @@ -521,46 +521,46 @@ "root": "/packages/detox", "source": "/packages/detox/src", "executors": { - "/packages/detox/executors/build": { + "/nx-api/detox/executors/build": { "description": "Run the command defined in build property of the specified configuration.", "file": "generated/packages/detox/executors/build.json", "hidden": false, "name": "build", "originalFilePath": "/packages/detox/src/executors/build/schema.json", - "path": "/packages/detox/executors/build", + "path": "/nx-api/detox/executors/build", "type": "executor" }, - "/packages/detox/executors/test": { + "/nx-api/detox/executors/test": { "description": "Initiating your detox test suite.", "file": "generated/packages/detox/executors/test.json", "hidden": false, "name": "test", "originalFilePath": "/packages/detox/src/executors/test/schema.json", - "path": "/packages/detox/executors/test", + "path": "/nx-api/detox/executors/test", "type": "executor" } }, "generators": { - "/packages/detox/generators/init": { + "/nx-api/detox/generators/init": { "description": "Initialize the `@nrwl/detox` plugin.", "file": "generated/packages/detox/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/detox/src/generators/init/schema.json", - "path": "/packages/detox/generators/init", + "path": "/nx-api/detox/generators/init", "type": "generator" }, - "/packages/detox/generators/application": { + "/nx-api/detox/generators/application": { "description": "Create a Detox application.", "file": "generated/packages/detox/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/detox/src/generators/application/schema.json", - "path": "/packages/detox/generators/application", + "path": "/nx-api/detox/generators/application", "type": "generator" } }, - "path": "/packages/detox" + "path": "/nx-api/detox" }, "devkit": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -568,25 +568,25 @@ "packageName": "@nx/devkit", "description": "The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more.", "documents": { - "/packages/devkit/documents/nx_devkit": { + "/nx-api/devkit/documents/nx_devkit": { "id": "nx_devkit", "name": "Overview", "description": "The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more.", "file": "generated/packages/devkit/documents/nx_devkit", "itemList": [], "isExternal": false, - "path": "/packages/devkit/documents/nx_devkit", + "path": "/nx-api/devkit/documents/nx_devkit", "tags": [], "originalFilePath": "generated/devkit/README" }, - "/packages/devkit/documents/ngcli_adapter": { + "/nx-api/devkit/documents/ngcli_adapter": { "id": "ngcli_adapter", "name": "Ng CLI Adapter", "description": "The Nx Devkit is used to customize Nx for different technologies and use cases. It contains many utility functions for reading and writing files, updating configuration, working with Abstract Syntax Trees(ASTs), and more.", "file": "generated/packages/devkit/documents/ngcli_adapter", "itemList": [], "isExternal": false, - "path": "/packages/devkit/documents/ngcli_adapter", + "path": "/nx-api/devkit/documents/ngcli_adapter", "tags": [], "originalFilePath": "generated/devkit/ngcli_adapter/README" } @@ -595,7 +595,7 @@ "source": "/packages/devkit/src", "executors": {}, "generators": {}, - "path": "/packages/devkit" + "path": "/nx-api/devkit" }, "esbuild": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -603,14 +603,14 @@ "packageName": "@nx/esbuild", "description": "The Nx Plugin for esbuild contains executors and generators that support building applications using esbuild", "documents": { - "/packages/esbuild/documents/overview": { + "/nx-api/esbuild/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for esbuild contains executors and generators that support building applications using esbuild", "file": "generated/packages/esbuild/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/esbuild/documents/overview", + "path": "/nx-api/esbuild/documents/overview", "tags": [], "originalFilePath": "shared/packages/esbuild/esbuild-plugin" } @@ -618,37 +618,37 @@ "root": "/packages/esbuild", "source": "/packages/esbuild/src", "executors": { - "/packages/esbuild/executors/esbuild": { + "/nx-api/esbuild/executors/esbuild": { "description": "Bundle a package using EsBuild.", "file": "generated/packages/esbuild/executors/esbuild.json", "hidden": false, "name": "esbuild", "originalFilePath": "/packages/esbuild/src/executors/esbuild/schema.json", - "path": "/packages/esbuild/executors/esbuild", + "path": "/nx-api/esbuild/executors/esbuild", "type": "executor" } }, "generators": { - "/packages/esbuild/generators/init": { + "/nx-api/esbuild/generators/init": { "description": "Initialize the `@nrwl/esbuild` plugin.", "file": "generated/packages/esbuild/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/esbuild/src/generators/init/schema.json", - "path": "/packages/esbuild/generators/init", + "path": "/nx-api/esbuild/generators/init", "type": "generator" }, - "/packages/esbuild/generators/configuration": { + "/nx-api/esbuild/generators/configuration": { "description": "Add esbuild configuration to a project.", "file": "generated/packages/esbuild/generators/configuration.json", "hidden": false, "name": "configuration", "originalFilePath": "/packages/esbuild/src/generators/configuration/schema.json", - "path": "/packages/esbuild/generators/configuration", + "path": "/nx-api/esbuild/generators/configuration", "type": "generator" } }, - "path": "/packages/esbuild" + "path": "/nx-api/esbuild" }, "eslint-plugin": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -656,36 +656,36 @@ "packageName": "@nx/eslint-plugin", "description": "The eslint-plugin package is an ESLint plugin that contains a collection of recommended ESLint rule configurations which you can extend from in your own ESLint configs, as well as an Nx-specific lint rule called enforce-module-boundaries.", "documents": { - "/packages/eslint-plugin/documents/overview": { + "/nx-api/eslint-plugin/documents/overview": { "id": "overview", "name": "Overview", "description": "The eslint-plugin package is an ESLint plugin that contains a collection of recommended ESLint rule configurations which you can extend from in your own ESLint configs, as well as an Nx-specific lint rule called enforce-module-boundaries.", "file": "generated/packages/eslint-plugin/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/eslint-plugin/documents/overview", + "path": "/nx-api/eslint-plugin/documents/overview", "tags": [], "originalFilePath": "shared/packages/linter/eslint-plugin" }, - "/packages/eslint-plugin/documents/enforce-module-boundaries": { + "/nx-api/eslint-plugin/documents/enforce-module-boundaries": { "id": "enforce-module-boundaries", "name": "The `enforce-module-boundaries` rule", "description": "The eslint-plugin package is an ESLint plugin that contains a collection of recommended ESLint rule configurations which you can extend from in your own ESLint configs, as well as an Nx-specific lint rule called enforce-module-boundaries.", "file": "generated/packages/eslint-plugin/documents/enforce-module-boundaries", "itemList": [], "isExternal": false, - "path": "/packages/eslint-plugin/documents/enforce-module-boundaries", + "path": "/nx-api/eslint-plugin/documents/enforce-module-boundaries", "tags": [], "originalFilePath": "shared/packages/linter/enforce-module-boundaries" }, - "/packages/eslint-plugin/documents/dependency-checks": { + "/nx-api/eslint-plugin/documents/dependency-checks": { "id": "dependency-checks", "name": "The `dependency-checks` rule", "description": "The eslint-plugin package is an ESLint plugin that contains a collection of recommended ESLint rule configurations which you can extend from in your own ESLint configs, as well as an Nx-specific lint rule called enforce-module-boundaries.", "file": "generated/packages/eslint-plugin/documents/dependency-checks", "itemList": [], "isExternal": false, - "path": "/packages/eslint-plugin/documents/dependency-checks", + "path": "/nx-api/eslint-plugin/documents/dependency-checks", "tags": [], "originalFilePath": "shared/packages/linter/dependency-checks" } @@ -694,7 +694,7 @@ "source": "/packages/eslint-plugin/src", "executors": {}, "generators": {}, - "path": "/packages/eslint-plugin" + "path": "/nx-api/eslint-plugin" }, "expo": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -702,14 +702,14 @@ "packageName": "@nx/expo", "description": "The Expo Plugin for Nx contains executors and generators for managing and developing an expo application within your workspace. For example, you can directly build for different target platforms as well as generate projects and publish your code.", "documents": { - "/packages/expo/documents/overview": { + "/nx-api/expo/documents/overview": { "id": "overview", "name": "Overview", "description": "The Expo Plugin for Nx contains executors and generators for managing and developing an expo application within your workspace. For example, you can directly build for different target platforms as well as generate projects and publish your code.", "file": "generated/packages/expo/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/expo/documents/overview", + "path": "/nx-api/expo/documents/overview", "tags": [], "originalFilePath": "shared/packages/expo/expo-plugin" } @@ -717,154 +717,154 @@ "root": "/packages/expo", "source": "/packages/expo/src", "executors": { - "/packages/expo/executors/update": { + "/nx-api/expo/executors/update": { "description": "Start an EAS update for your expo project", "file": "generated/packages/expo/executors/update.json", "hidden": false, "name": "update", "originalFilePath": "/packages/expo/src/executors/update/schema.json", - "path": "/packages/expo/executors/update", + "path": "/nx-api/expo/executors/update", "type": "executor" }, - "/packages/expo/executors/build": { + "/nx-api/expo/executors/build": { "description": "Start an EAS build for your expo project", "file": "generated/packages/expo/executors/build.json", "hidden": false, "name": "build", "originalFilePath": "/packages/expo/src/executors/build/schema.json", - "path": "/packages/expo/executors/build", + "path": "/nx-api/expo/executors/build", "type": "executor" }, - "/packages/expo/executors/build-list": { + "/nx-api/expo/executors/build-list": { "description": "List all EAS builds for your Expo project", "file": "generated/packages/expo/executors/build-list.json", "hidden": false, "name": "build-list", "originalFilePath": "/packages/expo/src/executors/build-list/schema.json", - "path": "/packages/expo/executors/build-list", + "path": "/nx-api/expo/executors/build-list", "type": "executor" }, - "/packages/expo/executors/download": { + "/nx-api/expo/executors/download": { "description": "Download an EAS build", "file": "generated/packages/expo/executors/download.json", "hidden": false, "name": "download", "originalFilePath": "/packages/expo/src/executors/download/schema.json", - "path": "/packages/expo/executors/download", + "path": "/nx-api/expo/executors/download", "type": "executor" }, - "/packages/expo/executors/run": { + "/nx-api/expo/executors/run": { "description": "Run the Android app binary locally or run the iOS app binary locally", "file": "generated/packages/expo/executors/run.json", "hidden": false, "name": "run", "originalFilePath": "/packages/expo/src/executors/run/schema.json", - "path": "/packages/expo/executors/run", + "path": "/nx-api/expo/executors/run", "type": "executor" }, - "/packages/expo/executors/start": { + "/nx-api/expo/executors/start": { "description": "Start a local dev server for the app or start a Webpack dev server for the web app", "file": "generated/packages/expo/executors/start.json", "hidden": false, "name": "start", "originalFilePath": "/packages/expo/src/executors/start/schema.json", - "path": "/packages/expo/executors/start", + "path": "/nx-api/expo/executors/start", "type": "executor" }, - "/packages/expo/executors/sync-deps": { + "/nx-api/expo/executors/sync-deps": { "description": "Syncs dependencies to package.json (required for autolinking).", "file": "generated/packages/expo/executors/sync-deps.json", "hidden": false, "name": "sync-deps", "originalFilePath": "/packages/expo/src/executors/sync-deps/schema.json", - "path": "/packages/expo/executors/sync-deps", + "path": "/nx-api/expo/executors/sync-deps", "type": "executor" }, - "/packages/expo/executors/ensure-symlink": { + "/nx-api/expo/executors/ensure-symlink": { "description": "Ensure workspace node_modules is symlink under app's node_modules folder.", "file": "generated/packages/expo/executors/ensure-symlink.json", "hidden": false, "name": "ensure-symlink", "originalFilePath": "/packages/expo/src/executors/ensure-symlink/schema.json", - "path": "/packages/expo/executors/ensure-symlink", + "path": "/nx-api/expo/executors/ensure-symlink", "type": "executor" }, - "/packages/expo/executors/prebuild": { + "/nx-api/expo/executors/prebuild": { "description": "Create native iOS and Android project files for building natively.", "file": "generated/packages/expo/executors/prebuild.json", "hidden": false, "name": "prebuild", "originalFilePath": "/packages/expo/src/executors/prebuild/schema.json", - "path": "/packages/expo/executors/prebuild", + "path": "/nx-api/expo/executors/prebuild", "type": "executor" }, - "/packages/expo/executors/install": { + "/nx-api/expo/executors/install": { "description": "Install a module or other package to a project.", "file": "generated/packages/expo/executors/install.json", "hidden": false, "name": "install", "originalFilePath": "/packages/expo/src/executors/install/schema.json", - "path": "/packages/expo/executors/install", + "path": "/nx-api/expo/executors/install", "type": "executor" }, - "/packages/expo/executors/export": { + "/nx-api/expo/executors/export": { "description": "Export the JavaScript and assets for your app using Metro/webpack bundler", "file": "generated/packages/expo/executors/export.json", "hidden": false, "name": "export", "originalFilePath": "/packages/expo/src/executors/export/schema.json", - "path": "/packages/expo/executors/export", + "path": "/nx-api/expo/executors/export", "type": "executor" }, - "/packages/expo/executors/submit": { + "/nx-api/expo/executors/submit": { "description": "Submit app binary to App Store and/or Play Store", "file": "generated/packages/expo/executors/submit.json", "hidden": false, "name": "submit", "originalFilePath": "/packages/expo/src/executors/submit/schema.json", - "path": "/packages/expo/executors/submit", + "path": "/nx-api/expo/executors/submit", "type": "executor" } }, "generators": { - "/packages/expo/generators/init": { + "/nx-api/expo/generators/init": { "description": "Initialize the @nrwl/expo plugin", "file": "generated/packages/expo/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/expo/src/generators/init/schema.json", - "path": "/packages/expo/generators/init", + "path": "/nx-api/expo/generators/init", "type": "generator" }, - "/packages/expo/generators/application": { + "/nx-api/expo/generators/application": { "description": "Create an application", "file": "generated/packages/expo/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/expo/src/generators/application/schema.json", - "path": "/packages/expo/generators/application", + "path": "/nx-api/expo/generators/application", "type": "generator" }, - "/packages/expo/generators/library": { + "/nx-api/expo/generators/library": { "description": "Create a library", "file": "generated/packages/expo/generators/library.json", "hidden": false, "name": "library", "originalFilePath": "/packages/expo/src/generators/library/schema.json", - "path": "/packages/expo/generators/library", + "path": "/nx-api/expo/generators/library", "type": "generator" }, - "/packages/expo/generators/component": { + "/nx-api/expo/generators/component": { "description": "Create a component", "file": "generated/packages/expo/generators/component.json", "hidden": false, "name": "component", "originalFilePath": "/packages/expo/src/generators/component/schema.json", - "path": "/packages/expo/generators/component", + "path": "/nx-api/expo/generators/component", "type": "generator" } }, - "path": "/packages/expo" + "path": "/nx-api/expo" }, "express": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -872,14 +872,14 @@ "packageName": "@nx/express", "description": "The Nx Plugin for Express contains executors and generators for allowing your workspace to create powerful Express Node applications and APIs.", "documents": { - "/packages/express/documents/overview": { + "/nx-api/express/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for Express contains executors and generators for allowing your workspace to create powerful Express Node applications and APIs.", "file": "generated/packages/express/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/express/documents/overview", + "path": "/nx-api/express/documents/overview", "tags": [], "originalFilePath": "shared/packages/express/express-plugin" } @@ -888,26 +888,26 @@ "source": "/packages/express/src", "executors": {}, "generators": { - "/packages/express/generators/init": { + "/nx-api/express/generators/init": { "description": "Initialize the `@nrwl/express` plugin.", "file": "generated/packages/express/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/express/src/generators/init/schema.json", - "path": "/packages/express/generators/init", + "path": "/nx-api/express/generators/init", "type": "generator" }, - "/packages/express/generators/application": { + "/nx-api/express/generators/application": { "description": "Create an Express application.", "file": "generated/packages/express/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/express/src/generators/application/schema.json", - "path": "/packages/express/generators/application", + "path": "/nx-api/express/generators/application", "type": "generator" } }, - "path": "/packages/express" + "path": "/nx-api/express" }, "jest": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -915,14 +915,14 @@ "packageName": "@nx/jest", "description": "The Nx Plugin for Jest contains executors and generators allowing your workspace to use the powerful Jest testing capabilities.", "documents": { - "/packages/jest/documents/overview": { + "/nx-api/jest/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for Jest contains executors and generators allowing your workspace to use the powerful Jest testing capabilities.", "file": "generated/packages/jest/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/jest/documents/overview", + "path": "/nx-api/jest/documents/overview", "tags": [], "originalFilePath": "shared/packages/jest/jest-plugin" } @@ -930,37 +930,37 @@ "root": "/packages/jest", "source": "/packages/jest/src", "executors": { - "/packages/jest/executors/jest": { + "/nx-api/jest/executors/jest": { "description": "Run Jest unit tests.", "file": "generated/packages/jest/executors/jest.json", "hidden": false, "name": "jest", "originalFilePath": "/packages/jest/src/executors/jest/schema.json", - "path": "/packages/jest/executors/jest", + "path": "/nx-api/jest/executors/jest", "type": "executor" } }, "generators": { - "/packages/jest/generators/init": { + "/nx-api/jest/generators/init": { "description": "Initialize the `@nrwl/jest` plugin.", "file": "generated/packages/jest/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/jest/src/generators/init/schema.json", - "path": "/packages/jest/generators/init", + "path": "/nx-api/jest/generators/init", "type": "generator" }, - "/packages/jest/generators/configuration": { + "/nx-api/jest/generators/configuration": { "description": "Add Jest configuration to a project.", "file": "generated/packages/jest/generators/configuration.json", "hidden": true, "name": "configuration", "originalFilePath": "/packages/jest/src/generators/configuration/schema.json", - "path": "/packages/jest/generators/configuration", + "path": "/nx-api/jest/generators/configuration", "type": "generator" } }, - "path": "/packages/jest" + "path": "/nx-api/jest" }, "js": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -968,14 +968,14 @@ "packageName": "@nx/js", "description": "The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. ", "documents": { - "/packages/js/documents/overview": { + "/nx-api/js/documents/overview": { "id": "overview", "name": "Overview", "description": "The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. ", "file": "generated/packages/js/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/js/documents/overview", + "path": "/nx-api/js/documents/overview", "tags": [], "originalFilePath": "shared/packages/js/js-plugin" } @@ -983,109 +983,109 @@ "root": "/packages/js", "source": "/packages/js/src", "executors": { - "/packages/js/executors/tsc": { + "/nx-api/js/executors/tsc": { "description": "Build a project using TypeScript.", "file": "generated/packages/js/executors/tsc.json", "hidden": false, "name": "tsc", "originalFilePath": "/packages/js/src/executors/tsc/schema.json", - "path": "/packages/js/executors/tsc", + "path": "/nx-api/js/executors/tsc", "type": "executor" }, - "/packages/js/executors/swc": { + "/nx-api/js/executors/swc": { "description": "Build a project using SWC.", "file": "generated/packages/js/executors/swc.json", "hidden": false, "name": "swc", "originalFilePath": "/packages/js/src/executors/swc/schema.json", - "path": "/packages/js/executors/swc", + "path": "/nx-api/js/executors/swc", "type": "executor" }, - "/packages/js/executors/node": { + "/nx-api/js/executors/node": { "description": "Execute a Node application.", "file": "generated/packages/js/executors/node.json", "hidden": false, "name": "node", "originalFilePath": "/packages/js/src/executors/node/schema.json", - "path": "/packages/js/executors/node", + "path": "/nx-api/js/executors/node", "type": "executor" }, - "/packages/js/executors/release-publish": { + "/nx-api/js/executors/release-publish": { "description": "DO NOT INVOKE DIRECTLY WITH `nx run`. Use `nx release publish` instead.", "file": "generated/packages/js/executors/release-publish.json", "hidden": true, "name": "release-publish", "originalFilePath": "/packages/js/src/executors/release-publish/schema.json", - "path": "/packages/js/executors/release-publish", + "path": "/nx-api/js/executors/release-publish", "type": "executor" }, - "/packages/js/executors/verdaccio": { + "/nx-api/js/executors/verdaccio": { "description": "Start local registry with verdaccio", "file": "generated/packages/js/executors/verdaccio.json", "hidden": false, "name": "verdaccio", "originalFilePath": "/packages/js/src/executors/verdaccio/schema.json", - "path": "/packages/js/executors/verdaccio", + "path": "/nx-api/js/executors/verdaccio", "type": "executor" } }, "generators": { - "/packages/js/generators/library": { + "/nx-api/js/generators/library": { "description": "Create a library", "file": "generated/packages/js/generators/library.json", "hidden": false, "name": "library", "originalFilePath": "/packages/js/src/generators/library/schema.json", - "path": "/packages/js/generators/library", + "path": "/nx-api/js/generators/library", "type": "generator" }, - "/packages/js/generators/init": { + "/nx-api/js/generators/init": { "description": "Initialize a TS/JS workspace.", "file": "generated/packages/js/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/js/src/generators/init/schema.json", - "path": "/packages/js/generators/init", + "path": "/nx-api/js/generators/init", "type": "generator" }, - "/packages/js/generators/convert-to-swc": { + "/nx-api/js/generators/convert-to-swc": { "description": "Convert a TypeScript library to compile with SWC.", "file": "generated/packages/js/generators/convert-to-swc.json", "hidden": false, "name": "convert-to-swc", "originalFilePath": "/packages/js/src/generators/convert-to-swc/schema.json", - "path": "/packages/js/generators/convert-to-swc", + "path": "/nx-api/js/generators/convert-to-swc", "type": "generator" }, - "/packages/js/generators/release-version": { + "/nx-api/js/generators/release-version": { "description": "DO NOT INVOKE DIRECTLY WITH `nx generate`. Use `nx release version` instead.", "file": "generated/packages/js/generators/release-version.json", "hidden": true, "name": "release-version", "originalFilePath": "/packages/js/src/generators/release-version/schema.json", - "path": "/packages/js/generators/release-version", + "path": "/nx-api/js/generators/release-version", "type": "generator" }, - "/packages/js/generators/setup-verdaccio": { + "/nx-api/js/generators/setup-verdaccio": { "description": "Setup Verdaccio for local package management.", "file": "generated/packages/js/generators/setup-verdaccio.json", "hidden": false, "name": "setup-verdaccio", "originalFilePath": "/packages/js/src/generators/setup-verdaccio/schema.json", - "path": "/packages/js/generators/setup-verdaccio", + "path": "/nx-api/js/generators/setup-verdaccio", "type": "generator" }, - "/packages/js/generators/setup-build": { + "/nx-api/js/generators/setup-build": { "description": "setup-build generator", "file": "generated/packages/js/generators/setup-build.json", "hidden": false, "name": "setup-build", "originalFilePath": "/packages/js/src/generators/setup-build/schema.json", - "path": "/packages/js/generators/setup-build", + "path": "/nx-api/js/generators/setup-build", "type": "generator" } }, - "path": "/packages/js" + "path": "/nx-api/js" }, "linter": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -1093,14 +1093,14 @@ "packageName": "@nx/linter", "description": "The Linter plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.", "documents": { - "/packages/linter/documents/overview": { + "/nx-api/linter/documents/overview": { "id": "overview", "name": "Overview", "description": "The Linter plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.", "file": "generated/packages/linter/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/linter/documents/overview", + "path": "/nx-api/linter/documents/overview", "tags": [], "originalFilePath": "shared/packages/linter/linter-plugin" } @@ -1108,46 +1108,46 @@ "root": "/packages/linter", "source": "/packages/linter/src", "executors": { - "/packages/linter/executors/eslint": { + "/nx-api/linter/executors/eslint": { "description": "Run ESLint on a project.", "file": "generated/packages/linter/executors/eslint.json", "hidden": false, "name": "eslint", "originalFilePath": "/packages/linter/src/executors/eslint/schema.json", - "path": "/packages/linter/executors/eslint", + "path": "/nx-api/linter/executors/eslint", "type": "executor" } }, "generators": { - "/packages/linter/generators/workspace-rules-project": { + "/nx-api/linter/generators/workspace-rules-project": { "description": "Create the Workspace Lint Rules Project.", "file": "generated/packages/linter/generators/workspace-rules-project.json", "hidden": true, "name": "workspace-rules-project", "originalFilePath": "/packages/linter/src/generators/workspace-rules-project/schema.json", - "path": "/packages/linter/generators/workspace-rules-project", + "path": "/nx-api/linter/generators/workspace-rules-project", "type": "generator" }, - "/packages/linter/generators/workspace-rule": { + "/nx-api/linter/generators/workspace-rule": { "description": "Create a new Workspace ESLint rule.", "file": "generated/packages/linter/generators/workspace-rule.json", "hidden": false, "name": "workspace-rule", "originalFilePath": "/packages/linter/src/generators/workspace-rule/schema.json", - "path": "/packages/linter/generators/workspace-rule", + "path": "/nx-api/linter/generators/workspace-rule", "type": "generator" }, - "/packages/linter/generators/convert-to-flat-config": { + "/nx-api/linter/generators/convert-to-flat-config": { "description": "Convert an Nx workspace's ESLint configs to use Flat Config.", "file": "generated/packages/linter/generators/convert-to-flat-config.json", "hidden": false, "name": "convert-to-flat-config", "originalFilePath": "/packages/linter/src/generators/convert-to-flat-config/schema.json", - "path": "/packages/linter/generators/convert-to-flat-config", + "path": "/nx-api/linter/generators/convert-to-flat-config", "type": "generator" } }, - "path": "/packages/linter" + "path": "/nx-api/linter" }, "nest": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -1155,14 +1155,14 @@ "packageName": "@nx/nest", "description": "The Nx Plugin for Nest contains executors and generators for allowing your workspace to create powerful Nest best in class APIs.", "documents": { - "/packages/nest/documents/overview": { + "/nx-api/nest/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for Nest contains executors and generators for allowing your workspace to create powerful Nest best in class APIs.", "file": "generated/packages/nest/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/nest/documents/overview", + "path": "/nx-api/nest/documents/overview", "tags": [], "originalFilePath": "shared/packages/nest/nest-plugin" } @@ -1171,179 +1171,179 @@ "source": "/packages/nest/src", "executors": {}, "generators": { - "/packages/nest/generators/application": { + "/nx-api/nest/generators/application": { "description": "Create a NestJS application.", "file": "generated/packages/nest/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/nest/src/generators/application/schema.json", - "path": "/packages/nest/generators/application", + "path": "/nx-api/nest/generators/application", "type": "generator" }, - "/packages/nest/generators/convert-tslint-to-eslint": { + "/nx-api/nest/generators/convert-tslint-to-eslint": { "description": "Convert a project from TSLint to ESLint.", "file": "generated/packages/nest/generators/convert-tslint-to-eslint.json", "hidden": false, "name": "convert-tslint-to-eslint", "originalFilePath": "/packages/nest/src/generators/convert-tslint-to-eslint/schema.json", - "path": "/packages/nest/generators/convert-tslint-to-eslint", + "path": "/nx-api/nest/generators/convert-tslint-to-eslint", "type": "generator" }, - "/packages/nest/generators/init": { + "/nx-api/nest/generators/init": { "description": "Initialize the `@nrwl/nest` plugin.", "file": "generated/packages/nest/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/nest/src/generators/init/schema.json", - "path": "/packages/nest/generators/init", + "path": "/nx-api/nest/generators/init", "type": "generator" }, - "/packages/nest/generators/library": { + "/nx-api/nest/generators/library": { "description": "Create a new NestJS library.", "file": "generated/packages/nest/generators/library.json", "hidden": false, "name": "library", "originalFilePath": "/packages/nest/src/generators/library/schema.json", - "path": "/packages/nest/generators/library", + "path": "/nx-api/nest/generators/library", "type": "generator" }, - "/packages/nest/generators/class": { + "/nx-api/nest/generators/class": { "description": "Run the `class` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/class.json", "hidden": false, "name": "class", "originalFilePath": "/packages/nest/src/generators/class/schema.json", - "path": "/packages/nest/generators/class", + "path": "/nx-api/nest/generators/class", "type": "generator" }, - "/packages/nest/generators/controller": { + "/nx-api/nest/generators/controller": { "description": "Run the `controller` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/controller.json", "hidden": false, "name": "controller", "originalFilePath": "/packages/nest/src/generators/controller/schema.json", - "path": "/packages/nest/generators/controller", + "path": "/nx-api/nest/generators/controller", "type": "generator" }, - "/packages/nest/generators/decorator": { + "/nx-api/nest/generators/decorator": { "description": "Run the `decorator` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/decorator.json", "hidden": false, "name": "decorator", "originalFilePath": "/packages/nest/src/generators/decorator/schema.json", - "path": "/packages/nest/generators/decorator", + "path": "/nx-api/nest/generators/decorator", "type": "generator" }, - "/packages/nest/generators/filter": { + "/nx-api/nest/generators/filter": { "description": "Run the `filter` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/filter.json", "hidden": false, "name": "filter", "originalFilePath": "/packages/nest/src/generators/filter/schema.json", - "path": "/packages/nest/generators/filter", + "path": "/nx-api/nest/generators/filter", "type": "generator" }, - "/packages/nest/generators/gateway": { + "/nx-api/nest/generators/gateway": { "description": "Run the `gateway` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/gateway.json", "hidden": false, "name": "gateway", "originalFilePath": "/packages/nest/src/generators/gateway/schema.json", - "path": "/packages/nest/generators/gateway", + "path": "/nx-api/nest/generators/gateway", "type": "generator" }, - "/packages/nest/generators/guard": { + "/nx-api/nest/generators/guard": { "description": "Run the `guard` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/guard.json", "hidden": false, "name": "guard", "originalFilePath": "/packages/nest/src/generators/guard/schema.json", - "path": "/packages/nest/generators/guard", + "path": "/nx-api/nest/generators/guard", "type": "generator" }, - "/packages/nest/generators/interceptor": { + "/nx-api/nest/generators/interceptor": { "description": "Run the `interceptor` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/interceptor.json", "hidden": false, "name": "interceptor", "originalFilePath": "/packages/nest/src/generators/interceptor/schema.json", - "path": "/packages/nest/generators/interceptor", + "path": "/nx-api/nest/generators/interceptor", "type": "generator" }, - "/packages/nest/generators/interface": { + "/nx-api/nest/generators/interface": { "description": "Run the `interface` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/interface.json", "hidden": false, "name": "interface", "originalFilePath": "/packages/nest/src/generators/interface/schema.json", - "path": "/packages/nest/generators/interface", + "path": "/nx-api/nest/generators/interface", "type": "generator" }, - "/packages/nest/generators/middleware": { + "/nx-api/nest/generators/middleware": { "description": "Run the `middleware` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/middleware.json", "hidden": false, "name": "middleware", "originalFilePath": "/packages/nest/src/generators/middleware/schema.json", - "path": "/packages/nest/generators/middleware", + "path": "/nx-api/nest/generators/middleware", "type": "generator" }, - "/packages/nest/generators/module": { + "/nx-api/nest/generators/module": { "description": "Run the `module` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/module.json", "hidden": false, "name": "module", "originalFilePath": "/packages/nest/src/generators/module/schema.json", - "path": "/packages/nest/generators/module", + "path": "/nx-api/nest/generators/module", "type": "generator" }, - "/packages/nest/generators/pipe": { + "/nx-api/nest/generators/pipe": { "description": "Run the `pipe` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/pipe.json", "hidden": false, "name": "pipe", "originalFilePath": "/packages/nest/src/generators/pipe/schema.json", - "path": "/packages/nest/generators/pipe", + "path": "/nx-api/nest/generators/pipe", "type": "generator" }, - "/packages/nest/generators/provider": { + "/nx-api/nest/generators/provider": { "description": "Run the `provider` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/provider.json", "hidden": false, "name": "provider", "originalFilePath": "/packages/nest/src/generators/provider/schema.json", - "path": "/packages/nest/generators/provider", + "path": "/nx-api/nest/generators/provider", "type": "generator" }, - "/packages/nest/generators/resolver": { + "/nx-api/nest/generators/resolver": { "description": "Run the `resolver` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/resolver.json", "hidden": false, "name": "resolver", "originalFilePath": "/packages/nest/src/generators/resolver/schema.json", - "path": "/packages/nest/generators/resolver", + "path": "/nx-api/nest/generators/resolver", "type": "generator" }, - "/packages/nest/generators/resource": { + "/nx-api/nest/generators/resource": { "description": "Run the `resource` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/resource.json", "hidden": false, "name": "resource", "originalFilePath": "/packages/nest/src/generators/resource/schema.json", - "path": "/packages/nest/generators/resource", + "path": "/nx-api/nest/generators/resource", "type": "generator" }, - "/packages/nest/generators/service": { + "/nx-api/nest/generators/service": { "description": "Run the `service` NestJS generator with Nx project support.", "file": "generated/packages/nest/generators/service.json", "hidden": false, "name": "service", "originalFilePath": "/packages/nest/src/generators/service/schema.json", - "path": "/packages/nest/generators/service", + "path": "/nx-api/nest/generators/service", "type": "generator" } }, - "path": "/packages/nest" + "path": "/nx-api/nest" }, "next": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -1351,14 +1351,14 @@ "packageName": "@nx/next", "description": "The Next.js plugin for Nx contains executors and generators for managing Next.js applications and libraries within an Nx workspace. It provides:\n\n\n- Scaffolding for creating, building, serving, linting, and testing Next.js applications.\n\n- Integration with building, serving, and exporting a Next.js application.\n\n- Integration with React libraries within the workspace. \n\nWhen using Next.js in Nx, you get the out-of-the-box support for TypeScript, Cypress, and Jest. No need to configure anything: watch mode, source maps, and typings just work.", "documents": { - "/packages/next/documents/overview": { + "/nx-api/next/documents/overview": { "id": "overview", "name": "Overview", "description": "The Next.js plugin for Nx contains executors and generators for managing Next.js applications and libraries within an Nx workspace. It provides:\n\n\n- Scaffolding for creating, building, serving, linting, and testing Next.js applications.\n\n- Integration with building, serving, and exporting a Next.js application.\n\n- Integration with React libraries within the workspace. \n\nWhen using Next.js in Nx, you get the out-of-the-box support for TypeScript, Cypress, and Jest. No need to configure anything: watch mode, source maps, and typings just work.", "file": "generated/packages/next/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/next/documents/overview", + "path": "/nx-api/next/documents/overview", "tags": [], "originalFilePath": "shared/packages/next/plugin-overview" } @@ -1366,100 +1366,100 @@ "root": "/packages/next", "source": "/packages/next/src", "executors": { - "/packages/next/executors/build": { + "/nx-api/next/executors/build": { "description": "Build a Next.js application.", "file": "generated/packages/next/executors/build.json", "hidden": false, "name": "build", "originalFilePath": "/packages/next/src/executors/build/schema.json", - "path": "/packages/next/executors/build", + "path": "/nx-api/next/executors/build", "type": "executor" }, - "/packages/next/executors/server": { + "/nx-api/next/executors/server": { "description": "Serve a Next.js application.", "file": "generated/packages/next/executors/server.json", "hidden": false, "name": "server", "originalFilePath": "/packages/next/src/executors/server/schema.json", - "path": "/packages/next/executors/server", + "path": "/nx-api/next/executors/server", "type": "executor" }, - "/packages/next/executors/export": { + "/nx-api/next/executors/export": { "description": "Export a Next.js application. The exported application is located at `dist/$outputPath/exported`.", "file": "generated/packages/next/executors/export.json", "hidden": false, "name": "export", "originalFilePath": "/packages/next/src/executors/export/schema.json", - "path": "/packages/next/executors/export", + "path": "/nx-api/next/executors/export", "type": "executor" } }, "generators": { - "/packages/next/generators/init": { + "/nx-api/next/generators/init": { "description": "Initialize the `@nrwl/next` plugin.", "file": "generated/packages/next/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/next/src/generators/init/schema.json", - "path": "/packages/next/generators/init", + "path": "/nx-api/next/generators/init", "type": "generator" }, - "/packages/next/generators/application": { + "/nx-api/next/generators/application": { "description": "Create an application.", "file": "generated/packages/next/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/next/src/generators/application/schema.json", - "path": "/packages/next/generators/application", + "path": "/nx-api/next/generators/application", "type": "generator" }, - "/packages/next/generators/page": { + "/nx-api/next/generators/page": { "description": "Create a page.", "file": "generated/packages/next/generators/page.json", "hidden": false, "name": "page", "originalFilePath": "/packages/next/src/generators/page/schema.json", - "path": "/packages/next/generators/page", + "path": "/nx-api/next/generators/page", "type": "generator" }, - "/packages/next/generators/component": { + "/nx-api/next/generators/component": { "description": "Create a component.", "file": "generated/packages/next/generators/component.json", "hidden": false, "name": "component", "originalFilePath": "/packages/next/src/generators/component/schema.json", - "path": "/packages/next/generators/component", + "path": "/nx-api/next/generators/component", "type": "generator" }, - "/packages/next/generators/library": { + "/nx-api/next/generators/library": { "description": "Create a library.", "file": "generated/packages/next/generators/library.json", "hidden": false, "name": "library", "originalFilePath": "/packages/next/src/generators/library/schema.json", - "path": "/packages/next/generators/library", + "path": "/nx-api/next/generators/library", "type": "generator" }, - "/packages/next/generators/custom-server": { + "/nx-api/next/generators/custom-server": { "description": "Set up a custom server.", "file": "generated/packages/next/generators/custom-server.json", "hidden": false, "name": "custom-server", "originalFilePath": "/packages/next/src/generators/custom-server/schema.json", - "path": "/packages/next/generators/custom-server", + "path": "/nx-api/next/generators/custom-server", "type": "generator" }, - "/packages/next/generators/cypress-component-configuration": { + "/nx-api/next/generators/cypress-component-configuration": { "description": "cypress-component-configuration generator", "file": "generated/packages/next/generators/cypress-component-configuration.json", "hidden": false, "name": "cypress-component-configuration", "originalFilePath": "/packages/next/src/generators/cypress-component-configuration/schema.json", - "path": "/packages/next/generators/cypress-component-configuration", + "path": "/nx-api/next/generators/cypress-component-configuration", "type": "generator" } }, - "path": "/packages/next" + "path": "/nx-api/next" }, "node": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -1467,14 +1467,14 @@ "packageName": "@nx/node", "description": "The Node Plugin for Nx contains generators to manage Node applications within an Nx workspace.", "documents": { - "/packages/node/documents/overview": { + "/nx-api/node/documents/overview": { "id": "overview", "name": "Overview", "description": "The Node Plugin for Nx contains generators to manage Node applications within an Nx workspace.", "file": "generated/packages/node/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/node/documents/overview", + "path": "/nx-api/node/documents/overview", "tags": [], "originalFilePath": "shared/packages/node/node-plugin" } @@ -1483,44 +1483,44 @@ "source": "/packages/node/src", "executors": {}, "generators": { - "/packages/node/generators/init": { + "/nx-api/node/generators/init": { "description": "Initialize the `@nrwl/node` plugin.", "file": "generated/packages/node/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/node/src/generators/init/schema.json", - "path": "/packages/node/generators/init", + "path": "/nx-api/node/generators/init", "type": "generator" }, - "/packages/node/generators/application": { + "/nx-api/node/generators/application": { "description": "Create a node application.", "file": "generated/packages/node/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/node/src/generators/application/schema.json", - "path": "/packages/node/generators/application", + "path": "/nx-api/node/generators/application", "type": "generator" }, - "/packages/node/generators/library": { + "/nx-api/node/generators/library": { "description": "Create a node library.", "file": "generated/packages/node/generators/library.json", "hidden": false, "name": "library", "originalFilePath": "/packages/node/src/generators/library/schema.json", - "path": "/packages/node/generators/library", + "path": "/nx-api/node/generators/library", "type": "generator" }, - "/packages/node/generators/setup-docker": { + "/nx-api/node/generators/setup-docker": { "description": "Set up Docker configuration for a project.", "file": "generated/packages/node/generators/setup-docker.json", "hidden": false, "name": "setup-docker", "originalFilePath": "/packages/node/src/generators/setup-docker/schema.json", - "path": "/packages/node/generators/setup-docker", + "path": "/nx-api/node/generators/setup-docker", "type": "generator" } }, - "path": "/packages/node" + "path": "/nx-api/node" }, "nx": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -1528,278 +1528,278 @@ "packageName": "nx", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "documents": { - "/packages/nx/documents/create-nx-workspace": { + "/nx-api/nx/documents/create-nx-workspace": { "id": "create-nx-workspace", "name": "create-nx-workspace", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/create-nx-workspace", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/create-nx-workspace", + "path": "/nx-api/nx/documents/create-nx-workspace", "tags": [], "originalFilePath": "generated/cli/create-nx-workspace" }, - "/packages/nx/documents/init": { + "/nx-api/nx/documents/init": { "id": "init", "name": "init", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/init", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/init", + "path": "/nx-api/nx/documents/init", "tags": [], "originalFilePath": "generated/cli/init" }, - "/packages/nx/documents/generate": { + "/nx-api/nx/documents/generate": { "id": "generate", "name": "generate", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/generate", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/generate", + "path": "/nx-api/nx/documents/generate", "tags": ["use-code-generators"], "originalFilePath": "generated/cli/generate" }, - "/packages/nx/documents/run": { + "/nx-api/nx/documents/run": { "id": "run", "name": "run", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/run", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/run", + "path": "/nx-api/nx/documents/run", "tags": ["run-tasks", "use-task-executors"], "originalFilePath": "generated/cli/run" }, - "/packages/nx/documents/daemon": { + "/nx-api/nx/documents/daemon": { "id": "daemon", "name": "daemon", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/daemon", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/daemon", + "path": "/nx-api/nx/documents/daemon", "tags": [], "originalFilePath": "generated/cli/daemon" }, - "/packages/nx/documents/dep-graph": { + "/nx-api/nx/documents/dep-graph": { "id": "dep-graph", "name": "graph", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/dep-graph", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/dep-graph", + "path": "/nx-api/nx/documents/dep-graph", "tags": ["explore-graph"], "originalFilePath": "generated/cli/graph" }, - "/packages/nx/documents/run-many": { + "/nx-api/nx/documents/run-many": { "id": "run-many", "name": "run-many", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/run-many", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/run-many", + "path": "/nx-api/nx/documents/run-many", "tags": ["run-tasks", "use-task-executors"], "originalFilePath": "generated/cli/run-many" }, - "/packages/nx/documents/affected": { + "/nx-api/nx/documents/affected": { "id": "affected", "name": "affected", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/affected", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/affected", + "path": "/nx-api/nx/documents/affected", "tags": ["run-tasks", "use-task-executors"], "originalFilePath": "generated/cli/affected" }, - "/packages/nx/documents/affected-dep-graph": { + "/nx-api/nx/documents/affected-dep-graph": { "id": "affected-dep-graph", "name": "affected:graph", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/affected-dep-graph", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/affected-dep-graph", + "path": "/nx-api/nx/documents/affected-dep-graph", "tags": [], "originalFilePath": "generated/cli/affected-graph" }, - "/packages/nx/documents/print-affected": { + "/nx-api/nx/documents/print-affected": { "id": "print-affected", "name": "print-affected", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/print-affected", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/print-affected", + "path": "/nx-api/nx/documents/print-affected", "tags": [], "originalFilePath": "generated/cli/print-affected" }, - "/packages/nx/documents/format-check": { + "/nx-api/nx/documents/format-check": { "id": "format-check", "name": "format:check", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/format-check", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/format-check", + "path": "/nx-api/nx/documents/format-check", "tags": ["enforce-module-boundaries"], "originalFilePath": "generated/cli/format-check" }, - "/packages/nx/documents/format-write": { + "/nx-api/nx/documents/format-write": { "id": "format-write", "name": "format:write", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/format-write", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/format-write", + "path": "/nx-api/nx/documents/format-write", "tags": ["enforce-module-boundaries"], "originalFilePath": "generated/cli/format-write" }, - "/packages/nx/documents/migrate": { + "/nx-api/nx/documents/migrate": { "id": "migrate", "name": "migrate", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/migrate", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/migrate", + "path": "/nx-api/nx/documents/migrate", "tags": ["automate-updating-dependencies"], "originalFilePath": "generated/cli/migrate" }, - "/packages/nx/documents/report": { + "/nx-api/nx/documents/report": { "id": "report", "name": "report", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/report", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/report", + "path": "/nx-api/nx/documents/report", "tags": [], "originalFilePath": "generated/cli/report" }, - "/packages/nx/documents/list": { + "/nx-api/nx/documents/list": { "id": "list", "name": "list", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/list", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/list", + "path": "/nx-api/nx/documents/list", "tags": [], "originalFilePath": "generated/cli/list" }, - "/packages/nx/documents/workspace-lint": { + "/nx-api/nx/documents/workspace-lint": { "id": "workspace-lint", "name": "workspace-lint", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/workspace-lint", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/workspace-lint", + "path": "/nx-api/nx/documents/workspace-lint", "tags": ["enforce-module-boundaries"], "originalFilePath": "generated/cli/workspace-lint" }, - "/packages/nx/documents/workspace-generator": { + "/nx-api/nx/documents/workspace-generator": { "id": "workspace-generator", "name": "workspace-generator", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/workspace-generator", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/workspace-generator", + "path": "/nx-api/nx/documents/workspace-generator", "tags": [], "originalFilePath": "generated/cli/workspace-generator" }, - "/packages/nx/documents/connect-to-nx-cloud": { + "/nx-api/nx/documents/connect-to-nx-cloud": { "id": "connect-to-nx-cloud", "name": "connect-to-nx-cloud", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/connect-to-nx-cloud", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/connect-to-nx-cloud", + "path": "/nx-api/nx/documents/connect-to-nx-cloud", "tags": ["cache-task-results", "distribute-task-execution"], "originalFilePath": "generated/cli/connect" }, - "/packages/nx/documents/reset": { + "/nx-api/nx/documents/reset": { "id": "reset", "name": "reset", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/reset", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/reset", + "path": "/nx-api/nx/documents/reset", "tags": ["cache-task-results"], "originalFilePath": "generated/cli/reset" }, - "/packages/nx/documents/repair": { + "/nx-api/nx/documents/repair": { "id": "repair", "name": "repair", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/repair", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/repair", + "path": "/nx-api/nx/documents/repair", "tags": [], "originalFilePath": "generated/cli/repair" }, - "/packages/nx/documents/exec": { + "/nx-api/nx/documents/exec": { "id": "exec", "name": "exec", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/exec", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/exec", + "path": "/nx-api/nx/documents/exec", "tags": [], "originalFilePath": "generated/cli/exec" }, - "/packages/nx/documents/watch": { + "/nx-api/nx/documents/watch": { "id": "watch", "name": "watch", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/watch", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/watch", + "path": "/nx-api/nx/documents/watch", "tags": ["workspace-watching"], "originalFilePath": "generated/cli/watch" }, - "/packages/nx/documents/show": { + "/nx-api/nx/documents/show": { "id": "show", "name": "show", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/show", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/show", + "path": "/nx-api/nx/documents/show", "tags": [], "originalFilePath": "generated/cli/show" }, - "/packages/nx/documents/view-logs": { + "/nx-api/nx/documents/view-logs": { "id": "view-logs", "name": "view-logs", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/view-logs", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/view-logs", + "path": "/nx-api/nx/documents/view-logs", "tags": [], "originalFilePath": "generated/cli/view-logs" }, - "/packages/nx/documents/release": { + "/nx-api/nx/documents/release": { "id": "release", "name": "release", "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/nx/documents/release", "itemList": [], "isExternal": false, - "path": "/packages/nx/documents/release", + "path": "/nx-api/nx/documents/release", "tags": [], "originalFilePath": "generated/cli/release" } @@ -1807,36 +1807,36 @@ "root": "/packages/nx", "source": "/packages/nx/src", "executors": { - "/packages/nx/executors/noop": { + "/nx-api/nx/executors/noop": { "description": "An executor that does nothing", "file": "generated/packages/nx/executors/noop.json", "hidden": false, "name": "noop", "originalFilePath": "/packages/nx/src/executors/noop/schema.json", - "path": "/packages/nx/executors/noop", + "path": "/nx-api/nx/executors/noop", "type": "executor" }, - "/packages/nx/executors/run-commands": { + "/nx-api/nx/executors/run-commands": { "description": "Run any custom commands with Nx.", "file": "generated/packages/nx/executors/run-commands.json", "hidden": false, "name": "run-commands", "originalFilePath": "/packages/nx/src/executors/run-commands/schema.json", - "path": "/packages/nx/executors/run-commands", + "path": "/nx-api/nx/executors/run-commands", "type": "executor" }, - "/packages/nx/executors/run-script": { + "/nx-api/nx/executors/run-script": { "description": "Run an NPM script using Nx.", "file": "generated/packages/nx/executors/run-script.json", "hidden": false, "name": "run-script", "originalFilePath": "/packages/nx/src/executors/run-script/schema.json", - "path": "/packages/nx/executors/run-script", + "path": "/nx-api/nx/executors/run-script", "type": "executor" } }, "generators": {}, - "path": "/packages/nx" + "path": "/nx-api/nx" }, "playwright": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -1844,14 +1844,14 @@ "packageName": "@nx/playwright", "description": "The Nx Plugin for Playwright contains executors and generators allowing your workspace to use the powerful Playwright integration testing capabilities.", "documents": { - "/packages/playwright/documents/overview": { + "/nx-api/playwright/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for Playwright contains executors and generators allowing your workspace to use the powerful Playwright integration testing capabilities.", "file": "generated/packages/playwright/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/playwright/documents/overview", + "path": "/nx-api/playwright/documents/overview", "tags": [], "originalFilePath": "shared/packages/playwright/playwright-plugin" } @@ -1859,37 +1859,37 @@ "root": "/packages/playwright", "source": "/packages/playwright/src", "executors": { - "/packages/playwright/executors/playwright": { + "/nx-api/playwright/executors/playwright": { "description": "Run Playwright tests.", "file": "generated/packages/playwright/executors/playwright.json", "hidden": false, "name": "playwright", "originalFilePath": "/packages/playwright/src/executors/playwright/schema.json", - "path": "/packages/playwright/executors/playwright", + "path": "/nx-api/playwright/executors/playwright", "type": "executor" } }, "generators": { - "/packages/playwright/generators/configuration": { + "/nx-api/playwright/generators/configuration": { "description": "Add Nx Playwright configuration to your project", "file": "generated/packages/playwright/generators/configuration.json", "hidden": false, "name": "configuration", "originalFilePath": "/packages/playwright/src/generators/configuration/schema.json", - "path": "/packages/playwright/generators/configuration", + "path": "/nx-api/playwright/generators/configuration", "type": "generator" }, - "/packages/playwright/generators/init": { + "/nx-api/playwright/generators/init": { "description": "Initializes a Playwright project in the current workspace", "file": "generated/packages/playwright/generators/init.json", "hidden": false, "name": "init", "originalFilePath": "/packages/playwright/src/generators/init/schema.json", - "path": "/packages/playwright/generators/init", + "path": "/nx-api/playwright/generators/init", "type": "generator" } }, - "path": "/packages/playwright" + "path": "/nx-api/playwright" }, "plugin": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -1897,14 +1897,14 @@ "packageName": "@nx/plugin", "description": "This plugin is used to create Nx plugins! It contains generators for generating common plugin features like generators, executors, migrations and more.", "documents": { - "/packages/plugin/documents/overview": { + "/nx-api/plugin/documents/overview": { "id": "overview", "name": "Overview", "description": "This plugin is used to create Nx plugins! It contains generators for generating common plugin features like generators, executors, migrations and more.", "file": "generated/packages/plugin/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/plugin/documents/overview", + "path": "/nx-api/plugin/documents/overview", "tags": [], "originalFilePath": "shared/packages/plugin/plugin" } @@ -1912,91 +1912,91 @@ "root": "/packages/plugin", "source": "/packages/plugin/src", "executors": { - "/packages/plugin/executors/e2e": { + "/nx-api/plugin/executors/e2e": { "description": "Creates and runs the E2E tests for an Nx Plugin.", "file": "generated/packages/plugin/executors/e2e.json", "hidden": false, "name": "e2e", "originalFilePath": "/packages/plugin/src/executors/e2e/schema.json", - "path": "/packages/plugin/executors/e2e", + "path": "/nx-api/plugin/executors/e2e", "type": "executor" } }, "generators": { - "/packages/plugin/generators/plugin": { + "/nx-api/plugin/generators/plugin": { "description": "Create a Nx Plugin.", "file": "generated/packages/plugin/generators/plugin.json", "hidden": false, "name": "plugin", "originalFilePath": "/packages/plugin/src/generators/plugin/schema.json", - "path": "/packages/plugin/generators/plugin", + "path": "/nx-api/plugin/generators/plugin", "type": "generator" }, - "/packages/plugin/generators/create-package": { + "/nx-api/plugin/generators/create-package": { "description": "Create a package which can be used by npx to create a new workspace", "file": "generated/packages/plugin/generators/create-package.json", "hidden": false, "name": "create-package", "originalFilePath": "/packages/plugin/src/generators/create-package/schema.json", - "path": "/packages/plugin/generators/create-package", + "path": "/nx-api/plugin/generators/create-package", "type": "generator" }, - "/packages/plugin/generators/e2e-project": { + "/nx-api/plugin/generators/e2e-project": { "description": "Create a E2E application for a Nx Plugin.", "file": "generated/packages/plugin/generators/e2e-project.json", "hidden": false, "name": "e2e-project", "originalFilePath": "/packages/plugin/src/generators/e2e-project/schema.json", - "path": "/packages/plugin/generators/e2e-project", + "path": "/nx-api/plugin/generators/e2e-project", "type": "generator" }, - "/packages/plugin/generators/migration": { + "/nx-api/plugin/generators/migration": { "description": "Create a migration for an Nx Plugin.", "file": "generated/packages/plugin/generators/migration.json", "hidden": false, "name": "migration", "originalFilePath": "/packages/plugin/src/generators/migration/schema.json", - "path": "/packages/plugin/generators/migration", + "path": "/nx-api/plugin/generators/migration", "type": "generator" }, - "/packages/plugin/generators/generator": { + "/nx-api/plugin/generators/generator": { "description": "Create a generator for an Nx Plugin.", "file": "generated/packages/plugin/generators/generator.json", "hidden": false, "name": "generator", "originalFilePath": "/packages/plugin/src/generators/generator/schema.json", - "path": "/packages/plugin/generators/generator", + "path": "/nx-api/plugin/generators/generator", "type": "generator" }, - "/packages/plugin/generators/executor": { + "/nx-api/plugin/generators/executor": { "description": "Create an executor for an Nx Plugin.", "file": "generated/packages/plugin/generators/executor.json", "hidden": false, "name": "executor", "originalFilePath": "/packages/plugin/src/generators/executor/schema.json", - "path": "/packages/plugin/generators/executor", + "path": "/nx-api/plugin/generators/executor", "type": "generator" }, - "/packages/plugin/generators/plugin-lint-checks": { + "/nx-api/plugin/generators/plugin-lint-checks": { "description": "Adds linting configuration to validate common json files for nx plugins.", "file": "generated/packages/plugin/generators/plugin-lint-checks.json", "hidden": false, "name": "plugin-lint-checks", "originalFilePath": "/packages/plugin/src/generators/lint-checks/schema.json", - "path": "/packages/plugin/generators/plugin-lint-checks", + "path": "/nx-api/plugin/generators/plugin-lint-checks", "type": "generator" }, - "/packages/plugin/generators/preset": { + "/nx-api/plugin/generators/preset": { "description": "Initializes a workspace with an nx-plugin inside of it. Use as: `create-nx-workspace --preset @nrwl/nx-plugin`.", "file": "generated/packages/plugin/generators/preset.json", "hidden": true, "name": "preset", "originalFilePath": "/packages/plugin/src/generators/preset/schema.json", - "path": "/packages/plugin/generators/preset", + "path": "/nx-api/plugin/generators/preset", "type": "generator" } }, - "path": "/packages/plugin" + "path": "/nx-api/plugin" }, "react": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2004,14 +2004,14 @@ "packageName": "@nx/react", "description": "The React plugin for Nx contains executors and generators for managing React applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Cypress, and Storybook.\n\n- Generators for applications, libraries, components, hooks, and more.\n\n- Library build support for publishing packages to npm or other registries.\n\n- Utilities for automatic workspace refactoring.", "documents": { - "/packages/react/documents/overview": { + "/nx-api/react/documents/overview": { "id": "overview", "name": "Overview", "description": "The React plugin for Nx contains executors and generators for managing React applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Cypress, and Storybook.\n\n- Generators for applications, libraries, components, hooks, and more.\n\n- Library build support for publishing packages to npm or other registries.\n\n- Utilities for automatic workspace refactoring.", "file": "generated/packages/react/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/react/documents/overview", + "path": "/nx-api/react/documents/overview", "tags": [], "originalFilePath": "shared/packages/react/react-plugin" } @@ -2019,172 +2019,172 @@ "root": "/packages/react", "source": "/packages/react/src", "executors": { - "/packages/react/executors/module-federation-dev-server": { + "/nx-api/react/executors/module-federation-dev-server": { "description": "Serve a host or remote application.", "file": "generated/packages/react/executors/module-federation-dev-server.json", "hidden": false, "name": "module-federation-dev-server", "originalFilePath": "/packages/react/src/executors/module-federation-dev-server/schema.json", - "path": "/packages/react/executors/module-federation-dev-server", + "path": "/nx-api/react/executors/module-federation-dev-server", "type": "executor" }, - "/packages/react/executors/module-federation-ssr-dev-server": { + "/nx-api/react/executors/module-federation-ssr-dev-server": { "description": "Serve a host application along with it's known remotes.", "file": "generated/packages/react/executors/module-federation-ssr-dev-server.json", "hidden": false, "name": "module-federation-ssr-dev-server", "originalFilePath": "/packages/react/src/executors/module-federation-ssr-dev-server/schema.json", - "path": "/packages/react/executors/module-federation-ssr-dev-server", + "path": "/nx-api/react/executors/module-federation-ssr-dev-server", "type": "executor" } }, "generators": { - "/packages/react/generators/init": { + "/nx-api/react/generators/init": { "description": "Initialize the `@nrwl/react` plugin.", "file": "generated/packages/react/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/react/src/generators/init/schema.json", - "path": "/packages/react/generators/init", + "path": "/nx-api/react/generators/init", "type": "generator" }, - "/packages/react/generators/application": { + "/nx-api/react/generators/application": { "description": "Create a React application.", "file": "generated/packages/react/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/react/src/generators/application/schema.json", - "path": "/packages/react/generators/application", + "path": "/nx-api/react/generators/application", "type": "generator" }, - "/packages/react/generators/library": { + "/nx-api/react/generators/library": { "description": "Create a React library.", "file": "generated/packages/react/generators/library.json", "hidden": false, "name": "library", "originalFilePath": "/packages/react/src/generators/library/schema.json", - "path": "/packages/react/generators/library", + "path": "/nx-api/react/generators/library", "type": "generator" }, - "/packages/react/generators/component": { + "/nx-api/react/generators/component": { "description": "Create a React component.", "file": "generated/packages/react/generators/component.json", "hidden": false, "name": "component", "originalFilePath": "/packages/react/src/generators/component/schema.json", - "path": "/packages/react/generators/component", + "path": "/nx-api/react/generators/component", "type": "generator" }, - "/packages/react/generators/redux": { + "/nx-api/react/generators/redux": { "description": "Create a Redux slice for a project.", "file": "generated/packages/react/generators/redux.json", "hidden": false, "name": "redux", "originalFilePath": "/packages/react/src/generators/redux/schema.json", - "path": "/packages/react/generators/redux", + "path": "/nx-api/react/generators/redux", "type": "generator" }, - "/packages/react/generators/storybook-configuration": { + "/nx-api/react/generators/storybook-configuration": { "description": "Set up storybook for a React app or library.", "file": "generated/packages/react/generators/storybook-configuration.json", "hidden": false, "name": "storybook-configuration", "originalFilePath": "/packages/react/src/generators/storybook-configuration/schema.json", - "path": "/packages/react/generators/storybook-configuration", + "path": "/nx-api/react/generators/storybook-configuration", "type": "generator" }, - "/packages/react/generators/component-story": { + "/nx-api/react/generators/component-story": { "description": "Generate storybook story for a React component", "file": "generated/packages/react/generators/component-story.json", "hidden": false, "name": "component-story", "originalFilePath": "/packages/react/src/generators/component-story/schema.json", - "path": "/packages/react/generators/component-story", + "path": "/nx-api/react/generators/component-story", "type": "generator" }, - "/packages/react/generators/stories": { + "/nx-api/react/generators/stories": { "description": "Create stories/specs for all components declared in an app or library.", "file": "generated/packages/react/generators/stories.json", "hidden": false, "name": "stories", "originalFilePath": "/packages/react/src/generators/stories/schema.json", - "path": "/packages/react/generators/stories", + "path": "/nx-api/react/generators/stories", "type": "generator" }, - "/packages/react/generators/component-cypress-spec": { + "/nx-api/react/generators/component-cypress-spec": { "description": "Create a Cypress spec for a UI component that has a story.", "file": "generated/packages/react/generators/component-cypress-spec.json", "hidden": false, "name": "component-cypress-spec", "originalFilePath": "/packages/react/src/generators/component-cypress-spec/schema.json", - "path": "/packages/react/generators/component-cypress-spec", + "path": "/nx-api/react/generators/component-cypress-spec", "type": "generator" }, - "/packages/react/generators/hook": { + "/nx-api/react/generators/hook": { "description": "Create a hook.", "file": "generated/packages/react/generators/hook.json", "hidden": false, "name": "hook", "originalFilePath": "/packages/react/src/generators/hook/schema.json", - "path": "/packages/react/generators/hook", + "path": "/nx-api/react/generators/hook", "type": "generator" }, - "/packages/react/generators/host": { + "/nx-api/react/generators/host": { "description": "Generate a host react application", "file": "generated/packages/react/generators/host.json", "hidden": false, "name": "host", "originalFilePath": "/packages/react/src/generators/host/schema.json", - "path": "/packages/react/generators/host", + "path": "/nx-api/react/generators/host", "type": "generator" }, - "/packages/react/generators/remote": { + "/nx-api/react/generators/remote": { "description": "Generate a remote react application", "file": "generated/packages/react/generators/remote.json", "hidden": false, "name": "remote", "originalFilePath": "/packages/react/src/generators/remote/schema.json", - "path": "/packages/react/generators/remote", + "path": "/nx-api/react/generators/remote", "type": "generator" }, - "/packages/react/generators/cypress-component-configuration": { + "/nx-api/react/generators/cypress-component-configuration": { "description": "Setup Cypress component testing for a React project", "file": "generated/packages/react/generators/cypress-component-configuration.json", "hidden": false, "name": "cypress-component-configuration", "originalFilePath": "/packages/react/src/generators/cypress-component-configuration/schema.json", - "path": "/packages/react/generators/cypress-component-configuration", + "path": "/nx-api/react/generators/cypress-component-configuration", "type": "generator" }, - "/packages/react/generators/component-test": { + "/nx-api/react/generators/component-test": { "description": "Generate a Cypress component test for a React component", "file": "generated/packages/react/generators/component-test.json", "hidden": false, "name": "component-test", "originalFilePath": "/packages/react/src/generators/component-test/schema.json", - "path": "/packages/react/generators/component-test", + "path": "/nx-api/react/generators/component-test", "type": "generator" }, - "/packages/react/generators/setup-tailwind": { + "/nx-api/react/generators/setup-tailwind": { "description": "Set up Tailwind configuration for a project.", "file": "generated/packages/react/generators/setup-tailwind.json", "hidden": false, "name": "setup-tailwind", "originalFilePath": "/packages/react/src/generators/setup-tailwind/schema.json", - "path": "/packages/react/generators/setup-tailwind", + "path": "/nx-api/react/generators/setup-tailwind", "type": "generator" }, - "/packages/react/generators/setup-ssr": { + "/nx-api/react/generators/setup-ssr": { "description": "Set up SSR configuration for a project.", "file": "generated/packages/react/generators/setup-ssr.json", "hidden": false, "name": "setup-ssr", "originalFilePath": "/packages/react/src/generators/setup-ssr/schema.json", - "path": "/packages/react/generators/setup-ssr", + "path": "/nx-api/react/generators/setup-ssr", "type": "generator" } }, - "path": "/packages/react" + "path": "/nx-api/react" }, "react-native": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2192,14 +2192,14 @@ "packageName": "@nx/react-native", "description": "The Nx Plugin for React Native contains generators for managing React Native applications and libraries within an Nx workspace. It provides: \n\n-Integration with libraries such as Jest, Detox, and Storybook.\n-Scaffolding for creating buildable libraries that can be published to npm.\n-Utilities for automatic workspace refactoring.", "documents": { - "/packages/react-native/documents/overview": { + "/nx-api/react-native/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for React Native contains generators for managing React Native applications and libraries within an Nx workspace. It provides: \n\n-Integration with libraries such as Jest, Detox, and Storybook.\n-Scaffolding for creating buildable libraries that can be published to npm.\n-Utilities for automatic workspace refactoring.", "file": "generated/packages/react-native/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/react-native/documents/overview", + "path": "/nx-api/react-native/documents/overview", "tags": [], "originalFilePath": "shared/packages/react-native/react-native-plugin" } @@ -2207,172 +2207,172 @@ "root": "/packages/react-native", "source": "/packages/react-native/src", "executors": { - "/packages/react-native/executors/run-android": { + "/nx-api/react-native/executors/run-android": { "description": "Runs Android application.", "file": "generated/packages/react-native/executors/run-android.json", "hidden": false, "name": "run-android", "originalFilePath": "/packages/react-native/src/executors/run-android/schema.json", - "path": "/packages/react-native/executors/run-android", + "path": "/nx-api/react-native/executors/run-android", "type": "executor" }, - "/packages/react-native/executors/run-ios": { + "/nx-api/react-native/executors/run-ios": { "description": "Runs iOS application.", "file": "generated/packages/react-native/executors/run-ios.json", "hidden": false, "name": "run-ios", "originalFilePath": "/packages/react-native/src/executors/run-ios/schema.json", - "path": "/packages/react-native/executors/run-ios", + "path": "/nx-api/react-native/executors/run-ios", "type": "executor" }, - "/packages/react-native/executors/bundle": { + "/nx-api/react-native/executors/bundle": { "description": "Builds the JavaScript bundle for offline use.", "file": "generated/packages/react-native/executors/bundle.json", "hidden": false, "name": "bundle", "originalFilePath": "/packages/react-native/src/executors/bundle/schema.json", - "path": "/packages/react-native/executors/bundle", + "path": "/nx-api/react-native/executors/bundle", "type": "executor" }, - "/packages/react-native/executors/build-android": { + "/nx-api/react-native/executors/build-android": { "description": "Release Build for Android.", "file": "generated/packages/react-native/executors/build-android.json", "hidden": false, "name": "build-android", "originalFilePath": "/packages/react-native/src/executors/build-android/schema.json", - "path": "/packages/react-native/executors/build-android", + "path": "/nx-api/react-native/executors/build-android", "type": "executor" }, - "/packages/react-native/executors/build-ios": { + "/nx-api/react-native/executors/build-ios": { "description": "Build iOS app", "file": "generated/packages/react-native/executors/build-ios.json", "hidden": false, "name": "build-ios", "originalFilePath": "/packages/react-native/src/executors/build-ios/schema.json", - "path": "/packages/react-native/executors/build-ios", + "path": "/nx-api/react-native/executors/build-ios", "type": "executor" }, - "/packages/react-native/executors/start": { + "/nx-api/react-native/executors/start": { "description": "Starts the Javascript server that communicates with connected devices.", "file": "generated/packages/react-native/executors/start.json", "hidden": false, "name": "start", "originalFilePath": "/packages/react-native/src/executors/start/schema.json", - "path": "/packages/react-native/executors/start", + "path": "/nx-api/react-native/executors/start", "type": "executor" }, - "/packages/react-native/executors/sync-deps": { + "/nx-api/react-native/executors/sync-deps": { "description": "Syncs dependencies to `package.json` (required for autolinking).", "file": "generated/packages/react-native/executors/sync-deps.json", "hidden": false, "name": "sync-deps", "originalFilePath": "/packages/react-native/src/executors/sync-deps/schema.json", - "path": "/packages/react-native/executors/sync-deps", + "path": "/nx-api/react-native/executors/sync-deps", "type": "executor" }, - "/packages/react-native/executors/ensure-symlink": { + "/nx-api/react-native/executors/ensure-symlink": { "description": "Ensure workspace `node_modules` is symlink under app's `node_modules` folder.", "file": "generated/packages/react-native/executors/ensure-symlink.json", "hidden": false, "name": "ensure-symlink", "originalFilePath": "/packages/react-native/src/executors/ensure-symlink/schema.json", - "path": "/packages/react-native/executors/ensure-symlink", + "path": "/nx-api/react-native/executors/ensure-symlink", "type": "executor" }, - "/packages/react-native/executors/storybook": { + "/nx-api/react-native/executors/storybook": { "description": "Serve React Native Storybook.", "file": "generated/packages/react-native/executors/storybook.json", "hidden": false, "name": "storybook", "originalFilePath": "/packages/react-native/src/executors/storybook/schema.json", - "path": "/packages/react-native/executors/storybook", + "path": "/nx-api/react-native/executors/storybook", "type": "executor" }, - "/packages/react-native/executors/pod-install": { + "/nx-api/react-native/executors/pod-install": { "description": "Run `pod install` in the `ios` directory.", "file": "generated/packages/react-native/executors/pod-install.json", "hidden": false, "name": "pod-install", "originalFilePath": "/packages/react-native/src/executors/pod-install/schema.json", - "path": "/packages/react-native/executors/pod-install", + "path": "/nx-api/react-native/executors/pod-install", "type": "executor" } }, "generators": { - "/packages/react-native/generators/init": { + "/nx-api/react-native/generators/init": { "description": "Initialize the `@nrwl/react-native` plugin.", "file": "generated/packages/react-native/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/react-native/src/generators/init/schema.json", - "path": "/packages/react-native/generators/init", + "path": "/nx-api/react-native/generators/init", "type": "generator" }, - "/packages/react-native/generators/application": { + "/nx-api/react-native/generators/application": { "description": "Create a React Native application.", "file": "generated/packages/react-native/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/react-native/src/generators/application/schema.json", - "path": "/packages/react-native/generators/application", + "path": "/nx-api/react-native/generators/application", "type": "generator" }, - "/packages/react-native/generators/library": { + "/nx-api/react-native/generators/library": { "description": "Create a React Native library.", "file": "generated/packages/react-native/generators/library.json", "hidden": false, "name": "library", "originalFilePath": "/packages/react-native/src/generators/library/schema.json", - "path": "/packages/react-native/generators/library", + "path": "/nx-api/react-native/generators/library", "type": "generator" }, - "/packages/react-native/generators/component": { + "/nx-api/react-native/generators/component": { "description": "Create a React Native component.", "file": "generated/packages/react-native/generators/component.json", "hidden": false, "name": "component", "originalFilePath": "/packages/react-native/src/generators/component/schema.json", - "path": "/packages/react-native/generators/component", + "path": "/nx-api/react-native/generators/component", "type": "generator" }, - "/packages/react-native/generators/storybook-configuration": { + "/nx-api/react-native/generators/storybook-configuration": { "description": "Set up Storybook for a React-native application or library.", "file": "generated/packages/react-native/generators/storybook-configuration.json", "hidden": false, "name": "storybook-configuration", "originalFilePath": "/packages/react-native/src/generators/storybook-configuration/schema.json", - "path": "/packages/react-native/generators/storybook-configuration", + "path": "/nx-api/react-native/generators/storybook-configuration", "type": "generator" }, - "/packages/react-native/generators/component-story": { + "/nx-api/react-native/generators/component-story": { "description": "Generate Storybook story for a React-native component.", "file": "generated/packages/react-native/generators/component-story.json", "hidden": false, "name": "component-story", "originalFilePath": "/packages/react-native/src/generators/component-story/schema.json", - "path": "/packages/react-native/generators/component-story", + "path": "/nx-api/react-native/generators/component-story", "type": "generator" }, - "/packages/react-native/generators/stories": { + "/nx-api/react-native/generators/stories": { "description": "Create stories/specs for all components declared in an application or library.", "file": "generated/packages/react-native/generators/stories.json", "hidden": false, "name": "stories", "originalFilePath": "/packages/react-native/src/generators/stories/schema.json", - "path": "/packages/react-native/generators/stories", + "path": "/nx-api/react-native/generators/stories", "type": "generator" }, - "/packages/react-native/generators/upgrade-native": { + "/nx-api/react-native/generators/upgrade-native": { "description": "Destructive command to upgrade native iOS and Android code to latest.", "file": "generated/packages/react-native/generators/upgrade-native.json", "hidden": false, "name": "upgrade-native", "originalFilePath": "/packages/react-native/src/generators/upgrade-native/schema.json", - "path": "/packages/react-native/generators/upgrade-native", + "path": "/nx-api/react-native/generators/upgrade-native", "type": "generator" } }, - "path": "/packages/react-native" + "path": "/nx-api/react-native" }, "rollup": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2383,37 +2383,37 @@ "root": "/packages/rollup", "source": "/packages/rollup/src", "executors": { - "/packages/rollup/executors/rollup": { + "/nx-api/rollup/executors/rollup": { "description": "Bundle a package using Rollup.", "file": "generated/packages/rollup/executors/rollup.json", "hidden": false, "name": "rollup", "originalFilePath": "/packages/rollup/src/executors/rollup/schema.json", - "path": "/packages/rollup/executors/rollup", + "path": "/nx-api/rollup/executors/rollup", "type": "executor" } }, "generators": { - "/packages/rollup/generators/init": { + "/nx-api/rollup/generators/init": { "description": "Initialize the `@nrwl/rollup` plugin.", "file": "generated/packages/rollup/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/rollup/src/generators/init/schema.json", - "path": "/packages/rollup/generators/init", + "path": "/nx-api/rollup/generators/init", "type": "generator" }, - "/packages/rollup/generators/configuration": { + "/nx-api/rollup/generators/configuration": { "description": "Add rollup configuration to a project.", "file": "generated/packages/rollup/generators/configuration.json", "hidden": false, "name": "configuration", "originalFilePath": "/packages/rollup/src/generators/configuration/schema.json", - "path": "/packages/rollup/generators/configuration", + "path": "/nx-api/rollup/generators/configuration", "type": "generator" } }, - "path": "/packages/rollup" + "path": "/nx-api/rollup" }, "storybook": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2421,36 +2421,36 @@ "packageName": "@nx/storybook", "description": "The Nx Plugin for Storybook contains executors and generators for allowing your workspace to use the powerful Storybook integration testing & documenting capabilities.", "documents": { - "/packages/storybook/documents/overview": { + "/nx-api/storybook/documents/overview": { "id": "overview", "name": "Nx Storybook Plugin Overview", "description": "This is an overview page for the Storybook plugin in Nx. It explains what Storybook is and how to set it up in your Nx workspace.", "file": "generated/packages/storybook/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/storybook/documents/overview", + "path": "/nx-api/storybook/documents/overview", "tags": [], "originalFilePath": "shared/packages/storybook/plugin-overview" }, - "/packages/storybook/documents/best-practices": { + "/nx-api/storybook/documents/best-practices": { "id": "best-practices", "name": "Storybook best practices for making the most out of Nx", "description": "The purpose of this guide is to help you set up Storybook in your Nx workspace so that you can get the most out of Nx and its powerful capabilities.", "file": "generated/packages/storybook/documents/best-practices", "itemList": [], "isExternal": false, - "path": "/packages/storybook/documents/best-practices", + "path": "/nx-api/storybook/documents/best-practices", "tags": [], "originalFilePath": "shared/packages/storybook/best-practices" }, - "/packages/storybook/documents/storybook-7-setup": { + "/nx-api/storybook/documents/storybook-7-setup": { "id": "storybook-7-setup", "name": "Storybook 7 overview", "description": "This guide explains how you can set up Storybook version 7 in your Nx workspace. It contains information about the generators and the frameworks that are supported.", "file": "generated/packages/storybook/documents/storybook-7-setup", "itemList": [], "isExternal": false, - "path": "/packages/storybook/documents/storybook-7-setup", + "path": "/nx-api/storybook/documents/storybook-7-setup", "tags": [], "originalFilePath": "shared/packages/storybook/storybook-7-setup" } @@ -2458,64 +2458,64 @@ "root": "/packages/storybook", "source": "/packages/storybook/src", "executors": { - "/packages/storybook/executors/storybook": { + "/nx-api/storybook/executors/storybook": { "description": "Serve Storybook.", "file": "generated/packages/storybook/executors/storybook.json", "hidden": false, "name": "storybook", "originalFilePath": "/packages/storybook/src/executors/storybook/schema.json", - "path": "/packages/storybook/executors/storybook", + "path": "/nx-api/storybook/executors/storybook", "type": "executor" }, - "/packages/storybook/executors/build": { + "/nx-api/storybook/executors/build": { "description": "Build Storybook.", "file": "generated/packages/storybook/executors/build.json", "hidden": false, "name": "build", "originalFilePath": "/packages/storybook/src/executors/build-storybook/schema.json", - "path": "/packages/storybook/executors/build", + "path": "/nx-api/storybook/executors/build", "type": "executor" } }, "generators": { - "/packages/storybook/generators/init": { + "/nx-api/storybook/generators/init": { "description": "Add Storybook configuration to the workspace.", "file": "generated/packages/storybook/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/storybook/src/generators/init/schema.json", - "path": "/packages/storybook/generators/init", + "path": "/nx-api/storybook/generators/init", "type": "generator" }, - "/packages/storybook/generators/configuration": { + "/nx-api/storybook/generators/configuration": { "description": "Add Storybook configuration to a UI library or an application.", "file": "generated/packages/storybook/generators/configuration.json", "hidden": false, "name": "configuration", "originalFilePath": "/packages/storybook/src/generators/configuration/schema.json", - "path": "/packages/storybook/generators/configuration", + "path": "/nx-api/storybook/generators/configuration", "type": "generator" }, - "/packages/storybook/generators/cypress-project": { + "/nx-api/storybook/generators/cypress-project": { "description": "Add cypress e2e app to test a UI library that is set up for Storybook.", "file": "generated/packages/storybook/generators/cypress-project.json", "hidden": false, "name": "cypress-project", "originalFilePath": "/packages/storybook/src/generators/cypress-project/schema.json", - "path": "/packages/storybook/generators/cypress-project", + "path": "/nx-api/storybook/generators/cypress-project", "type": "generator" }, - "/packages/storybook/generators/migrate-7": { + "/nx-api/storybook/generators/migrate-7": { "description": "Migrate to Storybook version 7.", "file": "generated/packages/storybook/generators/migrate-7.json", "hidden": false, "name": "migrate-7", "originalFilePath": "/packages/storybook/src/generators/migrate-7/schema.json", - "path": "/packages/storybook/generators/migrate-7", + "path": "/nx-api/storybook/generators/migrate-7", "type": "generator" } }, - "path": "/packages/storybook" + "path": "/nx-api/storybook" }, "tao": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2527,7 +2527,7 @@ "source": "/packages/tao/src", "executors": {}, "generators": {}, - "path": "/packages/tao" + "path": "/nx-api/tao" }, "vite": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2535,14 +2535,14 @@ "packageName": "@nx/vite", "description": "The Nx Plugin for building and testing applications using Vite", "documents": { - "/packages/vite/documents/overview": { + "/nx-api/vite/documents/overview": { "id": "overview", "name": "Overview of the Nx Vite Plugin", "description": "The Nx Plugin for Vite contains executors and generators that support building applications using Vite. This page also explains how to configure Vite on your Nx workspace.", "file": "generated/packages/vite/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/vite/documents/overview", + "path": "/nx-api/vite/documents/overview", "tags": [], "originalFilePath": "shared/packages/vite/vite-plugin" } @@ -2550,73 +2550,73 @@ "root": "/packages/vite", "source": "/packages/vite/src", "executors": { - "/packages/vite/executors/dev-server": { + "/nx-api/vite/executors/dev-server": { "description": "Vite dev server.", "file": "generated/packages/vite/executors/dev-server.json", "hidden": false, "name": "dev-server", "originalFilePath": "/packages/vite/src/executors/dev-server/schema.json", - "path": "/packages/vite/executors/dev-server", + "path": "/nx-api/vite/executors/dev-server", "type": "executor" }, - "/packages/vite/executors/build": { + "/nx-api/vite/executors/build": { "description": "Build with Vite.", "file": "generated/packages/vite/executors/build.json", "hidden": false, "name": "build", "originalFilePath": "/packages/vite/src/executors/build/schema.json", - "path": "/packages/vite/executors/build", + "path": "/nx-api/vite/executors/build", "type": "executor" }, - "/packages/vite/executors/test": { + "/nx-api/vite/executors/test": { "description": "Test with Vitest", "file": "generated/packages/vite/executors/test.json", "hidden": false, "name": "test", "originalFilePath": "/packages/vite/src/executors/test/schema.json", - "path": "/packages/vite/executors/test", + "path": "/nx-api/vite/executors/test", "type": "executor" }, - "/packages/vite/executors/preview-server": { + "/nx-api/vite/executors/preview-server": { "description": "Vite preview server", "file": "generated/packages/vite/executors/preview-server.json", "hidden": false, "name": "preview-server", "originalFilePath": "/packages/vite/src/executors/preview-server/schema.json", - "path": "/packages/vite/executors/preview-server", + "path": "/nx-api/vite/executors/preview-server", "type": "executor" } }, "generators": { - "/packages/vite/generators/init": { + "/nx-api/vite/generators/init": { "description": "Initialize Vite in the workspace.", "file": "generated/packages/vite/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/vite/src/generators/init/schema.json", - "path": "/packages/vite/generators/init", + "path": "/nx-api/vite/generators/init", "type": "generator" }, - "/packages/vite/generators/configuration": { + "/nx-api/vite/generators/configuration": { "description": "Add Vite configuration to an application.", "file": "generated/packages/vite/generators/configuration.json", "hidden": false, "name": "configuration", "originalFilePath": "/packages/vite/src/generators/configuration/schema.json", - "path": "/packages/vite/generators/configuration", + "path": "/nx-api/vite/generators/configuration", "type": "generator" }, - "/packages/vite/generators/vitest": { + "/nx-api/vite/generators/vitest": { "description": "Generate a vitest configuration", "file": "generated/packages/vite/generators/vitest.json", "hidden": false, "name": "vitest", "originalFilePath": "/packages/vite/src/generators/vitest/schema.json", - "path": "/packages/vite/generators/vitest", + "path": "/nx-api/vite/generators/vitest", "type": "generator" } }, - "path": "/packages/vite" + "path": "/nx-api/vite" }, "web": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2624,14 +2624,14 @@ "packageName": "@nx/web", "description": "The Nx Plugin for Web Components contains generators for managing Web Component applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Cypress, and Storybook.\n\n- Scaffolding for creating buildable libraries that can be published to npm.\n\n- Utilities for automatic workspace refactoring.", "documents": { - "/packages/web/documents/overview": { + "/nx-api/web/documents/overview": { "id": "overview", "name": "Overview", "description": "The Nx Plugin for Web Components contains generators for managing Web Component applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Cypress, and Storybook.\n\n- Scaffolding for creating buildable libraries that can be published to npm.\n\n- Utilities for automatic workspace refactoring.", "file": "generated/packages/web/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/web/documents/overview", + "path": "/nx-api/web/documents/overview", "tags": [], "originalFilePath": "shared/packages/web/web-plugin" } @@ -2639,46 +2639,46 @@ "root": "/packages/web", "source": "/packages/web/src", "executors": { - "/packages/web/executors/file-server": { + "/nx-api/web/executors/file-server": { "description": "Serve a web application from a folder.", "file": "generated/packages/web/executors/file-server.json", "hidden": false, "name": "file-server", "originalFilePath": "/packages/web/src/executors/file-server/schema.json", - "path": "/packages/web/executors/file-server", + "path": "/nx-api/web/executors/file-server", "type": "executor" } }, "generators": { - "/packages/web/generators/init": { + "/nx-api/web/generators/init": { "description": "Add `@nrwl/web` to a project.", "file": "generated/packages/web/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/web/src/generators/init/schema.json", - "path": "/packages/web/generators/init", + "path": "/nx-api/web/generators/init", "type": "generator" }, - "/packages/web/generators/application": { + "/nx-api/web/generators/application": { "description": "Create an web application.", "file": "generated/packages/web/generators/application.json", "hidden": false, "name": "application", "originalFilePath": "/packages/web/src/generators/application/schema.json", - "path": "/packages/web/generators/application", + "path": "/nx-api/web/generators/application", "type": "generator" }, - "/packages/web/generators/static-config": { + "/nx-api/web/generators/static-config": { "description": "Add a new static-serve target to a project.", "file": "generated/packages/web/generators/static-config.json", "hidden": false, "name": "static-config", "originalFilePath": "/packages/web/src/generators/static-serve/schema.json", - "path": "/packages/web/generators/static-config", + "path": "/nx-api/web/generators/static-config", "type": "generator" } }, - "path": "/packages/web" + "path": "/nx-api/web" }, "webpack": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2686,14 +2686,14 @@ "packageName": "@nx/webpack", "description": "The Nx Plugin for Webpack contains executors and generators that support building applications using Webpack.", "documents": { - "/packages/webpack/documents/overview": { + "/nx-api/webpack/documents/overview": { "id": "overview", "name": "Overview of the Nx Webpack Plugin", "description": "The Nx Plugin for Webpack contains executors and generators that support building applications using Webpack.", "file": "generated/packages/webpack/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/webpack/documents/overview", + "path": "/nx-api/webpack/documents/overview", "tags": [], "originalFilePath": "shared/packages/webpack/plugin-overview" } @@ -2701,55 +2701,55 @@ "root": "/packages/webpack", "source": "/packages/webpack/src", "executors": { - "/packages/webpack/executors/webpack": { + "/nx-api/webpack/executors/webpack": { "description": "Run webpack build.", "file": "generated/packages/webpack/executors/webpack.json", "hidden": false, "name": "webpack", "originalFilePath": "/packages/webpack/src/executors/webpack/schema.json", - "path": "/packages/webpack/executors/webpack", + "path": "/nx-api/webpack/executors/webpack", "type": "executor" }, - "/packages/webpack/executors/dev-server": { + "/nx-api/webpack/executors/dev-server": { "description": "Serve a web application.", "file": "generated/packages/webpack/executors/dev-server.json", "hidden": false, "name": "dev-server", "originalFilePath": "/packages/webpack/src/executors/dev-server/schema.json", - "path": "/packages/webpack/executors/dev-server", + "path": "/nx-api/webpack/executors/dev-server", "type": "executor" }, - "/packages/webpack/executors/ssr-dev-server": { + "/nx-api/webpack/executors/ssr-dev-server": { "description": "Serve a SSR application.", "file": "generated/packages/webpack/executors/ssr-dev-server.json", "hidden": false, "name": "ssr-dev-server", "originalFilePath": "/packages/webpack/src/executors/ssr-dev-server/schema.json", - "path": "/packages/webpack/executors/ssr-dev-server", + "path": "/nx-api/webpack/executors/ssr-dev-server", "type": "executor" } }, "generators": { - "/packages/webpack/generators/init": { + "/nx-api/webpack/generators/init": { "description": "Initialize the `@nrwl/webpack` plugin.", "file": "generated/packages/webpack/generators/init.json", "hidden": true, "name": "init", "originalFilePath": "/packages/webpack/src/generators/init/schema.json", - "path": "/packages/webpack/generators/init", + "path": "/nx-api/webpack/generators/init", "type": "generator" }, - "/packages/webpack/generators/configuration": { + "/nx-api/webpack/generators/configuration": { "description": "Add webpack configuration to a project.", "file": "generated/packages/webpack/generators/configuration.json", "hidden": true, "name": "configuration", "originalFilePath": "/packages/webpack/src/generators/configuration/schema.json", - "path": "/packages/webpack/generators/configuration", + "path": "/nx-api/webpack/generators/configuration", "type": "generator" } }, - "path": "/packages/webpack" + "path": "/nx-api/webpack" }, "workspace": { "githubRoot": "https://github.com/nrwl/nx/blob/master", @@ -2757,25 +2757,25 @@ "packageName": "@nx/workspace", "description": "The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.", "documents": { - "/packages/workspace/documents/overview": { + "/nx-api/workspace/documents/overview": { "id": "overview", "name": "Overview", "description": "The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.", "file": "generated/packages/workspace/documents/overview", "itemList": [], "isExternal": false, - "path": "/packages/workspace/documents/overview", + "path": "/nx-api/workspace/documents/overview", "tags": [], "originalFilePath": "shared/packages/workspace/workspace-plugin" }, - "/packages/workspace/documents/nx-nodejs-typescript-version-matrix": { + "/nx-api/workspace/documents/nx-nodejs-typescript-version-matrix": { "id": "nx-nodejs-typescript-version-matrix", "name": "Nx, NodeJS and Typescript Versions", "description": "The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.", "file": "generated/packages/workspace/documents/nx-nodejs-typescript-version-matrix", "itemList": [], "isExternal": false, - "path": "/packages/workspace/documents/nx-nodejs-typescript-version-matrix", + "path": "/nx-api/workspace/documents/nx-nodejs-typescript-version-matrix", "tags": [], "originalFilePath": "shared/packages/workspace/nx-compatibility-matrix" } @@ -2783,108 +2783,108 @@ "root": "/packages/workspace", "source": "/packages/workspace/src", "executors": { - "/packages/workspace/executors/counter": { + "/nx-api/workspace/executors/counter": { "description": "A dummy executor useful for E2E tests.", "file": "generated/packages/workspace/executors/counter.json", "hidden": true, "name": "counter", "originalFilePath": "/packages/workspace/src/executors/counter/schema.json", - "path": "/packages/workspace/executors/counter", + "path": "/nx-api/workspace/executors/counter", "type": "executor" } }, "generators": { - "/packages/workspace/generators/preset": { + "/nx-api/workspace/generators/preset": { "description": "Create application in an empty workspace.", "file": "generated/packages/workspace/generators/preset.json", "hidden": true, "name": "preset", "originalFilePath": "/packages/workspace/src/generators/preset/schema.json", - "path": "/packages/workspace/generators/preset", + "path": "/nx-api/workspace/generators/preset", "type": "generator" }, - "/packages/workspace/generators/move": { + "/nx-api/workspace/generators/move": { "description": "Move an application or library to another folder.", "file": "generated/packages/workspace/generators/move.json", "hidden": false, "name": "move", "originalFilePath": "/packages/workspace/src/generators/move/schema.json", - "path": "/packages/workspace/generators/move", + "path": "/nx-api/workspace/generators/move", "type": "generator" }, - "/packages/workspace/generators/remove": { + "/nx-api/workspace/generators/remove": { "description": "Remove an application or library.", "file": "generated/packages/workspace/generators/remove.json", "hidden": false, "name": "remove", "originalFilePath": "/packages/workspace/src/generators/remove/schema.json", - "path": "/packages/workspace/generators/remove", + "path": "/nx-api/workspace/generators/remove", "type": "generator" }, - "/packages/workspace/generators/convert-to-monorepo": { + "/nx-api/workspace/generators/convert-to-monorepo": { "description": "Convert a Nx project to a monorepo.", "file": "generated/packages/workspace/generators/convert-to-monorepo.json", "hidden": false, "name": "convert-to-monorepo", "originalFilePath": "/packages/workspace/src/generators/convert-to-monorepo/schema.json", - "path": "/packages/workspace/generators/convert-to-monorepo", + "path": "/nx-api/workspace/generators/convert-to-monorepo", "type": "generator" }, - "/packages/workspace/generators/new": { + "/nx-api/workspace/generators/new": { "description": "Create a workspace.", "file": "generated/packages/workspace/generators/new.json", "hidden": true, "name": "new", "originalFilePath": "/packages/workspace/src/generators/new/schema.json", - "path": "/packages/workspace/generators/new", + "path": "/nx-api/workspace/generators/new", "type": "generator" }, - "/packages/workspace/generators/workspace-generator": { + "/nx-api/workspace/generators/workspace-generator": { "description": "Generates a workspace generator.", "file": "generated/packages/workspace/generators/workspace-generator.json", "hidden": false, "name": "workspace-generator", "originalFilePath": "/packages/workspace/src/generators/workspace-generator/schema.json", - "path": "/packages/workspace/generators/workspace-generator", + "path": "/nx-api/workspace/generators/workspace-generator", "type": "generator" }, - "/packages/workspace/generators/run-commands": { + "/nx-api/workspace/generators/run-commands": { "description": "Generates a target to run any command in the terminal.", "file": "generated/packages/workspace/generators/run-commands.json", "hidden": false, "name": "run-commands", "originalFilePath": "/packages/workspace/src/generators/run-commands/schema.json", - "path": "/packages/workspace/generators/run-commands", + "path": "/nx-api/workspace/generators/run-commands", "type": "generator" }, - "/packages/workspace/generators/fix-configuration": { + "/nx-api/workspace/generators/fix-configuration": { "description": "Fixes projects configuration", "file": "generated/packages/workspace/generators/fix-configuration.json", "hidden": false, "name": "fix-configuration", "originalFilePath": "/packages/workspace/src/generators/convert-to-nx-project/schema.json", - "path": "/packages/workspace/generators/fix-configuration", + "path": "/nx-api/workspace/generators/fix-configuration", "type": "generator" }, - "/packages/workspace/generators/npm-package": { + "/nx-api/workspace/generators/npm-package": { "description": "Create a minimal NPM package.", "file": "generated/packages/workspace/generators/npm-package.json", "hidden": false, "name": "npm-package", "originalFilePath": "/packages/workspace/src/generators/npm-package/schema.json", - "path": "/packages/workspace/generators/npm-package", + "path": "/nx-api/workspace/generators/npm-package", "type": "generator" }, - "/packages/workspace/generators/ci-workflow": { + "/nx-api/workspace/generators/ci-workflow": { "description": "Generate a CI workflow.", "file": "generated/packages/workspace/generators/ci-workflow.json", "hidden": false, "name": "ci-workflow", "originalFilePath": "/packages/workspace/src/generators/ci-workflow/schema.json", - "path": "/packages/workspace/generators/ci-workflow", + "path": "/nx-api/workspace/generators/ci-workflow", "type": "generator" } }, - "path": "/packages/workspace" + "path": "/nx-api/workspace" } } diff --git a/docs/generated/manifests/nx.json b/docs/generated/manifests/nx.json index 0b49d189fc333..680cd8dbafc0c 100644 --- a/docs/generated/manifests/nx.json +++ b/docs/generated/manifests/nx.json @@ -6254,7 +6254,7 @@ "file": "", "itemList": [], "isExternal": true, - "path": "/packages/nx/documents/affected#skip-nx-cache", + "path": "/nx-api/nx/documents/affected#skip-nx-cache", "tags": ["cache-task-results"] }, { @@ -6332,14 +6332,14 @@ "path": "/nx-cloud/intro/what-is-nx-cloud", "tags": ["cache-task-results", "distribute-task-execution"] }, - "/packages/nx/documents/affected#skip-nx-cache": { + "/nx-api/nx/documents/affected#skip-nx-cache": { "id": "skip-nx-cache-flag", "name": "--skip-nx-cache flag", "description": "", "file": "", "itemList": [], "isExternal": true, - "path": "/packages/nx/documents/affected#skip-nx-cache", + "path": "/nx-api/nx/documents/affected#skip-nx-cache", "tags": ["cache-task-results"] }, "/reference/nx-json#tasks-runner-options": { diff --git a/docs/generated/manifests/tags.json b/docs/generated/manifests/tags.json index f1c09d2cf8722..e57578dac14d4 100644 --- a/docs/generated/manifests/tags.json +++ b/docs/generated/manifests/tags.json @@ -33,21 +33,21 @@ "file": "generated/packages/generated/packages/nx/documents/run", "id": "run", "name": "run", - "path": "/packages/nx/documents/run" + "path": "/nx-api/nx/documents/run" }, { "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/generated/packages/nx/documents/run-many", "id": "run-many", "name": "run-many", - "path": "/packages/nx/documents/run-many" + "path": "/nx-api/nx/documents/run-many" }, { "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/generated/packages/nx/documents/affected", "id": "affected", "name": "affected", - "path": "/packages/nx/documents/affected" + "path": "/nx-api/nx/documents/affected" } ], "cache-task-results": [ @@ -98,7 +98,7 @@ "file": "", "id": "skip-nx-cache-flag", "name": "--skip-nx-cache flag", - "path": "/packages/nx/documents/affected#skip-nx-cache" + "path": "/nx-api/nx/documents/affected#skip-nx-cache" }, { "description": "", @@ -126,14 +126,14 @@ "file": "generated/packages/generated/packages/nx/documents/connect-to-nx-cloud", "id": "connect-to-nx-cloud", "name": "connect-to-nx-cloud", - "path": "/packages/nx/documents/connect-to-nx-cloud" + "path": "/nx-api/nx/documents/connect-to-nx-cloud" }, { "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/generated/packages/nx/documents/reset", "id": "reset", "name": "reset", - "path": "/packages/nx/documents/reset" + "path": "/nx-api/nx/documents/reset" } ], "remote-cache": [ @@ -186,7 +186,7 @@ "file": "generated/packages/generated/packages/nx/documents/connect-to-nx-cloud", "id": "connect-to-nx-cloud", "name": "connect-to-nx-cloud", - "path": "/packages/nx/documents/connect-to-nx-cloud" + "path": "/nx-api/nx/documents/connect-to-nx-cloud" } ], "explore-graph": [ @@ -230,7 +230,7 @@ "file": "generated/packages/generated/packages/nx/documents/dep-graph", "id": "dep-graph", "name": "graph", - "path": "/packages/nx/documents/dep-graph" + "path": "/nx-api/nx/documents/dep-graph" } ], "automate-updating-dependencies": [ @@ -260,7 +260,7 @@ "file": "generated/packages/generated/packages/nx/documents/migrate", "id": "migrate", "name": "migrate", - "path": "/packages/nx/documents/migrate" + "path": "/nx-api/nx/documents/migrate" } ], "enforce-module-boundaries": [ @@ -353,21 +353,21 @@ "file": "generated/packages/generated/packages/nx/documents/format-check", "id": "format-check", "name": "format:check", - "path": "/packages/nx/documents/format-check" + "path": "/nx-api/nx/documents/format-check" }, { "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/generated/packages/nx/documents/format-write", "id": "format-write", "name": "format:write", - "path": "/packages/nx/documents/format-write" + "path": "/nx-api/nx/documents/format-write" }, { "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/generated/packages/nx/documents/workspace-lint", "id": "workspace-lint", "name": "workspace-lint", - "path": "/packages/nx/documents/workspace-lint" + "path": "/nx-api/nx/documents/workspace-lint" } ], "integrate-with-editors": [ @@ -511,21 +511,21 @@ "file": "generated/packages/generated/packages/nx/documents/run", "id": "run", "name": "run", - "path": "/packages/nx/documents/run" + "path": "/nx-api/nx/documents/run" }, { "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/generated/packages/nx/documents/run-many", "id": "run-many", "name": "run-many", - "path": "/packages/nx/documents/run-many" + "path": "/nx-api/nx/documents/run-many" }, { "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "file": "generated/packages/generated/packages/nx/documents/affected", "id": "affected", "name": "affected", - "path": "/packages/nx/documents/affected" + "path": "/nx-api/nx/documents/affected" } ], "use-code-generators": [ @@ -590,7 +590,7 @@ "file": "generated/packages/generated/packages/nx/documents/generate", "id": "generate", "name": "generate", - "path": "/packages/nx/documents/generate" + "path": "/nx-api/nx/documents/generate" } ], "intro": [ @@ -1017,7 +1017,7 @@ "file": "generated/packages/generated/packages/nx/documents/watch", "id": "watch", "name": "watch", - "path": "/packages/nx/documents/watch" + "path": "/nx-api/nx/documents/watch" } ], "yarn": [ diff --git a/docs/generated/packages/cypress/documents/overview.md b/docs/generated/packages/cypress/documents/overview.md index 4c4c3ad72910b..903620db4a51e 100644 --- a/docs/generated/packages/cypress/documents/overview.md +++ b/docs/generated/packages/cypress/documents/overview.md @@ -110,11 +110,11 @@ For adding more dynamic configurations to your cypress configuration, you can lo If you're needing to pass a variable to cypress that you wish to not commit to your repository, i.e. API keys, or dynamic values based on configurations, i.e. API Urls. This is where [Cypress environment variables](https://docs.cypress.io/guides/guides/environment-variables) can be used. -There are a handful of ways to pass environment variables to Cypress, but the most common is going to be via the [`cypress.env.json` file](https://docs.cypress.io/guides/guides/environment-variables#Option-1-configuration-file), the [env executor option for cypress](https://nx.dev/packages/cypress/executors/cypress#env) or the commandline. +There are a handful of ways to pass environment variables to Cypress, but the most common is going to be via the [`cypress.env.json` file](https://docs.cypress.io/guides/guides/environment-variables#Option-1-configuration-file), the [env executor option for cypress](/nx-api/cypress/executors/cypress#env) or the commandline. Create a `cypress.env.json` file in the projects root i.e. `apps/my-cool-app-e2e/cypress.env.json`. Cypress will automatically pick up this file. This method is helpful for configurations that you want to not commit. Just don't forget to add the file to the `.gitignore` and add documentation so people in your repo know what values to popluate in their local copy of the `cypress.env.json` file. -Using [@nx/cypress:cypress](/packages/cypress/executors/cypress) env executor option is a good way to add values you want to define that you don't mine commit to the repository, such as a base API url. You can leverage [target configurations](/reference/project-configuration#targets) to define different values as well. +Using [@nx/cypress:cypress](/nx-api/cypress/executors/cypress) env executor option is a good way to add values you want to define that you don't mine commit to the repository, such as a base API url. You can leverage [target configurations](/reference/project-configuration#targets) to define different values as well. Optionally, you can pass environment variables via the commandline with the `--env` flag. diff --git a/docs/generated/packages/esbuild/documents/overview.md b/docs/generated/packages/esbuild/documents/overview.md index 7d5300732bf4c..0a4d96a8b39b3 100644 --- a/docs/generated/packages/esbuild/documents/overview.md +++ b/docs/generated/packages/esbuild/documents/overview.md @@ -5,7 +5,7 @@ Why should you use this plugin? - _Fast_ builds using esbuild. - Type-checking using TypeScript, which esbuild does not handle. - Intelligent `package.json` output. -- Additional [assets](/packages/esbuild/executors/esbuild#assets) for the output. +- Additional [assets](/nx-api/esbuild/executors/esbuild#assets) for the output. ## Setting up esbuild @@ -141,4 +141,4 @@ Extra API options for esbuild can be passed in the `esbuildOptions` object for y ## More Documentation -- [Using JS](/packages/js) +- [Using JS](/nx-api/js) diff --git a/docs/generated/packages/eslint-plugin/documents/overview.md b/docs/generated/packages/eslint-plugin/documents/overview.md index dfe60ed93a138..dcab3273d9a5e 100644 --- a/docs/generated/packages/eslint-plugin/documents/overview.md +++ b/docs/generated/packages/eslint-plugin/documents/overview.md @@ -61,8 +61,8 @@ You can also use `@nx/react` which includes all three `@nx/react-*` plugins ### Enforce Module Boundaries rule -The `enforce-module-boundaries` ESLint rule enables you to define strict rules for accessing resources between different projects in the repository. Enforcing strict boundaries helps prevent unplanned cross-dependencies. Read more about it on a [dedicated page](/packages/eslint-plugin/documents/enforce-module-boundaries). +The `enforce-module-boundaries` ESLint rule enables you to define strict rules for accessing resources between different projects in the repository. Enforcing strict boundaries helps prevent unplanned cross-dependencies. Read more about it on a [dedicated page](/nx-api/eslint-plugin/documents/enforce-module-boundaries). ### Dependency Checks rule -The `@nx/dependency-checks` ESLint rule enables you to discover mismatches between dependencies specified in a project's `package.json` and the dependencies that your project actually depends on. Read more about it on a [dedicated page](/packages/eslint-plugin/documents/dependency-checks). +The `@nx/dependency-checks` ESLint rule enables you to discover mismatches between dependencies specified in a project's `package.json` and the dependencies that your project actually depends on. Read more about it on a [dedicated page](/nx-api/eslint-plugin/documents/dependency-checks). diff --git a/docs/generated/packages/expo/documents/overview.md b/docs/generated/packages/expo/documents/overview.md index a89d03374561c..0590c3e9e83f2 100644 --- a/docs/generated/packages/expo/documents/overview.md +++ b/docs/generated/packages/expo/documents/overview.md @@ -300,5 +300,5 @@ Below table is a map between expo commands and Nx commands: ## More Documentation -- [Using Detox](/packages/detox) -- [Using Jest](/packages/jest) +- [Using Detox](/nx-api/detox) +- [Using Jest](/nx-api/jest) diff --git a/docs/generated/packages/jest/documents/overview.md b/docs/generated/packages/jest/documents/overview.md index 890c397076c39..c531b9b6ff6ce 100644 --- a/docs/generated/packages/jest/documents/overview.md +++ b/docs/generated/packages/jest/documents/overview.md @@ -117,7 +117,7 @@ export default { ### Nx -Nx Jest Plugin options can be configured via the [project config file](/reference/project-configuration) or via the [command line flags](/packages/jest). +Nx Jest Plugin options can be configured via the [project config file](/reference/project-configuration) or via the [command line flags](/nx-api/jest). > Hint: Use `--help` to see all available options > @@ -203,4 +203,4 @@ export default async function () { ## More Documentation - [Jest Docs](https://jestjs.io/) -- [@nx/jest options](/packages/jest) +- [@nx/jest options](/nx-api/jest) diff --git a/docs/generated/packages/linter/documents/overview.md b/docs/generated/packages/linter/documents/overview.md index 299a251ecd977..30f9e8745c015 100644 --- a/docs/generated/packages/linter/documents/overview.md +++ b/docs/generated/packages/linter/documents/overview.md @@ -32,9 +32,9 @@ nx lint my-lib ## Utils -- [convert-to-flat-config](/packages/linter/generators/convert-to-flat-config) - Converts the workspace's [ESLint](https://eslint.org/) configs to the new [Flat Config](https://eslint.org/blog/2022/08/new-config-system-part-2) -- **Deprecated** [convert-tslint-to-eslint](/packages/angular/generators/convert-tslint-to-eslint) - Converts a project linter from [TSLint](https://palantir.github.io/tslint/) to [ESLint](https://eslint.org/) +- [convert-to-flat-config](/nx-api/linter/generators/convert-to-flat-config) - Converts the workspace's [ESLint](https://eslint.org/) configs to the new [Flat Config](https://eslint.org/blog/2022/08/new-config-system-part-2) +- **Deprecated** [convert-tslint-to-eslint](/nx-api/angular/generators/convert-tslint-to-eslint) - Converts a project linter from [TSLint](https://palantir.github.io/tslint/) to [ESLint](https://eslint.org/) ## ESLint plugin -Read about our dedicated ESLint plugin - [eslint-plugin-nx](/packages/eslint-plugin/documents/overview). +Read about our dedicated ESLint plugin - [eslint-plugin-nx](/nx-api/eslint-plugin/documents/overview). diff --git a/docs/generated/packages/nest/documents/overview.md b/docs/generated/packages/nest/documents/overview.md index 1f77855cd1615..878099daf3672 100644 --- a/docs/generated/packages/nest/documents/overview.md +++ b/docs/generated/packages/nest/documents/overview.md @@ -149,4 +149,4 @@ nx test my-nest-lib ## More Documentation -- [Using Jest](/packages/jest) +- [Using Jest](/nx-api/jest) diff --git a/docs/generated/packages/node/documents/overview.md b/docs/generated/packages/node/documents/overview.md index cb85e8116efde..13cbaa7b54120 100644 --- a/docs/generated/packages/node/documents/overview.md +++ b/docs/generated/packages/node/documents/overview.md @@ -86,5 +86,5 @@ For additional information on how to debug Node applications, see the [Node.js d ## More Documentation -- [Using Cypress](/packages/cypress) -- [Using Jest](/packages/jest) +- [Using Cypress](/nx-api/cypress) +- [Using Jest](/nx-api/jest) diff --git a/docs/generated/packages/react-native/documents/overview.md b/docs/generated/packages/react-native/documents/overview.md index 13e8a7c8c3f4e..f17aff1d971f0 100644 --- a/docs/generated/packages/react-native/documents/overview.md +++ b/docs/generated/packages/react-native/documents/overview.md @@ -83,7 +83,7 @@ The Nx CLI provides the [`migrate` command](/core-features/automate-updating-dep #### Use upgrade-native Generator -To upgrade native iOS and Android code to latest, you can use the [upgrade-native](/packages/react-native/generators/upgrade-native) generator: +To upgrade native iOS and Android code to latest, you can use the [upgrade-native](/nx-api/react-native/generators/upgrade-native) generator: ```shell nx generate @nx/react-native:upgrade-native @@ -147,5 +147,5 @@ The build artifacts will be located under `/android/app/build`. ## More Documentation -- [Using Detox](/packages/detox) -- [Using Jest](/packages/jest) +- [Using Detox](/nx-api/detox) +- [Using Jest](/nx-api/jest) diff --git a/docs/generated/packages/react/documents/overview.md b/docs/generated/packages/react/documents/overview.md index be6235625634c..0d134598567c1 100644 --- a/docs/generated/packages/react/documents/overview.md +++ b/docs/generated/packages/react/documents/overview.md @@ -124,6 +124,6 @@ The library in `dist` is publishable to npm or a private registry. ## More Documentation -- [Using Cypress](/packages/cypress) -- [Using Jest](/packages/jest) +- [Using Cypress](/nx-api/cypress) +- [Using Jest](/nx-api/jest) - [Using Storybook](/recipes/storybook/overview-react) diff --git a/docs/generated/packages/storybook/documents/best-practices.md b/docs/generated/packages/storybook/documents/best-practices.md index fe287924fd1a1..319143e26ce7e 100644 --- a/docs/generated/packages/storybook/documents/best-practices.md +++ b/docs/generated/packages/storybook/documents/best-practices.md @@ -7,7 +7,7 @@ description: The purpose of this guide is to help you set up Storybook in your N ## Purpose of this guide -The purpose of this guide is to help you [set up Storybook in your Nx workspace](/packages/storybook) so that you can get the most out of Nx and its powerful capabilities. +The purpose of this guide is to help you [set up Storybook in your Nx workspace](/nx-api/storybook) so that you can get the most out of Nx and its powerful capabilities. ## When to use Storybook @@ -31,7 +31,7 @@ First, let’s see what Nx offers, when you are in the process of developing a p #### Configuration generation -You can generate the Storybook configuration files and settings using the Nx [`@nx/storybook:configuration` generator](/packages/storybook/generators/configuration). You can read more about configuring Storybook with Nx in our [`@nx/storybook` package overview page](/packages/storybook#generating-storybook-configuration). With Nx, you configure Storybook for each individual project. +You can generate the Storybook configuration files and settings using the Nx [`@nx/storybook:configuration` generator](/nx-api/storybook/generators/configuration). You can read more about configuring Storybook with Nx in our [`@nx/storybook` package overview page](/nx-api/storybook#generating-storybook-configuration). With Nx, you configure Storybook for each individual project. #### Stories generation @@ -43,13 +43,13 @@ If your project is not configured yet, check out one of these guides: - [Set up Storybook for Angular Projects](/recipes/storybook/overview-angular) -If your project is [already configured](/packages/storybook), you can use the `stories` generator: +If your project is [already configured](/nx-api/storybook), you can use the `stories` generator: -- [React stories generator](/packages/react/generators/stories) +- [React stories generator](/nx-api/react/generators/stories) -- [React Native stories generator](/packages/react-native/generators/stories) +- [React Native stories generator](/nx-api/react-native/generators/stories) -- [Angular stories generator](/packages/angular/generators/stories) +- [Angular stories generator](/nx-api/angular/generators/stories) The stories generator will read your inputs (if you’re using Angular), or your props (if you're using React), and will generate stories with the corresponding arguments/controls already prefilled. @@ -77,11 +77,11 @@ When you are running the Cypress tests for a project, Cypress will start the Sto #### Serve -When you are configuring Storybook, Nx [adds a serve and a build target for Storybook](/packages/storybook#generating-storybook-configuration) in your `project.json`, as we explained above. You can use these targets to [serve](/packages/storybook/executors/storybook) and [build](/packages/storybook/executors/build) storybook locally, and also in production. Cypress will also use these targets when firing up the e2e tests. While developing, you can serve your Storybooks locally to see if your components work and look as expected. This can help you and speed up the development and debugging process (no need to fire up a complex dev stack). +When you are configuring Storybook, Nx [adds a serve and a build target for Storybook](/nx-api/storybook#generating-storybook-configuration) in your `project.json`, as we explained above. You can use these targets to [serve](/nx-api/storybook/executors/storybook) and [build](/nx-api/storybook/executors/build) storybook locally, and also in production. Cypress will also use these targets when firing up the e2e tests. While developing, you can serve your Storybooks locally to see if your components work and look as expected. This can help you and speed up the development and debugging process (no need to fire up a complex dev stack). #### Build and deploy -The build and deploy step usually comes in handy when you are ready to use Storybook for documentation, and you want to publish it. The [building](/packages/storybook/executors/build) step of Storybook is integrated in the Nx ecosystem, as explained above, and you can trigger your Storybook builds as you would trigger any other build inside your workspace. +The build and deploy step usually comes in handy when you are ready to use Storybook for documentation, and you want to publish it. The [building](/nx-api/storybook/executors/build) step of Storybook is integrated in the Nx ecosystem, as explained above, and you can trigger your Storybook builds as you would trigger any other build inside your workspace. When you publish your organization’s Storybook, as a result, ideally, you would want to have one shareable Storybook page/application living under one URL, that you can share. With Nx, you can build your Storybook and it will be ready for deployment. **However**, at this point, you have one Storybook per project in your workspace, and you could end up with far too many Storybooks that are built and ready for deployment. This is not ideal, and does not accomplish the ultimate goal of “one shareable documentation page”. @@ -150,4 +150,4 @@ If you have any questions or suggestions, please feel free to reach out to us on ### Nx & Storybook documentation -You can find all Storybook-related Nx documentation in the [packages page](/packages#storybook). +You can find all Storybook-related Nx documentation in the [packages page](/nx-api/storybook). diff --git a/docs/generated/packages/storybook/documents/overview.md b/docs/generated/packages/storybook/documents/overview.md index e88acfeb03769..5ba8376857f7a 100644 --- a/docs/generated/packages/storybook/documents/overview.md +++ b/docs/generated/packages/storybook/documents/overview.md @@ -53,7 +53,7 @@ You can generate Storybook configuration for an individual project with this com nx g @nx/storybook:configuration project-name ``` -If you are NOT using a framework-specific generator (for [Angular](/packages/angular/generators/storybook-configuration), [React](/packages/react/generators/storybook-configuration), [React Native](/packages/react-native/generators/storybook-configuration)), in the field `uiFramework` you must choose one of the following Storybook frameworks: +If you are NOT using a framework-specific generator (for [Angular](/nx-api/angular/generators/storybook-configuration), [React](/nx-api/react/generators/storybook-configuration), [React Native](/nx-api/react-native/generators/storybook-configuration)), in the field `uiFramework` you must choose one of the following Storybook frameworks: - `@storybook/angular` - `@storybook/html-webpack5` @@ -82,7 +82,7 @@ Choosing one of these frameworks will have the following effects on your workspa 4. Nx will generate a new Cypress e2e app for your project (if there isn't one already) to run against the Storybook instance. -Make sure to **use the framework-specific generators** if your project is using Angular, React, Next.js or React Native: [`@nx/angular:storybook-configuration`](/packages/angular/generators/storybook-configuration), [`@nx/react:storybook-configuration`](/packages/react/generators/storybook-configuration), [`@nx/react-native:storybook-configuration`](/packages/react-native/generators/storybook-configuration): +Make sure to **use the framework-specific generators** if your project is using Angular, React, Next.js or React Native: [`@nx/angular:storybook-configuration`](/nx-api/angular/generators/storybook-configuration), [`@nx/react:storybook-configuration`](/nx-api/react/generators/storybook-configuration), [`@nx/react-native:storybook-configuration`](/nx-api/react-native/generators/storybook-configuration): {% tabs %} {% tab label="Angular" %} @@ -210,8 +210,8 @@ Here's more information on common migration scenarios for Storybook with Nx. For - [Upgrading to Storybook 6](/deprecated/storybook/upgrade-storybook-v6-react) - [Migrate to the Nx React Storybook Addon](/deprecated/storybook/migrate-webpack-final-react) -- [Storybook 7 migration generator](/packages/storybook/generators/migrate-7) -- [Storybook 7 setup guide](/packages/storybook/documents/storybook-7-setup) +- [Storybook 7 migration generator](/nx-api/storybook/generators/migrate-7) +- [Storybook 7 setup guide](/nx-api/storybook/documents/storybook-7-setup) ## Older documentation diff --git a/docs/generated/packages/storybook/documents/storybook-7-setup.md b/docs/generated/packages/storybook/documents/storybook-7-setup.md index 747ebf37ac8c3..773cf00fabfc6 100644 --- a/docs/generated/packages/storybook/documents/storybook-7-setup.md +++ b/docs/generated/packages/storybook/documents/storybook-7-setup.md @@ -7,17 +7,17 @@ description: This guide explains how you can set up Storybook version 7 in your Storybook 7 is a major release that brings a lot of new features and improvements. You can read more about it in the [Storybook 7.0.0 release article](https://storybook.js.org/blog/storybook-7-0/). Apart from the new features and improvements it introduces, it also brings some breaking changes. You can read more about them in the [Storybook 7 migration docs](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#from-version-65x-to-700) and the [Storybook 7.0.0 migration guide](https://storybook.js.org/docs/react/migration-guide). -Nx provides new generators that allow you to generate Storybook 7 configuration for your projects, by installing the correct dependencies and creating the corresponding version 7 configuration files. Nx also provides a [Storybook 7 migration generator](/packages/storybook/generators/migrate-7) that you can use to migrate your existing Storybook configuration to version 7. +Nx provides new generators that allow you to generate Storybook 7 configuration for your projects, by installing the correct dependencies and creating the corresponding version 7 configuration files. Nx also provides a [Storybook 7 migration generator](/nx-api/storybook/generators/migrate-7) that you can use to migrate your existing Storybook configuration to version 7. So, let's see how you can use Storybook 7 on your Nx workspace. ## Migrate your existing workspace to Storybook 7 -If you already have Storybook configured in your Nx workspace, you can use the [Storybook 7 migrator generator](/packages/storybook/generators/migrate-7) to migrate your existing Storybook configuration to version 7. +If you already have Storybook configured in your Nx workspace, you can use the [Storybook 7 migrator generator](/nx-api/storybook/generators/migrate-7) to migrate your existing Storybook configuration to version 7. ## Set up Storybook 7 in a _new_ Nx Workspace -Please read the [`@nx/storybook` package overview](/packages/storybook) to see how you can configure Storybook in your Nx workspace. +Please read the [`@nx/storybook` package overview](/nx-api/storybook) to see how you can configure Storybook in your Nx workspace. ## Changes from the v6.5 Storybook configuration @@ -32,7 +32,7 @@ The Storybook configuration generated by Nx for Storybook 7 is very similar to t ### Changes in the `storybook` and `build-storybook` targets - The `uiFramework` field is not needed any more, thus it is not set. Nx was using the `uiFramework` field to load any framework specific options for the Storybook builder. This is no longer needed, since the `framework` set in `.storybook/main.js|ts` takes care of that. -- More options from the Storybook CLI are now exposed in the executors. You can see these in the [`@nx/storybook:storybook`](/packages/storybook/executors/storybook) and [`@nx/storybook:build`](/packages/storybook/executors/build) executor schemas. You can read more about these options in the [Storybook 7 CLI docs](https://storybook.js.org/docs/7.0/react/api/cli-options). If there's an option you need to pass but it's not in the executor schema, you can always pass it, since the executors are just passing the options to the Storybook CLI. +- More options from the Storybook CLI are now exposed in the executors. You can see these in the [`@nx/storybook:storybook`](/nx-api/storybook/executors/storybook) and [`@nx/storybook:build`](/nx-api/storybook/executors/build) executor schemas. You can read more about these options in the [Storybook 7 CLI docs](https://storybook.js.org/docs/7.0/react/api/cli-options). If there's an option you need to pass but it's not in the executor schema, you can always pass it, since the executors are just passing the options to the Storybook CLI. ## Report any issues and bugs diff --git a/docs/generated/packages/vite/documents/overview.md b/docs/generated/packages/vite/documents/overview.md index dc607a40b5875..5d1ae8f9548a1 100644 --- a/docs/generated/packages/vite/documents/overview.md +++ b/docs/generated/packages/vite/documents/overview.md @@ -38,7 +38,7 @@ There is a number of ways to use Vite in your existing workspace. ### Generate a new project using Vite -You can generate a [React](/packages/react) application or library or a [Web](/packages/web) application that uses Vite.js. The [`@nx/react:app`](/packages/react/generators/application), [`@nx/react:lib`](/packages/react/generators/library) and [`@nx/web:app`](/packages/web/generators/application) generators accept the `bundler` option, where you can pass `vite`. This will generate a new application configured to use Vite.js, and it will also install all the necessary dependencies, including the `@nx/vite` plugin. +You can generate a [React](/nx-api/react) application or library or a [Web](/nx-api/web) application that uses Vite.js. The [`@nx/react:app`](/nx-api/react/generators/application), [`@nx/react:lib`](/nx-api/react/generators/library) and [`@nx/web:app`](/nx-api/web/generators/application) generators accept the `bundler` option, where you can pass `vite`. This will generate a new application configured to use Vite.js, and it will also install all the necessary dependencies, including the `@nx/vite` plugin. To generate a React application using Vite.js, run the following: @@ -62,7 +62,7 @@ nx g @nx/web:app my-app --bundler=vite You can use the `@nx/vite:configuration` generator to change your React or Web project to use Vite.js. This generator will modify your project's configuration to use Vite.js, and it will also install all the necessary dependencies, including the `@nx/vite` plugin.. -You can read more about this generator on the [`@nx/vite:configuration`](/packages/vite/generators/configuration) generator page. +You can read more about this generator on the [`@nx/vite:configuration`](/nx-api/vite/generators/configuration) generator page. ### Initialize Vite.js diff --git a/docs/generated/packages/web/documents/overview.md b/docs/generated/packages/web/documents/overview.md index 7864a3bbe2db9..ff1c884fcaa17 100644 --- a/docs/generated/packages/web/documents/overview.md +++ b/docs/generated/packages/web/documents/overview.md @@ -35,12 +35,12 @@ The application uses no framework and generates with web components. You can add To start the application in development mode, run `nx serve my-new-app`. {% callout type="note" title="React" %} -If you are looking to add a React application, check out the [React plugin](/packages/react). +If you are looking to add a React application, check out the [React plugin](/nx-api/react). {% /callout %} ### Creating Libraries -To create a generic TypeScript library (i.e. non-framework specific), use the [`@nx/js`](/packages/js) plugin. +To create a generic TypeScript library (i.e. non-framework specific), use the [`@nx/js`](/nx-api/js) plugin. ```shell nx g @nx/js:lib my-new-lib @@ -98,5 +98,5 @@ The library in `dist` is publishable to npm or a private registry. ## More Documentation -- [Using Cypress](/packages/cypress) -- [Using Jest](/packages/jest) +- [Using Cypress](/nx-api/cypress) +- [Using Jest](/nx-api/jest) diff --git a/docs/generated/packages/webpack/documents/overview.md b/docs/generated/packages/webpack/documents/overview.md index cfed3a2b10c95..af0c063509a9c 100644 --- a/docs/generated/packages/webpack/documents/overview.md +++ b/docs/generated/packages/webpack/documents/overview.md @@ -27,7 +27,7 @@ npx create-nx-workspace@latest --preset=react-monorepo --bundler=webpack ## Generate a new project using Webpack -You can generate a [React](/packages/react) application or a [Web](/packages/web) application that uses Webpack in an existing Nx workspace. The [`@nx/react:app`](/packages/react/generators/application), [`@nx/node:app`](/packages/node/generators/application) and [`@nx/web:app`](/packages/web/generators/application) generators accept the `bundler` option, where you can pass `webpack`. This will generate a new application configured to use Webpack, and it will also install all the necessary dependencies, including the `@nx/webpack` plugin. +You can generate a [React](/nx-api/react) application or a [Web](/nx-api/web) application that uses Webpack in an existing Nx workspace. The [`@nx/react:app`](/nx-api/react/generators/application), [`@nx/node:app`](/nx-api/node/generators/application) and [`@nx/web:app`](/nx-api/web/generators/application) generators accept the `bundler` option, where you can pass `webpack`. This will generate a new application configured to use Webpack, and it will also install all the necessary dependencies, including the `@nx/webpack` plugin. To generate a React application using Webpack, run the following: diff --git a/docs/generated/packages/workspace/documents/overview.md b/docs/generated/packages/workspace/documents/overview.md index 84518542c6663..79289534fd807 100644 --- a/docs/generated/packages/workspace/documents/overview.md +++ b/docs/generated/packages/workspace/documents/overview.md @@ -9,7 +9,7 @@ Codifying your organization's best practices into local generators is a great wa ## Reorganizing Projects After some time of working within a workspace, projects might need to be moved or sometimes even removed. -The workspace plugin provides the [`@nx/workspace:move`](/packages/workspace/generators/move) and [`@nx/workspace:remove`](/packages/workspace/generators/remove) generators to help aid with this. +The workspace plugin provides the [`@nx/workspace:move`](/nx-api/workspace/generators/move) and [`@nx/workspace:remove`](/nx-api/workspace/generators/remove) generators to help aid with this. ### Moving Projects @@ -24,7 +24,7 @@ Moving the files manually can be done easily but a lot of steps are often missed 5. Paths in target options such as output path will be changed 6. Other configuration will be updated too, such as `extends` in `tsconfig.json`, the name of the project in `jest.config.js`, and the extends in `.eslintrc.json` -> See more about [`@nx/workspace:move`](/packages/workspace/generators/move) +> See more about [`@nx/workspace:move`](/nx-api/workspace/generators/move) ### Removing Projects @@ -37,12 +37,12 @@ Like when moving projects, some steps are often missed when removing projects. T 3. The project's configuration will be removed. 4. The path mapping in `tsconfig.base.json` will be removed. -> See more about [`@nx/workspace:remove`](/packages/workspace/generators/remove) +> See more about [`@nx/workspace:remove`](/nx-api/workspace/generators/remove) ## Running custom commands -Executors provide an optimized way of running targets but unfortunately, not every target has an executor written for it. The [`nx:run-commands`](/packages/nx/executors/run-commands) executor is an executor that runs any command or multiple commands in the shell. This can be useful when integrating with other tools which do not have an executor provided. There is also a generator to help configure this executor. +Executors provide an optimized way of running targets but unfortunately, not every target has an executor written for it. The [`nx:run-commands`](/nx-api/nx/executors/run-commands) executor is an executor that runs any command or multiple commands in the shell. This can be useful when integrating with other tools which do not have an executor provided. There is also a generator to help configure this executor. Running `nx g @nx/workspace:run-commands printhello --project my-feature-lib --command 'echo hello'` will create a `my-feature-lib:printhello` target that executes `echo hello` in the shell. -> See more about [`nx:run-commands`](/packages/nx/executors/run-commands) +> See more about [`nx:run-commands`](/nx-api/nx/executors/run-commands) diff --git a/docs/map.json b/docs/map.json index 245e2a6462573..0edcf9908297c 100644 --- a/docs/map.json +++ b/docs/map.json @@ -1418,7 +1418,7 @@ "id": "skip-nx-cache-flag", "file": "", "tags": ["cache-task-results"], - "path": "/packages/nx/documents/affected#skip-nx-cache", + "path": "/nx-api/nx/documents/affected#skip-nx-cache", "isExternal": true }, { @@ -1486,14 +1486,6 @@ "id": "getting-started", "description": "Learn how to extend Nx by creating and releasing your own Nx plugin.", "file": "shared/plugins/intro" - }, - { - "name": "Plugin Registry", - "description": "Browse official and community plugins", - "id": "registry", - "file": "", - "path": "/extending-nx/registry", - "isExternal": false } ] }, @@ -1915,7 +1907,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/workspace", + "path": "/nx-api/workspace", "file": "shared/packages/workspace/workspace-plugin" }, { @@ -1933,7 +1925,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/plugin", + "path": "/nx-api/plugin", "file": "shared/packages/plugin/plugin" } ] @@ -1963,7 +1955,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/js", + "path": "/nx-api/js", "file": "shared/packages/js/js-plugin" } ] @@ -1976,7 +1968,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/web", + "path": "/nx-api/web", "file": "shared/packages/web/web-plugin" } ] @@ -1989,7 +1981,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/esbuild", + "path": "/nx-api/esbuild", "file": "shared/packages/esbuild/esbuild-plugin" } ] @@ -2001,7 +1993,7 @@ "itemList": [ { "id": "overview", - "path": "/packages/vite", + "path": "/nx-api/vite", "name": "Overview of the Nx Vite Plugin", "description": "The Nx Plugin for Vite contains executors and generators that support building applications using Vite. This page also explains how to configure Vite on your Nx workspace.", "file": "shared/packages/vite/vite-plugin" @@ -2015,7 +2007,7 @@ "itemList": [ { "id": "overview", - "path": "/packages/vue", + "path": "/nx-api/vue", "name": "Overview of the Nx Vue Plugin", "description": "The Nx Plugin for Vue contains generators for managing Vue applications and libraries within an Nx workspace. This page also explains how to configure Vue on your Nx workspace.", "file": "shared/packages/vue/vue-plugin" @@ -2029,7 +2021,7 @@ "itemList": [ { "id": "overview", - "path": "/packages/webpack", + "path": "/nx-api/webpack", "name": "Overview of the Nx Webpack Plugin", "description": "The Nx Plugin for Webpack contains executors and generators that support building applications using Webpack.", "file": "shared/packages/webpack/plugin-overview" @@ -2044,7 +2036,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/angular", + "path": "/nx-api/angular", "file": "shared/packages/angular/angular-plugin" }, { @@ -2063,7 +2055,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/react", + "path": "/nx-api/react", "file": "shared/packages/react/react-plugin" } ] @@ -2076,7 +2068,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/jest", + "path": "/nx-api/jest", "file": "shared/packages/jest/jest-plugin" } ] @@ -2089,7 +2081,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/cypress", + "path": "/nx-api/cypress", "file": "shared/packages/cypress/cypress-plugin" } ] @@ -2102,7 +2094,7 @@ { "name": "Overview", "id": "overview", - "path": "/packages/playwright", + "path": "/nx-api/playwright", "file": "shared/packages/playwright/playwright-plugin" } ] @@ -2116,7 +2108,7 @@ "id": "overview", "name": "Nx Storybook Plugin Overview", "description": "This is an overview page for the Storybook plugin in Nx. It explains what Storybook is and how to set it up in your Nx workspace.", - "path": "/packages/storybook", + "path": "/nx-api/storybook", "file": "shared/packages/storybook/plugin-overview" }, { @@ -2141,7 +2133,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/linter", + "path": "/nx-api/linter", "file": "shared/packages/linter/linter-plugin" } ] @@ -2154,19 +2146,19 @@ { "id": "overview", "name": "Overview", - "path": "/packages/eslint-plugin", + "path": "/nx-api/eslint-plugin", "file": "shared/packages/linter/eslint-plugin" }, { "id": "enforce-module-boundaries", "name": "The `enforce-module-boundaries` rule", - "path": "/packages/eslint-plugin", + "path": "/nx-api/eslint-plugin", "file": "shared/packages/linter/enforce-module-boundaries" }, { "id": "dependency-checks", "name": "The `dependency-checks` rule", - "path": "/packages/eslint-plugin", + "path": "/nx-api/eslint-plugin", "file": "shared/packages/linter/dependency-checks" } ] @@ -2179,7 +2171,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/node", + "path": "/nx-api/node", "file": "shared/packages/node/node-plugin" } ] @@ -2192,7 +2184,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/express", + "path": "/nx-api/express", "file": "shared/packages/express/express-plugin" } ] @@ -2205,7 +2197,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/nest", + "path": "/nx-api/nest", "file": "shared/packages/nest/nest-plugin" } ] @@ -2218,7 +2210,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/next", + "path": "/nx-api/next", "file": "shared/packages/next/plugin-overview" } ] @@ -2231,7 +2223,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/detox", + "path": "/nx-api/detox", "file": "shared/packages/detox/detox-plugin" } ] @@ -2244,7 +2236,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/react-native", + "path": "/nx-api/react-native", "file": "shared/packages/react-native/react-native-plugin" } ] @@ -2257,7 +2249,7 @@ { "id": "overview", "name": "Overview", - "path": "/packages/expo", + "path": "/nx-api/expo", "file": "shared/packages/expo/expo-plugin" } ] diff --git a/docs/shared/angular-standalone-tutorial/1-code-generation.md b/docs/shared/angular-standalone-tutorial/1-code-generation.md index e910450a4e473..50001eea82c42 100644 --- a/docs/shared/angular-standalone-tutorial/1-code-generation.md +++ b/docs/shared/angular-standalone-tutorial/1-code-generation.md @@ -65,7 +65,7 @@ There are two projects that have been created for you: As far as Nx is concerned, the root-level `store` app owns every file that doesn't belong to a different project. So files in the `e2e` folder belong to the `e2e` project, everything else belongs to `store`. -{% card title="Nx Cypress Support" description="While we see the Cypress project here, we won't go deeper on Cypress in this tutorial. You can find more materials on Nx Cypress support on the @nx/cypress package page." url="/packages/cypress" /%} +{% card title="Nx Cypress Support" description="While we see the Cypress project here, we won't go deeper on Cypress in this tutorial. You can find more materials on Nx Cypress support on the @nx/cypress package page." url="/nx-api/cypress" /%} ## Generating a component for the store diff --git a/docs/shared/angular-standalone-tutorial/4-task-pipelines.md b/docs/shared/angular-standalone-tutorial/4-task-pipelines.md index df922c174cd8b..580479c42e97f 100644 --- a/docs/shared/angular-standalone-tutorial/4-task-pipelines.md +++ b/docs/shared/angular-standalone-tutorial/4-task-pipelines.md @@ -262,7 +262,7 @@ npx nx affected -t test This can be particularly helpful in CI pipelines for larger repos, where most commits only affect a small subset of the entire workspace. -{% card title="Affected Documentation" description="Checkout Affected documentation for more details" url="/packages/nx/documents/affected" /%} +{% card title="Affected Documentation" description="Checkout Affected documentation for more details" url="/nx-api/nx/documents/affected" /%} ## What's Next diff --git a/docs/shared/angular-tutorial/angular-monorepo.md b/docs/shared/angular-tutorial/angular-monorepo.md index a3774c8eb5838..d14cee1253253 100644 --- a/docs/shared/angular-tutorial/angular-monorepo.md +++ b/docs/shared/angular-tutorial/angular-monorepo.md @@ -317,7 +317,7 @@ nx g @nx/angular:library orders --directory=libs/orders --standalone nx g @nx/angular:library shared-ui --directory=libs/shared/ui --standalone ``` -Note how we type out the full path in the `directory` flag to place the libraries into a subfolder. You can choose whatever folder structure you like to organize your projects. If you change your mind later, you can run the [move generator](/packages/workspace/generators/move) to move a project to a different folder. +Note how we type out the full path in the `directory` flag to place the libraries into a subfolder. You can choose whatever folder structure you like to organize your projects. If you change your mind later, you can run the [move generator](/nx-api/workspace/generators/move) to move a project to a different folder. Running the above commands should lead to the following directory structure: diff --git a/docs/shared/core-features/automate-updating-dependencies.md b/docs/shared/core-features/automate-updating-dependencies.md index fe050d7cba2f4..1f320e04983f1 100644 --- a/docs/shared/core-features/automate-updating-dependencies.md +++ b/docs/shared/core-features/automate-updating-dependencies.md @@ -15,9 +15,9 @@ src="https://www.youtube.com/embed/Ss6MfcXi0jE" title="How Automated Code Migrations Work" /%} -Nx knows where its configuration files are and can therefore make sure they match the expected format. This automated update process, commonly referred to as "migration," becomes even more powerful when you leverage [Nx plugins](/packages). Nx plugins, which are NPM packages with a range of capabilities (code generation, task automation...), offer targeted updates based on their specific areas of responsibility. +Nx knows where its configuration files are and can therefore make sure they match the expected format. This automated update process, commonly referred to as "migration," becomes even more powerful when you leverage [Nx plugins](/nx-api). Nx plugins, which are NPM packages with a range of capabilities (code generation, task automation...), offer targeted updates based on their specific areas of responsibility. -For example, the [Nx ESLint plugin](/packages/linter) excels at configuring linting in your workspace. With its understanding of the configuration file locations, this plugin can provide precise migration scripts to update ESLint packages in your `package.json` and corresponding configuration files in your workspace when a new version is released. +For example, the [Nx ESLint plugin](/nx-api/linter) excels at configuring linting in your workspace. With its understanding of the configuration file locations, this plugin can provide precise migration scripts to update ESLint packages in your `package.json` and corresponding configuration files in your workspace when a new version is released. Updating happens in three steps: diff --git a/docs/shared/core-features/cache-task-results.md b/docs/shared/core-features/cache-task-results.md index ff6cfe34bc1f1..bcb5dfe32640e 100644 --- a/docs/shared/core-features/cache-task-results.md +++ b/docs/shared/core-features/cache-task-results.md @@ -73,4 +73,4 @@ For a more in-depth understanding of the caching implementation and to fine-tune ## Local Computation Caching By default, Nx uses a local computation cache. Nx stores the cached values only for a week, after which they -are deleted. To clear the cache run [`nx reset`](/packages/nx/documents/reset), and Nx will create a new one the next time it tries to access it. +are deleted. To clear the cache run [`nx reset`](/nx-api/nx/documents/reset), and Nx will create a new one the next time it tries to access it. diff --git a/docs/shared/core-features/run-tasks.md b/docs/shared/core-features/run-tasks.md index 7c68c89bacf82..1fef99035d323 100644 --- a/docs/shared/core-features/run-tasks.md +++ b/docs/shared/core-features/run-tasks.md @@ -90,7 +90,7 @@ npx nx run-many -t build lint test -p header footer Note that Nx parallelizes all these tasks making also sure they are run in the right order based on their dependencies and the [task pipeline configuration](/concepts/task-pipeline-configuration). -Learn more about the [run-many](/packages/nx/documents/run-many) command. +Learn more about the [run-many](/nx-api/nx/documents/run-many) command. ### Run Tasks on Projects Affected by a PR @@ -124,7 +124,7 @@ To invoke it, use: npx nx docs ``` -If you want Nx to cache the task, but prefer to use npm (or pnpm/yarn) to run the script (i.e. `npm run docs`) you can use the [nx exec](/packages/nx/documents/exec) command: +If you want Nx to cache the task, but prefer to use npm (or pnpm/yarn) to run the script (i.e. `npm run docs`) you can use the [nx exec](/nx-api/nx/documents/exec) command: ```json {% fileName="package.json" %} { diff --git a/docs/shared/core-tutorial/02-create-cli.md b/docs/shared/core-tutorial/02-create-cli.md index 4da534451d8ef..b85f1df0cf233 100644 --- a/docs/shared/core-tutorial/02-create-cli.md +++ b/docs/shared/core-tutorial/02-create-cli.md @@ -68,7 +68,7 @@ All of these reasons are matters of preference. After this tutorial, you should - `root`, `sourceRoot` and `application` are properties that help Nx know more about your project. - `targets` is similar to the `scripts` property in `package.json`. - Just as in `package.json`, `build` and `serve` can be any string you pick. -- The `executor` is the code that runs the target. In this case, [`run-commands`](https://nx.dev/packages/nx/executors/run-commands) launches a terminal process to execute whatever command you pass in. +- The `executor` is the code that runs the target. In this case, [`run-commands`](/nx-api/nx/executors/run-commands) launches a terminal process to execute whatever command you pass in. - `options` contains whatever configuration properties the executor needs to run. ## Create the CLI diff --git a/docs/shared/deprecated/storybook/angular-browser-target.md b/docs/shared/deprecated/storybook/angular-browser-target.md index dc1f6d1955389..be205f9c69e84 100644 --- a/docs/shared/deprecated/storybook/angular-browser-target.md +++ b/docs/shared/deprecated/storybook/angular-browser-target.md @@ -6,12 +6,12 @@ description: This document explains the role of the browserTarget in Angular pro # The `browserTarget` for Angular projects with a Storybook configuration {% callout type="note" title="Note" %} -This documentation page contains information about the [Storybook plugin](/packages/storybook), specifically regarding [Angular projects that are using Storybook](/recipes/storybook/overview-angular). +This documentation page contains information about the [Storybook plugin](/nx-api/storybook), specifically regarding [Angular projects that are using Storybook](/recipes/storybook/overview-angular). {% /callout %} ## Setting up `browserTarget` -If you're using [Storybook](/packages/storybook) in your Angular project, you will notice that `browserTarget` is specified for the `storybook` and `build-storybook` targets, much like it is done for `serve` or other targets. Angular needs the `browserTarget` for Storybook in order to know which configuration to use for the build. If your project is buildable (it has a `build` target, and uses the main Angular builder - `@angular-devkit/build-angular:browser`) the `browserTarget` for Storybook will use the `build` target, if it's not buildable it will use the `build-storybook` target. +If you're using [Storybook](/nx-api/storybook) in your Angular project, you will notice that `browserTarget` is specified for the `storybook` and `build-storybook` targets, much like it is done for `serve` or other targets. Angular needs the `browserTarget` for Storybook in order to know which configuration to use for the build. If your project is buildable (it has a `build` target, and uses the main Angular builder - `@angular-devkit/build-angular:browser`) the `browserTarget` for Storybook will use the `build` target, if it's not buildable it will use the `build-storybook` target. You do not have to do anything manually. Nx will create the configuration for you. Even if you are migrating from an older version of Nx, Nx will make sure to change your `package.json` Storybook targets to match the new schema. You can read more about the `browserTarget` in the [official Angular documentation](https://angular.io/cli/serve). diff --git a/docs/shared/deprecated/storybook/angular-storybook-targets.md b/docs/shared/deprecated/storybook/angular-storybook-targets.md index d49ec1e083a8e..2805906f26992 100644 --- a/docs/shared/deprecated/storybook/angular-storybook-targets.md +++ b/docs/shared/deprecated/storybook/angular-storybook-targets.md @@ -6,7 +6,7 @@ description: This document explains the role of the storybook and build-storyboo # Information about `storybook` and `build-storybook` targets for Angular projects with a Storybook configuration {% callout type="note" title="Note" %} -This documentation page contains information about the [Storybook plugin](/packages/storybook), specifically regarding [Angular projects that are using Storybook](/recipes/storybook/overview-angular). +This documentation page contains information about the [Storybook plugin](/nx-api/storybook), specifically regarding [Angular projects that are using Storybook](/recipes/storybook/overview-angular). {% /callout %} If you are on Nx version `>=14.1.8`, the [Nx Storybook plugin for _Angular_ projects](/recipes/storybook/overview-angular) uses the original Storybook executors for Angular (`"@storybook/angular:start-storybook"` and `"@storybook/angular:build-storybook"`) to serve and build Storybook. diff --git a/docs/shared/deprecated/workspace-json.md b/docs/shared/deprecated/workspace-json.md index c62f1fddb0aab..61f7f134129e7 100644 --- a/docs/shared/deprecated/workspace-json.md +++ b/docs/shared/deprecated/workspace-json.md @@ -17,7 +17,7 @@ To remove `workspace.json` in favor of `project.json` files, run: nx g @nx/workspace:fix-configuration ``` -See [fix-configuration](/packages/workspace/generators/fix-configuration) for more options. +See [fix-configuration](/nx-api/workspace/generators/fix-configuration) for more options. After this command, `workspace.json` should look like this: diff --git a/docs/shared/deprecated/workspace-lint.md b/docs/shared/deprecated/workspace-lint.md index 5a605d5e96a1a..455809d963fcd 100644 --- a/docs/shared/deprecated/workspace-lint.md +++ b/docs/shared/deprecated/workspace-lint.md @@ -8,6 +8,6 @@ Before Nx 15, the `workspace-lint` command performed workspace wide lint checks Checks (1) and (2) are no longer necessary because [Nx no longer uses a `workspace.json` file](/deprecated/workspace-json) to define project locations. Instead, Nx dynamically detects projects anywhere in the workspace based on the presence of `package.json` or `project.json` files. -Check (3) is now accomplished manually with the [`nx report` command](/packages/nx/documents/report). +Check (3) is now accomplished manually with the [`nx report` command](/nx-api/nx/documents/report). In Nx 15 and 16, `nx workspace-lint` does nothing except display a deprecation message. In Nx 17, `workspace-lint` will be completely removed. diff --git a/docs/shared/getting-started/intro.md b/docs/shared/getting-started/intro.md index 3ac9c1865f3bc..3fa8e6299ea50 100644 --- a/docs/shared/getting-started/intro.md +++ b/docs/shared/getting-started/intro.md @@ -57,16 +57,16 @@ npx create-nx-workspace@latest {% cards cols="3" lgCols="8" mdCols="6" smCols="5" moreLink="/showcase/example-repos" %} -{% link-card title="Express" appearance="small" url="/packages/express" icon="express" /%} +{% link-card title="Express" appearance="small" url="/nx-api/express" icon="express" /%} {% link-card title="Vue" appearance="small" url="/showcase/example-repos/add-vue" icon="vue" /%} -{% link-card title="Next" appearance="small" url="/packages/next" icon="nextjs" /%} +{% link-card title="Next" appearance="small" url="/nx-api/next" icon="nextjs" /%} {% link-card title="Nuxt" appearance="small" url="/showcase/example-repos/add-nuxt" icon="nuxt" /%} -{% link-card title="Nest" appearance="small" url="/packages/nest" icon="nestjs" /%} +{% link-card title="Nest" appearance="small" url="/nx-api/nest" icon="nestjs" /%} {% link-card title="Remix" appearance="small" url="/recipes/react/remix" icon="remix" /%} -{% link-card title="Expo" appearance="small" url="/packages/expo" icon="expo" /%} -{% link-card title="React Native" appearance="small" url="/packages/react-native" icon="react" /%} +{% link-card title="Expo" appearance="small" url="/nx-api/expo" icon="expo" /%} +{% link-card title="React Native" appearance="small" url="/nx-api/react-native" icon="react" /%} {% link-card title="Fastify" appearance="small" url="/showcase/example-repos/mongo-fastify" icon="fastify" /%} -{% link-card title="Deno" appearance="small" url="https://github.com/nrwl/nx-labs/tree/main/packages/deno" icon="deno" /%} +{% link-card title="Deno" appearance="small" url="https://github.com/nrwl/nx-labs/tree/main/api/deno" icon="deno" /%} {% link-card title="Svelte" appearance="small" url="/showcase/example-repos/add-svelte" icon="svelte" /%} {% link-card title="Solid" appearance="small" url="/showcase/example-repos/add-solid" icon="solid" /%} {% link-card title="Lit" appearance="small" url="/showcase/example-repos/add-lit" icon="lit" /%} @@ -76,12 +76,12 @@ npx create-nx-workspace@latest {% link-card title="Rust" appearance="small" url="/showcase/example-repos/add-rust" icon="rust" /%} {% link-card title="Go" appearance="small" url="https://github.com/nrwl/nx-recipes/blob/main/go/README.md" icon="go" /%} {% link-card title=".NET" appearance="small" url="https://github.com/nrwl/nx-recipes/tree/main/dot-net-standalone" icon="dotnet" /%} -{% link-card title="Cypress" appearance="small" url="/packages/cypress" icon="cypress" /%} -{% link-card title="Playwright" appearance="small" url="/packages/playwright" icon="playwright" /%} -{% link-card title="Vite" appearance="small" url="/packages/vite" icon="vite" /%} -{% link-card title="Storybook" appearance="small" url="/packages/storybook" icon="storybook" /%} -{% link-card title="Jest" appearance="small" url="/packages/jest" icon="jest" /%} -{% link-card title="Rspack" appearance="small" url="/packages/rspack" icon="rspack" /%} +{% link-card title="Cypress" appearance="small" url="/nx-api/cypress" icon="cypress" /%} +{% link-card title="Playwright" appearance="small" url="/nx-api/playwright" icon="playwright" /%} +{% link-card title="Vite" appearance="small" url="/nx-api/vite" icon="vite" /%} +{% link-card title="Storybook" appearance="small" url="/nx-api/storybook" icon="storybook" /%} +{% link-card title="Jest" appearance="small" url="/nx-api/jest" icon="jest" /%} +{% link-card title="Rspack" appearance="small" url="/nx-api/rspack" icon="rspack" /%} {% /cards %} diff --git a/docs/shared/getting-started/why-nx.md b/docs/shared/getting-started/why-nx.md index b852fffe8a218..fe9c1237156fa 100644 --- a/docs/shared/getting-started/why-nx.md +++ b/docs/shared/getting-started/why-nx.md @@ -28,7 +28,7 @@ Nx is built in a modular fashion to let you only use the features you need. ![High-level Nx architecture](/shared/images/nx-architecture.svg) - The **Nx** package provides fundamental technology-agnostic capabilities such as: [workspace analysis](/core-features/explore-graph), [task running](/core-features/run-tasks), [caching](/core-features/cache-task-results), [distribution](/core-features/distribute-task-execution), [code generation](/core-features/plugin-features/use-code-generators) and [automated code migrations](/core-features/automate-updating-dependencies). -- **Plugins** are NPM packages that built on top of the fundamental capabilities provided by the Nx package. Nx plugins contain [code generators](/core-features/plugin-features/use-code-generators), [executors](/core-features/plugin-features/use-task-executors) (to abstract lower-level build tooling) and automated code migrations for keeping your tools up to date. Contrary to the Nx package, which works the same way with any JS or non-JS project, plugins are usually technology specific. For instance, `@nx/react` adds support for building React apps and libs, `@nx/cypress` adds e2e testing capabilities with Cypress. Plugins make developers more productive by removing any friction of integrating different tools with each other and by providing utilities to keep them up to date. The Nx team maintains plugins for React, Next, Remix, Angular, Jest, Cypress, Storybook and more. You can use the `@nx/plugin` package to easily [scaffold a new plugin](/extending-nx/intro/getting-started) or even just [automate your local workspace](/extending-nx/recipes/local-generators). There are also more than 80 [community plugins](/extending-nx/registry). +- **Plugins** are NPM packages that built on top of the fundamental capabilities provided by the Nx package. Nx plugins contain [code generators](/core-features/plugin-features/use-code-generators), [executors](/core-features/plugin-features/use-task-executors) (to abstract lower-level build tooling) and automated code migrations for keeping your tools up to date. Contrary to the Nx package, which works the same way with any JS or non-JS project, plugins are usually technology specific. For instance, `@nx/react` adds support for building React apps and libs, `@nx/cypress` adds e2e testing capabilities with Cypress. Plugins make developers more productive by removing any friction of integrating different tools with each other and by providing utilities to keep them up to date. The Nx team maintains plugins for React, Next, Remix, Angular, Jest, Cypress, Storybook and more. You can use the `@nx/plugin` package to easily [scaffold a new plugin](/extending-nx/intro/getting-started) or even just [automate your local workspace](/extending-nx/recipes/local-generators). There are also more than 80 [community plugins](/plugin-registry). - **Devkit** is a set of utilities for [building Nx plugins](/extending-nx/intro/getting-started). - **Nx Cloud** helps scale your project on CI by [adding remote caching](/concepts/how-caching-works) and [distributed task execution](/concepts/more-concepts/illustrated-dte). It also improves developer ergonomics by integrating with GitHub, GitLab and BitBucket and providing searchable structured logs. Learn more at [nx.app](https://nx.app). - **Nx Console** is an extension for **VSCode, IntelliJ and VIM**. It provides code autocompletion, interactive generators, workspace visualizations, powerful refactorings and more. You can [install it here](/core-features/integrate-with-editors). diff --git a/docs/shared/guides/define-environment-variables.md b/docs/shared/guides/define-environment-variables.md index 6926e3a4f52d5..7f6c90e866083 100644 --- a/docs/shared/guides/define-environment-variables.md +++ b/docs/shared/guides/define-environment-variables.md @@ -54,7 +54,7 @@ for workspace-specific settings (like the [Nx Cloud token](/core-features/remote If you want to load variables from `env` files other than the ones listed above: 1. Use the [env-cmd](https://www.npmjs.com/package/env-cmd) package: `env-cmd -f .qa.env nx serve` -2. Use the `envFile` option of the [run-commands](/packages/nx/executors/run-commands#envfile) builder and execute your command inside of the builder +2. Use the `envFile` option of the [run-commands](/nx-api/nx/executors/run-commands#envfile) builder and execute your command inside of the builder ### Ad-hoc variables diff --git a/docs/shared/guides/js-and-ts.md b/docs/shared/guides/js-and-ts.md index 7e83856d611fc..9b75b92cfde9a 100644 --- a/docs/shared/guides/js-and-ts.md +++ b/docs/shared/guides/js-and-ts.md @@ -15,4 +15,4 @@ Regardless whether you use JavaScript or TypeScript, you will have a `tsconfig.b ## Interested in building and distributing TypeScript packages? -You might want to check out the `@nx/js` package which comes with advanced TypeScript support, including [SWC](https://swc.rs/) and more. Find out more in the [plugin documentation](/packages/js). +You might want to check out the `@nx/js` package which comes with advanced TypeScript support, including [SWC](https://swc.rs/) and more. Find out more in the [plugin documentation](/nx-api/js). diff --git a/docs/shared/guides/nx-and-angular-cli.md b/docs/shared/guides/nx-and-angular-cli.md index e3d4085a5de2c..00bfc308437f2 100644 --- a/docs/shared/guides/nx-and-angular-cli.md +++ b/docs/shared/guides/nx-and-angular-cli.md @@ -65,7 +65,7 @@ More details: Nx [project configuration](/reference/project-configuration). Nx comes with slightly different terminology than the Angular CLI for some features. -**Angular Builders** are called [Executors](/core-features/plugin-features/use-task-executors) in Nx but work very much similarly. You use them in your project configuration to define how to build, test, lint, and serve your project. You can use both Nx executors from [Nx Plugins](/extending-nx/registry) or Angular Builders from the Angular Devkit. +**Angular Builders** are called [Executors](/core-features/plugin-features/use-task-executors) in Nx but work very much similarly. You use them in your project configuration to define how to build, test, lint, and serve your project. You can use both Nx executors from [Nx Plugins](/plugin-registry) or Angular Builders from the Angular Devkit. ```json { @@ -132,7 +132,7 @@ What's the difference? - Fix migrations that "almost work". - Commit a partially migrated state. - Change versions of packages to match org requirements. -- [Opt out of Angular updates when updating Nx versions](/recipes/tips-n-tricks/advanced-update#choosing-optional-package-updates-to-apply) as long as [the Angular version is still supported](/packages/angular/documents/angular-nx-version-matrix) +- [Opt out of Angular updates when updating Nx versions](/recipes/tips-n-tricks/advanced-update#choosing-optional-package-updates-to-apply) as long as [the Angular version is still supported](/nx-api/angular/documents/angular-nx-version-matrix) `nx migrate` does this by splitting the process into two steps. `nx migrate latest` creates a `migrations.json` file with a list of all the migrations needed by Nx, Angular, and other packages. You can then modify that file before running `nx migrate --run-migrations` to execute those migrations. @@ -162,7 +162,7 @@ Features like - offering [remote caching abilities](/core-features/remote-cache) on CI - offering [task distribution across machines (DTE)](/core-features/distribute-task-execution) -And, Nx already uses fast, modern tooling like [ESBuild](/packages/esbuild), [Vite](/packages/vite), Vitest and [Rspack](/packages/rspack) for non-Angular stacks. So once Angular is ready to use these tools, Nx will also be ready. +And, Nx already uses fast, modern tooling like [ESBuild](/nx-api/esbuild), [Vite](/nx-api/vite), Vitest and [Rspack](/nx-api/rspack) for non-Angular stacks. So once Angular is ready to use these tools, Nx will also be ready. ## Editor Integration @@ -295,9 +295,9 @@ Learn more about the [graph features here](/core-features/explore-graph). ## Extensible and Customizable: Make it fit your own needs -Nx is [built to be extensible](/getting-started/why-nx#how-does-nx-work). Just like the [packages published by the Nx core team](/packages) you can create your own Nx plugins by [extending Nx](/extending-nx/intro/getting-started). +Nx is [built to be extensible](/getting-started/why-nx#how-does-nx-work). Just like the [packages published by the Nx core team](/nx-api) you can create your own Nx plugins by [extending Nx](/extending-nx/intro/getting-started). -This can be as simple as using [run-commands](/packages/nx/executors/run-commands) to integrate custom commands into the project configuration or as complex as [creating your own local executor](/extending-nx/recipes/local-executors). +This can be as simple as using [run-commands](/nx-api/nx/executors/run-commands) to integrate custom commands into the project configuration or as complex as [creating your own local executor](/extending-nx/recipes/local-executors). ## Diversification diff --git a/docs/shared/guides/nx-devkit-angular-devkit.md b/docs/shared/guides/nx-devkit-angular-devkit.md index 5edc005858595..f8b0ce7be4fbc 100644 --- a/docs/shared/guides/nx-devkit-angular-devkit.md +++ b/docs/shared/guides/nx-devkit-angular-devkit.md @@ -1,7 +1,7 @@ # Nx Devkit and Angular Devkit {% callout type="note" title="Nx & Angular" %} -This document covers the difference between Nx Devkit and Angular Devkit. See the [Nx Devkit](/packages/devkit/documents/nx_devkit) guide for more in-depth details about Nx Devkit. +This document covers the difference between Nx Devkit and Angular Devkit. See the [Nx Devkit](/nx-api/devkit/documents/nx_devkit) guide for more in-depth details about Nx Devkit. {% /callout %} Nx comes with a devkit to write generators and executors, but you can also use Angular devkit (schematics and builders). In other words, you can use an Angular schematic to implement a generator, and you can use an Angular builder to implement an executor. diff --git a/docs/shared/guides/react-native.md b/docs/shared/guides/react-native.md index 4c84372635889..866fa2fd9bbc1 100644 --- a/docs/shared/guides/react-native.md +++ b/docs/shared/guides/react-native.md @@ -1,6 +1,6 @@ # React Native with Nx -Nx provides a holistic dev experience powered by an advanced CLI and editor plugins. It provides rich support for common tools like [Detox](/packages/detox), Storybook, Jest, and more. +Nx provides a holistic dev experience powered by an advanced CLI and editor plugins. It provides rich support for common tools like [Detox](/nx-api/detox), Storybook, Jest, and more. In this guide we will show you how to develop [React Native](https://reactnative.dev/) applications with Nx. diff --git a/docs/shared/guides/using-tailwind-css-with-angular-projects.md b/docs/shared/guides/using-tailwind-css-with-angular-projects.md index 6a9c7dbc274a6..24ed6d5365e0d 100644 --- a/docs/shared/guides/using-tailwind-css-with-angular-projects.md +++ b/docs/shared/guides/using-tailwind-css-with-angular-projects.md @@ -34,7 +34,7 @@ To add Tailwind CSS to an existing Angular application, buildable library or pub npx nx g @nx/angular:setup-tailwind my-project ``` -You can see the available options for the above generator in [its docs](/packages/angular/generators/setup-tailwind). +You can see the available options for the above generator in [its docs](/nx-api/angular/generators/setup-tailwind). ## Configuring the content sources for a project and its dependencies diff --git a/docs/shared/guides/why-monorepos.md b/docs/shared/guides/why-monorepos.md index 90ae72a13071a..d5b5c38f97e39 100644 --- a/docs/shared/guides/why-monorepos.md +++ b/docs/shared/guides/why-monorepos.md @@ -38,7 +38,7 @@ Nx provides tools to give you the benefits of a monorepo without the drawbacks o - **Consistent Code Generation** - Generators allow you to customize and standardize organizational conventions and structure, removing the need to perform the same manual setup tasks repetitively. -- **Affected Commands** - [Nx’s affected commands](/packages/nx/documents/affected) analyze your source code, the context of the changes, and only runs tasks on the affected projects impacted by the source code changes. +- **Affected Commands** - [Nx’s affected commands](/nx-api/nx/documents/affected) analyze your source code, the context of the changes, and only runs tasks on the affected projects impacted by the source code changes. - **Distributed Caching** - Nx provides local caching and support for distributed caching of command executions. With distributed caching, when someone on your team runs a command, everyone else gets access to those artifacts to speed up their command executions, bringing them down from minutes to seconds. Nx helps you scale your development to massive applications and libraries even more with distributed task execution and incremental builds. diff --git a/docs/shared/migration/angular-manual.md b/docs/shared/migration/angular-manual.md index 85e06967c09b0..902cba7cd7702 100644 --- a/docs/shared/migration/angular-manual.md +++ b/docs/shared/migration/angular-manual.md @@ -1,7 +1,7 @@ # Migrating an Angular application manually {% callout type="note" title="Older Angular Versions" %} -If you are using older versions of Angular (version 13 or lower), make sure to use the appropriate version of Nx that matches your version of Angular. See the [Nx and Angular Version Compatibility Matrix](/packages/angular/documents/angular-nx-version-matrix) to find the correct version. The generated files will also be slightly different. +If you are using older versions of Angular (version 13 or lower), make sure to use the appropriate version of Nx that matches your version of Angular. See the [Nx and Angular Version Compatibility Matrix](/nx-api/angular/documents/angular-nx-version-matrix) to find the correct version. The generated files will also be slightly different. {% /callout %} If you are unable to automatically transform your Angular CLI workspace to an [Nx workspace](/recipes/angular/migration/angular), there are some manual steps you can take to move your project(s) into an Nx workspace. @@ -69,7 +69,7 @@ A new Nx workspace with your `org name` as the folder name, and your `applicatio ### Review Angular installed packages versions -Creating an Nx workspace with the latest version will install the Angular packages on their latest versions. If you're using a [lower version that's supported by the latest Nx](/packages/angular/documents/angular-nx-version-matrix), make sure to adjust the newly generated `package.json` file with your versions. +Creating an Nx workspace with the latest version will install the Angular packages on their latest versions. If you're using a [lower version that's supported by the latest Nx](/nx-api/angular/documents/angular-nx-version-matrix), make sure to adjust the newly generated `package.json` file with your versions. ### Copying over application files @@ -191,6 +191,6 @@ yarn lint Learn more about the advantages of Nx in the following guides: -[Using Cypress for e2e tests](/packages/cypress) \ -[Using Jest for unit tests](/packages/jest) \ +[Using Cypress for e2e tests](/nx-api/cypress) \ +[Using Jest for unit tests](/nx-api/jest) \ [Rebuilding and Retesting What is Affected](/concepts/affected) diff --git a/docs/shared/migration/from-turborepo.md b/docs/shared/migration/from-turborepo.md index c553532973348..3311be7e75782 100644 --- a/docs/shared/migration/from-turborepo.md +++ b/docs/shared/migration/from-turborepo.md @@ -149,41 +149,41 @@ For each `turbo.json` configuration property, the equivalent Nx property is list | `pipeline[task].outputs` | [Same syntax](/reference/project-configuration#outputs). | | `pipeline[task].cache` | Define in the [`nx.json` `cacheableOperations` property](/reference/nx-json#tasks-runner-options) | | `pipeline[task].inputs` | [Same syntax](/reference/project-configuration#filesets). | -| `pipeline[task].outputMode` | Use the [`--output-style` command line flag](/packages/nx/documents/run-many#output-style) | +| `pipeline[task].outputMode` | Use the [`--output-style` command line flag](/nx-api/nx/documents/run-many#output-style) | | `pipeline[task].persistent` | N/A. | ## Command Equivalents -| | | -| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `turbo run test lint build` | [`nx run-many -t test lint build`](/packages/nx/documents/run-many) | -| `--cache-dir` | Set in [`nx.json` under `tasksRunnerOptions.default.options.cacheDirectory`](/reference/nx-json#tasks-runner-options) | -| `--concurrency` | [`--parallel`](/packages/nx/documents/run-many#parallel) | -| `--continue` | [Use `--nx-bail`](/packages/nx/documents/run-many#nx-bail) with the inverse value | -| `--cwd` | Available when using the [`run-commands` executor](/packages/nx/executors/run-commands#cwd) | -| `--dry-run` | N/A. Nx has `--dry-run` for `nx generate` but not for running tasks. | -| `--env-mode` | N/A | -| `--filter` | Use [`-p admin-*` or `-p tag:api-*`](/packages/nx/documents/run-many#projects). Also see [`nx affected`](/packages/nx/documents/affected). | -| `--graph` | [Same syntax](/packages/nx/documents/run-many#graph) or [`nx graph`](/packages/nx/documents/dep-graph) for the entire graph | -| `--force` | [`nx reset`](/packages/nx/documents/reset) and then run the command again | -| `--global-deps` | Use [`inputs` in the `nx.json`](/concepts/more-concepts/customizing-inputs) or project configuration | -| `--framework-inference` | Nx knows if you're using a particular framework if you use an executor for that framework. | -| `--ignore` | Use an [`.nxignore` file](/reference/nxignore) (or `.gitignore`) | -| `--log-order` | Use [`--output-style`](/packages/nx/documents/run-many#output-style) | -| `--no-cache` | Use [`--skip-nx-cache`](/packages/nx/documents/run-many#skip-nx-cache) | -| `--no-daemon` | Use [`NX_DAEMON=false` or set `useDaemonProcess: false`](/concepts/more-concepts/nx-daemon#turning-it-off) in `nx.json` | -| `--output-logs` | Use [`--output-style`](/packages/nx/documents/run-many#output-style) | -| `--only` | N/A | -| `--parallel` | N/A | -| `--remote-only` | N/A. Can [ignore the remote cache](/core-features/remote-cache#skipping-cloud) with `--no-cloud`. | -| `--summarize` | N/A | -| `--token` | Set the [Nx Cloud token in `nx.json`](/nx-cloud/account/access-tokens#setting-access-tokens) or as an environment variable (`NX_CLOUD_ACCESS_TOKEN`) | -| `--team` | See `--token` for choosing a different Nx Cloud workspace. You can [use `--runner`](/packages/nx/documents/run-many#runner) to choose a different runner defined in the `nx.json` file. | -| `--preflight` | N/A | -| `--trace` | N/A. [`--verbose`](/packages/nx/documents/run-many#verbose) for more logging. | -| `--heap` | N/A. [`--verbose`](/packages/nx/documents/run-many#verbose) for more logging. | -| `--cpuprofile` | Use [`NX_PROFILE=profile.json`](/recipes/troubleshooting/performance-profiling). | -| `--verbosity` | Use [`--verbose`](/packages/nx/documents/run-many#verbose) | -| `turbo gen` | [Use `nx generate`](/packages/nx/documents/generate) | -| `turbo login` | No need. [Use `nx connect`](/packages/nx/documents/connect-to-nx-cloud) once to set up Nx Cloud. | -| `turbo link` | [Use `nx connect`](/packages/nx/documents/connect-to-nx-cloud) | +| | | +| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `turbo run test lint build` | [`nx run-many -t test lint build`](/nx-api/nx/documents/run-many) | +| `--cache-dir` | Set in [`nx.json` under `tasksRunnerOptions.default.options.cacheDirectory`](/reference/nx-json#tasks-runner-options) | +| `--concurrency` | [`--parallel`](/nx-api/nx/documents/run-many#parallel) | +| `--continue` | [Use `--nx-bail`](/nx-api/nx/documents/run-many#nx-bail) with the inverse value | +| `--cwd` | Available when using the [`run-commands` executor](/nx-api/nx/executors/run-commands#cwd) | +| `--dry-run` | N/A. Nx has `--dry-run` for `nx generate` but not for running tasks. | +| `--env-mode` | N/A | +| `--filter` | Use [`-p admin-*` or `-p tag:api-*`](/nx-api/nx/documents/run-many#projects). Also see [`nx affected`](/nx-api/nx/documents/affected). | +| `--graph` | [Same syntax](/nx-api/nx/documents/run-many#graph) or [`nx graph`](/nx-api/nx/documents/dep-graph) for the entire graph | +| `--force` | [`nx reset`](/nx-api/nx/documents/reset) and then run the command again | +| `--global-deps` | Use [`inputs` in the `nx.json`](/concepts/more-concepts/customizing-inputs) or project configuration | +| `--framework-inference` | Nx knows if you're using a particular framework if you use an executor for that framework. | +| `--ignore` | Use an [`.nxignore` file](/reference/nxignore) (or `.gitignore`) | +| `--log-order` | Use [`--output-style`](/nx-api/nx/documents/run-many#output-style) | +| `--no-cache` | Use [`--skip-nx-cache`](/nx-api/nx/documents/run-many#skip-nx-cache) | +| `--no-daemon` | Use [`NX_DAEMON=false` or set `useDaemonProcess: false`](/concepts/more-concepts/nx-daemon#turning-it-off) in `nx.json` | +| `--output-logs` | Use [`--output-style`](/nx-api/nx/documents/run-many#output-style) | +| `--only` | N/A | +| `--parallel` | N/A | +| `--remote-only` | N/A. Can [ignore the remote cache](/core-features/remote-cache#skipping-cloud) with `--no-cloud`. | +| `--summarize` | N/A | +| `--token` | Set the [Nx Cloud token in `nx.json`](/nx-cloud/account/access-tokens#setting-access-tokens) or as an environment variable (`NX_CLOUD_ACCESS_TOKEN`) | +| `--team` | See `--token` for choosing a different Nx Cloud workspace. You can [use `--runner`](/nx-api/nx/documents/run-many#runner) to choose a different runner defined in the `nx.json` file. | +| `--preflight` | N/A | +| `--trace` | N/A. [`--verbose`](/nx-api/nx/documents/run-many#verbose) for more logging. | +| `--heap` | N/A. [`--verbose`](/nx-api/nx/documents/run-many#verbose) for more logging. | +| `--cpuprofile` | Use [`NX_PROFILE=profile.json`](/recipes/troubleshooting/performance-profiling). | +| `--verbosity` | Use [`--verbose`](/nx-api/nx/documents/run-many#verbose) | +| `turbo gen` | [Use `nx generate`](/nx-api/nx/documents/generate) | +| `turbo login` | No need. [Use `nx connect`](/nx-api/nx/documents/connect-to-nx-cloud) once to set up Nx Cloud. | +| `turbo link` | [Use `nx connect`](/nx-api/nx/documents/connect-to-nx-cloud) | diff --git a/docs/shared/migration/manual.md b/docs/shared/migration/manual.md index cf4b29cad10ec..4c0a127614985 100644 --- a/docs/shared/migration/manual.md +++ b/docs/shared/migration/manual.md @@ -54,8 +54,8 @@ nx generate @nx/react:application my-application There are a lot of options when creating your application. If you want to follow Nx recommendations, you can accept the defaults. If you have a well-established codebase, you can configure those options at the time of application generation. You can find documentation for these options for the different frameworks here: -- [Angular](/packages/angular/generators/application) -- [React](/packages/react/generators/application) +- [Angular](/nx-api/angular/generators/application) +- [React](/nx-api/react/generators/application) You may also find it useful to use the [Nx Console](/core-features/integrate-with-editors) in Visual Studio Code. This will give you a visual way to generate your application with all of the options laid out in front of you. @@ -151,7 +151,7 @@ Nx uses Prettier to ensure standard formatting across your codebase. Prettier co nx format:write ``` -[Learn more about formatting](/packages/nx/documents/format-write) +[Learn more about formatting](/nx-api/nx/documents/format-write) ### Adding tasks @@ -161,7 +161,7 @@ You should consider implementing them as Nx tasks which should be a quick transi Your use-case may also be covered by one of our community plugins. Plugin authors are able to extend the functionality of Nx through our plugin API. -[Learn more about the `run-commands` executor](/packages/nx/executors/run-commands) +[Learn more about the `run-commands` executor](/nx-api/nx/executors/run-commands) [Learn more about caching](/concepts/how-caching-works) diff --git a/docs/shared/migration/migration-angular.md b/docs/shared/migration/migration-angular.md index 2bb3fcc6c73d8..72ff5c23148dd 100644 --- a/docs/shared/migration/migration-angular.md +++ b/docs/shared/migration/migration-angular.md @@ -114,8 +114,8 @@ Your workspace is now powered by Nx! You can verify that your application still Learn more about the advantages of Nx in the following guides: -- [Using Cypress for e2e tests](/packages/cypress) -- [Using Jest for unit tests](/packages/jest) +- [Using Cypress for e2e tests](/nx-api/cypress) +- [Using Jest for unit tests](/nx-api/jest) - [Computation Caching](/concepts/how-caching-works) - [Rebuilding and Retesting What is Affected](/concepts/affected) - [Integrate with Editors](/core-features/integrate-with-editors) diff --git a/docs/shared/monorepo-ci-azure.md b/docs/shared/monorepo-ci-azure.md index 5447deed3ce1e..f2a9ec219ebc3 100644 --- a/docs/shared/monorepo-ci-azure.md +++ b/docs/shared/monorepo-ci-azure.md @@ -195,6 +195,6 @@ jobs: - script: npx nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) -t lint --parallel=3 & npx nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) -t test --parallel=3 --configuration=ci & npx nx affected --base=$(BASE_SHA) --head=$(HEAD_SHA) -t build --parallel=3 ``` -You can also use our [ci-workflow generator](/packages/workspace/generators/ci-workflow) to generate the pipeline file. +You can also use our [ci-workflow generator](/nx-api/workspace/generators/ci-workflow) to generate the pipeline file. {% /nx-cloud-section %} diff --git a/docs/shared/monorepo-ci-circle-ci.md b/docs/shared/monorepo-ci-circle-ci.md index 966a69644af52..799e8218ddff5 100644 --- a/docs/shared/monorepo-ci-circle-ci.md +++ b/docs/shared/monorepo-ci-circle-ci.md @@ -82,6 +82,6 @@ workflows: - main ``` -You can also use our [ci-workflow generator](/packages/workspace/generators/ci-workflow) to generate the configuration file. +You can also use our [ci-workflow generator](/nx-api/workspace/generators/ci-workflow) to generate the configuration file. {% /nx-cloud-section %} diff --git a/docs/shared/monorepo-ci-github-actions.md b/docs/shared/monorepo-ci-github-actions.md index 267dc88173a99..e9135f68acc62 100644 --- a/docs/shared/monorepo-ci-github-actions.md +++ b/docs/shared/monorepo-ci-github-actions.md @@ -69,7 +69,7 @@ jobs: number-of-agents: 3 ``` -You can also use our [ci-workflow generator](/packages/workspace/generators/ci-workflow) to generate the workflow file. +You can also use our [ci-workflow generator](/nx-api/workspace/generators/ci-workflow) to generate the workflow file. ## Custom distributed CI with Nx Cloud diff --git a/docs/shared/monorepo-nx-enterprise.md b/docs/shared/monorepo-nx-enterprise.md index f06452f59f08f..d8d2e540449b5 100644 --- a/docs/shared/monorepo-nx-enterprise.md +++ b/docs/shared/monorepo-nx-enterprise.md @@ -214,7 +214,7 @@ will get the following problems: - We will be affected by the code your change didn't touch We should utilize `affected:*` commands to build and test projects. Read more about -them [here](/packages/nx/documents/affected). +them [here](/nx-api/nx/documents/affected). ### Trunk-based development diff --git a/docs/shared/node-server-tutorial/4-task-pipelines.md b/docs/shared/node-server-tutorial/4-task-pipelines.md index c64910ca97d23..961477fdcc6a3 100644 --- a/docs/shared/node-server-tutorial/4-task-pipelines.md +++ b/docs/shared/node-server-tutorial/4-task-pipelines.md @@ -217,7 +217,7 @@ npx nx affected -t lint This can be particularly helpful in CI pipelines for larger repos, where most commits only affect a small subset of the entire workspace. -{% card title="Affected Documentation" description="Checkout Affected documentation for more details" url="/packages/nx/documents/affected" /%} +{% card title="Affected Documentation" description="Checkout Affected documentation for more details" url="/nx-api/nx/documents/affected" /%} ## What's Next diff --git a/docs/shared/packages/cypress/cypress-component-testing.md b/docs/shared/packages/cypress/cypress-component-testing.md index 0e81ad353f952..0ba40e6d945b9 100644 --- a/docs/shared/packages/cypress/cypress-component-testing.md +++ b/docs/shared/packages/cypress/cypress-component-testing.md @@ -3,12 +3,12 @@ > Component testing requires Cypress v10 and above. > See our [guide for more information](/recipes/cypress/cypress-v11-migration) to migrate to Cypress v10. -Unlike [E2E testing](/packages/cypress), component testing does not create a new project. Instead, Cypress component testing is added -directly to a project, like [Jest](/packages/jest) +Unlike [E2E testing](/nx-api/cypress), component testing does not create a new project. Instead, Cypress component testing is added +directly to a project, like [Jest](/nx-api/jest) ## Add Component Testing to a Project -> Currently only [@nx/react](/packages/react/generators/cypress-component-configuration), [@nx/angular](/packages/angular/generators/cypress-component-configuration), and [@nx/next](/packages/next/generators/cypress-component-configuration) plugins support component testing +> Currently only [@nx/react](/nx-api/react/generators/cypress-component-configuration), [@nx/angular](/nx-api/angular/generators/cypress-component-configuration), and [@nx/next](/nx-api/next/generators/cypress-component-configuration) plugins support component testing Use the `cypress-component-configuration` generator from the respective plugin to add component testing to a project. @@ -24,7 +24,7 @@ You can optionally pass in `--generate-tests` to create component tests for all Component testing supports both applications and libraries. By default, the generator attempts to find the build target for you based on the project's dependent apps. But you can manually specify the build target to use via the `--build-target` option. Note, in most cases, the build target will be from a different project than the one being configured. The only case where the build targets are from the same project is when the component tests are being added to an application. -> Note: The [@nx/next:cypress-component-configuration generator](/packages/next/generators/cypress-component-configuration) doesn't require a build target +> Note: The [@nx/next:cypress-component-configuration generator](/nx-api/next/generators/cypress-component-configuration) doesn't require a build target ```shell nx g @nx/react:cypress-component-configuration --project=your-project --build-target=my-react-app:build diff --git a/docs/shared/packages/cypress/cypress-plugin.md b/docs/shared/packages/cypress/cypress-plugin.md index 4c4c3ad72910b..903620db4a51e 100644 --- a/docs/shared/packages/cypress/cypress-plugin.md +++ b/docs/shared/packages/cypress/cypress-plugin.md @@ -110,11 +110,11 @@ For adding more dynamic configurations to your cypress configuration, you can lo If you're needing to pass a variable to cypress that you wish to not commit to your repository, i.e. API keys, or dynamic values based on configurations, i.e. API Urls. This is where [Cypress environment variables](https://docs.cypress.io/guides/guides/environment-variables) can be used. -There are a handful of ways to pass environment variables to Cypress, but the most common is going to be via the [`cypress.env.json` file](https://docs.cypress.io/guides/guides/environment-variables#Option-1-configuration-file), the [env executor option for cypress](https://nx.dev/packages/cypress/executors/cypress#env) or the commandline. +There are a handful of ways to pass environment variables to Cypress, but the most common is going to be via the [`cypress.env.json` file](https://docs.cypress.io/guides/guides/environment-variables#Option-1-configuration-file), the [env executor option for cypress](/nx-api/cypress/executors/cypress#env) or the commandline. Create a `cypress.env.json` file in the projects root i.e. `apps/my-cool-app-e2e/cypress.env.json`. Cypress will automatically pick up this file. This method is helpful for configurations that you want to not commit. Just don't forget to add the file to the `.gitignore` and add documentation so people in your repo know what values to popluate in their local copy of the `cypress.env.json` file. -Using [@nx/cypress:cypress](/packages/cypress/executors/cypress) env executor option is a good way to add values you want to define that you don't mine commit to the repository, such as a base API url. You can leverage [target configurations](/reference/project-configuration#targets) to define different values as well. +Using [@nx/cypress:cypress](/nx-api/cypress/executors/cypress) env executor option is a good way to add values you want to define that you don't mine commit to the repository, such as a base API url. You can leverage [target configurations](/reference/project-configuration#targets) to define different values as well. Optionally, you can pass environment variables via the commandline with the `--env` flag. diff --git a/docs/shared/packages/esbuild/esbuild-plugin.md b/docs/shared/packages/esbuild/esbuild-plugin.md index 7d5300732bf4c..0a4d96a8b39b3 100644 --- a/docs/shared/packages/esbuild/esbuild-plugin.md +++ b/docs/shared/packages/esbuild/esbuild-plugin.md @@ -5,7 +5,7 @@ Why should you use this plugin? - _Fast_ builds using esbuild. - Type-checking using TypeScript, which esbuild does not handle. - Intelligent `package.json` output. -- Additional [assets](/packages/esbuild/executors/esbuild#assets) for the output. +- Additional [assets](/nx-api/esbuild/executors/esbuild#assets) for the output. ## Setting up esbuild @@ -141,4 +141,4 @@ Extra API options for esbuild can be passed in the `esbuildOptions` object for y ## More Documentation -- [Using JS](/packages/js) +- [Using JS](/nx-api/js) diff --git a/docs/shared/packages/expo/expo-plugin.md b/docs/shared/packages/expo/expo-plugin.md index a89d03374561c..0590c3e9e83f2 100644 --- a/docs/shared/packages/expo/expo-plugin.md +++ b/docs/shared/packages/expo/expo-plugin.md @@ -300,5 +300,5 @@ Below table is a map between expo commands and Nx commands: ## More Documentation -- [Using Detox](/packages/detox) -- [Using Jest](/packages/jest) +- [Using Detox](/nx-api/detox) +- [Using Jest](/nx-api/jest) diff --git a/docs/shared/packages/jest/jest-plugin.md b/docs/shared/packages/jest/jest-plugin.md index 890c397076c39..c531b9b6ff6ce 100644 --- a/docs/shared/packages/jest/jest-plugin.md +++ b/docs/shared/packages/jest/jest-plugin.md @@ -117,7 +117,7 @@ export default { ### Nx -Nx Jest Plugin options can be configured via the [project config file](/reference/project-configuration) or via the [command line flags](/packages/jest). +Nx Jest Plugin options can be configured via the [project config file](/reference/project-configuration) or via the [command line flags](/nx-api/jest). > Hint: Use `--help` to see all available options > @@ -203,4 +203,4 @@ export default async function () { ## More Documentation - [Jest Docs](https://jestjs.io/) -- [@nx/jest options](/packages/jest) +- [@nx/jest options](/nx-api/jest) diff --git a/docs/shared/packages/linter/eslint-plugin.md b/docs/shared/packages/linter/eslint-plugin.md index dfe60ed93a138..dcab3273d9a5e 100644 --- a/docs/shared/packages/linter/eslint-plugin.md +++ b/docs/shared/packages/linter/eslint-plugin.md @@ -61,8 +61,8 @@ You can also use `@nx/react` which includes all three `@nx/react-*` plugins ### Enforce Module Boundaries rule -The `enforce-module-boundaries` ESLint rule enables you to define strict rules for accessing resources between different projects in the repository. Enforcing strict boundaries helps prevent unplanned cross-dependencies. Read more about it on a [dedicated page](/packages/eslint-plugin/documents/enforce-module-boundaries). +The `enforce-module-boundaries` ESLint rule enables you to define strict rules for accessing resources between different projects in the repository. Enforcing strict boundaries helps prevent unplanned cross-dependencies. Read more about it on a [dedicated page](/nx-api/eslint-plugin/documents/enforce-module-boundaries). ### Dependency Checks rule -The `@nx/dependency-checks` ESLint rule enables you to discover mismatches between dependencies specified in a project's `package.json` and the dependencies that your project actually depends on. Read more about it on a [dedicated page](/packages/eslint-plugin/documents/dependency-checks). +The `@nx/dependency-checks` ESLint rule enables you to discover mismatches between dependencies specified in a project's `package.json` and the dependencies that your project actually depends on. Read more about it on a [dedicated page](/nx-api/eslint-plugin/documents/dependency-checks). diff --git a/docs/shared/packages/linter/linter-plugin.md b/docs/shared/packages/linter/linter-plugin.md index 299a251ecd977..30f9e8745c015 100644 --- a/docs/shared/packages/linter/linter-plugin.md +++ b/docs/shared/packages/linter/linter-plugin.md @@ -32,9 +32,9 @@ nx lint my-lib ## Utils -- [convert-to-flat-config](/packages/linter/generators/convert-to-flat-config) - Converts the workspace's [ESLint](https://eslint.org/) configs to the new [Flat Config](https://eslint.org/blog/2022/08/new-config-system-part-2) -- **Deprecated** [convert-tslint-to-eslint](/packages/angular/generators/convert-tslint-to-eslint) - Converts a project linter from [TSLint](https://palantir.github.io/tslint/) to [ESLint](https://eslint.org/) +- [convert-to-flat-config](/nx-api/linter/generators/convert-to-flat-config) - Converts the workspace's [ESLint](https://eslint.org/) configs to the new [Flat Config](https://eslint.org/blog/2022/08/new-config-system-part-2) +- **Deprecated** [convert-tslint-to-eslint](/nx-api/angular/generators/convert-tslint-to-eslint) - Converts a project linter from [TSLint](https://palantir.github.io/tslint/) to [ESLint](https://eslint.org/) ## ESLint plugin -Read about our dedicated ESLint plugin - [eslint-plugin-nx](/packages/eslint-plugin/documents/overview). +Read about our dedicated ESLint plugin - [eslint-plugin-nx](/nx-api/eslint-plugin/documents/overview). diff --git a/docs/shared/packages/nest/nest-plugin.md b/docs/shared/packages/nest/nest-plugin.md index 1f77855cd1615..878099daf3672 100644 --- a/docs/shared/packages/nest/nest-plugin.md +++ b/docs/shared/packages/nest/nest-plugin.md @@ -149,4 +149,4 @@ nx test my-nest-lib ## More Documentation -- [Using Jest](/packages/jest) +- [Using Jest](/nx-api/jest) diff --git a/docs/shared/packages/next/next-config-setup.md b/docs/shared/packages/next/next-config-setup.md index 1d8253c37c1f9..e7ccfc46f8c7f 100644 --- a/docs/shared/packages/next/next-config-setup.md +++ b/docs/shared/packages/next/next-config-setup.md @@ -30,7 +30,7 @@ There is a popular package called `next-compose-plugins` that has not been maint ## `withNx` plugin -The `withNx` Next.js plugin provides integration with Nx, including support for [workspace libraries](/packages/next/generators/library), SVGR, and more. It is included by default when you generate a Next.js [application](/packages/next/generators/application) with Nx. When you customize your `next.config.js` file, make sure to include the `withNx` plugin. +The `withNx` Next.js plugin provides integration with Nx, including support for [workspace libraries](/nx-api/next/generators/library), SVGR, and more. It is included by default when you generate a Next.js [application](/nx-api/next/generators/application) with Nx. When you customize your `next.config.js` file, make sure to include the `withNx` plugin. ### Options diff --git a/docs/shared/packages/node/node-plugin.md b/docs/shared/packages/node/node-plugin.md index cb85e8116efde..13cbaa7b54120 100644 --- a/docs/shared/packages/node/node-plugin.md +++ b/docs/shared/packages/node/node-plugin.md @@ -86,5 +86,5 @@ For additional information on how to debug Node applications, see the [Node.js d ## More Documentation -- [Using Cypress](/packages/cypress) -- [Using Jest](/packages/jest) +- [Using Cypress](/nx-api/cypress) +- [Using Jest](/nx-api/jest) diff --git a/docs/shared/packages/react-native/react-native-plugin.md b/docs/shared/packages/react-native/react-native-plugin.md index 13e8a7c8c3f4e..f17aff1d971f0 100644 --- a/docs/shared/packages/react-native/react-native-plugin.md +++ b/docs/shared/packages/react-native/react-native-plugin.md @@ -83,7 +83,7 @@ The Nx CLI provides the [`migrate` command](/core-features/automate-updating-dep #### Use upgrade-native Generator -To upgrade native iOS and Android code to latest, you can use the [upgrade-native](/packages/react-native/generators/upgrade-native) generator: +To upgrade native iOS and Android code to latest, you can use the [upgrade-native](/nx-api/react-native/generators/upgrade-native) generator: ```shell nx generate @nx/react-native:upgrade-native @@ -147,5 +147,5 @@ The build artifacts will be located under `/android/app/build`. ## More Documentation -- [Using Detox](/packages/detox) -- [Using Jest](/packages/jest) +- [Using Detox](/nx-api/detox) +- [Using Jest](/nx-api/jest) diff --git a/docs/shared/packages/react/react-plugin.md b/docs/shared/packages/react/react-plugin.md index be6235625634c..0d134598567c1 100644 --- a/docs/shared/packages/react/react-plugin.md +++ b/docs/shared/packages/react/react-plugin.md @@ -124,6 +124,6 @@ The library in `dist` is publishable to npm or a private registry. ## More Documentation -- [Using Cypress](/packages/cypress) -- [Using Jest](/packages/jest) +- [Using Cypress](/nx-api/cypress) +- [Using Jest](/nx-api/jest) - [Using Storybook](/recipes/storybook/overview-react) diff --git a/docs/shared/packages/storybook/best-practices.md b/docs/shared/packages/storybook/best-practices.md index fe287924fd1a1..319143e26ce7e 100644 --- a/docs/shared/packages/storybook/best-practices.md +++ b/docs/shared/packages/storybook/best-practices.md @@ -7,7 +7,7 @@ description: The purpose of this guide is to help you set up Storybook in your N ## Purpose of this guide -The purpose of this guide is to help you [set up Storybook in your Nx workspace](/packages/storybook) so that you can get the most out of Nx and its powerful capabilities. +The purpose of this guide is to help you [set up Storybook in your Nx workspace](/nx-api/storybook) so that you can get the most out of Nx and its powerful capabilities. ## When to use Storybook @@ -31,7 +31,7 @@ First, let’s see what Nx offers, when you are in the process of developing a p #### Configuration generation -You can generate the Storybook configuration files and settings using the Nx [`@nx/storybook:configuration` generator](/packages/storybook/generators/configuration). You can read more about configuring Storybook with Nx in our [`@nx/storybook` package overview page](/packages/storybook#generating-storybook-configuration). With Nx, you configure Storybook for each individual project. +You can generate the Storybook configuration files and settings using the Nx [`@nx/storybook:configuration` generator](/nx-api/storybook/generators/configuration). You can read more about configuring Storybook with Nx in our [`@nx/storybook` package overview page](/nx-api/storybook#generating-storybook-configuration). With Nx, you configure Storybook for each individual project. #### Stories generation @@ -43,13 +43,13 @@ If your project is not configured yet, check out one of these guides: - [Set up Storybook for Angular Projects](/recipes/storybook/overview-angular) -If your project is [already configured](/packages/storybook), you can use the `stories` generator: +If your project is [already configured](/nx-api/storybook), you can use the `stories` generator: -- [React stories generator](/packages/react/generators/stories) +- [React stories generator](/nx-api/react/generators/stories) -- [React Native stories generator](/packages/react-native/generators/stories) +- [React Native stories generator](/nx-api/react-native/generators/stories) -- [Angular stories generator](/packages/angular/generators/stories) +- [Angular stories generator](/nx-api/angular/generators/stories) The stories generator will read your inputs (if you’re using Angular), or your props (if you're using React), and will generate stories with the corresponding arguments/controls already prefilled. @@ -77,11 +77,11 @@ When you are running the Cypress tests for a project, Cypress will start the Sto #### Serve -When you are configuring Storybook, Nx [adds a serve and a build target for Storybook](/packages/storybook#generating-storybook-configuration) in your `project.json`, as we explained above. You can use these targets to [serve](/packages/storybook/executors/storybook) and [build](/packages/storybook/executors/build) storybook locally, and also in production. Cypress will also use these targets when firing up the e2e tests. While developing, you can serve your Storybooks locally to see if your components work and look as expected. This can help you and speed up the development and debugging process (no need to fire up a complex dev stack). +When you are configuring Storybook, Nx [adds a serve and a build target for Storybook](/nx-api/storybook#generating-storybook-configuration) in your `project.json`, as we explained above. You can use these targets to [serve](/nx-api/storybook/executors/storybook) and [build](/nx-api/storybook/executors/build) storybook locally, and also in production. Cypress will also use these targets when firing up the e2e tests. While developing, you can serve your Storybooks locally to see if your components work and look as expected. This can help you and speed up the development and debugging process (no need to fire up a complex dev stack). #### Build and deploy -The build and deploy step usually comes in handy when you are ready to use Storybook for documentation, and you want to publish it. The [building](/packages/storybook/executors/build) step of Storybook is integrated in the Nx ecosystem, as explained above, and you can trigger your Storybook builds as you would trigger any other build inside your workspace. +The build and deploy step usually comes in handy when you are ready to use Storybook for documentation, and you want to publish it. The [building](/nx-api/storybook/executors/build) step of Storybook is integrated in the Nx ecosystem, as explained above, and you can trigger your Storybook builds as you would trigger any other build inside your workspace. When you publish your organization’s Storybook, as a result, ideally, you would want to have one shareable Storybook page/application living under one URL, that you can share. With Nx, you can build your Storybook and it will be ready for deployment. **However**, at this point, you have one Storybook per project in your workspace, and you could end up with far too many Storybooks that are built and ready for deployment. This is not ideal, and does not accomplish the ultimate goal of “one shareable documentation page”. @@ -150,4 +150,4 @@ If you have any questions or suggestions, please feel free to reach out to us on ### Nx & Storybook documentation -You can find all Storybook-related Nx documentation in the [packages page](/packages#storybook). +You can find all Storybook-related Nx documentation in the [packages page](/nx-api/storybook). diff --git a/docs/shared/packages/storybook/plugin-overview.md b/docs/shared/packages/storybook/plugin-overview.md index e88acfeb03769..5ba8376857f7a 100644 --- a/docs/shared/packages/storybook/plugin-overview.md +++ b/docs/shared/packages/storybook/plugin-overview.md @@ -53,7 +53,7 @@ You can generate Storybook configuration for an individual project with this com nx g @nx/storybook:configuration project-name ``` -If you are NOT using a framework-specific generator (for [Angular](/packages/angular/generators/storybook-configuration), [React](/packages/react/generators/storybook-configuration), [React Native](/packages/react-native/generators/storybook-configuration)), in the field `uiFramework` you must choose one of the following Storybook frameworks: +If you are NOT using a framework-specific generator (for [Angular](/nx-api/angular/generators/storybook-configuration), [React](/nx-api/react/generators/storybook-configuration), [React Native](/nx-api/react-native/generators/storybook-configuration)), in the field `uiFramework` you must choose one of the following Storybook frameworks: - `@storybook/angular` - `@storybook/html-webpack5` @@ -82,7 +82,7 @@ Choosing one of these frameworks will have the following effects on your workspa 4. Nx will generate a new Cypress e2e app for your project (if there isn't one already) to run against the Storybook instance. -Make sure to **use the framework-specific generators** if your project is using Angular, React, Next.js or React Native: [`@nx/angular:storybook-configuration`](/packages/angular/generators/storybook-configuration), [`@nx/react:storybook-configuration`](/packages/react/generators/storybook-configuration), [`@nx/react-native:storybook-configuration`](/packages/react-native/generators/storybook-configuration): +Make sure to **use the framework-specific generators** if your project is using Angular, React, Next.js or React Native: [`@nx/angular:storybook-configuration`](/nx-api/angular/generators/storybook-configuration), [`@nx/react:storybook-configuration`](/nx-api/react/generators/storybook-configuration), [`@nx/react-native:storybook-configuration`](/nx-api/react-native/generators/storybook-configuration): {% tabs %} {% tab label="Angular" %} @@ -210,8 +210,8 @@ Here's more information on common migration scenarios for Storybook with Nx. For - [Upgrading to Storybook 6](/deprecated/storybook/upgrade-storybook-v6-react) - [Migrate to the Nx React Storybook Addon](/deprecated/storybook/migrate-webpack-final-react) -- [Storybook 7 migration generator](/packages/storybook/generators/migrate-7) -- [Storybook 7 setup guide](/packages/storybook/documents/storybook-7-setup) +- [Storybook 7 migration generator](/nx-api/storybook/generators/migrate-7) +- [Storybook 7 setup guide](/nx-api/storybook/documents/storybook-7-setup) ## Older documentation diff --git a/docs/shared/packages/storybook/storybook-7-setup.md b/docs/shared/packages/storybook/storybook-7-setup.md index 747ebf37ac8c3..773cf00fabfc6 100644 --- a/docs/shared/packages/storybook/storybook-7-setup.md +++ b/docs/shared/packages/storybook/storybook-7-setup.md @@ -7,17 +7,17 @@ description: This guide explains how you can set up Storybook version 7 in your Storybook 7 is a major release that brings a lot of new features and improvements. You can read more about it in the [Storybook 7.0.0 release article](https://storybook.js.org/blog/storybook-7-0/). Apart from the new features and improvements it introduces, it also brings some breaking changes. You can read more about them in the [Storybook 7 migration docs](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#from-version-65x-to-700) and the [Storybook 7.0.0 migration guide](https://storybook.js.org/docs/react/migration-guide). -Nx provides new generators that allow you to generate Storybook 7 configuration for your projects, by installing the correct dependencies and creating the corresponding version 7 configuration files. Nx also provides a [Storybook 7 migration generator](/packages/storybook/generators/migrate-7) that you can use to migrate your existing Storybook configuration to version 7. +Nx provides new generators that allow you to generate Storybook 7 configuration for your projects, by installing the correct dependencies and creating the corresponding version 7 configuration files. Nx also provides a [Storybook 7 migration generator](/nx-api/storybook/generators/migrate-7) that you can use to migrate your existing Storybook configuration to version 7. So, let's see how you can use Storybook 7 on your Nx workspace. ## Migrate your existing workspace to Storybook 7 -If you already have Storybook configured in your Nx workspace, you can use the [Storybook 7 migrator generator](/packages/storybook/generators/migrate-7) to migrate your existing Storybook configuration to version 7. +If you already have Storybook configured in your Nx workspace, you can use the [Storybook 7 migrator generator](/nx-api/storybook/generators/migrate-7) to migrate your existing Storybook configuration to version 7. ## Set up Storybook 7 in a _new_ Nx Workspace -Please read the [`@nx/storybook` package overview](/packages/storybook) to see how you can configure Storybook in your Nx workspace. +Please read the [`@nx/storybook` package overview](/nx-api/storybook) to see how you can configure Storybook in your Nx workspace. ## Changes from the v6.5 Storybook configuration @@ -32,7 +32,7 @@ The Storybook configuration generated by Nx for Storybook 7 is very similar to t ### Changes in the `storybook` and `build-storybook` targets - The `uiFramework` field is not needed any more, thus it is not set. Nx was using the `uiFramework` field to load any framework specific options for the Storybook builder. This is no longer needed, since the `framework` set in `.storybook/main.js|ts` takes care of that. -- More options from the Storybook CLI are now exposed in the executors. You can see these in the [`@nx/storybook:storybook`](/packages/storybook/executors/storybook) and [`@nx/storybook:build`](/packages/storybook/executors/build) executor schemas. You can read more about these options in the [Storybook 7 CLI docs](https://storybook.js.org/docs/7.0/react/api/cli-options). If there's an option you need to pass but it's not in the executor schema, you can always pass it, since the executors are just passing the options to the Storybook CLI. +- More options from the Storybook CLI are now exposed in the executors. You can see these in the [`@nx/storybook:storybook`](/nx-api/storybook/executors/storybook) and [`@nx/storybook:build`](/nx-api/storybook/executors/build) executor schemas. You can read more about these options in the [Storybook 7 CLI docs](https://storybook.js.org/docs/7.0/react/api/cli-options). If there's an option you need to pass but it's not in the executor schema, you can always pass it, since the executors are just passing the options to the Storybook CLI. ## Report any issues and bugs diff --git a/docs/shared/packages/vite/set-up-vite-manually.md b/docs/shared/packages/vite/set-up-vite-manually.md index 769270f01dbac..30f228f0d8c05 100644 --- a/docs/shared/packages/vite/set-up-vite-manually.md +++ b/docs/shared/packages/vite/set-up-vite-manually.md @@ -6,14 +6,14 @@ description: This guide explains how you can manually set up your project to use # Manually set up your project to use Vite.js {% callout type="note" title="Use our generator!" %} -It is recommended that you use the [`@nx/vite:configuration`](/packages/vite/generators/configuration) generator to do convert an existing project to use [Vite](https://vitejs.dev/). +It is recommended that you use the [`@nx/vite:configuration`](/nx-api/vite/generators/configuration) generator to do convert an existing project to use [Vite](https://vitejs.dev/). {% /callout %} -You can use the `@nx/vite:dev-server`,`@nx/vite:build` and `@nx/vite:test` executors to serve, build and test your project using [Vite](https://vitejs.dev/) and [Vitest](https://vitest.dev/). To do this, you need to make a few adjustments to your project. It is recommended that you use the [`@nx/vite:configuration`](/packages/vite/generators/configuration) generator to do this, but you can also do it manually. +You can use the `@nx/vite:dev-server`,`@nx/vite:build` and `@nx/vite:test` executors to serve, build and test your project using [Vite](https://vitejs.dev/) and [Vitest](https://vitest.dev/). To do this, you need to make a few adjustments to your project. It is recommended that you use the [`@nx/vite:configuration`](/nx-api/vite/generators/configuration) generator to do this, but you can also do it manually. A reason you may need to do this manually, is if our generator does not support conversion for your project, or if you want to experiment with custom options. -The list of steps below assumes that your project can be converted to use the `@nx/vite` executors. However, if it's not supported by the [`@nx/vite:configuration`](/packages/vite/generators/configuration) generator, it's likely that your project will not work as expected when converted. So, proceed with caution and always commit your code before making any changes. +The list of steps below assumes that your project can be converted to use the `@nx/vite` executors. However, if it's not supported by the [`@nx/vite:configuration`](/nx-api/vite/generators/configuration) generator, it's likely that your project will not work as expected when converted. So, proceed with caution and always commit your code before making any changes. ## 1. Change the executors in your `project.json` @@ -43,7 +43,7 @@ In your app's `project.json` file, change the executor of your `serve` target to ``` {% callout type="note" title="Other options" %} -Any extra options that you may need to add to your server's configuration can be added in your project's `vite.config.ts` file. You can find all the options that are supported in the [Vite.js documentation](https://vitejs.dev/config/). You can see which of these options you can add in your `project.json` in the [`@nx/vite:dev-server`](/packages/vite/executors/dev-server#options) documentation. +Any extra options that you may need to add to your server's configuration can be added in your project's `vite.config.ts` file. You can find all the options that are supported in the [Vite.js documentation](https://vitejs.dev/config/). You can see which of these options you can add in your `project.json` in the [`@nx/vite:dev-server`](/nx-api/vite/executors/dev-server#options) documentation. {% /callout %} ### The `build` target diff --git a/docs/shared/packages/vite/vite-plugin.md b/docs/shared/packages/vite/vite-plugin.md index dc607a40b5875..5d1ae8f9548a1 100644 --- a/docs/shared/packages/vite/vite-plugin.md +++ b/docs/shared/packages/vite/vite-plugin.md @@ -38,7 +38,7 @@ There is a number of ways to use Vite in your existing workspace. ### Generate a new project using Vite -You can generate a [React](/packages/react) application or library or a [Web](/packages/web) application that uses Vite.js. The [`@nx/react:app`](/packages/react/generators/application), [`@nx/react:lib`](/packages/react/generators/library) and [`@nx/web:app`](/packages/web/generators/application) generators accept the `bundler` option, where you can pass `vite`. This will generate a new application configured to use Vite.js, and it will also install all the necessary dependencies, including the `@nx/vite` plugin. +You can generate a [React](/nx-api/react) application or library or a [Web](/nx-api/web) application that uses Vite.js. The [`@nx/react:app`](/nx-api/react/generators/application), [`@nx/react:lib`](/nx-api/react/generators/library) and [`@nx/web:app`](/nx-api/web/generators/application) generators accept the `bundler` option, where you can pass `vite`. This will generate a new application configured to use Vite.js, and it will also install all the necessary dependencies, including the `@nx/vite` plugin. To generate a React application using Vite.js, run the following: @@ -62,7 +62,7 @@ nx g @nx/web:app my-app --bundler=vite You can use the `@nx/vite:configuration` generator to change your React or Web project to use Vite.js. This generator will modify your project's configuration to use Vite.js, and it will also install all the necessary dependencies, including the `@nx/vite` plugin.. -You can read more about this generator on the [`@nx/vite:configuration`](/packages/vite/generators/configuration) generator page. +You can read more about this generator on the [`@nx/vite:configuration`](/nx-api/vite/generators/configuration) generator page. ### Initialize Vite.js diff --git a/docs/shared/packages/web/web-plugin.md b/docs/shared/packages/web/web-plugin.md index 7864a3bbe2db9..ff1c884fcaa17 100644 --- a/docs/shared/packages/web/web-plugin.md +++ b/docs/shared/packages/web/web-plugin.md @@ -35,12 +35,12 @@ The application uses no framework and generates with web components. You can add To start the application in development mode, run `nx serve my-new-app`. {% callout type="note" title="React" %} -If you are looking to add a React application, check out the [React plugin](/packages/react). +If you are looking to add a React application, check out the [React plugin](/nx-api/react). {% /callout %} ### Creating Libraries -To create a generic TypeScript library (i.e. non-framework specific), use the [`@nx/js`](/packages/js) plugin. +To create a generic TypeScript library (i.e. non-framework specific), use the [`@nx/js`](/nx-api/js) plugin. ```shell nx g @nx/js:lib my-new-lib @@ -98,5 +98,5 @@ The library in `dist` is publishable to npm or a private registry. ## More Documentation -- [Using Cypress](/packages/cypress) -- [Using Jest](/packages/jest) +- [Using Cypress](/nx-api/cypress) +- [Using Jest](/nx-api/jest) diff --git a/docs/shared/packages/webpack/plugin-overview.md b/docs/shared/packages/webpack/plugin-overview.md index cfed3a2b10c95..af0c063509a9c 100644 --- a/docs/shared/packages/webpack/plugin-overview.md +++ b/docs/shared/packages/webpack/plugin-overview.md @@ -27,7 +27,7 @@ npx create-nx-workspace@latest --preset=react-monorepo --bundler=webpack ## Generate a new project using Webpack -You can generate a [React](/packages/react) application or a [Web](/packages/web) application that uses Webpack in an existing Nx workspace. The [`@nx/react:app`](/packages/react/generators/application), [`@nx/node:app`](/packages/node/generators/application) and [`@nx/web:app`](/packages/web/generators/application) generators accept the `bundler` option, where you can pass `webpack`. This will generate a new application configured to use Webpack, and it will also install all the necessary dependencies, including the `@nx/webpack` plugin. +You can generate a [React](/nx-api/react) application or a [Web](/nx-api/web) application that uses Webpack in an existing Nx workspace. The [`@nx/react:app`](/nx-api/react/generators/application), [`@nx/node:app`](/nx-api/node/generators/application) and [`@nx/web:app`](/nx-api/web/generators/application) generators accept the `bundler` option, where you can pass `webpack`. This will generate a new application configured to use Webpack, and it will also install all the necessary dependencies, including the `@nx/webpack` plugin. To generate a React application using Webpack, run the following: diff --git a/docs/shared/packages/workspace/workspace-plugin.md b/docs/shared/packages/workspace/workspace-plugin.md index 84518542c6663..79289534fd807 100644 --- a/docs/shared/packages/workspace/workspace-plugin.md +++ b/docs/shared/packages/workspace/workspace-plugin.md @@ -9,7 +9,7 @@ Codifying your organization's best practices into local generators is a great wa ## Reorganizing Projects After some time of working within a workspace, projects might need to be moved or sometimes even removed. -The workspace plugin provides the [`@nx/workspace:move`](/packages/workspace/generators/move) and [`@nx/workspace:remove`](/packages/workspace/generators/remove) generators to help aid with this. +The workspace plugin provides the [`@nx/workspace:move`](/nx-api/workspace/generators/move) and [`@nx/workspace:remove`](/nx-api/workspace/generators/remove) generators to help aid with this. ### Moving Projects @@ -24,7 +24,7 @@ Moving the files manually can be done easily but a lot of steps are often missed 5. Paths in target options such as output path will be changed 6. Other configuration will be updated too, such as `extends` in `tsconfig.json`, the name of the project in `jest.config.js`, and the extends in `.eslintrc.json` -> See more about [`@nx/workspace:move`](/packages/workspace/generators/move) +> See more about [`@nx/workspace:move`](/nx-api/workspace/generators/move) ### Removing Projects @@ -37,12 +37,12 @@ Like when moving projects, some steps are often missed when removing projects. T 3. The project's configuration will be removed. 4. The path mapping in `tsconfig.base.json` will be removed. -> See more about [`@nx/workspace:remove`](/packages/workspace/generators/remove) +> See more about [`@nx/workspace:remove`](/nx-api/workspace/generators/remove) ## Running custom commands -Executors provide an optimized way of running targets but unfortunately, not every target has an executor written for it. The [`nx:run-commands`](/packages/nx/executors/run-commands) executor is an executor that runs any command or multiple commands in the shell. This can be useful when integrating with other tools which do not have an executor provided. There is also a generator to help configure this executor. +Executors provide an optimized way of running targets but unfortunately, not every target has an executor written for it. The [`nx:run-commands`](/nx-api/nx/executors/run-commands) executor is an executor that runs any command or multiple commands in the shell. This can be useful when integrating with other tools which do not have an executor provided. There is also a generator to help configure this executor. Running `nx g @nx/workspace:run-commands printhello --project my-feature-lib --command 'echo hello'` will create a `my-feature-lib:printhello` target that executes `echo hello` in the shell. -> See more about [`nx:run-commands`](/packages/nx/executors/run-commands) +> See more about [`nx:run-commands`](/nx-api/nx/executors/run-commands) diff --git a/docs/shared/plugin-features/use-code-generators.md b/docs/shared/plugin-features/use-code-generators.md index 9aab1ebd259c0..919483436d5a2 100644 --- a/docs/shared/plugin-features/use-code-generators.md +++ b/docs/shared/plugin-features/use-code-generators.md @@ -12,7 +12,7 @@ There are three main types of generators: ## Invoking Plugin Generators -Generators allow you to create or modify your codebase in a simple and repeatable way. Generators are invoked using the [`nx generate`](/packages/nx/documents/generate) command. +Generators allow you to create or modify your codebase in a simple and repeatable way. Generators are invoked using the [`nx generate`](/nx-api/nx/documents/generate) command. ```shell nx generate [plugin]:[generator-name] [options] diff --git a/docs/shared/plugin-features/use-task-executors.md b/docs/shared/plugin-features/use-task-executors.md index dcfe339a7d434..a29cc60de7fa5 100644 --- a/docs/shared/plugin-features/use-task-executors.md +++ b/docs/shared/plugin-features/use-task-executors.md @@ -56,7 +56,7 @@ Each executor definition has an `executor` property and, optionally, an `options ## Running executors -The [`nx run`](/packages/nx/documents/run) cli command (or the shorthand versions) can be used to run executors. +The [`nx run`](/nx-api/nx/documents/run) cli command (or the shorthand versions) can be used to run executors. ```shell nx run [project]:[command] @@ -102,7 +102,7 @@ If defining a new target that needs to run a single shell command, there is a sh } ``` -For more info, see the [run-commands documentation](/packages/nx/executors/run-commands) +For more info, see the [run-commands documentation](/nx-api/nx/executors/run-commands) ## Use Executor Configurations diff --git a/docs/shared/plugins/intro.md b/docs/shared/plugins/intro.md index 723017bb0bd7d..a0368184bf4b1 100644 --- a/docs/shared/plugins/intro.md +++ b/docs/shared/plugins/intro.md @@ -17,7 +17,7 @@ Nx plugins help you scaffold new projects, pre-configure tooling, follow best pr {% cards cols="2" %} -{% card title="Browse Existing Plugins" description="Find a plugin to use" url="/extending-nx/registry" /%} +{% card title="Browse Existing Plugins" description="Find a plugin to use" url="/plugin-registry" /%} {% card title="Use Task Executors" description="Run operations on your code" url="/core-features/plugin-features/use-task-executors" /%} {% card title="Use Code Generators" description="Create or modify code" url="/core-features/plugin-features/use-code-generators" /%} diff --git a/docs/shared/react-tutorial/react-monorepo.md b/docs/shared/react-tutorial/react-monorepo.md index fb512ec341513..50814e352a6de 100644 --- a/docs/shared/react-tutorial/react-monorepo.md +++ b/docs/shared/react-tutorial/react-monorepo.md @@ -308,7 +308,7 @@ nx g @nx/react:library orders --directory=libs/orders --unitTestRunner=vitest -- nx g @nx/react:library shared-ui --directory=libs/shared/ui --unitTestRunner=vitest --bundler=none ``` -Note how we type out the full path in the `directory` flag to place the libraries into a subfolder. You can choose whatever folder structure you like to organize your projects. If you change your mind later, you can run the [move generator](/packages/workspace/generators/move) to move a project to a different folder. +Note how we type out the full path in the `directory` flag to place the libraries into a subfolder. You can choose whatever folder structure you like to organize your projects. If you change your mind later, you can run the [move generator](/nx-api/workspace/generators/move) to move a project to a different folder. Running the above commands should lead to the following directory structure: diff --git a/docs/shared/recipes/add-stack/add-astro.md b/docs/shared/recipes/add-stack/add-astro.md index 5102ea83d3185..6595ffe9003e7 100644 --- a/docs/shared/recipes/add-stack/add-astro.md +++ b/docs/shared/recipes/add-stack/add-astro.md @@ -59,7 +59,7 @@ Because Nx [understands package.json scripts](/reference/project-configuration#p nx build ``` -If you plan on using your package manager to run the tasks, then you'll want to use [`nx exec`](/packages/nx/documents/exec) to wrap the command +If you plan on using your package manager to run the tasks, then you'll want to use [`nx exec`](/nx-api/nx/documents/exec) to wrap the command i.e. @@ -77,7 +77,7 @@ If you plan to only run tasks with the Nx CLI, then you can omit `nx exec`. The ## Using Other Plugins -With Nx plugins, you can create projects to help break out functionality of the project. For example, using the [`@nx/js:library`](/packages/js/generators/library#@nx/js:library) to contain our reusable `.astro` components. +With Nx plugins, you can create projects to help break out functionality of the project. For example, using the [`@nx/js:library`](/nx-api/js/generators/library#@nx/js:library) to contain our reusable `.astro` components. Install `@nx/js` plugin. diff --git a/docs/shared/recipes/add-stack/add-express.md b/docs/shared/recipes/add-stack/add-express.md index 3867591f23f07..41b913041a0dc 100644 --- a/docs/shared/recipes/add-stack/add-express.md +++ b/docs/shared/recipes/add-stack/add-express.md @@ -107,6 +107,6 @@ Now when you serve your API, you'll see the content from the library being displ ## More Documentation -- [@nx/express](/packages/express) -- [@nx/js](/packages/js) +- [@nx/express](/nx-api/express) +- [@nx/js](/nx-api/js) - [Express](https://expressjs.com/) diff --git a/docs/shared/recipes/add-stack/add-fastify.md b/docs/shared/recipes/add-stack/add-fastify.md index bf994b7a6a76f..bdaba7bc8f746 100644 --- a/docs/shared/recipes/add-stack/add-fastify.md +++ b/docs/shared/recipes/add-stack/add-fastify.md @@ -110,7 +110,7 @@ Now when you serve your API, you'll see the content from the library being displ ## More Documentation -- [@nx/node](/packages/node) +- [@nx/node](/nx-api/node) - [Using Mongo with Fastify](/showcase/example-repos/mongo-fastify) - [Using Redis with Fastify](/showcase/example-repos/redis-fastify) - [Using Postgres with Fastify](/showcase/example-repos/postgres-fastify) diff --git a/docs/shared/recipes/add-stack/add-lit.md b/docs/shared/recipes/add-stack/add-lit.md index fc74523781d63..d941548968386 100644 --- a/docs/shared/recipes/add-stack/add-lit.md +++ b/docs/shared/recipes/add-stack/add-lit.md @@ -209,6 +209,6 @@ Now when you serve your application, you'll see the content from the library bei ## More Documentation -- [@nx/esbuild](/packages/esbuild) -- [@nx/js](/packages/js) +- [@nx/esbuild](/nx-api/esbuild) +- [@nx/js](/nx-api/js) - [Lit](https://lit.dev/) diff --git a/docs/shared/recipes/add-stack/add-solid.md b/docs/shared/recipes/add-stack/add-solid.md index 158cc5ebf009a..ecda1c1c7b2f5 100644 --- a/docs/shared/recipes/add-stack/add-solid.md +++ b/docs/shared/recipes/add-stack/add-solid.md @@ -312,7 +312,7 @@ Now when you serve your application, you'll see the content from the library bei ## More Documentation -- [@nx/vite](/packages/vite) -- [@nx/js](/packages/js) -- [@nx/web](/packages/web) +- [@nx/vite](/nx-api/vite) +- [@nx/js](/nx-api/js) +- [@nx/web](/nx-api/web) - [Solid](https://www.solidjs.com/) diff --git a/docs/shared/recipes/add-stack/add-svelte.md b/docs/shared/recipes/add-stack/add-svelte.md index 0978cc5008a2e..30f2231ef53c4 100644 --- a/docs/shared/recipes/add-stack/add-svelte.md +++ b/docs/shared/recipes/add-stack/add-svelte.md @@ -338,6 +338,6 @@ To serve the application at `http://localhost:4200`. A larger example including libraries, test and more is available at [Nx Svelte Example](https://github.com/nrwl/nx-recipes/tree/main/svelte) on Github. -- [Nx Vite Plugin](https://nx.dev/packages/vite) +- [Nx Vite Plugin](/nx-api/vite) - [Vite](https://vitejs.dev/) - [Svelte](https://svelte.dev/) diff --git a/docs/shared/recipes/add-stack/add-vue.md b/docs/shared/recipes/add-stack/add-vue.md index 370f045201951..637108c8281a3 100644 --- a/docs/shared/recipes/add-stack/add-vue.md +++ b/docs/shared/recipes/add-stack/add-vue.md @@ -6,7 +6,7 @@ The code for this example is available on Github: **Supported Features** -We'll be using an Nx plugin for Vue called [@nx/vite](https://nx.dev/packages/vite). Although we are using `@nx/vite`, not all dependencies will be able to be automatically updated. So we'll have to update any framework dependencies as needed. +We'll be using an Nx plugin for Vue called [@nx/vite](/nx-api/vite). Although we are using `@nx/vite`, not all dependencies will be able to be automatically updated. So we'll have to update any framework dependencies as needed. {% pill url="/core-features/run-tasks" %}✅ Run Tasks{% /pill %} {% pill url="/core-features/cache-task-results" %}✅ Cache Task Results{% /pill %} @@ -299,6 +299,6 @@ nx serve acme A larger example including libraries, tests, and more is available at [Nx Vue Example](https://github.com/nrwl/nx-recipes/tree/main/vue) on Github. -- [Nx Vite Plugin](https://nx.dev/packages/vite) +- [Nx Vite Plugin](/nx-api/vite) - [Vite](https://vitejs.dev/) - [Vue](https://v3.vuejs.org/) diff --git a/docs/shared/recipes/generators/local-generators.md b/docs/shared/recipes/generators/local-generators.md index 71af382977e76..ede617e7bc39f 100644 --- a/docs/shared/recipes/generators/local-generators.md +++ b/docs/shared/recipes/generators/local-generators.md @@ -116,4 +116,4 @@ Nx uses the paths from `tsconfig.base.json` when running plugins locally, but us ## Generator Utilities -The [`@nx/devkit` package](/packages/devkit/documents/nx_devkit) provides many utility functions that can be used in generators to help with modifying files, reading and updating configuration files, and working with an Abstract Syntax Tree (AST). +The [`@nx/devkit` package](/nx-api/devkit/documents/nx_devkit) provides many utility functions that can be used in generators to help with modifying files, reading and updating configuration files, and working with an Abstract Syntax Tree (AST). diff --git a/docs/shared/recipes/node/wait-for-tasks.md b/docs/shared/recipes/node/wait-for-tasks.md index 016cf88e3f104..87c62411bf930 100644 --- a/docs/shared/recipes/node/wait-for-tasks.md +++ b/docs/shared/recipes/node/wait-for-tasks.md @@ -4,7 +4,7 @@ There are a couple ways to ensure that a set up task has been run before you run The most common solution is to use the [`dependsOn` property](/reference/project-configuration#dependson). This works regardless of what executor the task is using. Once the dependent tasks have completed, the primary task will start. Reference the [project configuration documentation](/reference/project-configuration#dependson) for more information. -If you are using the `@nx/js:node` executor, you can also use the [`waitUntilTargets` option](/packages/js/executors/node#waituntiltargets) of that executor. Once the dependent tasks emit something to the console, the primary task will start. +If you are using the `@nx/js:node` executor, you can also use the [`waitUntilTargets` option](/nx-api/js/executors/node#waituntiltargets) of that executor. Once the dependent tasks emit something to the console, the primary task will start. ## waitUntilTargets diff --git a/docs/shared/recipes/plugins/compose-executors.md b/docs/shared/recipes/plugins/compose-executors.md index 449f11f54c499..7584590e5079c 100644 --- a/docs/shared/recipes/plugins/compose-executors.md +++ b/docs/shared/recipes/plugins/compose-executors.md @@ -69,7 +69,7 @@ The `runExecutor` utility will find the target in the configuration, find the ex | readTargetOptions | Reads and combines options for a given target | | runExecutor | Constructs options and invokes an executor | -See more helper functions in the [Devkit API Docs](/packages/devkit/documents/nx_devkit#functions) +See more helper functions in the [Devkit API Docs](/nx-api/devkit/documents/nx_devkit#functions) ## Using RxJS observables diff --git a/docs/shared/recipes/plugins/create-install-package.md b/docs/shared/recipes/plugins/create-install-package.md index a1767d1e91827..ce09e32ec5cb3 100644 --- a/docs/shared/recipes/plugins/create-install-package.md +++ b/docs/shared/recipes/plugins/create-install-package.md @@ -111,7 +111,7 @@ Because your `create-my-plugin` package will install your plugin package at runt } ``` -_(If you don't have such a `local-registry` target, refer to the following [docs page to generate one](/packages/js/generators/setup-verdaccio))_ +_(If you don't have such a `local-registry` target, refer to the following [docs page to generate one](/nx-api/js/generators/setup-verdaccio))_ By running diff --git a/docs/shared/recipes/plugins/create-preset.md b/docs/shared/recipes/plugins/create-preset.md index 0948bcd82e32e..a88bb579367b1 100644 --- a/docs/shared/recipes/plugins/create-preset.md +++ b/docs/shared/recipes/plugins/create-preset.md @@ -1,6 +1,6 @@ # Create a Custom Plugin Preset -When you create a new nx workspace, you run the command: [`npx create-nx-workspace`](/packages/nx/documents/create-nx-workspace). +When you create a new nx workspace, you run the command: [`npx create-nx-workspace`](/nx-api/nx/documents/create-nx-workspace). This command accepts a `--preset` option, for example: `npx create-nx-workspace --preset=react-standalone`. This preset option is pointing to a special generator function (remember, a generator is a function that simplifies an entire code generation script into a single function) that Nx will call when this `npx create-nx-workspace` command is run, that will generate your initial workspace. diff --git a/docs/shared/recipes/plugins/project-graph-plugins.md b/docs/shared/recipes/plugins/project-graph-plugins.md index d9fe4c4b7329b..e14265e231eb6 100644 --- a/docs/shared/recipes/plugins/project-graph-plugins.md +++ b/docs/shared/recipes/plugins/project-graph-plugins.md @@ -34,7 +34,7 @@ You can register a plugin by adding it to the plugins array in `nx.json`: ## Adding New Nodes to the Project Graph -You can add nodes to the project graph with [`createNodes`](/packages/devkit/documents/CreateNodes). This is the API that Nx uses under the hood to identify Nx projects coming from a `project.json` file or a `package.json` that's listed in a package manager's workspaces section. +You can add nodes to the project graph with [`createNodes`](/nx-api/devkit/documents/CreateNodes). This is the API that Nx uses under the hood to identify Nx projects coming from a `project.json` file or a `package.json` that's listed in a package manager's workspaces section. ### Identifying Projects @@ -85,7 +85,7 @@ External nodes are identified by a unique name, and if plugins identify an exter It's more common for plugins to create new dependencies. First-party code contained in the workspace is added to the project graph automatically. Whether your project contains TypeScript or say Java, both projects will be created in the same way. However, Nx does not know how to analyze Java sources, and that's what plugins can do. -The shape of the [`createDependencies`](/packages/devkit/documents/CreateDependencies) function follows: +The shape of the [`createDependencies`](/nx-api/devkit/documents/CreateDependencies) function follows: ```typescript export type CreateDependencies = ( diff --git a/docs/shared/recipes/root-level-scripts.md b/docs/shared/recipes/root-level-scripts.md index 346ce713f4223..6ed9adac15201 100644 --- a/docs/shared/recipes/root-level-scripts.md +++ b/docs/shared/recipes/root-level-scripts.md @@ -114,4 +114,4 @@ You can keep using `npm run docs` instead of the new `npx nx docs` version and s } ``` -Read more in the [Nx exec docs](/packages/nx/documents/exec). +Read more in the [Nx exec docs](/nx-api/nx/documents/exec). diff --git a/docs/shared/recipes/storybook/angular-configuring-styles.md b/docs/shared/recipes/storybook/angular-configuring-styles.md index 62c95478e623a..920dbf771d4a5 100644 --- a/docs/shared/recipes/storybook/angular-configuring-styles.md +++ b/docs/shared/recipes/storybook/angular-configuring-styles.md @@ -6,7 +6,7 @@ description: This document explains how to configure styles and preprocessor opt # Configuring styles and preprocessor options for Angular projects with a Storybook configuration {% callout type="note" title="Note" %} -This documentation page contains information about the [Storybook plugin](/packages/storybook), specifically regarding [Angular projects that are using Storybook](/recipes/storybook/overview-angular). +This documentation page contains information about the [Storybook plugin](/nx-api/storybook), specifically regarding [Angular projects that are using Storybook](/recipes/storybook/overview-angular). {% /callout %} Angular supports including extra entry-point files for styles. Also, in case you use Sass, you can add extra base paths that will be checked for imports. In your project's `project.json` file you can use the `styles` and `stylePreprocessorOptions` properties in your `storybook` and `build-storybook` target `options`, as you would in your Storybook or your Angular configurations. If your project is an application, you can add these extra options in your `build` target. Your `storybook` and `build-storybook` `browserTarget` are going to be pointing to the `build` target, so they will pick up these styles from there. Check out the [Angular Workspace Configuration](https://angular.io/guide/workspace-config#styles-and-scripts-configuration) documentation for more information. You can also check the [official Storybook for Angular documentation](https://storybook.js.org/docs/angular/configure/styling-and-css) on working with styles and CSS. diff --git a/docs/shared/recipes/storybook/angular-storybook-compodoc.md b/docs/shared/recipes/storybook/angular-storybook-compodoc.md index 081ca8e20e25a..31fb5a34d1ef1 100644 --- a/docs/shared/recipes/storybook/angular-storybook-compodoc.md +++ b/docs/shared/recipes/storybook/angular-storybook-compodoc.md @@ -6,7 +6,7 @@ description: This guide explains how to set up Compodoc for Storybook on Angular # Set up Compodoc for Storybook on Nx {% callout type="note" title="Note" %} -This documentation page contains information about the [Storybook plugin](/packages/storybook), specifically regarding [Angular projects that are using Storybook](/recipes/storybook/overview-angular). +This documentation page contains information about the [Storybook plugin](/nx-api/storybook), specifically regarding [Angular projects that are using Storybook](/recipes/storybook/overview-angular). {% /callout %} {% github-repository url="https://github.com/nrwl/nx-recipes/tree/main/storybook-compodoc-angular" /%} @@ -141,7 +141,7 @@ Let's see the result for our `web` app `storybook` target, for example (in `apps {% callout type="warning" title="Check the version!" %} Make sure you are on Nx version `>=14.1.8` and your `storybook` target is using `@storybook/angular:start-storybook` as the `executor` (like the example above). -If you are using an older version of Nx, you can use [`nx migrate`](/packages/nx/documents/migrate) to migrate your codebase to a later version. Using `nx migrate` will also make sure to update your `storybook` and `build-storybook` targets to match the new format. +If you are using an older version of Nx, you can use [`nx migrate`](/nx-api/nx/documents/migrate) to migrate your codebase to a later version. Using `nx migrate` will also make sure to update your `storybook` and `build-storybook` targets to match the new format. If you **are** on Nx `>=14.1.8` and you are still using the old executor (`@nx/storybook:storybook`), you can read our documentation about the [Angular Storybook targets](/deprecated/storybook/angular-storybook-targets) to help you change your `storybook` and `build-storybook` targets across your workspace for your Angular projects using Storybook. {% /callout %} diff --git a/docs/shared/recipes/storybook/configuring-storybook.md b/docs/shared/recipes/storybook/configuring-storybook.md index fd8f46d587d26..35bef02d97bfe 100644 --- a/docs/shared/recipes/storybook/configuring-storybook.md +++ b/docs/shared/recipes/storybook/configuring-storybook.md @@ -6,7 +6,7 @@ description: This guide explains how Storybook is configured on your Nx workspac # Configuring Storybook on Nx {% callout type="info" title="Best practices" %} -Read our [Using Storybook in a Nx workspace - Best practices](/packages/storybook/documents/best-practices) guide! +Read our [Using Storybook in a Nx workspace - Best practices](/nx-api/storybook/documents/best-practices) guide! {% /callout %} Starting with version 15.7, Nx is no longer generating a root Storybook directory and shared root Storybook configurations. Instead, it is only generating a Storybook configuration for each project in your workspace. You may still manually create a root Storybook configuration file, if it is needed for your use case. @@ -44,6 +44,6 @@ In all the other cases, Nx will not interfere with your Storybook setup. ## Read our guides for Configuring Storybook -You can read all our guides for configuring Storybook in our [Storybook documents page](/packages/storybook/documents). +You can read all our guides for configuring Storybook in our [Storybook documents page](/nx-api/storybook/documents). -Please also make sure to read our [Using Storybook in a Nx workspace - Best practices](/packages/storybook/documents/best-practices) guide, where you can find some best practices for using Storybook in a Nx workspace. +Please also make sure to read our [Using Storybook in a Nx workspace - Best practices](/nx-api/storybook/documents/best-practices) guide, where you can find some best practices for using Storybook in a Nx workspace. diff --git a/docs/shared/recipes/storybook/interaction-tests.md b/docs/shared/recipes/storybook/interaction-tests.md index b09cbe9ea2421..ffdf36717c7cc 100644 --- a/docs/shared/recipes/storybook/interaction-tests.md +++ b/docs/shared/recipes/storybook/interaction-tests.md @@ -15,7 +15,7 @@ You can read more about Storybook interaction tests in the following sections of - [The `play` function](https://storybook.js.org/docs/react/writing-stories/play-function) {% callout type="warning" title="Set up Storybook in your workspace" %} -You first need to set up Storybook for your Nx workspace, if you haven't already. You can read the [Storybook plugin overview guide](/packages/storybook) to get started. +You first need to set up Storybook for your Nx workspace, if you haven't already. You can read the [Storybook plugin overview guide](/nx-api/storybook) to get started. {% /callout %} ## Setup Storybook Interaction Tests @@ -50,7 +50,7 @@ nx g @nx/storybook:configuration project-name --interactionTests=true This command will: -- [Set up Storybook for your project](/packages/storybook) - including the `@storybook/addon-interactions` addon. +- [Set up Storybook for your project](/nx-api/storybook) - including the `@storybook/addon-interactions` addon. - Add a `play` function to your stories. - Install the necessary dependencies. - Generate a `test-storybook` target in your project's `project.json`, which has a command to invoke the Storybook test runner. diff --git a/docs/shared/recipes/storybook/one-storybook-for-all.md b/docs/shared/recipes/storybook/one-storybook-for-all.md index 77e6aeff23339..39af36a494edf 100644 --- a/docs/shared/recipes/storybook/one-storybook-for-all.md +++ b/docs/shared/recipes/storybook/one-storybook-for-all.md @@ -6,7 +6,7 @@ description: Dive into a comprehensive guide on how to consolidate all your Stor # Publishing Storybook: One main Storybook instance for all projects This guide extends the -[Using Storybook in a Nx workspace - Best practices](/packages/storybook/documents/best-practices) guide. In that guide, we discussed the best practices of using Storybook in a Nx workspace. We explained the main concepts and the mental model of how to best set up Storybook. In this guide, we are going to see how to put that into practice, by looking at a real-world example. We are going to see how you can publish one single Storybook for your workspace. +[Using Storybook in a Nx workspace - Best practices](/nx-api/storybook/documents/best-practices) guide. In that guide, we discussed the best practices of using Storybook in a Nx workspace. We explained the main concepts and the mental model of how to best set up Storybook. In this guide, we are going to see how to put that into practice, by looking at a real-world example. We are going to see how you can publish one single Storybook for your workspace. This case would work if all your projects (applications and libraries) containing stories that you want to use are using the same framework (Angular, React, Vue, etc). The reason is that you will be importing the stories in a central host Storybook's `.storybook/main.js`, and we will be using one specific builder to build that Storybook. Storybook does not support mixing frameworks in the same Storybook instance. @@ -32,7 +32,7 @@ Now, you have a new library, which will act as a shell/host for all your stories ### Configure the new library to use Storybook -Now let’s configure our new library to use Storybook, using the [`@nx/storybook:configuration` generator](/packages/storybook/generators/configuration). Run: +Now let’s configure our new library to use Storybook, using the [`@nx/storybook:configuration` generator](/nx-api/storybook/generators/configuration). Run: ```shell nx g @nx/storybook:configuration storybook-host diff --git a/docs/shared/recipes/storybook/one-storybook-per-scope.md b/docs/shared/recipes/storybook/one-storybook-per-scope.md index a67b9a422746b..5bf13b486c44b 100644 --- a/docs/shared/recipes/storybook/one-storybook-per-scope.md +++ b/docs/shared/recipes/storybook/one-storybook-per-scope.md @@ -6,7 +6,7 @@ description: Learn how to set up individual Storybook instances for each scope w # Publishing Storybook: One Storybook instance per scope This guide extends the -[Using Storybook in a Nx workspace - Best practices](/packages/storybook/documents/best-practices) guide. In that guide, we discussed the best practices of using Storybook in a Nx workspace. We explained the main concepts and the mental model of how to best set up Storybook. In this guide, we are going to see how to put that into practice, by looking at a real-world example. We are going to see how you can publish one Storybook per scope (eg. theme, app, framework) for your workspace. +[Using Storybook in a Nx workspace - Best practices](/nx-api/storybook/documents/best-practices) guide. In that guide, we discussed the best practices of using Storybook in a Nx workspace. We explained the main concepts and the mental model of how to best set up Storybook. In this guide, we are going to see how to put that into practice, by looking at a real-world example. We are going to see how you can publish one Storybook per scope (eg. theme, app, framework) for your workspace. Sometimes, you have multiple apps and libraries, and each of these is associated with a specific scope. You can read more about grouping libraries and scoping them in the [Library Types](/concepts/more-concepts/library-types) documentation page, and also in the [Code Organization and Naming Conventions](/concepts/more-concepts/monorepo-nx-enterprise#code-organization-&-naming-conventions) documentation section. diff --git a/docs/shared/recipes/storybook/one-storybook-with-composition.md b/docs/shared/recipes/storybook/one-storybook-with-composition.md index aa3279fd667fe..0b9e2e7184c68 100644 --- a/docs/shared/recipes/storybook/one-storybook-with-composition.md +++ b/docs/shared/recipes/storybook/one-storybook-with-composition.md @@ -6,7 +6,7 @@ description: Dive into the comprehensive guide on publishing a unified Storybook # Publishing Storybook: One main Storybook instance using Storybook Composition This guide extends the -[Using Storybook in a Nx workspace - Best practices](/packages/storybook/documents/best-practices) guide. In that guide, we discussed the best practices of using Storybook in a Nx workspace. We explained the main concepts and the mental model of how to best set up Storybook. In this guide, we are going to see how to put that into practice, by looking at a real-world example. We are going to see how you can publish one single Storybook for your workspace, even you are using multiple frameworks, taking advantage of [Storybook Composition](/recipes/storybook/storybook-composition-setup). +[Using Storybook in a Nx workspace - Best practices](/nx-api/storybook/documents/best-practices) guide. In that guide, we discussed the best practices of using Storybook in a Nx workspace. We explained the main concepts and the mental model of how to best set up Storybook. In this guide, we are going to see how to put that into practice, by looking at a real-world example. We are going to see how you can publish one single Storybook for your workspace, even you are using multiple frameworks, taking advantage of [Storybook Composition](/recipes/storybook/storybook-composition-setup). In this case, we are dealing with a Nx workspace that uses multiple frameworks. Essentially, you would need to have one Storybook host for each of the frameworks, containing all the stories of that specific framework, since the Storybook builder can not handle multiple frameworks simultaneously. diff --git a/docs/shared/recipes/storybook/plugin-angular.md b/docs/shared/recipes/storybook/plugin-angular.md index 6216e3f8141a2..40ebc46ba2a65 100644 --- a/docs/shared/recipes/storybook/plugin-angular.md +++ b/docs/shared/recipes/storybook/plugin-angular.md @@ -8,12 +8,12 @@ description: This guide explains how to set up Storybook for Angular projects in This guide will walk you through setting up [Storybook](https://storybook.js.org) for Angular projects in your Nx workspace. {% callout type="warning" title="Set up Storybook in your workspace" %} -You first need to set up Storybook for your Nx workspace, if you haven't already. You can read the [Storybook plugin overview guide](/packages/storybook) to get started. +You first need to set up Storybook for your Nx workspace, if you haven't already. You can read the [Storybook plugin overview guide](/nx-api/storybook) to get started. {% /callout %} ## Generate Storybook Configuration for an Angular project -You can generate Storybook configuration for an individual Angular project by using the [`@nx/angular:storybook-configuration` generator](/packages/angular/generators/storybook-configuration), like this: +You can generate Storybook configuration for an individual Angular project by using the [`@nx/angular:storybook-configuration` generator](/nx-api/angular/generators/storybook-configuration), like this: ```shell nx g @nx/angular:storybook-configuration project-name @@ -21,7 +21,7 @@ nx g @nx/angular:storybook-configuration project-name ## Auto-generate Stories -The [`@nx/angular:storybook-configuration` generator](/packages/angular/generators/storybook-configuration) has the option to automatically generate `*.stories.ts` files for each component declared in the library. The stories will be generated using [Component Story Format 3 (CSF3)](https://storybook.js.org/blog/storybook-csf3-is-here/). +The [`@nx/angular:storybook-configuration` generator](/nx-api/angular/generators/storybook-configuration) has the option to automatically generate `*.stories.ts` files for each component declared in the library. The stories will be generated using [Component Story Format 3 (CSF3)](https://storybook.js.org/blog/storybook-csf3-is-here/). ```text / @@ -29,7 +29,7 @@ The [`@nx/angular:storybook-configuration` generator](/packages/angular/generato └── my.component.stories.ts ``` -If you add more components to your project, and want to generate stories for all your (new) components at any point, you can use the [`@nx/angular:stories` generator](/packages/angular/generators/stories): +If you add more components to your project, and want to generate stories for all your (new) components at any point, you can use the [`@nx/angular:stories` generator](/nx-api/angular/generators/stories): ```shell nx g @nx/angular:stories --project= @@ -75,7 +75,7 @@ and the result would be the following: ## Cypress tests for Stories -The [`@nx/angular:storybook-configuration` generator](/packages/angular/generators/storybook-configuration) gives the option to set up an e2e Cypress app that is configured to run against the project's Storybook instance. +The [`@nx/angular:storybook-configuration` generator](/nx-api/angular/generators/storybook-configuration) gives the option to set up an e2e Cypress app that is configured to run against the project's Storybook instance. To launch Storybook and run the Cypress tests against the iframe inside of Storybook: @@ -99,7 +99,7 @@ Let's take for a example a library in your workspace, under `libs/feature/ui`, c ### Story file -The [`@nx/angular:storybook-configuration` generator](/packages/angular/generators/storybook-configuration) would generate a Story file that looks like this: +The [`@nx/angular:storybook-configuration` generator](/nx-api/angular/generators/storybook-configuration) would generate a Story file that looks like this: ```typescript {% fileName="libs/feature/ui/src/lib/my-button/my-button.component.stories.ts" %} import { Meta } from '@storybook/angular'; @@ -149,7 +149,7 @@ Depending on your Cypress version, the file will end with `.spec.ts` or `.cy.ts` - [Configuring styles and preprocessor options](/recipes/storybook/angular-configuring-styles) - [The `browserTarget`](/deprecated/storybook/angular-browser-target) -You can find all Storybook-related Nx topics [here](/packages#storybook). +You can find all Storybook-related Nx topics [here](/nx-api#storybook). For more on using Storybook, see the [official Storybook documentation](https://storybook.js.org/docs/angular/get-started/introduction). @@ -157,8 +157,8 @@ For more on using Storybook, see the [official Storybook documentation](https:// Here's more information on common migration scenarios for Storybook with Nx. For Storybook specific migrations that are not automatically handled by Nx please refer to the [official Storybook page](https://storybook.js.org/) -- [Set up Storybook version 7](/packages/storybook/documents/storybook-7-setup) -- [Migrate to Storybook version 7](/packages/storybook/generators/migrate-7) +- [Set up Storybook version 7](/nx-api/storybook/documents/storybook-7-setup) +- [Migrate to Storybook version 7](/nx-api/storybook/generators/migrate-7) #### Older migration scenarios diff --git a/docs/shared/recipes/storybook/plugin-react.md b/docs/shared/recipes/storybook/plugin-react.md index 523bd77de827f..d468ca14f2564 100644 --- a/docs/shared/recipes/storybook/plugin-react.md +++ b/docs/shared/recipes/storybook/plugin-react.md @@ -8,12 +8,12 @@ description: This guide explains how to set up Storybook for React projects in y This guide will walk you through setting up [Storybook](https://storybook.js.org) for React projects in your Nx workspace. {% callout type="warning" title="Set up Storybook in your workspace" %} -You first need to set up Storybook for your Nx workspace, if you haven't already. You can read the [Storybook plugin overview guide](/packages/storybook) to get started. +You first need to set up Storybook for your Nx workspace, if you haven't already. You can read the [Storybook plugin overview guide](/nx-api/storybook) to get started. {% /callout %} ## Generate Storybook Configuration for a React project -You can generate Storybook configuration for an individual React project by using the [`@nx/react:storybook-configuration` generator](/packages/react/generators/storybook-configuration), like this: +You can generate Storybook configuration for an individual React project by using the [`@nx/react:storybook-configuration` generator](/nx-api/react/generators/storybook-configuration), like this: ```shell nx g @nx/react:storybook-configuration project-name @@ -21,7 +21,7 @@ nx g @nx/react:storybook-configuration project-name ## Nx React Storybook Preset -The [`@nx/react`](/packages/react) package ships with a Storybook addon to make sure it uses the very same configuration as your Nx React application. When you generate a Storybook configuration for a project, it'll automatically add the addon to your configuration. +The [`@nx/react`](/nx-api/react) package ships with a Storybook addon to make sure it uses the very same configuration as your Nx React application. When you generate a Storybook configuration for a project, it'll automatically add the addon to your configuration. ```typescript module.exports = { @@ -33,7 +33,7 @@ module.exports = { ## Auto-generate Stories -The [`@nx/react:storybook-configuration` generator](/packages/react/generators/storybook-configuration) has the option to automatically generate `*.stories.ts|tsx` files for each component declared in the library. The stories will be generated using [Component Story Format 3 (CSF3)](https://storybook.js.org/blog/storybook-csf3-is-here/). +The [`@nx/react:storybook-configuration` generator](/nx-api/react/generators/storybook-configuration) has the option to automatically generate `*.stories.ts|tsx` files for each component declared in the library. The stories will be generated using [Component Story Format 3 (CSF3)](https://storybook.js.org/blog/storybook-csf3-is-here/). ```text / @@ -41,7 +41,7 @@ The [`@nx/react:storybook-configuration` generator](/packages/react/generators/s └── my-component.stories.tsx ``` -If you add more components to your project, and want to generate stories for all your (new) components at any point, you can use the [`@nx/react:stories` generator](/packages/react/generators/stories): +If you add more components to your project, and want to generate stories for all your (new) components at any point, you can use the [`@nx/react:stories` generator](/nx-api/react/generators/stories): ```shell nx g @nx/react:stories --project= @@ -87,7 +87,7 @@ and the result would be the following: ## Cypress tests for Stories -The [`@nx/react:storybook-configuration` generator](/packages/react/generators/storybook-configuration) gives the option to set up an e2e Cypress app that is configured to run against the project's Storybook instance. +The [`@nx/react:storybook-configuration` generator](/nx-api/react/generators/storybook-configuration) gives the option to set up an e2e Cypress app that is configured to run against the project's Storybook instance. To launch Storybook and run the Cypress tests against the iframe inside of Storybook: @@ -111,7 +111,7 @@ Let's take for a example a library in your workspace, under `libs/feature/ui`, c ### Story file -The [`@nx/react:storybook-configuration` generator](/packages/react/generators/storybook-configuration) would generate a Story file that looks like this: +The [`@nx/react:storybook-configuration` generator](/nx-api/react/generators/storybook-configuration) would generate a Story file that looks like this: ```typescript {% fileName="libs/feature/ui/src/lib/my-button/my-button.stories.tsx" %} import type { Meta } from '@storybook/react'; @@ -154,7 +154,7 @@ Depending on your Cypress version, the file will end with `.spec.ts` or `.cy.ts` ## More Documentation -You can find all Storybook-related Nx topics [here](/packages#storybook). +You can find all Storybook-related Nx topics [here](/nx-api#storybook). For more on using Storybook, see the [official Storybook documentation](https://storybook.js.org/docs/react/get-started/introduction). @@ -162,8 +162,8 @@ For more on using Storybook, see the [official Storybook documentation](https:// Here's more information on common migration scenarios for Storybook with Nx. For Storybook specific migrations that are not automatically handled by Nx please refer to the [official Storybook page](https://storybook.js.org/) -- [Set up Storybook version 7](/packages/storybook/documents/storybook-7-setup) -- [Migrate to Storybook version 7](/packages/storybook/generators/migrate-7) +- [Set up Storybook version 7](/nx-api/storybook/documents/storybook-7-setup) +- [Migrate to Storybook version 7](/nx-api/storybook/generators/migrate-7) #### Older migration scenarios diff --git a/docs/shared/recipes/storybook/storybook-composition-setup.md b/docs/shared/recipes/storybook/storybook-composition-setup.md index 747ba8ee0dbe3..efe72f73584eb 100644 --- a/docs/shared/recipes/storybook/storybook-composition-setup.md +++ b/docs/shared/recipes/storybook/storybook-composition-setup.md @@ -49,7 +49,7 @@ You can always read more in the [official Storybook docs](https://storybook.js.o It's quite easy to use this feature, in Nx and in general, since you do not need to make any code changes, you just need to have the "composed" Storybook instances (the ones you need to "compose") running, choose a "host" Storybook, and just add the composed Storybooks in it's `.storybook/main.js` file. -Nx provides the [`run-many`](/packages/nx/documents/run-many) command, which will allow you to easily run multiple Storybooks at the same time. You need to run the `run-many` command with the parallel flag (eg. `--parallel=3`), because you want to run all your Storybooks in parallel. You can change the value of the `parallel` flag to be of as many Storybooks you want to run in parallel as you need. However, be **very carefull** with putting large numbers in this +Nx provides the [`run-many`](/nx-api/nx/documents/run-many) command, which will allow you to easily run multiple Storybooks at the same time. You need to run the `run-many` command with the parallel flag (eg. `--parallel=3`), because you want to run all your Storybooks in parallel. You can change the value of the `parallel` flag to be of as many Storybooks you want to run in parallel as you need. However, be **very carefull** with putting large numbers in this flag, since it can cause big delays or get stuck. You can play around and adjust that number to one your machine runs comfortably with. Keep in mind that you can add in this feature however many live/public Storybooks as you need (Storybooks that you do not run locally). In order to get it working for you, you need to two things: @@ -128,7 +128,7 @@ module.exports = { ### Optional: use `run-commands` and create a `storybook-composition` target -If you want to take advantage of the [`run-commands`](https://nx.dev/packages/nx/executors/run-commands) functionality of Nx, you can create a custom target that will invoke the `run-parallel` command for your "composed" Storybook instances. +If you want to take advantage of the [`run-commands`](https://nx.dev/api/nx/executors/run-commands) functionality of Nx, you can create a custom target that will invoke the `run-parallel` command for your "composed" Storybook instances. The objective is to end up with a new target in your `main-host`'s `project.json` file (`apps/main-host/project.json`) that looks like this: diff --git a/docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md b/docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md index 3df3000e99b37..641f4332a187a 100644 --- a/docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md +++ b/docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md @@ -156,7 +156,7 @@ module.exports = { For additional details, head over to [ESLint's official blog post](https://eslint.org/blog/2022/08/new-config-system-part-2/). -Since version 16.8.0, Nx supports the usage of flat config in the [@nx/linter:eslint](/packages/linter/executors/eslint) executor and `@nx/*` generators, and provides an automated config conversion from `.eslintrc.json` config files. +Since version 16.8.0, Nx supports the usage of flat config in the [@nx/linter:eslint](/nx-api/linter/executors/eslint) executor and `@nx/*` generators, and provides an automated config conversion from `.eslintrc.json` config files. ## Converting workspace from .eslintrc.json to flat config diff --git a/docs/shared/reference/nx-json.md b/docs/shared/reference/nx-json.md index c0356b043732f..8151b4bbbec51 100644 --- a/docs/shared/reference/nx-json.md +++ b/docs/shared/reference/nx-json.md @@ -102,7 +102,7 @@ This makes app or lib generators behave in the following way: - `nx g app my-app --directory=nested` creates a new application named `nested-my-app` in the `/demos/nested/my-app` folder - `nx g lib my-lib --directory=shared/ui` creates a new library named `shared-ui-my-lib` in the `/packages/shared/ui/my-lib` folder -If you accidentally generate a project in the wrong folder, use the [move generator](/packages/workspace/generators/move) to move it to the correct location. +If you accidentally generate a project in the wrong folder, use the [move generator](/nx-api/workspace/generators/move) to move it to the correct location. ### inputs & namedInputs diff --git a/docs/shared/reference/sitemap.md b/docs/shared/reference/sitemap.md index 102ae09768f0a..ef4c3026bd68d 100644 --- a/docs/shared/reference/sitemap.md +++ b/docs/shared/reference/sitemap.md @@ -241,7 +241,6 @@ - [Intro](/extending-nx/intro) - [Getting Started with Plugins](/extending-nx/intro/getting-started) - - [Plugin Registry](/extending-nx/registry) - [5 Min Tutorials](/extending-nx/tutorials) - [Create a Local Plugin](/extending-nx/tutorials/create-plugin) - [Maintain a Published Plugin](/extending-nx/tutorials/publish-plugin) @@ -290,362 +289,362 @@ - [Server API Reference](/nx-cloud/reference/server-api) - [Release Notes](/nx-cloud/reference/release-notes) -- Packages - - [angular](/packages/angular) - - [documents](/packages/angular/documents) - - [Overview](/packages/angular/documents/overview) - - [Angular and Nx Version Matrix](/packages/angular/documents/angular-nx-version-matrix) - - [executors](/packages/angular/executors) - - [delegate-build](/packages/angular/executors/delegate-build) - - [ng-packagr-lite](/packages/angular/executors/ng-packagr-lite) - - [package](/packages/angular/executors/package) - - [browser-esbuild](/packages/angular/executors/browser-esbuild) - - [webpack-browser](/packages/angular/executors/webpack-browser) - - [webpack-dev-server](/packages/angular/executors/webpack-dev-server) - - [webpack-server](/packages/angular/executors/webpack-server) - - [module-federation-dev-server](/packages/angular/executors/module-federation-dev-server) - - [module-federation-dev-ssr](/packages/angular/executors/module-federation-dev-ssr) - - [generators](/packages/angular/generators) - - [add-linting](/packages/angular/generators/add-linting) - - [application](/packages/angular/generators/application) - - [component](/packages/angular/generators/component) - - [component-cypress-spec](/packages/angular/generators/component-cypress-spec) - - [component-story](/packages/angular/generators/component-story) - - [component-test](/packages/angular/generators/component-test) - - [convert-tslint-to-eslint](/packages/angular/generators/convert-tslint-to-eslint) - - [directive](/packages/angular/generators/directive) - - [init](/packages/angular/generators/init) - - [library](/packages/angular/generators/library) - - [library-secondary-entry-point](/packages/angular/generators/library-secondary-entry-point) - - [remote](/packages/angular/generators/remote) - - [move](/packages/angular/generators/move) - - [convert-to-with-mf](/packages/angular/generators/convert-to-with-mf) - - [host](/packages/angular/generators/host) - - [ng-add](/packages/angular/generators/ng-add) - - [ngrx](/packages/angular/generators/ngrx) - - [ngrx-feature-store](/packages/angular/generators/ngrx-feature-store) - - [ngrx-root-store](/packages/angular/generators/ngrx-root-store) - - [pipe](/packages/angular/generators/pipe) - - [scam-to-standalone](/packages/angular/generators/scam-to-standalone) - - [scam](/packages/angular/generators/scam) - - [scam-directive](/packages/angular/generators/scam-directive) - - [scam-pipe](/packages/angular/generators/scam-pipe) - - [setup-mf](/packages/angular/generators/setup-mf) - - [setup-ssr](/packages/angular/generators/setup-ssr) - - [setup-tailwind](/packages/angular/generators/setup-tailwind) - - [stories](/packages/angular/generators/stories) - - [storybook-configuration](/packages/angular/generators/storybook-configuration) - - [cypress-component-configuration](/packages/angular/generators/cypress-component-configuration) - - [web-worker](/packages/angular/generators/web-worker) - - [create-nx-plugin](/packages/create-nx-plugin) - - [create-nx-workspace](/packages/create-nx-workspace) - - [cypress](/packages/cypress) - - [documents](/packages/cypress/documents) - - [Overview](/packages/cypress/documents/overview) - - [executors](/packages/cypress/executors) - - [cypress](/packages/cypress/executors/cypress) - - [generators](/packages/cypress/generators) - - [init](/packages/cypress/generators/init) - - [cypress-project](/packages/cypress/generators/cypress-project) - - [configuration](/packages/cypress/generators/configuration) - - [component-configuration](/packages/cypress/generators/component-configuration) - - [migrate-to-cypress-11](/packages/cypress/generators/migrate-to-cypress-11) - - [detox](/packages/detox) - - [documents](/packages/detox/documents) - - [Overview](/packages/detox/documents/overview) - - [executors](/packages/detox/executors) - - [build](/packages/detox/executors/build) - - [test](/packages/detox/executors/test) - - [generators](/packages/detox/generators) - - [init](/packages/detox/generators/init) - - [application](/packages/detox/generators/application) - - [devkit](/packages/devkit) - - [documents](/packages/devkit/documents) - - [Overview](/packages/devkit/documents/nx_devkit) - - [Ng CLI Adapter](/packages/devkit/documents/ngcli_adapter) - - [esbuild](/packages/esbuild) - - [documents](/packages/esbuild/documents) - - [Overview](/packages/esbuild/documents/overview) - - [executors](/packages/esbuild/executors) - - [esbuild](/packages/esbuild/executors/esbuild) - - [generators](/packages/esbuild/generators) - - [init](/packages/esbuild/generators/init) - - [configuration](/packages/esbuild/generators/configuration) - - [eslint-plugin](/packages/eslint-plugin) - - [documents](/packages/eslint-plugin/documents) - - [Overview](/packages/eslint-plugin/documents/overview) - - [The `enforce-module-boundaries` rule](/packages/eslint-plugin/documents/enforce-module-boundaries) - - [The `dependency-checks` rule](/packages/eslint-plugin/documents/dependency-checks) - - [expo](/packages/expo) - - [documents](/packages/expo/documents) - - [Overview](/packages/expo/documents/overview) - - [executors](/packages/expo/executors) - - [update](/packages/expo/executors/update) - - [build](/packages/expo/executors/build) - - [build-list](/packages/expo/executors/build-list) - - [download](/packages/expo/executors/download) - - [run](/packages/expo/executors/run) - - [start](/packages/expo/executors/start) - - [sync-deps](/packages/expo/executors/sync-deps) - - [ensure-symlink](/packages/expo/executors/ensure-symlink) - - [prebuild](/packages/expo/executors/prebuild) - - [install](/packages/expo/executors/install) - - [export](/packages/expo/executors/export) - - [submit](/packages/expo/executors/submit) - - [generators](/packages/expo/generators) - - [init](/packages/expo/generators/init) - - [application](/packages/expo/generators/application) - - [library](/packages/expo/generators/library) - - [component](/packages/expo/generators/component) - - [express](/packages/express) - - [documents](/packages/express/documents) - - [Overview](/packages/express/documents/overview) - - [generators](/packages/express/generators) - - [init](/packages/express/generators/init) - - [application](/packages/express/generators/application) - - [jest](/packages/jest) - - [documents](/packages/jest/documents) - - [Overview](/packages/jest/documents/overview) - - [executors](/packages/jest/executors) - - [jest](/packages/jest/executors/jest) - - [generators](/packages/jest/generators) - - [init](/packages/jest/generators/init) - - [configuration](/packages/jest/generators/configuration) - - [js](/packages/js) - - [documents](/packages/js/documents) - - [Overview](/packages/js/documents/overview) - - [executors](/packages/js/executors) - - [tsc](/packages/js/executors/tsc) - - [swc](/packages/js/executors/swc) - - [node](/packages/js/executors/node) - - [release-publish](/packages/js/executors/release-publish) - - [verdaccio](/packages/js/executors/verdaccio) - - [generators](/packages/js/generators) - - [library](/packages/js/generators/library) - - [init](/packages/js/generators/init) - - [convert-to-swc](/packages/js/generators/convert-to-swc) - - [release-version](/packages/js/generators/release-version) - - [setup-verdaccio](/packages/js/generators/setup-verdaccio) - - [setup-build](/packages/js/generators/setup-build) - - [linter](/packages/linter) - - [documents](/packages/linter/documents) - - [Overview](/packages/linter/documents/overview) - - [executors](/packages/linter/executors) - - [eslint](/packages/linter/executors/eslint) - - [generators](/packages/linter/generators) - - [workspace-rules-project](/packages/linter/generators/workspace-rules-project) - - [workspace-rule](/packages/linter/generators/workspace-rule) - - [convert-to-flat-config](/packages/linter/generators/convert-to-flat-config) - - [nest](/packages/nest) - - [documents](/packages/nest/documents) - - [Overview](/packages/nest/documents/overview) - - [generators](/packages/nest/generators) - - [application](/packages/nest/generators/application) - - [convert-tslint-to-eslint](/packages/nest/generators/convert-tslint-to-eslint) - - [init](/packages/nest/generators/init) - - [library](/packages/nest/generators/library) - - [class](/packages/nest/generators/class) - - [controller](/packages/nest/generators/controller) - - [decorator](/packages/nest/generators/decorator) - - [filter](/packages/nest/generators/filter) - - [gateway](/packages/nest/generators/gateway) - - [guard](/packages/nest/generators/guard) - - [interceptor](/packages/nest/generators/interceptor) - - [interface](/packages/nest/generators/interface) - - [middleware](/packages/nest/generators/middleware) - - [module](/packages/nest/generators/module) - - [pipe](/packages/nest/generators/pipe) - - [provider](/packages/nest/generators/provider) - - [resolver](/packages/nest/generators/resolver) - - [resource](/packages/nest/generators/resource) - - [service](/packages/nest/generators/service) - - [next](/packages/next) - - [documents](/packages/next/documents) - - [Overview](/packages/next/documents/overview) - - [executors](/packages/next/executors) - - [build](/packages/next/executors/build) - - [server](/packages/next/executors/server) - - [export](/packages/next/executors/export) - - [generators](/packages/next/generators) - - [init](/packages/next/generators/init) - - [application](/packages/next/generators/application) - - [page](/packages/next/generators/page) - - [component](/packages/next/generators/component) - - [library](/packages/next/generators/library) - - [custom-server](/packages/next/generators/custom-server) - - [cypress-component-configuration](/packages/next/generators/cypress-component-configuration) - - [node](/packages/node) - - [documents](/packages/node/documents) - - [Overview](/packages/node/documents/overview) - - [generators](/packages/node/generators) - - [init](/packages/node/generators/init) - - [application](/packages/node/generators/application) - - [library](/packages/node/generators/library) - - [setup-docker](/packages/node/generators/setup-docker) - - [nx](/packages/nx) - - [documents](/packages/nx/documents) - - [create-nx-workspace](/packages/nx/documents/create-nx-workspace) - - [init](/packages/nx/documents/init) - - [generate](/packages/nx/documents/generate) - - [run](/packages/nx/documents/run) - - [daemon](/packages/nx/documents/daemon) - - [graph](/packages/nx/documents/dep-graph) - - [run-many](/packages/nx/documents/run-many) - - [affected](/packages/nx/documents/affected) - - [affected:graph](/packages/nx/documents/affected-dep-graph) - - [print-affected](/packages/nx/documents/print-affected) - - [format:check](/packages/nx/documents/format-check) - - [format:write](/packages/nx/documents/format-write) - - [migrate](/packages/nx/documents/migrate) - - [report](/packages/nx/documents/report) - - [list](/packages/nx/documents/list) - - [workspace-lint](/packages/nx/documents/workspace-lint) - - [workspace-generator](/packages/nx/documents/workspace-generator) - - [connect-to-nx-cloud](/packages/nx/documents/connect-to-nx-cloud) - - [reset](/packages/nx/documents/reset) - - [repair](/packages/nx/documents/repair) - - [exec](/packages/nx/documents/exec) - - [watch](/packages/nx/documents/watch) - - [show](/packages/nx/documents/show) - - [view-logs](/packages/nx/documents/view-logs) - - [release](/packages/nx/documents/release) - - [executors](/packages/nx/executors) - - [noop](/packages/nx/executors/noop) - - [run-commands](/packages/nx/executors/run-commands) - - [run-script](/packages/nx/executors/run-script) - - [playwright](/packages/playwright) - - [documents](/packages/playwright/documents) - - [Overview](/packages/playwright/documents/overview) - - [executors](/packages/playwright/executors) - - [playwright](/packages/playwright/executors/playwright) - - [generators](/packages/playwright/generators) - - [configuration](/packages/playwright/generators/configuration) - - [init](/packages/playwright/generators/init) - - [plugin](/packages/plugin) - - [documents](/packages/plugin/documents) - - [Overview](/packages/plugin/documents/overview) - - [executors](/packages/plugin/executors) - - [e2e](/packages/plugin/executors/e2e) - - [generators](/packages/plugin/generators) - - [plugin](/packages/plugin/generators/plugin) - - [create-package](/packages/plugin/generators/create-package) - - [e2e-project](/packages/plugin/generators/e2e-project) - - [migration](/packages/plugin/generators/migration) - - [generator](/packages/plugin/generators/generator) - - [executor](/packages/plugin/generators/executor) - - [plugin-lint-checks](/packages/plugin/generators/plugin-lint-checks) - - [preset](/packages/plugin/generators/preset) - - [react](/packages/react) - - [documents](/packages/react/documents) - - [Overview](/packages/react/documents/overview) - - [executors](/packages/react/executors) - - [module-federation-dev-server](/packages/react/executors/module-federation-dev-server) - - [module-federation-ssr-dev-server](/packages/react/executors/module-federation-ssr-dev-server) - - [generators](/packages/react/generators) - - [init](/packages/react/generators/init) - - [application](/packages/react/generators/application) - - [library](/packages/react/generators/library) - - [component](/packages/react/generators/component) - - [redux](/packages/react/generators/redux) - - [storybook-configuration](/packages/react/generators/storybook-configuration) - - [component-story](/packages/react/generators/component-story) - - [stories](/packages/react/generators/stories) - - [component-cypress-spec](/packages/react/generators/component-cypress-spec) - - [hook](/packages/react/generators/hook) - - [host](/packages/react/generators/host) - - [remote](/packages/react/generators/remote) - - [cypress-component-configuration](/packages/react/generators/cypress-component-configuration) - - [component-test](/packages/react/generators/component-test) - - [setup-tailwind](/packages/react/generators/setup-tailwind) - - [setup-ssr](/packages/react/generators/setup-ssr) - - [react-native](/packages/react-native) - - [documents](/packages/react-native/documents) - - [Overview](/packages/react-native/documents/overview) - - [executors](/packages/react-native/executors) - - [run-android](/packages/react-native/executors/run-android) - - [run-ios](/packages/react-native/executors/run-ios) - - [bundle](/packages/react-native/executors/bundle) - - [build-android](/packages/react-native/executors/build-android) - - [build-ios](/packages/react-native/executors/build-ios) - - [start](/packages/react-native/executors/start) - - [sync-deps](/packages/react-native/executors/sync-deps) - - [ensure-symlink](/packages/react-native/executors/ensure-symlink) - - [storybook](/packages/react-native/executors/storybook) - - [pod-install](/packages/react-native/executors/pod-install) - - [generators](/packages/react-native/generators) - - [init](/packages/react-native/generators/init) - - [application](/packages/react-native/generators/application) - - [library](/packages/react-native/generators/library) - - [component](/packages/react-native/generators/component) - - [storybook-configuration](/packages/react-native/generators/storybook-configuration) - - [component-story](/packages/react-native/generators/component-story) - - [stories](/packages/react-native/generators/stories) - - [upgrade-native](/packages/react-native/generators/upgrade-native) - - [rollup](/packages/rollup) - - [executors](/packages/rollup/executors) - - [rollup](/packages/rollup/executors/rollup) - - [generators](/packages/rollup/generators) - - [init](/packages/rollup/generators/init) - - [configuration](/packages/rollup/generators/configuration) - - [storybook](/packages/storybook) - - [documents](/packages/storybook/documents) - - [Nx Storybook Plugin Overview](/packages/storybook/documents/overview) - - [Storybook best practices for making the most out of Nx](/packages/storybook/documents/best-practices) - - [Storybook 7 overview](/packages/storybook/documents/storybook-7-setup) - - [executors](/packages/storybook/executors) - - [storybook](/packages/storybook/executors/storybook) - - [build](/packages/storybook/executors/build) - - [generators](/packages/storybook/generators) - - [init](/packages/storybook/generators/init) - - [configuration](/packages/storybook/generators/configuration) - - [cypress-project](/packages/storybook/generators/cypress-project) - - [migrate-7](/packages/storybook/generators/migrate-7) - - [tao](/packages/tao) - - [vite](/packages/vite) - - [documents](/packages/vite/documents) - - [Overview of the Nx Vite Plugin](/packages/vite/documents/overview) - - [executors](/packages/vite/executors) - - [dev-server](/packages/vite/executors/dev-server) - - [build](/packages/vite/executors/build) - - [test](/packages/vite/executors/test) - - [preview-server](/packages/vite/executors/preview-server) - - [generators](/packages/vite/generators) - - [init](/packages/vite/generators/init) - - [configuration](/packages/vite/generators/configuration) - - [vitest](/packages/vite/generators/vitest) - - [web](/packages/web) - - [documents](/packages/web/documents) - - [Overview](/packages/web/documents/overview) - - [executors](/packages/web/executors) - - [file-server](/packages/web/executors/file-server) - - [generators](/packages/web/generators) - - [init](/packages/web/generators/init) - - [application](/packages/web/generators/application) - - [static-config](/packages/web/generators/static-config) - - [webpack](/packages/webpack) - - [documents](/packages/webpack/documents) - - [Overview of the Nx Webpack Plugin](/packages/webpack/documents/overview) - - [executors](/packages/webpack/executors) - - [webpack](/packages/webpack/executors/webpack) - - [dev-server](/packages/webpack/executors/dev-server) - - [ssr-dev-server](/packages/webpack/executors/ssr-dev-server) - - [generators](/packages/webpack/generators) - - [init](/packages/webpack/generators/init) - - [configuration](/packages/webpack/generators/configuration) - - [workspace](/packages/workspace) - - [documents](/packages/workspace/documents) - - [Overview](/packages/workspace/documents/overview) - - [Nx, NodeJS and Typescript Versions](/packages/workspace/documents/nx-nodejs-typescript-version-matrix) - - [executors](/packages/workspace/executors) - - [counter](/packages/workspace/executors/counter) - - [generators](/packages/workspace/generators) - - [preset](/packages/workspace/generators/preset) - - [move](/packages/workspace/generators/move) - - [remove](/packages/workspace/generators/remove) - - [convert-to-monorepo](/packages/workspace/generators/convert-to-monorepo) - - [new](/packages/workspace/generators/new) - - [workspace-generator](/packages/workspace/generators/workspace-generator) - - [run-commands](/packages/workspace/generators/run-commands) - - [fix-configuration](/packages/workspace/generators/fix-configuration) - - [npm-package](/packages/workspace/generators/npm-package) - - [ci-workflow](/packages/workspace/generators/ci-workflow) +- Nx-api + - [angular](/nx-api/angular) + - [documents](/nx-api/angular/documents) + - [Overview](/nx-api/angular/documents/overview) + - [Angular and Nx Version Matrix](/nx-api/angular/documents/angular-nx-version-matrix) + - [executors](/nx-api/angular/executors) + - [delegate-build](/nx-api/angular/executors/delegate-build) + - [ng-packagr-lite](/nx-api/angular/executors/ng-packagr-lite) + - [package](/nx-api/angular/executors/package) + - [browser-esbuild](/nx-api/angular/executors/browser-esbuild) + - [webpack-browser](/nx-api/angular/executors/webpack-browser) + - [webpack-dev-server](/nx-api/angular/executors/webpack-dev-server) + - [webpack-server](/nx-api/angular/executors/webpack-server) + - [module-federation-dev-server](/nx-api/angular/executors/module-federation-dev-server) + - [module-federation-dev-ssr](/nx-api/angular/executors/module-federation-dev-ssr) + - [generators](/nx-api/angular/generators) + - [add-linting](/nx-api/angular/generators/add-linting) + - [application](/nx-api/angular/generators/application) + - [component](/nx-api/angular/generators/component) + - [component-cypress-spec](/nx-api/angular/generators/component-cypress-spec) + - [component-story](/nx-api/angular/generators/component-story) + - [component-test](/nx-api/angular/generators/component-test) + - [convert-tslint-to-eslint](/nx-api/angular/generators/convert-tslint-to-eslint) + - [directive](/nx-api/angular/generators/directive) + - [init](/nx-api/angular/generators/init) + - [library](/nx-api/angular/generators/library) + - [library-secondary-entry-point](/nx-api/angular/generators/library-secondary-entry-point) + - [remote](/nx-api/angular/generators/remote) + - [move](/nx-api/angular/generators/move) + - [convert-to-with-mf](/nx-api/angular/generators/convert-to-with-mf) + - [host](/nx-api/angular/generators/host) + - [ng-add](/nx-api/angular/generators/ng-add) + - [ngrx](/nx-api/angular/generators/ngrx) + - [ngrx-feature-store](/nx-api/angular/generators/ngrx-feature-store) + - [ngrx-root-store](/nx-api/angular/generators/ngrx-root-store) + - [pipe](/nx-api/angular/generators/pipe) + - [scam-to-standalone](/nx-api/angular/generators/scam-to-standalone) + - [scam](/nx-api/angular/generators/scam) + - [scam-directive](/nx-api/angular/generators/scam-directive) + - [scam-pipe](/nx-api/angular/generators/scam-pipe) + - [setup-mf](/nx-api/angular/generators/setup-mf) + - [setup-ssr](/nx-api/angular/generators/setup-ssr) + - [setup-tailwind](/nx-api/angular/generators/setup-tailwind) + - [stories](/nx-api/angular/generators/stories) + - [storybook-configuration](/nx-api/angular/generators/storybook-configuration) + - [cypress-component-configuration](/nx-api/angular/generators/cypress-component-configuration) + - [web-worker](/nx-api/angular/generators/web-worker) + - [create-nx-plugin](/nx-api/create-nx-plugin) + - [create-nx-workspace](/nx-api/create-nx-workspace) + - [cypress](/nx-api/cypress) + - [documents](/nx-api/cypress/documents) + - [Overview](/nx-api/cypress/documents/overview) + - [executors](/nx-api/cypress/executors) + - [cypress](/nx-api/cypress/executors/cypress) + - [generators](/nx-api/cypress/generators) + - [init](/nx-api/cypress/generators/init) + - [cypress-project](/nx-api/cypress/generators/cypress-project) + - [configuration](/nx-api/cypress/generators/configuration) + - [component-configuration](/nx-api/cypress/generators/component-configuration) + - [migrate-to-cypress-11](/nx-api/cypress/generators/migrate-to-cypress-11) + - [detox](/nx-api/detox) + - [documents](/nx-api/detox/documents) + - [Overview](/nx-api/detox/documents/overview) + - [executors](/nx-api/detox/executors) + - [build](/nx-api/detox/executors/build) + - [test](/nx-api/detox/executors/test) + - [generators](/nx-api/detox/generators) + - [init](/nx-api/detox/generators/init) + - [application](/nx-api/detox/generators/application) + - [devkit](/nx-api/devkit) + - [documents](/nx-api/devkit/documents) + - [Overview](/nx-api/devkit/documents/nx_devkit) + - [Ng CLI Adapter](/nx-api/devkit/documents/ngcli_adapter) + - [esbuild](/nx-api/esbuild) + - [documents](/nx-api/esbuild/documents) + - [Overview](/nx-api/esbuild/documents/overview) + - [executors](/nx-api/esbuild/executors) + - [esbuild](/nx-api/esbuild/executors/esbuild) + - [generators](/nx-api/esbuild/generators) + - [init](/nx-api/esbuild/generators/init) + - [configuration](/nx-api/esbuild/generators/configuration) + - [eslint-plugin](/nx-api/eslint-plugin) + - [documents](/nx-api/eslint-plugin/documents) + - [Overview](/nx-api/eslint-plugin/documents/overview) + - [The `enforce-module-boundaries` rule](/nx-api/eslint-plugin/documents/enforce-module-boundaries) + - [The `dependency-checks` rule](/nx-api/eslint-plugin/documents/dependency-checks) + - [expo](/nx-api/expo) + - [documents](/nx-api/expo/documents) + - [Overview](/nx-api/expo/documents/overview) + - [executors](/nx-api/expo/executors) + - [update](/nx-api/expo/executors/update) + - [build](/nx-api/expo/executors/build) + - [build-list](/nx-api/expo/executors/build-list) + - [download](/nx-api/expo/executors/download) + - [run](/nx-api/expo/executors/run) + - [start](/nx-api/expo/executors/start) + - [sync-deps](/nx-api/expo/executors/sync-deps) + - [ensure-symlink](/nx-api/expo/executors/ensure-symlink) + - [prebuild](/nx-api/expo/executors/prebuild) + - [install](/nx-api/expo/executors/install) + - [export](/nx-api/expo/executors/export) + - [submit](/nx-api/expo/executors/submit) + - [generators](/nx-api/expo/generators) + - [init](/nx-api/expo/generators/init) + - [application](/nx-api/expo/generators/application) + - [library](/nx-api/expo/generators/library) + - [component](/nx-api/expo/generators/component) + - [express](/nx-api/express) + - [documents](/nx-api/express/documents) + - [Overview](/nx-api/express/documents/overview) + - [generators](/nx-api/express/generators) + - [init](/nx-api/express/generators/init) + - [application](/nx-api/express/generators/application) + - [jest](/nx-api/jest) + - [documents](/nx-api/jest/documents) + - [Overview](/nx-api/jest/documents/overview) + - [executors](/nx-api/jest/executors) + - [jest](/nx-api/jest/executors/jest) + - [generators](/nx-api/jest/generators) + - [init](/nx-api/jest/generators/init) + - [configuration](/nx-api/jest/generators/configuration) + - [js](/nx-api/js) + - [documents](/nx-api/js/documents) + - [Overview](/nx-api/js/documents/overview) + - [executors](/nx-api/js/executors) + - [tsc](/nx-api/js/executors/tsc) + - [swc](/nx-api/js/executors/swc) + - [node](/nx-api/js/executors/node) + - [release-publish](/nx-api/js/executors/release-publish) + - [verdaccio](/nx-api/js/executors/verdaccio) + - [generators](/nx-api/js/generators) + - [library](/nx-api/js/generators/library) + - [init](/nx-api/js/generators/init) + - [convert-to-swc](/nx-api/js/generators/convert-to-swc) + - [release-version](/nx-api/js/generators/release-version) + - [setup-verdaccio](/nx-api/js/generators/setup-verdaccio) + - [setup-build](/nx-api/js/generators/setup-build) + - [linter](/nx-api/linter) + - [documents](/nx-api/linter/documents) + - [Overview](/nx-api/linter/documents/overview) + - [executors](/nx-api/linter/executors) + - [eslint](/nx-api/linter/executors/eslint) + - [generators](/nx-api/linter/generators) + - [workspace-rules-project](/nx-api/linter/generators/workspace-rules-project) + - [workspace-rule](/nx-api/linter/generators/workspace-rule) + - [convert-to-flat-config](/nx-api/linter/generators/convert-to-flat-config) + - [nest](/nx-api/nest) + - [documents](/nx-api/nest/documents) + - [Overview](/nx-api/nest/documents/overview) + - [generators](/nx-api/nest/generators) + - [application](/nx-api/nest/generators/application) + - [convert-tslint-to-eslint](/nx-api/nest/generators/convert-tslint-to-eslint) + - [init](/nx-api/nest/generators/init) + - [library](/nx-api/nest/generators/library) + - [class](/nx-api/nest/generators/class) + - [controller](/nx-api/nest/generators/controller) + - [decorator](/nx-api/nest/generators/decorator) + - [filter](/nx-api/nest/generators/filter) + - [gateway](/nx-api/nest/generators/gateway) + - [guard](/nx-api/nest/generators/guard) + - [interceptor](/nx-api/nest/generators/interceptor) + - [interface](/nx-api/nest/generators/interface) + - [middleware](/nx-api/nest/generators/middleware) + - [module](/nx-api/nest/generators/module) + - [pipe](/nx-api/nest/generators/pipe) + - [provider](/nx-api/nest/generators/provider) + - [resolver](/nx-api/nest/generators/resolver) + - [resource](/nx-api/nest/generators/resource) + - [service](/nx-api/nest/generators/service) + - [next](/nx-api/next) + - [documents](/nx-api/next/documents) + - [Overview](/nx-api/next/documents/overview) + - [executors](/nx-api/next/executors) + - [build](/nx-api/next/executors/build) + - [server](/nx-api/next/executors/server) + - [export](/nx-api/next/executors/export) + - [generators](/nx-api/next/generators) + - [init](/nx-api/next/generators/init) + - [application](/nx-api/next/generators/application) + - [page](/nx-api/next/generators/page) + - [component](/nx-api/next/generators/component) + - [library](/nx-api/next/generators/library) + - [custom-server](/nx-api/next/generators/custom-server) + - [cypress-component-configuration](/nx-api/next/generators/cypress-component-configuration) + - [node](/nx-api/node) + - [documents](/nx-api/node/documents) + - [Overview](/nx-api/node/documents/overview) + - [generators](/nx-api/node/generators) + - [init](/nx-api/node/generators/init) + - [application](/nx-api/node/generators/application) + - [library](/nx-api/node/generators/library) + - [setup-docker](/nx-api/node/generators/setup-docker) + - [nx](/nx-api/nx) + - [documents](/nx-api/nx/documents) + - [create-nx-workspace](/nx-api/nx/documents/create-nx-workspace) + - [init](/nx-api/nx/documents/init) + - [generate](/nx-api/nx/documents/generate) + - [run](/nx-api/nx/documents/run) + - [daemon](/nx-api/nx/documents/daemon) + - [graph](/nx-api/nx/documents/dep-graph) + - [run-many](/nx-api/nx/documents/run-many) + - [affected](/nx-api/nx/documents/affected) + - [affected:graph](/nx-api/nx/documents/affected-dep-graph) + - [print-affected](/nx-api/nx/documents/print-affected) + - [format:check](/nx-api/nx/documents/format-check) + - [format:write](/nx-api/nx/documents/format-write) + - [migrate](/nx-api/nx/documents/migrate) + - [report](/nx-api/nx/documents/report) + - [list](/nx-api/nx/documents/list) + - [workspace-lint](/nx-api/nx/documents/workspace-lint) + - [workspace-generator](/nx-api/nx/documents/workspace-generator) + - [connect-to-nx-cloud](/nx-api/nx/documents/connect-to-nx-cloud) + - [reset](/nx-api/nx/documents/reset) + - [repair](/nx-api/nx/documents/repair) + - [exec](/nx-api/nx/documents/exec) + - [watch](/nx-api/nx/documents/watch) + - [show](/nx-api/nx/documents/show) + - [view-logs](/nx-api/nx/documents/view-logs) + - [release](/nx-api/nx/documents/release) + - [executors](/nx-api/nx/executors) + - [noop](/nx-api/nx/executors/noop) + - [run-commands](/nx-api/nx/executors/run-commands) + - [run-script](/nx-api/nx/executors/run-script) + - [playwright](/nx-api/playwright) + - [documents](/nx-api/playwright/documents) + - [Overview](/nx-api/playwright/documents/overview) + - [executors](/nx-api/playwright/executors) + - [playwright](/nx-api/playwright/executors/playwright) + - [generators](/nx-api/playwright/generators) + - [configuration](/nx-api/playwright/generators/configuration) + - [init](/nx-api/playwright/generators/init) + - [plugin](/nx-api/plugin) + - [documents](/nx-api/plugin/documents) + - [Overview](/nx-api/plugin/documents/overview) + - [executors](/nx-api/plugin/executors) + - [e2e](/nx-api/plugin/executors/e2e) + - [generators](/nx-api/plugin/generators) + - [plugin](/nx-api/plugin/generators/plugin) + - [create-package](/nx-api/plugin/generators/create-package) + - [e2e-project](/nx-api/plugin/generators/e2e-project) + - [migration](/nx-api/plugin/generators/migration) + - [generator](/nx-api/plugin/generators/generator) + - [executor](/nx-api/plugin/generators/executor) + - [plugin-lint-checks](/nx-api/plugin/generators/plugin-lint-checks) + - [preset](/nx-api/plugin/generators/preset) + - [react](/nx-api/react) + - [documents](/nx-api/react/documents) + - [Overview](/nx-api/react/documents/overview) + - [executors](/nx-api/react/executors) + - [module-federation-dev-server](/nx-api/react/executors/module-federation-dev-server) + - [module-federation-ssr-dev-server](/nx-api/react/executors/module-federation-ssr-dev-server) + - [generators](/nx-api/react/generators) + - [init](/nx-api/react/generators/init) + - [application](/nx-api/react/generators/application) + - [library](/nx-api/react/generators/library) + - [component](/nx-api/react/generators/component) + - [redux](/nx-api/react/generators/redux) + - [storybook-configuration](/nx-api/react/generators/storybook-configuration) + - [component-story](/nx-api/react/generators/component-story) + - [stories](/nx-api/react/generators/stories) + - [component-cypress-spec](/nx-api/react/generators/component-cypress-spec) + - [hook](/nx-api/react/generators/hook) + - [host](/nx-api/react/generators/host) + - [remote](/nx-api/react/generators/remote) + - [cypress-component-configuration](/nx-api/react/generators/cypress-component-configuration) + - [component-test](/nx-api/react/generators/component-test) + - [setup-tailwind](/nx-api/react/generators/setup-tailwind) + - [setup-ssr](/nx-api/react/generators/setup-ssr) + - [react-native](/nx-api/react-native) + - [documents](/nx-api/react-native/documents) + - [Overview](/nx-api/react-native/documents/overview) + - [executors](/nx-api/react-native/executors) + - [run-android](/nx-api/react-native/executors/run-android) + - [run-ios](/nx-api/react-native/executors/run-ios) + - [bundle](/nx-api/react-native/executors/bundle) + - [build-android](/nx-api/react-native/executors/build-android) + - [build-ios](/nx-api/react-native/executors/build-ios) + - [start](/nx-api/react-native/executors/start) + - [sync-deps](/nx-api/react-native/executors/sync-deps) + - [ensure-symlink](/nx-api/react-native/executors/ensure-symlink) + - [storybook](/nx-api/react-native/executors/storybook) + - [pod-install](/nx-api/react-native/executors/pod-install) + - [generators](/nx-api/react-native/generators) + - [init](/nx-api/react-native/generators/init) + - [application](/nx-api/react-native/generators/application) + - [library](/nx-api/react-native/generators/library) + - [component](/nx-api/react-native/generators/component) + - [storybook-configuration](/nx-api/react-native/generators/storybook-configuration) + - [component-story](/nx-api/react-native/generators/component-story) + - [stories](/nx-api/react-native/generators/stories) + - [upgrade-native](/nx-api/react-native/generators/upgrade-native) + - [rollup](/nx-api/rollup) + - [executors](/nx-api/rollup/executors) + - [rollup](/nx-api/rollup/executors/rollup) + - [generators](/nx-api/rollup/generators) + - [init](/nx-api/rollup/generators/init) + - [configuration](/nx-api/rollup/generators/configuration) + - [storybook](/nx-api/storybook) + - [documents](/nx-api/storybook/documents) + - [Nx Storybook Plugin Overview](/nx-api/storybook/documents/overview) + - [Storybook best practices for making the most out of Nx](/nx-api/storybook/documents/best-practices) + - [Storybook 7 overview](/nx-api/storybook/documents/storybook-7-setup) + - [executors](/nx-api/storybook/executors) + - [storybook](/nx-api/storybook/executors/storybook) + - [build](/nx-api/storybook/executors/build) + - [generators](/nx-api/storybook/generators) + - [init](/nx-api/storybook/generators/init) + - [configuration](/nx-api/storybook/generators/configuration) + - [cypress-project](/nx-api/storybook/generators/cypress-project) + - [migrate-7](/nx-api/storybook/generators/migrate-7) + - [tao](/nx-api/tao) + - [vite](/nx-api/vite) + - [documents](/nx-api/vite/documents) + - [Overview of the Nx Vite Plugin](/nx-api/vite/documents/overview) + - [executors](/nx-api/vite/executors) + - [dev-server](/nx-api/vite/executors/dev-server) + - [build](/nx-api/vite/executors/build) + - [test](/nx-api/vite/executors/test) + - [preview-server](/nx-api/vite/executors/preview-server) + - [generators](/nx-api/vite/generators) + - [init](/nx-api/vite/generators/init) + - [configuration](/nx-api/vite/generators/configuration) + - [vitest](/nx-api/vite/generators/vitest) + - [web](/nx-api/web) + - [documents](/nx-api/web/documents) + - [Overview](/nx-api/web/documents/overview) + - [executors](/nx-api/web/executors) + - [file-server](/nx-api/web/executors/file-server) + - [generators](/nx-api/web/generators) + - [init](/nx-api/web/generators/init) + - [application](/nx-api/web/generators/application) + - [static-config](/nx-api/web/generators/static-config) + - [webpack](/nx-api/webpack) + - [documents](/nx-api/webpack/documents) + - [Overview of the Nx Webpack Plugin](/nx-api/webpack/documents/overview) + - [executors](/nx-api/webpack/executors) + - [webpack](/nx-api/webpack/executors/webpack) + - [dev-server](/nx-api/webpack/executors/dev-server) + - [ssr-dev-server](/nx-api/webpack/executors/ssr-dev-server) + - [generators](/nx-api/webpack/generators) + - [init](/nx-api/webpack/generators/init) + - [configuration](/nx-api/webpack/generators/configuration) + - [workspace](/nx-api/workspace) + - [documents](/nx-api/workspace/documents) + - [Overview](/nx-api/workspace/documents/overview) + - [Nx, NodeJS and Typescript Versions](/nx-api/workspace/documents/nx-nodejs-typescript-version-matrix) + - [executors](/nx-api/workspace/executors) + - [counter](/nx-api/workspace/executors/counter) + - [generators](/nx-api/workspace/generators) + - [preset](/nx-api/workspace/generators/preset) + - [move](/nx-api/workspace/generators/move) + - [remove](/nx-api/workspace/generators/remove) + - [convert-to-monorepo](/nx-api/workspace/generators/convert-to-monorepo) + - [new](/nx-api/workspace/generators/new) + - [workspace-generator](/nx-api/workspace/generators/workspace-generator) + - [run-commands](/nx-api/workspace/generators/run-commands) + - [fix-configuration](/nx-api/workspace/generators/fix-configuration) + - [npm-package](/nx-api/workspace/generators/npm-package) + - [ci-workflow](/nx-api/workspace/generators/ci-workflow) diff --git a/docs/shared/running-custom-commands.md b/docs/shared/running-custom-commands.md index d2262d79d5345..df2b8c4fa20fc 100644 --- a/docs/shared/running-custom-commands.md +++ b/docs/shared/running-custom-commands.md @@ -31,7 +31,7 @@ For each project for which you want to enable `make`, add a target in its `proje } ``` -For more information (e.g. how to forward arguments), see the [run-commands api doc](/packages/nx/executors/run-commands). +For more information (e.g. how to forward arguments), see the [run-commands api doc](/nx-api/nx/executors/run-commands). ## 3. Run the command diff --git a/docs/shared/workspace/buildable-and-publishable-libraries.md b/docs/shared/workspace/buildable-and-publishable-libraries.md index efc87fea5ba14..a700b4e19e69b 100644 --- a/docs/shared/workspace/buildable-and-publishable-libraries.md +++ b/docs/shared/workspace/buildable-and-publishable-libraries.md @@ -17,7 +17,7 @@ One typical scenario for this may be that you use Nx to develop your organizatio A normal Nx library - let’s call it "workspace library" - is not made for building or publishing. Rather it only includes common lint and test targets in its `project.json` file. These libraries are directly referenced from one of the monorepo’s applications and built together with them. -Keep in mind that the `--publishable` flag does not enable automatic publishing. Rather it adds to your Nx workspace library a builder target that **compiles** and **bundles** your app. The resulting artifact will be ready to be published to some registry (e.g. [npm](https://npmjs.com/)). By having that builder, you can invoke the build via a command like: `nx build mylib` (where "mylib" is the name of the lib) which will then produce an optimized bundle in the `dist/mylib` folder. Nx [also analyzes](/packages/angular/executors/package#updatebuildableprojectdepsinpackagejson) the library’s dependencies and automatically compiles the dependencies in the resulting `package.json` file. +Keep in mind that the `--publishable` flag does not enable automatic publishing. Rather it adds to your Nx workspace library a builder target that **compiles** and **bundles** your app. The resulting artifact will be ready to be published to some registry (e.g. [npm](https://npmjs.com/)). By having that builder, you can invoke the build via a command like: `nx build mylib` (where "mylib" is the name of the lib) which will then produce an optimized bundle in the `dist/mylib` folder. Nx [also analyzes](/nx-api/angular/executors/package#updatebuildableprojectdepsinpackagejson) the library’s dependencies and automatically compiles the dependencies in the resulting `package.json` file. One particularity when generating a library with `--publishable` is that it requires you to also provide an `--importPath`. Your import path is the actual scope of your distributable package (e.g.: `@myorg/mylib`) - which needs to be a [valid npm package name](https://docs.npmjs.com/files/package.json#name). diff --git a/docs/shared/workspace/grouping-libraries.md b/docs/shared/workspace/grouping-libraries.md index 2040c1d659be6..597671ec4b6f1 100644 --- a/docs/shared/workspace/grouping-libraries.md +++ b/docs/shared/workspace/grouping-libraries.md @@ -4,7 +4,7 @@ Libraries should be grouped by _scope_. A library's scope is either application ## Move Generator -Don't be too anxious about choosing the exact right folder structure from the beginning. Libraries can be moved or renamed using the [`@nx/workspace:move` generator](/packages/workspace/generators/move). +Don't be too anxious about choosing the exact right folder structure from the beginning. Libraries can be moved or renamed using the [`@nx/workspace:move` generator](/nx-api/workspace/generators/move). For instance, if a library under the `booking` folder is now being shared by multiple apps, you can move it to the shared folder like this: @@ -13,12 +13,12 @@ nx g move --project booking-some-library shared/some-library ``` {% callout type="note" title="Angular" %} -For Angular projects, you should use the [`@nx/angular:move` generator](/packages/angular/generators/move) instead. +For Angular projects, you should use the [`@nx/angular:move` generator](/nx-api/angular/generators/move) instead. {% /callout %} ## Remove Generator -Similarly, if you no longer need a library, you can remove it with the [`@nx/workspace:remove` generator](/packages/workspace/generators/remove). +Similarly, if you no longer need a library, you can remove it with the [`@nx/workspace:remove` generator](/nx-api/workspace/generators/remove). ```shell nx g remove booking-some-library diff --git a/nx-dev/data-access-documents/src/lib/documents.api.ts b/nx-dev/data-access-documents/src/lib/documents.api.ts index dca0444acc63e..1f1a17b491ebd 100644 --- a/nx-dev/data-access-documents/src/lib/documents.api.ts +++ b/nx-dev/data-access-documents/src/lib/documents.api.ts @@ -69,7 +69,7 @@ export class DocumentsApi { if (!document) { if ( - path[0] === 'packages' && + path[0] === 'nx-api' && path[1] === 'devkit' && path[2] === 'documents' ) { diff --git a/nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx b/nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx index b784f689bb0c9..c15d4871705e7 100644 --- a/nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx +++ b/nx-dev/feature-doc-viewer/src/lib/doc-viewer.tsx @@ -25,7 +25,7 @@ export function DocViewer({ const hideTableOfContent = router.asPath.includes('/getting-started/intro') || router.asPath.includes('/extending-nx/intro/getting-started') || - router.asPath.includes('/packages/devkit') || + router.asPath.includes('/nx-api/devkit') || router.asPath.includes('/reference/glossary'); const ref = useRef(null); diff --git a/nx-dev/nx-dev/lib/packages.api.ts b/nx-dev/nx-dev/lib/packages.api.ts index 22b210e27875c..f756774a849d5 100644 --- a/nx-dev/nx-dev/lib/packages.api.ts +++ b/nx-dev/nx-dev/lib/packages.api.ts @@ -1,10 +1,10 @@ import { PackagesApi } from '@nx/nx-dev/data-access-packages/node-only'; import { ProcessedPackageMetadata } from '@nx/nx-dev/models-package'; -import packages from '../public/documentation/generated/manifests/packages.json'; +import packages from '../public/documentation/generated/manifests/nx-api.json'; import { tagsApi } from './tags.api'; export const nxPackagesApi = new PackagesApi({ - id: 'packages', + id: 'nx-api', manifest: packages as Record, prefix: '', publicDocsRoot: 'public/documentation', diff --git a/nx-dev/nx-dev/lib/rspack/content/overview.ts b/nx-dev/nx-dev/lib/rspack/content/overview.ts index 38e16634d8db5..06f99f06b614a 100644 --- a/nx-dev/nx-dev/lib/rspack/content/overview.ts +++ b/nx-dev/nx-dev/lib/rspack/content/overview.ts @@ -70,7 +70,7 @@ nx build my-app ### Generate a non-React project using Rspack -You can generate a [Web](/packages/web) application, and then use the \`@nx/rspack:configuration\` generator to configure the build and serve targets. +You can generate a [Web](/nx-api/web) application, and then use the \`@nx/rspack:configuration\` generator to configure the build and serve targets. Make sure you have the Web plugin installed. @@ -109,7 +109,7 @@ nx g @nx/rspack:configuration --project=my-app You can use the \`@nx/rspack:configuration\` generator to change your React or Web project to use Rspack. This generator will modify your project's configuration to use Rspack, and it will also install all the necessary dependencies. -You can read more about this generator on the [\`@nx/rspack:configuration\`](/packages/rspack/generators/configuration) generator page. +You can read more about this generator on the [\`@nx/rspack:configuration\`](/nx-api/rspack/generators/configuration) generator page. ### Initialize Rspack diff --git a/nx-dev/nx-dev/lib/rspack/content/rspack-config-setup.ts b/nx-dev/nx-dev/lib/rspack/content/rspack-config-setup.ts index df24dd432c79f..7b4d8c4b6e5f8 100644 --- a/nx-dev/nx-dev/lib/rspack/content/rspack-config-setup.ts +++ b/nx-dev/nx-dev/lib/rspack/content/rspack-config-setup.ts @@ -53,7 +53,7 @@ This gives you the ability to customize the Rspack configuration as needed, and ### Add configurations for other functionalities -In addition to the basic configuration, you can add configurations for other frameworks or features. The \`@nx/rspack\` package provides plugins such as \`withWeb\` and \`withReact\`. This plugins provide features such as TS support, CSS support, JSX support, etc. You can read more about how these plugins work and how to use them in our [Rspack Plugins guide](/packages/rspack/documents/rspack-plugins). +In addition to the basic configuration, you can add configurations for other frameworks or features. The \`@nx/rspack\` package provides plugins such as \`withWeb\` and \`withReact\`. This plugins provide features such as TS support, CSS support, JSX support, etc. You can read more about how these plugins work and how to use them in our [Rspack Plugins guide](/nx-api/rspack/documents/rspack-plugins). You may still reconfigure everything manually, without using the Nx plugins. However, these plugins ensure that you have the necessary configuration for Nx to work with your project. diff --git a/nx-dev/nx-dev/lib/rspack/content/rspack-plugin.ts b/nx-dev/nx-dev/lib/rspack/content/rspack-plugin.ts index 977e00e50cc54..b77e9266d8da0 100644 --- a/nx-dev/nx-dev/lib/rspack/content/rspack-plugin.ts +++ b/nx-dev/nx-dev/lib/rspack/content/rspack-plugin.ts @@ -6,7 +6,7 @@ configuration object and returns an updated configuration object. Plugins are us functionality to the Rspack build. This guide contains information on the plugins provided by Nx. For more information on customizing Rspack configuration, refer to the -[Nx Rspack configuration guide](/packages/rspack/documents/rspack-config-setup). +[Nx Rspack configuration guide](/nx-api/rspack/documents/rspack-config-setup). ## withNx diff --git a/nx-dev/nx-dev/lib/rspack/pkg.ts b/nx-dev/nx-dev/lib/rspack/pkg.ts index 852b13b1d36e2..da1643f4ef983 100644 --- a/nx-dev/nx-dev/lib/rspack/pkg.ts +++ b/nx-dev/nx-dev/lib/rspack/pkg.ts @@ -3,7 +3,7 @@ import { ProcessedPackageMetadata } from '@nx/nx-dev/models-package'; export const pkg: ProcessedPackageMetadata = { description: '', documents: { - '/packages/rspack/documents/overview': { + '/nx-api/rspack/documents/overview': { id: 'overview', name: 'Overview of the Nx Rspack plugin', description: @@ -11,20 +11,20 @@ export const pkg: ProcessedPackageMetadata = { file: '', itemList: [], isExternal: false, - path: '/packages/rspack/documents/overview', + path: '/nx-api/rspack/documents/overview', tags: [], }, - '/packages/rspack/documents/rspack-plugins': { + '/nx-api/rspack/documents/rspack-plugins': { id: 'rspack-plugins', name: 'Rspack plugins', description: 'Rspack plugins', file: '', itemList: [], isExternal: false, - path: '/packages/rspack/documents/rspack-plugins', + path: '/nx-api/rspack/documents/rspack-plugins', tags: [], }, - '/packages/rspack/documents/rspack-config-setup': { + '/nx-api/rspack/documents/rspack-config-setup': { id: 'rspack-config-setup', name: ' How to configure Rspack on your Nx workspace', description: @@ -32,58 +32,57 @@ export const pkg: ProcessedPackageMetadata = { file: '', itemList: [], isExternal: false, - path: '/packages/rspack/documents/rspack-config-setup', + path: '/nx-api/rspack/documents/rspack-config-setup', tags: [], }, }, executors: { - '/packages/rspack/executors/rspack': { + '/nx-api/rspack/executors/rspack': { description: 'Run rspack build.', file: 'generated/packages/rspack/executors/rspack.json', hidden: false, name: 'rspack', - originalFilePath: '/packages/rspack/src/executors/rspack/schema.json', - path: '/packages/rspack/executors/rspack', + originalFilePath: '/nx-api/rspack/src/executors/rspack/schema.json', + path: '/nx-api/rspack/executors/rspack', type: 'executor', }, - '/packages/rspack/executors/dev-server': { + '/nx-api/rspack/executors/dev-server': { description: 'Serve a web application.', file: 'generated/packages/rspack/executors/dev-server.json', hidden: false, name: 'dev-server', - originalFilePath: '/packages/rspack/src/executors/dev-server/schema.json', - path: '/packages/rspack/executors/dev-server', + originalFilePath: '/nx-api/rspack/src/executors/dev-server/schema.json', + path: '/nx-api/rspack/executors/dev-server', type: 'executor', }, }, generators: { - '/packages/rspack/generators/init': { + '/nx-api/rspack/generators/init': { description: 'Initialize the `@nx/rspack` plugin.', file: 'generated/packages/rspack/generators/init.json', hidden: false, name: 'init', - originalFilePath: '/packages/rspack/src/generators/init/schema.json', - path: '/packages/rspack/generators/init', + originalFilePath: '/nx-api/rspack/src/generators/init/schema.json', + path: '/nx-api/rspack/generators/init', type: 'generator', }, - '/packages/rspack/generators/configuration': { + '/nx-api/rspack/generators/configuration': { description: 'Add Rspack configuration to a project.', file: 'generated/packages/rspack/generators/configuration.json', hidden: false, name: 'configuration', originalFilePath: - '/packages/rspack/src/generators/configuration/schema.json', - path: '/packages/rspack/generators/configuration', + '/nx-api/rspack/src/generators/configuration/schema.json', + path: '/nx-api/rspack/generators/configuration', type: 'generator', }, - '/packages/rspack/generators/application': { + '/nx-api/rspack/generators/application': { description: 'Add Rspack application to a project.', file: 'generated/packages/rspack/generators/application.json', hidden: false, name: 'application', - originalFilePath: - '/packages/rspack/src/generators/application/schema.json', - path: '/packages/rspack/generators/application', + originalFilePath: '/nx-api/rspack/src/generators/application/schema.json', + path: '/nx-api/rspack/generators/application', type: 'generator', }, }, diff --git a/nx-dev/nx-dev/lib/rspack/schema/executors/dev-server.ts b/nx-dev/nx-dev/lib/rspack/schema/executors/dev-server.ts index 1cb6fe0646a9e..a133ca1b61a4d 100644 --- a/nx-dev/nx-dev/lib/rspack/schema/executors/dev-server.ts +++ b/nx-dev/nx-dev/lib/rspack/schema/executors/dev-server.ts @@ -30,6 +30,6 @@ export const schema = { description: 'Serve a web application.', aliases: [], hidden: false, - path: '/packages/rspack/src/executors/dev-server/schema.json', + path: '/nx-api/rspack/src/executors/dev-server/schema.json', type: 'executor', }; diff --git a/nx-dev/nx-dev/lib/rspack/schema/executors/rspack.ts b/nx-dev/nx-dev/lib/rspack/schema/executors/rspack.ts index 44256660db3cb..e71d951b82627 100644 --- a/nx-dev/nx-dev/lib/rspack/schema/executors/rspack.ts +++ b/nx-dev/nx-dev/lib/rspack/schema/executors/rspack.ts @@ -107,6 +107,6 @@ export const schema = { description: 'Run rspack build.', aliases: [], hidden: false, - path: '/packages/rspack/src/executors/rspack/schema.json', + path: '/nx-api/rspack/src/executors/rspack/schema.json', type: 'executor', }; diff --git a/nx-dev/nx-dev/lib/rspack/schema/generators/application.ts b/nx-dev/nx-dev/lib/rspack/schema/generators/application.ts index 13df434f0bdc7..ce8e3342a121d 100644 --- a/nx-dev/nx-dev/lib/rspack/schema/generators/application.ts +++ b/nx-dev/nx-dev/lib/rspack/schema/generators/application.ts @@ -108,6 +108,6 @@ export const schema = { hidden: false, implementation: '/packages/rspack/src/generators/application/application#applicationGenerator.ts', - path: '/packages/rspack/src/generators/application/schema.json', + path: '/api/rspack/src/generators/application/schema.json', type: 'generator', }; diff --git a/nx-dev/nx-dev/lib/rspack/schema/generators/configuration.ts b/nx-dev/nx-dev/lib/rspack/schema/generators/configuration.ts index ca19116c7c019..8c20986e90959 100644 --- a/nx-dev/nx-dev/lib/rspack/schema/generators/configuration.ts +++ b/nx-dev/nx-dev/lib/rspack/schema/generators/configuration.ts @@ -85,6 +85,6 @@ export const schema = { hidden: false, implementation: '/packages/rspack/src/generators/configuration/configuration#configurationGenerator.ts', - path: '/packages/rspack/src/generators/configuration/schema.json', + path: '/nx-api/rspack/src/generators/configuration/schema.json', type: 'generator', }; diff --git a/nx-dev/nx-dev/lib/rspack/schema/generators/init.ts b/nx-dev/nx-dev/lib/rspack/schema/generators/init.ts index a3269fcc57339..1736278f7025e 100644 --- a/nx-dev/nx-dev/lib/rspack/schema/generators/init.ts +++ b/nx-dev/nx-dev/lib/rspack/schema/generators/init.ts @@ -31,6 +31,6 @@ export const schema = { hidden: false, implementation: '/packages/rspack/src/generators/init/init#rspackInitGenerator.ts', - path: '/packages/rspack/src/generators/init/schema.json', + path: '/nx-api/rspack/src/generators/init/schema.json', type: 'generator', }; diff --git a/nx-dev/nx-dev/pages/[...segments].tsx b/nx-dev/nx-dev/pages/[...segments].tsx index 236a10d22e961..219d4382227e7 100644 --- a/nx-dev/nx-dev/pages/[...segments].tsx +++ b/nx-dev/nx-dev/pages/[...segments].tsx @@ -76,7 +76,7 @@ export default function NxDocumentation({ } export const getStaticPaths: GetStaticPaths = () => { - const reservedPaths = ['/nx-cloud', '/packages', '/changelog']; + const reservedPaths = ['/nx-cloud', '/nx-api', '/changelog']; return { paths: nxDocumentationApi .getSlugsStaticDocumentPaths() diff --git a/nx-dev/nx-dev/pages/extending-nx/[...segments].tsx b/nx-dev/nx-dev/pages/extending-nx/[...segments].tsx index 6b7128517c3d7..5e08c75a67e4c 100644 --- a/nx-dev/nx-dev/pages/extending-nx/[...segments].tsx +++ b/nx-dev/nx-dev/pages/extending-nx/[...segments].tsx @@ -85,9 +85,7 @@ export default function Pages({ export const getStaticPaths: GetStaticPaths = () => { return { - paths: nxPluginsApi - .getSlugsStaticDocumentPaths() - .filter((v) => v !== '/extending-nx/registry'), + paths: nxPluginsApi.getSlugsStaticDocumentPaths(), fallback: 'blocking', }; }; diff --git a/nx-dev/nx-dev/pages/packages/[name]/documents/[...segments].tsx b/nx-dev/nx-dev/pages/nx-api/[name]/documents/[...segments].tsx similarity index 97% rename from nx-dev/nx-dev/pages/packages/[name]/documents/[...segments].tsx rename to nx-dev/nx-dev/pages/nx-api/[name]/documents/[...segments].tsx index de802de86702e..9b702275699d5 100644 --- a/nx-dev/nx-dev/pages/packages/[name]/documents/[...segments].tsx +++ b/nx-dev/nx-dev/pages/nx-api/[name]/documents/[...segments].tsx @@ -110,7 +110,7 @@ export async function getStaticProps({ params: { name: string; segments: string[] }; }) { try { - const segments = ['packages', params.name, 'documents', ...params.segments]; + const segments = ['nx-api', params.name, 'documents', ...params.segments]; const documents = new DocumentsApi({ id: [params.name, 'documents'].join('-'), manifest: nxPackagesApi.getPackageDocuments(params.name), @@ -130,7 +130,7 @@ export async function getStaticProps({ relatedDocuments: tagsApi .getAssociatedItemsFromTags(document.tags) .filter((item) => item.path !== '/' + segments.join('/')), // Remove currently displayed item - menu: menusApi.getMenu('packages', ''), + menu: menusApi.getMenu('nx-api', ''), }, }; } catch (e) { diff --git a/nx-dev/nx-dev/pages/packages/[name]/documents/index.tsx b/nx-dev/nx-dev/pages/nx-api/[name]/documents/index.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/[name]/documents/index.tsx rename to nx-dev/nx-dev/pages/nx-api/[name]/documents/index.tsx index 9e5c57f510e4b..a0e558830be58 100644 --- a/nx-dev/nx-dev/pages/packages/[name]/documents/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/[name]/documents/index.tsx @@ -101,7 +101,7 @@ export async function getStaticProps({ const pkg = nxPackagesApi.getPackage([params.name]); return { props: { - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), pkg, }, }; diff --git a/nx-dev/nx-dev/pages/packages/[name]/executors/[...segments].tsx b/nx-dev/nx-dev/pages/nx-api/[name]/executors/[...segments].tsx similarity index 96% rename from nx-dev/nx-dev/pages/packages/[name]/executors/[...segments].tsx rename to nx-dev/nx-dev/pages/nx-api/[name]/executors/[...segments].tsx index 776738ad8a12c..d76e9e73c254c 100644 --- a/nx-dev/nx-dev/pages/packages/[name]/executors/[...segments].tsx +++ b/nx-dev/nx-dev/pages/nx-api/[name]/executors/[...segments].tsx @@ -114,10 +114,10 @@ function getData( pkg: nxPackagesApi.getPackage([packageName]), schema: nxPackagesApi.getSchemaMetadata( nxPackagesApi.getPackageFileMetadatas(packageName, 'executors')[ - '/' + ['packages', packageName, 'executors', ...segments].join('/') + '/' + ['nx-api', packageName, 'executors', ...segments].join('/') ] ), - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), }; } export async function getStaticProps({ diff --git a/nx-dev/nx-dev/pages/packages/[name]/executors/index.tsx b/nx-dev/nx-dev/pages/nx-api/[name]/executors/index.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/[name]/executors/index.tsx rename to nx-dev/nx-dev/pages/nx-api/[name]/executors/index.tsx index 0f3df9ff4dd96..5f4b7f870235c 100644 --- a/nx-dev/nx-dev/pages/packages/[name]/executors/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/[name]/executors/index.tsx @@ -101,7 +101,7 @@ export async function getStaticProps({ const pkg = nxPackagesApi.getPackage([params.name]); return { props: { - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), pkg, }, }; diff --git a/nx-dev/nx-dev/pages/packages/[name]/generators/[...segments].tsx b/nx-dev/nx-dev/pages/nx-api/[name]/generators/[...segments].tsx similarity index 96% rename from nx-dev/nx-dev/pages/packages/[name]/generators/[...segments].tsx rename to nx-dev/nx-dev/pages/nx-api/[name]/generators/[...segments].tsx index 7fae5086a71ba..974ab01525c61 100644 --- a/nx-dev/nx-dev/pages/packages/[name]/generators/[...segments].tsx +++ b/nx-dev/nx-dev/pages/nx-api/[name]/generators/[...segments].tsx @@ -114,10 +114,10 @@ function getData( pkg: nxPackagesApi.getPackage([packageName]), schema: nxPackagesApi.getSchemaMetadata( nxPackagesApi.getPackageFileMetadatas(packageName, 'generators')[ - '/' + ['packages', packageName, 'generators', ...segments].join('/') + '/' + ['nx-api', packageName, 'generators', ...segments].join('/') ] ), - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), }; } export async function getStaticProps({ diff --git a/nx-dev/nx-dev/pages/packages/[name]/generators/index.tsx b/nx-dev/nx-dev/pages/nx-api/[name]/generators/index.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/[name]/generators/index.tsx rename to nx-dev/nx-dev/pages/nx-api/[name]/generators/index.tsx index d32d59bc21572..3a7c027b81bf6 100644 --- a/nx-dev/nx-dev/pages/packages/[name]/generators/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/[name]/generators/index.tsx @@ -101,7 +101,7 @@ export async function getStaticProps({ const pkg = nxPackagesApi.getPackage([params.name]); return { props: { - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), pkg, }, }; diff --git a/nx-dev/nx-dev/pages/packages/[name]/index.tsx b/nx-dev/nx-dev/pages/nx-api/[name]/index.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/[name]/index.tsx rename to nx-dev/nx-dev/pages/nx-api/[name]/index.tsx index 0741414304eca..47c7bcef09eea 100644 --- a/nx-dev/nx-dev/pages/packages/[name]/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/[name]/index.tsx @@ -110,7 +110,7 @@ function getData(packageName: string): { let overview = ''; try { overview = documents.getDocument([ - 'packages', + 'nx-api', packageName, 'documents', 'overview', @@ -120,7 +120,7 @@ function getData(packageName: string): { } return { - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), overview: overview, pkg, }; diff --git a/nx-dev/nx-dev/pages/packages/index.tsx b/nx-dev/nx-dev/pages/nx-api/index.tsx similarity index 99% rename from nx-dev/nx-dev/pages/packages/index.tsx rename to nx-dev/nx-dev/pages/nx-api/index.tsx index 7acc24a582544..79ace30622cb9 100644 --- a/nx-dev/nx-dev/pages/packages/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/index.tsx @@ -160,7 +160,7 @@ export async function getStaticProps(): Promise<{ return { props: { packages: nxPackagesApi.getRootPackageIndex(), - menu: menusApi.getMenu('packages', ''), + menu: menusApi.getMenu('nx-api', ''), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/documents/index.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/documents/index.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/documents/index.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/documents/index.tsx index 7e1f98f076f58..01c9ef358890e 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/documents/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/documents/index.tsx @@ -85,7 +85,7 @@ export async function getStaticProps(): Promise<{ }> { return { props: { - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), pkg, }, }; diff --git a/nx-dev/nx-dev/pages/packages/rspack/documents/overview.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/documents/overview.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/documents/overview.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/documents/overview.tsx index badb40132070f..2c5a16d329043 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/documents/overview.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/documents/overview.tsx @@ -107,7 +107,7 @@ export async function getStaticProps() { githubStarsCount: await fetchGithubStarCount(), }, relatedDocuments: [], - menu: menusApi.getMenu('packages', ''), + menu: menusApi.getMenu('nx-api', ''), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/documents/rspack-config-setup.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/documents/rspack-config-setup.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/documents/rspack-config-setup.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/documents/rspack-config-setup.tsx index 0ba2309bf3385..fa3e970ef9507 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/documents/rspack-config-setup.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/documents/rspack-config-setup.tsx @@ -108,7 +108,7 @@ export async function getStaticProps() { githubStarsCount: await fetchGithubStarCount(), }, relatedDocuments: [], - menu: menusApi.getMenu('packages', ''), + menu: menusApi.getMenu('nx-api', ''), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/documents/rspack-plugins.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/documents/rspack-plugins.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/documents/rspack-plugins.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/documents/rspack-plugins.tsx index 6567ff04f58af..8fb2fa4a19878 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/documents/rspack-plugins.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/documents/rspack-plugins.tsx @@ -107,7 +107,7 @@ export async function getStaticProps() { githubStarsCount: await fetchGithubStarCount(), }, relatedDocuments: [], - menu: menusApi.getMenu('packages', ''), + menu: menusApi.getMenu('nx-api', ''), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/executors/dev-server.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/executors/dev-server.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/executors/dev-server.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/executors/dev-server.tsx index 24a93fab58846..29f8f40b0e208 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/executors/dev-server.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/executors/dev-server.tsx @@ -93,7 +93,7 @@ export async function getStaticProps() { props: { pkg, schema, - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/executors/index.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/executors/index.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/executors/index.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/executors/index.tsx index d144534d5fcb0..80b0e45f45ceb 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/executors/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/executors/index.tsx @@ -85,7 +85,7 @@ export async function getStaticProps(): Promise<{ }> { return { props: { - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), pkg, }, }; diff --git a/nx-dev/nx-dev/pages/packages/rspack/executors/rspack.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/executors/rspack.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/executors/rspack.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/executors/rspack.tsx index cc4230bd06b95..9e0140114fc5f 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/executors/rspack.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/executors/rspack.tsx @@ -93,7 +93,7 @@ export async function getStaticProps() { props: { pkg, schema, - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/generators/application.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/generators/application.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/generators/application.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/generators/application.tsx index f818c95e8623e..ad198d6a09d20 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/generators/application.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/generators/application.tsx @@ -93,7 +93,7 @@ export async function getStaticProps() { props: { pkg, schema, - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/generators/configuration.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/generators/configuration.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/generators/configuration.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/generators/configuration.tsx index 41f0031877c1a..9b7dab01411b9 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/generators/configuration.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/generators/configuration.tsx @@ -93,7 +93,7 @@ export async function getStaticProps() { props: { pkg, schema, - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/generators/index.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/generators/index.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/generators/index.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/generators/index.tsx index 508f9a7eceeba..44a63631e115c 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/generators/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/generators/index.tsx @@ -85,7 +85,7 @@ export async function getStaticProps(): Promise<{ }> { return { props: { - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), pkg, }, }; diff --git a/nx-dev/nx-dev/pages/packages/rspack/generators/init.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/generators/init.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/generators/init.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/generators/init.tsx index e028bb541fd29..c1fc50154046d 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/generators/init.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/generators/init.tsx @@ -93,7 +93,7 @@ export async function getStaticProps() { props: { pkg, schema, - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), }, }; } diff --git a/nx-dev/nx-dev/pages/packages/rspack/index.tsx b/nx-dev/nx-dev/pages/nx-api/rspack/index.tsx similarity index 98% rename from nx-dev/nx-dev/pages/packages/rspack/index.tsx rename to nx-dev/nx-dev/pages/nx-api/rspack/index.tsx index 8c0a32087609f..e1a474bdd460a 100644 --- a/nx-dev/nx-dev/pages/packages/rspack/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/rspack/index.tsx @@ -83,7 +83,7 @@ export default function RspackIndex({ export async function getStaticProps() { return { props: { - menu: menusApi.getMenu('packages', 'packages'), + menu: menusApi.getMenu('nx-api', 'nx-api'), overview: content, pkg, }, diff --git a/nx-dev/nx-dev/pages/extending-nx/registry.tsx b/nx-dev/nx-dev/pages/plugin-registry.tsx similarity index 91% rename from nx-dev/nx-dev/pages/extending-nx/registry.tsx rename to nx-dev/nx-dev/pages/plugin-registry.tsx index c5888b98a8d5a..7cbb8a80f631a 100644 --- a/nx-dev/nx-dev/pages/extending-nx/registry.tsx +++ b/nx-dev/nx-dev/pages/plugin-registry.tsx @@ -1,18 +1,13 @@ import { getBasicPluginsSection } from '@nx/nx-dev/data-access-menu'; import { Menu } from '@nx/nx-dev/models-menu'; -import { - Breadcrumbs, - DocumentationHeader, - Footer, - SidebarContainer, -} from '@nx/nx-dev/ui-common'; +import { Breadcrumbs, DocumentationHeader, Footer } from '@nx/nx-dev/ui-common'; import { PluginDirectory } from '@nx/nx-dev/ui-community'; import { NextSeo } from 'next-seo'; import { useRouter } from 'next/router'; import { useRef } from 'react'; -import { menusApi } from '../../lib/menus.api'; -import { useNavToggle } from '../../lib/navigation-toggle.effect'; -import { nxPackagesApi } from '../../lib/packages.api'; +import { menusApi } from '../lib/menus.api'; +import { useNavToggle } from '../lib/navigation-toggle.effect'; +import { nxPackagesApi } from '../lib/packages.api'; declare const fetch: any; let qualityIndicators = require('./quality-indicators.json'); @@ -111,7 +106,6 @@ export default function Browse(props: BrowseProps): JSX.Element { role="main" className="flex h-full flex-1 overflow-y-hidden" > -
void; }): JSX.Element { const router = useRouter(); - const isNxCloud: boolean = router.asPath.startsWith('/nx-cloud'); - const isPackages: boolean = router.asPath.startsWith('/packages'); - const isPlugins: boolean = router.asPath.startsWith('/extending-nx'); - const isChangelog: boolean = router.asPath.startsWith('/changelog'); - const isNx: boolean = !isNxCloud && !isPackages && !isPlugins && !isChangelog; + let routerPath = router.asPath; + const isNxCloud: boolean = routerPath.startsWith('/nx-cloud'); + const isAPI: boolean = routerPath.startsWith('/nx-api'); + const isExtendingNx: boolean = routerPath.startsWith('/extending-nx'); + const isPlugins: boolean = routerPath.startsWith('/plugin-registry'); + const isChangelog: boolean = routerPath.startsWith('/changelog'); + const isNx: boolean = + !isNxCloud && !isAPI && !isExtendingNx && !isPlugins && !isChangelog; const sections = [ { name: 'Nx', href: '/getting-started/intro', current: isNx }, @@ -54,12 +57,17 @@ export function DocumentationHeader({ { name: 'Extending Nx', href: '/extending-nx/intro/getting-started', + current: isExtendingNx, + }, + { + name: 'Plugins', + href: '/plugin-registry', current: isPlugins, }, { - name: 'Packages', - href: '/packages', - current: isPackages, + name: 'API', + href: '/nx-api', + current: isAPI, }, { name: 'Changelog', diff --git a/nx-dev/ui-common/src/lib/sidebar-container.tsx b/nx-dev/ui-common/src/lib/sidebar-container.tsx index 2801ec0e34791..936f9aee90d8b 100644 --- a/nx-dev/ui-common/src/lib/sidebar-container.tsx +++ b/nx-dev/ui-common/src/lib/sidebar-container.tsx @@ -1,4 +1,4 @@ -import { Menu } from '@nx/nx-dev/models-menu'; +import { Menu, MenuItem, MenuSection } from '@nx/nx-dev/models-menu'; import { Sidebar, SidebarMobile } from './sidebar'; import { useMemo } from 'react'; @@ -9,12 +9,12 @@ const rspackSection = { itemList: [ { id: 'documents', - path: '/packages/rspack/documents', + path: '/nx-api/rspack/documents', name: 'documents', children: [ { name: 'Overview of the Nx Rspack plugin', - path: '/packages/rspack/documents/overview', + path: '/nx-api/rspack/documents/overview', id: 'overview', isExternal: false, children: [], @@ -22,7 +22,7 @@ const rspackSection = { }, { name: 'Rspack plugins', - path: '/packages/rspack/documents/rspack-plugins', + path: '/nx-api/rspack/documents/rspack-plugins', id: 'rspack-plugins', isExternal: false, children: [], @@ -30,7 +30,7 @@ const rspackSection = { }, { name: 'How to configure Rspack in your Nx workspace', - path: '/packages/rspack/documents/rspack-config-setup', + path: '/nx-api/rspack/documents/rspack-config-setup', id: 'rspack-config-setup', isExternal: false, children: [], @@ -42,12 +42,12 @@ const rspackSection = { }, { id: 'executors', - path: '/packages/rspack/executors', + path: '/nx-api/rspack/executors', name: 'executors', children: [ { id: 'rspack', - path: '/packages/rspack/executors/rspack', + path: '/nx-api/rspack/executors/rspack', name: 'rspack', children: [], isExternal: false, @@ -55,7 +55,7 @@ const rspackSection = { }, { id: 'dev-server', - path: '/packages/rspack/executors/dev-server', + path: '/nx-api/rspack/executors/dev-server', name: 'dev-server', children: [], isExternal: false, @@ -67,12 +67,12 @@ const rspackSection = { }, { id: 'generators', - path: '/packages/rspack/generators', + path: '/nx-api/rspack/generators', name: 'generators', children: [ { id: 'init', - path: '/packages/rspack/generators/init', + path: '/nx-api/rspack/generators/init', name: 'init', children: [], isExternal: false, @@ -80,7 +80,7 @@ const rspackSection = { }, { id: 'configuration', - path: '/packages/rspack/generators/configuration', + path: '/nx-api/rspack/generators/configuration', name: 'configuration', children: [], isExternal: false, @@ -88,7 +88,7 @@ const rspackSection = { }, { id: 'application', - path: '/packages/rspack/generators/application', + path: '/nx-api/rspack/generators/application', name: 'application', children: [], isExternal: false, diff --git a/nx-dev/ui-common/src/lib/sidebar.tsx b/nx-dev/ui-common/src/lib/sidebar.tsx index 499d84b35a647..68bfcfb9a6977 100644 --- a/nx-dev/ui-common/src/lib/sidebar.tsx +++ b/nx-dev/ui-common/src/lib/sidebar.tsx @@ -178,9 +178,9 @@ export function SidebarMobile({ }: FloatingSidebarProps): JSX.Element { const router = useRouter(); const isNxCloud: boolean = router.asPath.startsWith('/nx-cloud'); - const isPackages: boolean = router.asPath.startsWith('/packages'); + const isAPI: boolean = router.asPath.startsWith('/nx-api'); const isPlugins: boolean = router.asPath.startsWith('/extending-nx'); - const isNx: boolean = !isNxCloud && !isPackages && !isPlugins; + const isNx: boolean = !isNxCloud && !isAPI && !isPlugins; const sections = [ { name: 'Home', href: '/', current: false }, @@ -191,9 +191,9 @@ export function SidebarMobile({ current: isNxCloud, }, { - name: 'Packages', - href: '/packages', - current: isPackages, + name: 'API', + href: '/nx-api', + current: isAPI, }, { name: 'Extending Nx', diff --git a/scripts/documentation/generators/generate-manifests.ts b/scripts/documentation/generators/generate-manifests.ts index aad8a7b3043ad..d7d452a64cb56 100644 --- a/scripts/documentation/generators/generate-manifests.ts +++ b/scripts/documentation/generators/generate-manifests.ts @@ -209,7 +209,7 @@ function createPackagesMenu(packages: PackageManifest): { const packagesMenu: MenuItem[] = Object.values(packages.records).map((p) => { const item: MenuItem = { id: p.name, - path: '/packages/' + p.name, + path: '/nx-api/' + p.name, name: p.name, children: [], isExternal: false, @@ -220,7 +220,7 @@ function createPackagesMenu(packages: PackageManifest): { // Might need to remove the path set in the "additional api resources" items item.children.push({ id: 'documents', - path: '/' + ['packages', p.name, 'documents'].join('/'), + path: '/' + ['nx-api', p.name, 'documents'].join('/'), name: 'documents', children: Object.values(p.documents).map((d) => menuItemRecurseOperations(d) @@ -233,11 +233,11 @@ function createPackagesMenu(packages: PackageManifest): { if (!!Object.values(p.executors).length) { item.children.push({ id: 'executors', - path: '/' + ['packages', p.name, 'executors'].join('/'), + path: '/' + ['nx-api', p.name, 'executors'].join('/'), name: 'executors', children: Object.values(p.executors).map((e) => ({ id: e.name, - path: '/' + ['packages', p.name, 'executors', e.name].join('/'), + path: '/' + ['nx-api', p.name, 'executors', e.name].join('/'), name: e.name, children: [], isExternal: false, @@ -251,11 +251,11 @@ function createPackagesMenu(packages: PackageManifest): { if (!!Object.values(p.generators).length) { item.children.push({ id: 'generators', - path: '/' + ['packages', p.name, 'generators'].join('/'), + path: '/' + ['nx-api', p.name, 'generators'].join('/'), name: 'generators', children: Object.values(p.generators).map((g) => ({ id: g.name, - path: '/' + ['packages', p.name, 'generators', g.name].join('/'), + path: '/' + ['nx-api', p.name, 'generators', g.name].join('/'), name: g.name, children: [], isExternal: false, @@ -267,7 +267,7 @@ function createPackagesMenu(packages: PackageManifest): { } return item; }); - return { id: 'packages', menu: packagesMenu }; + return { id: 'nx-api', menu: packagesMenu }; } function getDocumentMenus(manifests: DocumentManifest[]): { @@ -289,7 +289,7 @@ function createPackagesManifest(packages: PackageMetadata[]): { const packagesManifest: { id: string; records: Record; - } = { id: 'packages', records: {} }; + } = { id: 'nx-api', records: {} }; packages.forEach((p) => { packagesManifest.records[p.name] = { @@ -301,7 +301,7 @@ function createPackagesManifest(packages: PackageMetadata[]): { p.documents.map((d) => documentRecurseOperations( d, - createDocumentMetadata({ id: p.name, path: 'packages/' }) + createDocumentMetadata({ id: p.name, path: 'nx-api/' }) ) ), 'path' @@ -311,18 +311,18 @@ function createPackagesManifest(packages: PackageMetadata[]): { executors: convertToDictionary( p.executors.map((e) => ({ ...e, - path: generatePath({ id: e.name, path: e.path }, 'packages'), + path: generatePath({ id: e.name, path: e.path }, 'nx-api'), })), 'path' ), generators: convertToDictionary( p.generators.map((g) => ({ ...g, - path: generatePath({ id: g.name, path: g.path }, 'packages'), + path: generatePath({ id: g.name, path: g.path }, 'nx-api'), })), 'path' ), - path: generatePath({ id: p.name, path: '' }, 'packages'), + path: generatePath({ id: p.name, path: '' }, 'nx-api'), }; }); diff --git a/scripts/documentation/internal-link-checker.ts b/scripts/documentation/internal-link-checker.ts index 6dd5c2b60763c..c25a6f5061709 100644 --- a/scripts/documentation/internal-link-checker.ts +++ b/scripts/documentation/internal-link-checker.ts @@ -87,7 +87,7 @@ function readSiteMapLinks(filePath: string): string[] { * This function checks if a link is for a private package. * When link is for a private package, it is not included in the sitemap. * However, some shared docs might be written for this private package during development. - * @param link e.g. /packages/vite/generators/configuration + * @param link e.g. /nx-api/vite/generators/configuration * @returns true if the link is for a private package or NODE_ENV is not development, false otherwise. */ function checkLinkIsForPrivatePackage(link: string) { @@ -96,10 +96,10 @@ function checkLinkIsForPrivatePackage(link: string) { return false; } const pathSegments = link.split('/').filter(Boolean); - if (pathSegments[0] === 'packages') { + if (pathSegments[0] === 'nx-api') { const packageJsonPath = join( workspaceRoot, - pathSegments[0], + 'packages', pathSegments[1], 'package.json' ); diff --git a/scripts/documentation/plugin-quality-indicators.ts b/scripts/documentation/plugin-quality-indicators.ts index 7558fa98e93ae..af40ae56dcdcf 100644 --- a/scripts/documentation/plugin-quality-indicators.ts +++ b/scripts/documentation/plugin-quality-indicators.ts @@ -12,7 +12,7 @@ interface PluginRegistry { url: string; } -const packagesJson = require('../../nx-dev/nx-dev/public/documentation/generated/manifests/packages.json'); +const packagesJson = require('../../nx-dev/nx-dev/public/documentation/generated/manifests/nx-api.json'); const officialPlugins = Object.keys(packagesJson) .filter( (m: any) => @@ -75,7 +75,7 @@ async function main() { }); writeFileSync( - './nx-dev/nx-dev/pages/extending-nx/quality-indicators.json', + './nx-dev/nx-dev/pages/quality-indicators.json', JSON.stringify(qualityIndicators, null, 2) ); } catch (ex) { diff --git a/tools/documentation/create-embeddings/src/main.mts b/tools/documentation/create-embeddings/src/main.mts index d0c1c66d8b535..3c0ceac8a4052 100644 --- a/tools/documentation/create-embeddings/src/main.mts +++ b/tools/documentation/create-embeddings/src/main.mts @@ -18,7 +18,7 @@ import mapJson from '../../../../docs/map.json' assert { type: 'json' }; import manifestsCloud from '../../../../docs/generated/manifests/cloud.json' assert { type: 'json' }; import manifestsExtending from '../../../../docs/generated/manifests/extending-nx.json' assert { type: 'json' }; import manifestsNx from '../../../../docs/generated/manifests/nx.json' assert { type: 'json' }; -import manifestsPackages from '../../../../docs/generated/manifests/packages.json' assert { type: 'json' }; +import manifestsPackages from '../../../../docs/generated/manifests/nx-api.json' assert { type: 'json' }; import manifestsTags from '../../../../docs/generated/manifests/tags.json' assert { type: 'json' }; import communityPlugins from '../../../../community/approved-plugins.json' assert { type: 'json' };