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

docs(nx-dev): make recipes to nx section

Browse Source
This commit is contained in:
Miroslav Jonas 2023-07-24 11:09:34 +02:00 committed by Juri Strumpflohner
parent 42a06b67d2
commit 09b70521e7
14 changed files with 4640 additions and 1663 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1727
docs/generated/manifests/menus.json
View File

File diff suppressed because it is too large Load Diff

2680
docs/generated/manifests/nx.json
View File

File diff suppressed because it is too large Load Diff

84
docs/generated/manifests/tags.json
View File

@ -79,6 +79,13 @@
"name": "Customizing Inputs", "name": "Customizing Inputs",
"path": "/concepts/more-concepts/customizing-inputs" "path": "/concepts/more-concepts/customizing-inputs"
}, },
{
"description": "",
"file": "shared/recipes/troubleshoot-cache-misses",
"id": "troubleshoot-cache-misses",
"name": "Troubleshoot Cache Misses",
"path": "/recipes/troubleshooting/troubleshoot-cache-misses"
},
{ {
"description": "", "description": "",
"file": "", "file": "",
@ -114,13 +121,6 @@
"name": "Project Configuration reference: inputs and namedInputs", "name": "Project Configuration reference: inputs and namedInputs",
"path": "/reference/project-configuration#inputs-&-namedinputs" "path": "/reference/project-configuration#inputs-&-namedinputs"
}, },
{
"description": "",
"file": "shared/recipes/troubleshoot-cache-misses",
"id": "troubleshoot-cache-misses",
"name": "Troubleshoot Cache Misses",
"path": "/recipes/troubleshooting/troubleshoot-cache-misses"
},
{ {
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "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/connect-to-nx-cloud", "file": "generated/packages/generated/packages/nx/documents/connect-to-nx-cloud",
@ -211,13 +211,6 @@
"name": "Illustrated Distributed Task Execution", "name": "Illustrated Distributed Task Execution",
"path": "/concepts/more-concepts/illustrated-dte" "path": "/concepts/more-concepts/illustrated-dte"
}, },
{
"description": "",
"file": "",
"id": "nx-cloud-documentation",
"name": "Nx Cloud Documentation",
"path": "/nx-cloud/intro/what-is-nx-cloud"
},
{ {
"description": "", "description": "",
"file": "shared/ci-overview", "file": "shared/ci-overview",
@ -225,6 +218,13 @@
"name": "CI Setup", "name": "CI Setup",
"path": "/recipes/ci/ci-setup" "path": "/recipes/ci/ci-setup"
}, },
{
"description": "",
"file": "",
"id": "nx-cloud-documentation",
"name": "Nx Cloud Documentation",
"path": "/nx-cloud/intro/what-is-nx-cloud"
},
{ {
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "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/connect-to-nx-cloud", "file": "generated/packages/generated/packages/nx/documents/connect-to-nx-cloud",
@ -350,20 +350,6 @@
"name": "Grouping Libraries", "name": "Grouping Libraries",
"path": "/concepts/more-concepts/grouping-libraries" "path": "/concepts/more-concepts/grouping-libraries"
}, },
{
"description": "",
"file": "shared/reference/nxignore",
"id": "nxignore",
"name": ".nxignore",
"path": "/reference/nxignore"
},
{
"description": "",
"file": "",
"id": "nxjson-workspaceLayout",
"name": "nx.json workspaceLayout property",
"path": "/reference/nx-json#workspace-layout"
},
{ {
"description": "", "description": "",
"file": "shared/recipes/ban-dependencies-with-tags", "file": "shared/recipes/ban-dependencies-with-tags",
@ -392,6 +378,20 @@
"name": "Tags Allow List", "name": "Tags Allow List",
"path": "/recipes/enforce-module-boundaries/tags-allow-list" "path": "/recipes/enforce-module-boundaries/tags-allow-list"
}, },
{
"description": "",
"file": "shared/reference/nxignore",
"id": "nxignore",
"name": ".nxignore",
"path": "/reference/nxignore"
},
{
"description": "",
"file": "",
"id": "nxjson-workspaceLayout",
"name": "nx.json workspaceLayout property",
"path": "/reference/nx-json#workspace-layout"
},
{ {
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.", "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-check", "file": "generated/packages/generated/packages/nx/documents/format-check",
@ -436,13 +436,6 @@
"name": "Incremental Builds", "name": "Incremental Builds",
"path": "/concepts/more-concepts/incremental-builds" "path": "/concepts/more-concepts/incremental-builds"
}, },
{
"description": "",
"file": "shared/reference/project-configuration",
"id": "project-configuration",
"name": "Project Configuration",
"path": "/reference/project-configuration"
},
{ {
"description": "", "description": "",
"file": "shared/recipes/module-federation-with-ssr", "file": "shared/recipes/module-federation-with-ssr",
@ -478,6 +471,13 @@
"name": "Running Custom Commands", "name": "Running Custom Commands",
"path": "/recipes/tips-n-tricks/run-commands-executor" "path": "/recipes/tips-n-tricks/run-commands-executor"
}, },
{
"description": "",
"file": "shared/reference/project-configuration",
"id": "project-configuration",
"name": "Project Configuration",
"path": "/reference/project-configuration"
},
{ {
"description": "", "description": "",
"file": "shared/recipes/plugins/local-executors", "file": "shared/recipes/plugins/local-executors",
@ -649,13 +649,6 @@
} }
], ],
"environment-variables": [ "environment-variables": [
{
"description": "",
"file": "shared/reference/environment-variables",
"id": "environment-variables",
"name": "Environment Variables",
"path": "/reference/environment-variables"
},
{ {
"description": "", "description": "",
"file": "shared/guides/use-environment-variables-in-angular", "file": "shared/guides/use-environment-variables-in-angular",
@ -683,6 +676,13 @@
"id": "define-environment-variables", "id": "define-environment-variables",
"name": "Define Environment Variables", "name": "Define Environment Variables",
"path": "/recipes/tips-n-tricks/define-environment-variables" "path": "/recipes/tips-n-tricks/define-environment-variables"
},
{
"description": "",
"file": "shared/reference/environment-variables",
"id": "environment-variables",
"name": "Environment Variables",
"path": "/reference/environment-variables"
} }
], ],
"module-federation": [ "module-federation": [

1070
docs/map.json
View File

File diff suppressed because it is too large Load Diff

8
docs/shared/migration/migration-angular.md
View File

@ -77,11 +77,11 @@ After the changes are applied, your workspace file structure should look similar
### Older Versions of Angular ### Older Versions of Angular
Support for workspaces with multiple applications and libraries was added in Nx v14.1.0. If you are migrating using an older version of Nx, your workspace can only contain one application and no libraries in order to use the automated migration, otherwise, you can still [migrate manually](/recipes/angular/migration/manual). Support for workspaces with multiple applications and libraries was added in Nx v14.1.0. If you are migrating using an older version of Nx, your workspace can only contain one application and no libraries in order to use the automated migration, otherwise, you can still [migrate manually](/recipes/angular/migration/angular-manual).
### Modified Folder Structure ### Modified Folder Structure
The automated migration supports Angular CLI workspaces with a standard structure, configurations and features. If your workspace has deviated from what the Angular CLI generates, you might not be able to use the automated migration and you will need to [manually migrate your workspace](/recipes/angular/migration/manual). The automated migration supports Angular CLI workspaces with a standard structure, configurations and features. If your workspace has deviated from what the Angular CLI generates, you might not be able to use the automated migration and you will need to [manually migrate your workspace](/recipes/angular/migration/angular-manual).
Currently, the automated migration supports workspaces using the following executors (builders): Currently, the automated migration supports workspaces using the following executors (builders):
@ -152,8 +152,8 @@ If you're not ready to make the change yet, you can come back to this later:
{% card title="Nx and the Angular CLI" description="Differences between Nx and the Angular CLI" type="documentation" url="/concepts/more-concepts/nx-and-angular" /%} {% card title="Nx and the Angular CLI" description="Differences between Nx and the Angular CLI" type="documentation" url="/concepts/more-concepts/nx-and-angular" /%}
{% card title="Angular CLI manual migration" description="Add Nx by hand" type="documentation" url="/recipes/angular/migration/manual" /%} {% card title="Angular CLI manual migration" description="Add Nx by hand" type="documentation" url="/recipes/angular/migration/angular-manual" /%}
{% card title="Multiple Angular Repositories to one Nx Workspace" description="Combine multiple Angular CLI workspaces into one Nx workspace" type="documentation" url="/recipes/angular/migration/multiple" /%} {% card title="Multiple Angular Repositories to one Nx Workspace" description="Combine multiple Angular CLI workspaces into one Nx workspace" type="documentation" url="/recipes/angular/migration/angular-multiple" /%}
{% /cards %} {% /cards %}

187
docs/shared/reference/sitemap.md
View File

@ -89,9 +89,98 @@
- [How the Project Graph is Built](/concepts/more-concepts/how-project-graph-is-built) - [How the Project Graph is Built](/concepts/more-concepts/how-project-graph-is-built)
- [Nx and the Nx Wrapper](/concepts/more-concepts/nx-and-the-wrapper) - [Nx and the Nx Wrapper](/concepts/more-concepts/nx-and-the-wrapper)
- [Managing your Global Nx Installation](/concepts/more-concepts/global-nx) - [Managing your Global Nx Installation](/concepts/more-concepts/global-nx)
- [All Recipes »](/recipes) - [Recipes](/recipes)
- [CI Setup](/recipes/ci/ci-setup)
- [Adopting Nx](/recipes/adopting-nx) - [Adopting Nx](/recipes/adopting-nx)
- [NPM/Yarn/PNPM workspaces](/recipes/adopting-nx/adding-to-monorepo)
- [Add to any Project](/recipes/adopting-nx/adding-to-existing-project)
- [Nx and Lerna](/recipes/adopting-nx/lerna-and-nx)
- [Preserving Git Histories](/recipes/adopting-nx/preserving-git-histories)
- [Manual migration](/recipes/adopting-nx/manual)
- [Angular](/recipes/angular)
- [Migration](/recipes/angular/migration)
- [Migrating from Angular CLI](/recipes/angular/migration/angular)
- [Migrating From Multiple Angular CLI Repos](/recipes/angular/migration/angular-multiple)
- [Migrating Angular Application manually](/recipes/angular/migration/angular-manual)
- [Migrating from AngularJS](/recipes/angular/migration/angularjs)
- [Use Environment Variables in Angular](/recipes/angular/use-environment-variables-in-angular)
- [Using Tailwind CSS with Angular projects](/recipes/angular/using-tailwind-css-with-angular-projects)
- [Setup Module Federation with SSR for Angular](/recipes/angular/module-federation-with-ssr)
- [Advanced Micro Frontends with Angular using Dynamic Federation](/recipes/angular/dynamic-module-federation-with-angular)
- [Setup incremental builds for Angular applications](/recipes/angular/setup-incremental-builds-angular)
- [React](/recipes/react)
- [Migrating from CRA](/recipes/react/migration-cra)
- [React 18 Migration](/recipes/react/react-18)
- [React Native with Nx](/recipes/react/react-native)
- [Remix with Nx](/recipes/react/remix)
- [Use Environment Variables in React](/recipes/react/use-environment-variables-in-react)
- [Using Tailwind CSS in React](/recipes/react/using-tailwind-css-in-react)
- [Adding Images, Fonts, and Files](/recipes/react/adding-assets-react)
- [Setup Module Federation with SSR for React](/recipes/react/module-federation-with-ssr)
- [Deploying Next.js applications to Vercel](/recipes/react/deploy-nextjs-to-vercel)
- [Node](/recipes/node)
- [Deploying a Node App to Fly.io](/recipes/node/node-server-fly-io)
- [Add and Deploy Netlify Edge Functions with Node](/recipes/node/node-serverless-functions-netlify)
- [Deploying AWS lambda in Node.js](/recipes/node/node-aws-lambda)
- [Storybook](/recipes/storybook)
- [One main Storybook instance for all projects](/recipes/storybook/one-storybook-for-all)
- [One Storybook instance per scope](/recipes/storybook/one-storybook-per-scope)
- [One main Storybook instance using Storybook Composition](/recipes/storybook/one-storybook-with-composition)
- [Enforce Module Boundaries](/recipes/enforce-module-boundaries)
- [Ban Dependencies with Certain Tags](/recipes/enforce-module-boundaries/ban-dependencies-with-tags)
- [Tag in Multiple Dimensions](/recipes/enforce-module-boundaries/tag-multiple-dimensions)
- [Ban External Imports](/recipes/enforce-module-boundaries/ban-external-imports)
- [Tags Allow List](/recipes/enforce-module-boundaries/tags-allow-list)
- [CI](/recipes/ci)
- [CI Setup](/recipes/ci/ci-setup)
- [Prepare applications for deployment via CI](/recipes/ci/ci-deployment)
- [Setting up Azure Pipelines](/recipes/ci/monorepo-ci-azure)
- [Setting up CircleCI](/recipes/ci/monorepo-ci-circle-ci)
- [Setting up GitHub Actions](/recipes/ci/monorepo-ci-github-actions)
- [Setting up Jenkins](/recipes/ci/monorepo-ci-jenkins)
- [Setting up GitLab](/recipes/ci/monorepo-ci-gitlab)
- [Setting up Bitbucket](/recipes/ci/monorepo-ci-bitbucket-pipelines)
- [Nx Console](/recipes/nx-console)
- [Telemetry](/recipes/nx-console/console-telemetry)
- [Generate Command](/recipes/nx-console/console-generate-command)
- [Run Command](/recipes/nx-console/console-run-command)
- [Add Dependency Command](/recipes/nx-console/console-add-dependency-command)
- [Project Pane](/recipes/nx-console/console-project-pane)
- [Keyboard Shortcuts](/recipes/nx-console/console-shortcuts)
- [Troubleshooting](/recipes/troubleshooting)
- [Resolve Circular Dependencies](/recipes/troubleshooting/resolve-circular-dependencies)
- [Troubleshooting Nx Install Issues](/recipes/troubleshooting/troubleshoot-nx-install-issues)
- [Troubleshoot Cache Misses](/recipes/troubleshooting/troubleshoot-cache-misses)
- [Unknown Local Cache Error](/recipes/troubleshooting/unknown-local-cache)
- [Profiling Build Performance](/recipes/troubleshooting/performance-profiling)
- [Tips and tricks](/recipes/tips-n-tricks)
- [Configuring ESLint with Typescript](/recipes/tips-n-tricks/eslint)
- [Define Environment Variables](/recipes/tips-n-tricks/define-environment-variables)
- [Configuring Browser Support](/recipes/tips-n-tricks/browser-support)
- [Include Assets in Build](/recipes/tips-n-tricks/include-assets-in-build)
- [Include All package.json Files as Projects](/recipes/tips-n-tricks/include-all-packagejson)
- [Identify Dependencies Between Folders](/recipes/tips-n-tricks/identify-dependencies-between-folders)
- [Run Root-Level NPM Scripts with Nx](/recipes/tips-n-tricks/root-level-scripts)
- [Disable Graph Links Created from Analyzing Source Files](/recipes/tips-n-tricks/analyze-source-files)
- [Workspace Watching](/recipes/tips-n-tricks/workspace-watching)
- [Convert from a Standalone Repository to an Integrated Repository](/recipes/tips-n-tricks/standalone-to-integrated)
- [Use JavaScript instead TypeScript](/recipes/tips-n-tricks/js-and-ts)
- [Altering Migration Process](/recipes/tips-n-tricks/advanced-update)
- [Running Custom Commands](/recipes/tips-n-tricks/run-commands-executor)
- [Other](/recipes/other)
- [Serverless deployment with Deno Deploy](/recipes/other/deno-deploy)
- [Add and Deploy Netlify Edge Functions with Deno](/recipes/other/deno-netlify-functions)
- [Rescope Packages from @nrwl to @nx](/recipes/other/rescope)
- [Example Repos](/recipes/example-repos)
- [Powering Up React Development With Nx](/recipes/example-repos/react-nx)
- [Using Apollo GraphQL](/recipes/example-repos/apollo-react)
- [Using Prisma with NestJS](/recipes/example-repos/nestjs-prisma)
- [Using Mongo with Fastify](/recipes/example-repos/mongo-fastify)
- [Using Redis with Fastify](/recipes/example-repos/redis-fastify)
- [Using Postgres with Fastify](/recipes/example-repos/postgres-fastify)
- [Using PlanetScale with Serverless Fastify](/recipes/example-repos/serverless-fastify-planetscale)
- [Large Repo and Caching](/recipes/example-repos/caching)
- [Large Repo and DTE](/recipes/example-repos/dte)
- [Nx Micro-Frontend Example](/recipes/example-repos/mfe)
- [Reference](/reference) - [Reference](/reference)
- [Commands](/reference/commands) - [Commands](/reference/commands)
- [nx.json](/reference/nx-json) - [nx.json](/reference/nx-json)
@ -117,100 +206,6 @@
- [See Also](/see-also) - [See Also](/see-also)
- [Site Map](/see-also/sitemap) - [Site Map](/see-also/sitemap)
- Recipes
- [Migrating to Nx](/recipes/adopting-nx)
- [NPM/Yarn/PNPM workspaces](/recipes/adopting-nx/adding-to-monorepo)
- [Add to any Project](/recipes/adopting-nx/adding-to-existing-project)
- [Nx and Lerna](/recipes/adopting-nx/lerna-and-nx)
- [Preserving Git Histories](/recipes/adopting-nx/preserving-git-histories)
- [Manual migration](/recipes/adopting-nx/manual)
- [Angular](/recipes/angular)
- [Migration](/recipes/angular/migration)
- [Migrating from Angular CLI](/recipes/angular/migration/angular)
- [Migrating From Multiple Angular CLI Repos](/recipes/angular/migration/angular-multiple)
- [Migrating Angular Application manually](/recipes/angular/migration/angular-manual)
- [Migrating from AngularJS](/recipes/angular/migration/angularjs)
- [Use Environment Variables in Angular](/recipes/angular/use-environment-variables-in-angular)
- [Using Tailwind CSS with Angular projects](/recipes/angular/using-tailwind-css-with-angular-projects)
- [Setup Module Federation with SSR for Angular](/recipes/angular/module-federation-with-ssr)
- [Advanced Micro Frontends with Angular using Dynamic Federation](/recipes/angular/dynamic-module-federation-with-angular)
- [Setup incremental builds for Angular applications](/recipes/angular/setup-incremental-builds-angular)
- [React](/recipes/react)
- [Migrating from CRA](/recipes/react/migration-cra)
- [React 18 Migration](/recipes/react/react-18)
- [React Native with Nx](/recipes/react/react-native)
- [Remix with Nx](/recipes/react/remix)
- [Use Environment Variables in React](/recipes/react/use-environment-variables-in-react)
- [Using Tailwind CSS in React](/recipes/react/using-tailwind-css-in-react)
- [Adding Images, Fonts, and Files](/recipes/react/adding-assets-react)
- [Setup Module Federation with SSR for React](/recipes/react/module-federation-with-ssr)
- [Deploying Next.js applications to Vercel](/recipes/react/deploy-nextjs-to-vercel)
- [Node](/recipes/node)
- [Deploying a Node App to Fly.io](/recipes/node/node-server-fly-io)
- [Add and Deploy Netlify Edge Functions with Node](/recipes/node/node-serverless-functions-netlify)
- [Deploying AWS lambda in Node.js](/recipes/node/node-aws-lambda)
- [Storybook](/recipes/storybook)
- [One main Storybook instance for all projects](/recipes/storybook/one-storybook-for-all)
- [One Storybook instance per scope](/recipes/storybook/one-storybook-per-scope)
- [One main Storybook instance using Storybook Composition](/recipes/storybook/one-storybook-with-composition)
- [Enforce Module Boundaries](/recipes/enforce-module-boundaries)
- [Ban Dependencies with Certain Tags](/recipes/enforce-module-boundaries/ban-dependencies-with-tags)
- [Tag in Multiple Dimensions](/recipes/enforce-module-boundaries/tag-multiple-dimensions)
- [Ban External Imports](/recipes/enforce-module-boundaries/ban-external-imports)
- [Tags Allow List](/recipes/enforce-module-boundaries/tags-allow-list)
- [CI](/recipes/ci)
- [CI Setup](/recipes/ci/ci-setup)
- [Prepare applications for deployment via CI](/recipes/ci/ci-deployment)
- [Setting up Azure Pipelines](/recipes/ci/monorepo-ci-azure)
- [Setting up CircleCI](/recipes/ci/monorepo-ci-circle-ci)
- [Setting up GitHub Actions](/recipes/ci/monorepo-ci-github-actions)
- [Setting up Jenkins](/recipes/ci/monorepo-ci-jenkins)
- [Setting up GitLab](/recipes/ci/monorepo-ci-gitlab)
- [Setting up Bitbucket](/recipes/ci/monorepo-ci-bitbucket-pipelines)
- [Nx Console](/recipes/nx-console)
- [Telemetry](/recipes/nx-console/console-telemetry)
- [Generate Command](/recipes/nx-console/console-generate-command)
- [Run Command](/recipes/nx-console/console-run-command)
- [Add Dependency Command](/recipes/nx-console/console-add-dependency-command)
- [Project Pane](/recipes/nx-console/console-project-pane)
- [Keyboard Shortcuts](/recipes/nx-console/console-shortcuts)
- [Troubleshooting](/recipes/troubleshooting)
- [Resolve Circular Dependencies](/recipes/troubleshooting/resolve-circular-dependencies)
- [Troubleshooting Nx Install Issues](/recipes/troubleshooting/troubleshoot-nx-install-issues)
- [Troubleshoot Cache Misses](/recipes/troubleshooting/troubleshoot-cache-misses)
- [Unknown Local Cache Error](/recipes/troubleshooting/unknown-local-cache)
- [Profiling Build Performance](/recipes/troubleshooting/performance-profiling)
- [Tips and tricks](/recipes/tips-n-tricks)
- [Configuring ESLint with Typescript](/recipes/tips-n-tricks/eslint)
- [Define Environment Variables](/recipes/tips-n-tricks/define-environment-variables)
- [Configuring Browser Support](/recipes/tips-n-tricks/browser-support)
- [Include Assets in Build](/recipes/tips-n-tricks/include-assets-in-build)
- [Include All package.json Files as Projects](/recipes/tips-n-tricks/include-all-packagejson)
- [Identify Dependencies Between Folders](/recipes/tips-n-tricks/identify-dependencies-between-folders)
- [Run Root-Level NPM Scripts with Nx](/recipes/tips-n-tricks/root-level-scripts)
- [Disable Graph Links Created from Analyzing Source Files](/recipes/tips-n-tricks/analyze-source-files)
- [Workspace Watching](/recipes/tips-n-tricks/workspace-watching)
- [Convert from a Standalone Repository to an Integrated Repository](/recipes/tips-n-tricks/standalone-to-integrated)
- [Use JavaScript instead TypeScript](/recipes/tips-n-tricks/js-and-ts)
- [Altering Migration Process](/recipes/tips-n-tricks/advanced-update)
- [Running Custom Commands](/recipes/tips-n-tricks/run-commands-executor)
- [Other](/recipes/other)
- [Serverless deployment with Deno Deploy](/recipes/other/deno-deploy)
- [Add and Deploy Netlify Edge Functions with Deno](/recipes/other/deno-netlify-functions)
- [Rescope Packages from @nrwl to @nx](/recipes/other/rescope)
- [Example Repos](/recipes/example-repos)
- [Powering Up React Development With Nx](/recipes/example-repos/react-nx)
- [Using Apollo GraphQL](/recipes/example-repos/apollo-react)
- [Using Prisma with NestJS](/recipes/example-repos/nestjs-prisma)
- [Using Mongo with Fastify](/recipes/example-repos/mongo-fastify)
- [Using Redis with Fastify](/recipes/example-repos/redis-fastify)
- [Using Postgres with Fastify](/recipes/example-repos/postgres-fastify)
- [Using PlanetScale with Serverless Fastify](/recipes/example-repos/serverless-fastify-planetscale)
- [Large Repo and Caching](/recipes/example-repos/caching)
- [Large Repo and DTE](/recipes/example-repos/dte)
- [Nx Micro-Frontend Example](/recipes/example-repos/mfe)
- Extending-nx - Extending-nx
- [Intro](/extending-nx/intro) - [Intro](/extending-nx/intro)

2
nx-dev/nx-dev/pages/[...segments].tsx
View File

@ -80,7 +80,7 @@ export default function NxDocumentation({
} }
export const getStaticPaths: GetStaticPaths = () => { export const getStaticPaths: GetStaticPaths = () => {
const reservedPaths = ['/recipes', '/nx-cloud', '/packages', '/changelog']; const reservedPaths = ['/nx-cloud', '/packages', '/changelog'];
return { return {
paths: nxDocumentationApi paths: nxDocumentationApi
.getSlugsStaticDocumentPaths() .getSlugsStaticDocumentPaths()

113
nx-dev/nx-dev/pages/recipes/[...segments].tsx
View File

@ -1,113 +0,0 @@
import { getBasicRecipesSection } from '@nx/nx-dev/data-access-menu';
import { DocViewer } from '@nx/nx-dev/feature-doc-viewer';
import { ProcessedDocument, RelatedDocument } from '@nx/nx-dev/models-document';
import { Menu, MenuItem } from '@nx/nx-dev/models-menu';
import { DocumentationHeader, SidebarContainer } from '@nx/nx-dev/ui-common';
import { GetStaticPaths, GetStaticProps } from 'next';
import { useRouter } from 'next/router';
import { useEffect, useRef } from 'react';
import { menusApi } from '../../lib/menus.api';
import { useNavToggle } from '../../lib/navigation-toggle.effect';
import { nxRecipesApi } from '../../lib/recipes.api';
import { tagsApi } from '../../lib/tags.api';
export default function Recipes({
document,
menu,
relatedDocuments,
}: {
document: ProcessedDocument;
menu: MenuItem[];
relatedDocuments: RelatedDocument[];
}): JSX.Element {
const router = useRouter();
const { toggleNav, navIsOpen } = useNavToggle();
const wrapperElement = useRef(null);
useEffect(() => {
const handleRouteChange = (url: string) => {
if (url.includes('#')) return;
if (!wrapperElement) return;
(wrapperElement as any).current.scrollTo({
top: 0,
left: 0,
behavior: 'smooth',
});
};
router.events.on('routeChangeComplete', handleRouteChange);
return () => router.events.off('routeChangeComplete', handleRouteChange);
}, [router, wrapperElement]);
const vm: {
document: ProcessedDocument;
menu: Menu;
relatedDocuments: RelatedDocument[];
} = {
document,
menu: {
sections: [getBasicRecipesSection(menu)],
},
relatedDocuments,
};
return (
<div id="shell" className="flex h-full flex-col">
<div className="w-full flex-shrink-0">
<DocumentationHeader isNavOpen={navIsOpen} toggleNav={toggleNav} />
</div>
<main
id="main"
role="main"
className="flex h-full flex-1 overflow-y-hidden"
>
<SidebarContainer menu={vm.menu} navIsOpen={navIsOpen} />
<div
ref={wrapperElement}
id="wrapper"
data-testid="wrapper"
className="relative flex flex-grow flex-col items-stretch justify-start overflow-y-scroll"
>
<DocViewer
document={vm.document}
relatedDocuments={vm.relatedDocuments}
/>
</div>
</main>
</div>
);
}
export const getStaticPaths: GetStaticPaths = () => {
return {
paths: nxRecipesApi.getSlugsStaticDocumentPaths(),
fallback: 'blocking',
};
};
export const getStaticProps: GetStaticProps = async ({
params,
}: {
params: { segments: string[] };
}) => {
try {
const segments = ['recipes', ...params.segments];
const document = nxRecipesApi.getDocument(segments);
return {
props: {
document,
relatedDocuments: tagsApi
.getAssociatedItemsFromTags(document.tags)
.filter((item) => item.path !== '/' + segments.join('/')), // Remove currently displayed item
menu: menusApi.getMenu('recipes', ''),
},
};
} catch (e) {
return {
notFound: true,
props: {
statusCode: 404,
},
};
}
};

96
nx-dev/nx-dev/pages/recipes/index.tsx
View File

@ -1,96 +0,0 @@
import { getBasicRecipesSection } from '@nx/nx-dev/data-access-menu';
import { DocViewer } from '@nx/nx-dev/feature-doc-viewer';
import { ProcessedDocument, RelatedDocument } from '@nx/nx-dev/models-document';
import { Menu, MenuItem } from '@nx/nx-dev/models-menu';
import { DocumentationHeader, SidebarContainer } from '@nx/nx-dev/ui-common';
import { GetStaticProps } from 'next';
import { useRouter } from 'next/router';
import { useEffect, useRef } from 'react';
import { menusApi } from '../../lib/menus.api';
import { useNavToggle } from '../../lib/navigation-toggle.effect';
import { nxRecipesApi } from '../../lib/recipes.api';
import { tagsApi } from '../../lib/tags.api';
export default function RecipesRoot({
document,
menu,
relatedDocuments,
}: {
document: ProcessedDocument;
menu: MenuItem[];
relatedDocuments: RelatedDocument[];
}) {
const router = useRouter();
const { toggleNav, navIsOpen } = useNavToggle();
const wrapperElement = useRef(null);
useEffect(() => {
const handleRouteChange = (url: string) => {
if (url.includes('#')) return;
if (!wrapperElement) return;
(wrapperElement as any).current.scrollTo({
top: 0,
left: 0,
behavior: 'smooth',
});
};
router.events.on('routeChangeComplete', handleRouteChange);
return () => router.events.off('routeChangeComplete', handleRouteChange);
}, [router, wrapperElement]);
const vm: {
document: ProcessedDocument;
menu: Menu;
relatedDocuments: RelatedDocument[];
} = {
document,
menu: {
sections: [getBasicRecipesSection(menu)],
},
relatedDocuments,
};
return (
<div id="shell" className="flex h-full flex-col">
<div className="w-full flex-shrink-0">
<DocumentationHeader isNavOpen={navIsOpen} toggleNav={toggleNav} />
</div>
<main
id="main"
role="main"
className="flex h-full flex-1 overflow-y-hidden"
>
<SidebarContainer menu={vm.menu} navIsOpen={navIsOpen} />
<div
ref={wrapperElement}
id="wrapper"
data-testid="wrapper"
className="relative flex flex-grow flex-col items-stretch justify-start overflow-y-scroll"
>
<DocViewer
document={document}
relatedDocuments={vm.relatedDocuments}
/>
</div>
</main>
</div>
);
}
export const getStaticProps: GetStaticProps = async () => {
const document = nxRecipesApi.generateRootDocumentIndex({
name: 'Recipes',
description: 'Learn quickly how to do things with Nx.',
});
return {
props: {
document,
menu: menusApi.getMenu('recipes', ''),
relatedDocuments: document.tags
.map((t) => tagsApi.getAssociatedItems(t))
.flat(),
},
};
};

4
nx-dev/nx-dev/redirect-rules.js
View File

@ -738,9 +738,9 @@ const latestRecipesRefactoring = {
'/recipes/adopting-nx-angular/angular-integrated': '/recipes/adopting-nx-angular/angular-integrated':
'/recipes/angular/migration/angular', '/recipes/angular/migration/angular',
'/recipes/adopting-nx-angular/angular-manual': '/recipes/adopting-nx-angular/angular-manual':
'/recipes/angular/migration/manual', '/recipes/angular/migration/angular-manual',
'/recipes/adopting-nx-angular/angular-multiple': '/recipes/adopting-nx-angular/angular-multiple':
'/recipes/angular/migration/multiple', '/recipes/angular/migration/angular-multiple',
'/recipes/adopting-nx/migration-angularjs': '/recipes/adopting-nx/migration-angularjs':
'/recipes/angular/migration/angularjs', '/recipes/angular/migration/angularjs',
'/recipes/environment-variables/use-environment-variables-in-angular': '/recipes/environment-variables/use-environment-variables-in-angular':

9
nx-dev/ui-common/src/lib/documentation-header.tsx
View File

@ -41,10 +41,8 @@ export function DocumentationHeader({
const isNxCloud: boolean = router.asPath.startsWith('/nx-cloud'); const isNxCloud: boolean = router.asPath.startsWith('/nx-cloud');
const isPackages: boolean = router.asPath.startsWith('/packages'); const isPackages: boolean = router.asPath.startsWith('/packages');
const isPlugins: boolean = router.asPath.startsWith('/extending-nx'); const isPlugins: boolean = router.asPath.startsWith('/extending-nx');
const isRecipes: boolean = router.asPath.startsWith('/recipes');
const isChangelog: boolean = router.asPath.startsWith('/changelog'); const isChangelog: boolean = router.asPath.startsWith('/changelog');
const isNx: boolean = const isNx: boolean = !isNxCloud && !isPackages && !isPlugins && !isChangelog;
!isNxCloud && !isPackages && !isPlugins && !isRecipes && !isChangelog;
const sections = [ const sections = [
{ name: 'Nx', href: '/getting-started/intro', current: isNx }, { name: 'Nx', href: '/getting-started/intro', current: isNx },
@ -63,11 +61,6 @@ export function DocumentationHeader({
href: '/packages', href: '/packages',
current: isPackages, current: isPackages,
}, },
{
name: 'Recipes',
href: '/recipes',
current: isRecipes,
},
{ {
name: 'Changelog', name: 'Changelog',
href: '/changelog', href: '/changelog',

8
nx-dev/ui-common/src/lib/sidebar.tsx
View File

@ -180,8 +180,7 @@ export function SidebarMobile({
const isNxCloud: boolean = router.asPath.startsWith('/nx-cloud'); const isNxCloud: boolean = router.asPath.startsWith('/nx-cloud');
const isPackages: boolean = router.asPath.startsWith('/packages'); const isPackages: boolean = router.asPath.startsWith('/packages');
const isPlugins: boolean = router.asPath.startsWith('/extending-nx'); const isPlugins: boolean = router.asPath.startsWith('/extending-nx');
const isRecipes: boolean = router.asPath.startsWith('/recipes'); const isNx: boolean = !isNxCloud && !isPackages && !isPlugins;
const isNx: boolean = !isNxCloud && !isPackages && !isPlugins && !isRecipes;
const sections = [ const sections = [
{ name: 'Home', href: '/', current: false }, { name: 'Home', href: '/', current: false },
@ -201,11 +200,6 @@ export function SidebarMobile({
href: '/extending-nx/intro/getting-started', href: '/extending-nx/intro/getting-started',
current: isPlugins, current: isPlugins,
}, },
{
name: 'Recipes',
href: '/recipes',
current: isRecipes,
},
]; ];
return ( return (
<Transition.Root show={navIsOpen} as={Fragment}> <Transition.Root show={navIsOpen} as={Fragment}>

6
scripts/documentation/generators/generate-manifests.ts
View File

@ -361,12 +361,6 @@ function createDocumentSections(
.itemList as Partial<DocumentMetadata>[], .itemList as Partial<DocumentMetadata>[],
prefix: '', prefix: '',
}, },
{
name: 'recipes',
content: documents.find((x) => x.id === 'nx-recipes')!
.itemList as Partial<DocumentMetadata>[],
prefix: 'recipes',
},
{ {
name: 'extending-nx', name: 'extending-nx',
content: documents.find((x) => x.id === 'extending-nx')! content: documents.find((x) => x.id === 'extending-nx')!

309
tsconfig.base.json
View File

@ -8,136 +8,61 @@
"experimentalDecorators": true, "experimentalDecorators": true,
"emitDecoratorMetadata": true, "emitDecoratorMetadata": true,
"skipLibCheck": true, "skipLibCheck": true,
"types": [ "types": ["node", "jest"],
"node", "lib": ["es2019"],
"jest"
],
"lib": [
"es2019"
],
"declaration": true, "declaration": true,
"resolveJsonModule": true, "resolveJsonModule": true,
"baseUrl": ".", "baseUrl": ".",
"rootDir": ".", "rootDir": ".",
"allowJs": true, "allowJs": true,
"paths": { "paths": {
"@nrwl/tao": [ "@nrwl/tao": ["packages/tao"],
"packages/tao" "@nrwl/tao/*": ["packages/tao/*"],
], "@nx/angular": ["packages/angular"],
"@nrwl/tao/*": [ "@nx/angular/*": ["packages/angular/*"],
"packages/tao/*" "@nx/cypress": ["packages/cypress"],
], "@nx/cypress/*": ["packages/cypress/*"],
"@nx/angular": [ "@nx/detox": ["packages/detox"],
"packages/angular" "@nx/devkit": ["packages/devkit"],
], "@nx/devkit/*": ["packages/devkit/*"],
"@nx/angular/*": [ "@nx/docs": ["docs"],
"packages/angular/*" "@nx/docs/*": ["docs/*"],
], "@nx/e2e/utils": ["e2e/utils"],
"@nx/cypress": [ "@nx/esbuild": ["packages/esbuild"],
"packages/cypress" "@nx/eslint-plugin": ["packages/eslint-plugin/src"],
], "@nx/expo": ["packages/expo"],
"@nx/cypress/*": [ "@nx/expo/*": ["packages/expo/*"],
"packages/cypress/*" "@nx/express": ["packages/express"],
], "@nx/graph/ui-components": ["graph/ui-components/src/index.ts"],
"@nx/detox": [ "@nx/graph/ui-graph": ["graph/ui-graph/src/index.ts"],
"packages/detox" "@nx/graph/ui-tooltips": ["graph/ui-tooltips/src/index.ts"],
], "@nx/jest": ["packages/jest"],
"@nx/devkit": [ "@nx/jest/*": ["packages/jest/*"],
"packages/devkit" "@nx/js": ["packages/js/src"],
], "@nx/js/*": ["packages/js/*"],
"@nx/devkit/*": [ "@nx/linter": ["packages/linter"],
"packages/devkit/*" "@nx/linter/*": ["packages/linter/*"],
], "@nx/nest": ["packages/nest"],
"@nx/docs": [ "@nx/next": ["packages/next"],
"docs" "@nx/next/*": ["packages/next/*"],
], "@nx/node": ["packages/node"],
"@nx/docs/*": [ "@nx/node/*": ["packages/node/*"],
"docs/*" "@nx/nx-dev/data-access-ai": ["nx-dev/data-access-ai/src/index.ts"],
],
"@nx/e2e/utils": [
"e2e/utils"
],
"@nx/esbuild": [
"packages/esbuild"
],
"@nx/eslint-plugin": [
"packages/eslint-plugin/src"
],
"@nx/expo": [
"packages/expo"
],
"@nx/expo/*": [
"packages/expo/*"
],
"@nx/express": [
"packages/express"
],
"@nx/graph/ui-components": [
"graph/ui-components/src/index.ts"
],
"@nx/graph/ui-graph": [
"graph/ui-graph/src/index.ts"
],
"@nx/graph/ui-tooltips": [
"graph/ui-tooltips/src/index.ts"
],
"@nx/jest": [
"packages/jest"
],
"@nx/jest/*": [
"packages/jest/*"
],
"@nx/js": [
"packages/js/src"
],
"@nx/js/*": [
"packages/js/*"
],
"@nx/linter": [
"packages/linter"
],
"@nx/linter/*": [
"packages/linter/*"
],
"@nx/nest": [
"packages/nest"
],
"@nx/next": [
"packages/next"
],
"@nx/next/*": [
"packages/next/*"
],
"@nx/node": [
"packages/node"
],
"@nx/node/*": [
"packages/node/*"
],
"@nx/nx-dev/data-access-ai": [
"nx-dev/data-access-ai/src/index.ts"
],
"@nx/nx-dev/data-access-documents": [ "@nx/nx-dev/data-access-documents": [
"nx-dev/data-access-documents/src/index.ts" "nx-dev/data-access-documents/src/index.ts"
], ],
"@nx/nx-dev/data-access-documents/node-only": [ "@nx/nx-dev/data-access-documents/node-only": [
"nx-dev/data-access-documents/src/node.index.ts" "nx-dev/data-access-documents/src/node.index.ts"
], ],
"@nx/nx-dev/data-access-menu": [ "@nx/nx-dev/data-access-menu": ["nx-dev/data-access-menu/src/index.ts"],
"nx-dev/data-access-menu/src/index.ts"
],
"@nx/nx-dev/data-access-packages": [ "@nx/nx-dev/data-access-packages": [
"nx-dev/data-access-packages/src/index.ts" "nx-dev/data-access-packages/src/index.ts"
], ],
"@nx/nx-dev/data-access-packages/node-only": [ "@nx/nx-dev/data-access-packages/node-only": [
"nx-dev/data-access-packages/src/node.index.ts" "nx-dev/data-access-packages/src/node.index.ts"
], ],
"@nx/nx-dev/feature-ai": [ "@nx/nx-dev/feature-ai": ["nx-dev/feature-ai/src/index.ts"],
"nx-dev/feature-ai/src/index.ts" "@nx/nx-dev/feature-analytics": ["nx-dev/feature-analytics/src/index.ts"],
],
"@nx/nx-dev/feature-analytics": [
"nx-dev/feature-analytics/src/index.ts"
],
"@nx/nx-dev/feature-doc-viewer": [ "@nx/nx-dev/feature-doc-viewer": [
"nx-dev/feature-doc-viewer/src/index.ts" "nx-dev/feature-doc-viewer/src/index.ts"
], ],
@ -147,126 +72,46 @@
"@nx/nx-dev/feature-package-schema-viewer/*": [ "@nx/nx-dev/feature-package-schema-viewer/*": [
"nx-dev/feature-package-schema-viewer/*" "nx-dev/feature-package-schema-viewer/*"
], ],
"@nx/nx-dev/feature-search": [ "@nx/nx-dev/feature-search": ["nx-dev/feature-search/src/index.ts"],
"nx-dev/feature-search/src/index.ts" "@nx/nx-dev/models-document": ["nx-dev/models-document/src/index.ts"],
], "@nx/nx-dev/models-menu": ["nx-dev/models-menu/src/index.ts"],
"@nx/nx-dev/models-document": [ "@nx/nx-dev/models-package": ["nx-dev/models-package/src/index.ts"],
"nx-dev/models-document/src/index.ts" "@nx/nx-dev/ui-commands": ["nx-dev/ui-commands/src/index.ts"],
], "@nx/nx-dev/ui-common": ["nx-dev/ui-common/src/index.ts"],
"@nx/nx-dev/models-menu": [ "@nx/nx-dev/ui-community": ["nx-dev/ui-community/src/index.ts"],
"nx-dev/models-menu/src/index.ts" "@nx/nx-dev/ui-conference": ["nx-dev/ui-conference/src/index.ts"],
], "@nx/nx-dev/ui-home": ["nx-dev/ui-home/src/index.ts"],
"@nx/nx-dev/models-package": [ "@nx/nx-dev/ui-markdoc": ["nx-dev/ui-markdoc/src/index.ts"],
"nx-dev/models-package/src/index.ts" "@nx/nx-dev/ui-member-card": ["nx-dev/ui-member-card/src/index.ts"],
], "@nx/nx-dev/ui-primitives": ["nx-dev/ui-primitives/src/index.ts"],
"@nx/nx-dev/ui-commands": [ "@nx/nx-dev/ui-references": ["nx-dev/ui-references/src/index.ts"],
"nx-dev/ui-commands/src/index.ts" "@nx/nx-dev/ui-sponsor-card": ["nx-dev/ui-sponsor-card/src/index.ts"],
], "@nx/nx-dev/ui-theme": ["nx-dev/ui-theme/src/index.ts"],
"@nx/nx-dev/ui-common": [ "@nx/playwright": ["packages/playwright/index.ts"],
"nx-dev/ui-common/src/index.ts" "@nx/plugin": ["packages/plugin"],
], "@nx/plugin/*": ["packages/plugin/*"],
"@nx/nx-dev/ui-community": [ "@nx/react": ["packages/react"],
"nx-dev/ui-community/src/index.ts" "@nx/react-native": ["packages/react-native"],
], "@nx/react-native/*": ["packages/react-native/*"],
"@nx/nx-dev/ui-conference": [ "@nx/react/*": ["packages/react/*"],
"nx-dev/ui-conference/src/index.ts" "@nx/rollup": ["packages/rollup"],
], "@nx/rollup/*": ["packages/rollup/*"],
"@nx/nx-dev/ui-home": [ "@nx/storybook": ["packages/storybook"],
"nx-dev/ui-home/src/index.ts" "@nx/storybook/*": ["packages/storybook/*"],
], "@nx/typedoc-theme": ["typedoc-theme/src/index.ts"],
"@nx/nx-dev/ui-markdoc": [ "@nx/vite": ["packages/vite"],
"nx-dev/ui-markdoc/src/index.ts" "@nx/vite/*": ["packages/vite/*"],
], "@nx/web": ["packages/web"],
"@nx/nx-dev/ui-member-card": [ "@nx/web/*": ["packages/web/*"],
"nx-dev/ui-member-card/src/index.ts" "@nx/webpack": ["packages/webpack"],
], "@nx/webpack/*": ["packages/webpack/*"],
"@nx/nx-dev/ui-primitives": [ "@nx/workspace": ["packages/workspace"],
"nx-dev/ui-primitives/src/index.ts" "@nx/workspace/*": ["packages/workspace/*"],
], "@nx/workspace/testing": ["packages/workspace/testing"],
"@nx/nx-dev/ui-references": [ "create-nx-workspace": ["packages/create-nx-workspace/index.ts"],
"nx-dev/ui-references/src/index.ts" "create-nx-workspace/*": ["packages/create-nx-workspace/*"],
], "nx": ["packages/nx"],
"@nx/nx-dev/ui-sponsor-card": [ "nx/*": ["packages/nx/*"]
"nx-dev/ui-sponsor-card/src/index.ts"
],
"@nx/nx-dev/ui-theme": [
"nx-dev/ui-theme/src/index.ts"
],
"@nx/playwright": [
"packages/playwright/index.ts"
],
"@nx/plugin": [
"packages/plugin"
],
"@nx/plugin/*": [
"packages/plugin/*"
],
"@nx/react": [
"packages/react"
],
"@nx/react-native": [
"packages/react-native"
],
"@nx/react-native/*": [
"packages/react-native/*"
],
"@nx/react/*": [
"packages/react/*"
],
"@nx/rollup": [
"packages/rollup"
],
"@nx/rollup/*": [
"packages/rollup/*"
],
"@nx/storybook": [
"packages/storybook"
],
"@nx/storybook/*": [
"packages/storybook/*"
],
"@nx/typedoc-theme": [
"typedoc-theme/src/index.ts"
],
"@nx/vite": [
"packages/vite"
],
"@nx/vite/*": [
"packages/vite/*"
],
"@nx/web": [
"packages/web"
],
"@nx/web/*": [
"packages/web/*"
],
"@nx/webpack": [
"packages/webpack"
],
"@nx/webpack/*": [
"packages/webpack/*"
],
"@nx/workspace": [
"packages/workspace"
],
"@nx/workspace/*": [
"packages/workspace/*"
],
"@nx/workspace/testing": [
"packages/workspace/testing"
],
"create-nx-workspace": [
"packages/create-nx-workspace/index.ts"
],
"create-nx-workspace/*": [
"packages/create-nx-workspace/*"
],
"nx": [
"packages/nx"
],
"nx/*": [
"packages/nx/*"
]
} }
} }
} }