From ef0a509a00348d7e626dd112b9283e0c7ef439fa Mon Sep 17 00:00:00 2001 From: Victor Savkin Date: Tue, 15 Aug 2023 10:31:18 -0400 Subject: [PATCH] feat(repo): enable agents --- .circleci/config.yml | 143 ++++------------ .gitignore | 1 + .nx/workflows/agents.yaml | 57 +++++++ docs/generated/cli/affected-graph.md | 168 ------------------- docs/generated/cli/affected.md | 196 ---------------------- docs/generated/cli/connect.md | 30 ---- docs/generated/cli/create-nx-workspace.md | 182 -------------------- docs/generated/cli/daemon.md | 42 ----- docs/generated/cli/exec.md | 98 ----------- docs/generated/cli/format-check.md | 84 ---------- docs/generated/cli/format-write.md | 84 ---------- docs/generated/cli/generate.md | 98 ----------- docs/generated/cli/graph.md | 184 -------------------- docs/generated/cli/init.md | 84 ---------- docs/generated/cli/list.md | 50 ------ docs/generated/cli/migrate.md | 156 ----------------- docs/generated/cli/print-affected.md | 126 -------------- docs/generated/cli/repair.md | 36 ---- docs/generated/cli/report.md | 16 -- docs/generated/cli/reset.md | 16 -- docs/generated/cli/run-many.md | 174 ------------------- docs/generated/cli/run.md | 44 ----- docs/generated/cli/show.md | 186 -------------------- docs/generated/cli/view-logs.md | 16 -- docs/generated/cli/watch.md | 74 -------- docs/generated/cli/workspace-generator.md | 66 -------- docs/generated/cli/workspace-lint.md | 18 -- nx.json | 3 +- 28 files changed, 90 insertions(+), 2342 deletions(-) create mode 100644 .nx/workflows/agents.yaml delete mode 100644 docs/generated/cli/affected-graph.md delete mode 100644 docs/generated/cli/affected.md delete mode 100644 docs/generated/cli/connect.md delete mode 100644 docs/generated/cli/create-nx-workspace.md delete mode 100644 docs/generated/cli/daemon.md delete mode 100644 docs/generated/cli/exec.md delete mode 100644 docs/generated/cli/format-check.md delete mode 100644 docs/generated/cli/format-write.md delete mode 100644 docs/generated/cli/generate.md delete mode 100644 docs/generated/cli/graph.md delete mode 100644 docs/generated/cli/init.md delete mode 100644 docs/generated/cli/list.md delete mode 100644 docs/generated/cli/migrate.md delete mode 100644 docs/generated/cli/print-affected.md delete mode 100644 docs/generated/cli/repair.md delete mode 100644 docs/generated/cli/report.md delete mode 100644 docs/generated/cli/reset.md delete mode 100644 docs/generated/cli/run-many.md delete mode 100644 docs/generated/cli/run.md delete mode 100644 docs/generated/cli/show.md delete mode 100644 docs/generated/cli/view-logs.md delete mode 100644 docs/generated/cli/watch.md delete mode 100644 docs/generated/cli/workspace-generator.md delete mode 100644 docs/generated/cli/workspace-lint.md diff --git a/.circleci/config.yml b/.circleci/config.yml index 24225eca401d14..16ec514d2bac55 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -68,91 +68,10 @@ commands: - ~/.pnpm-store - ~/.cache/Cypress - node_modules - - setup: - parameters: - os: - type: string - steps: - - checkout - - when: - condition: - equal: [<< parameters.os >>, macos] - steps: - - restore_cache: - name: Restore Homebrew packages - keys: - - nrwl-nx-homebrew-packages - - run: - name: Configure Detox Environment, Install applesimutils - command: | - HOMEBREW_NO_AUTO_UPDATE=1 brew tap wix/brew >/dev/null - HOMEBREW_NO_AUTO_UPDATE=1 brew install applesimutils >/dev/null - xcrun simctl shutdown all && xcrun simctl erase all - no_output_timeout: 20m - - save_cache: - name: Save Homebrew Cache - key: nrwl-nx-homebrew-packages - paths: - - /usr/local/Homebrew - - ~/Library/Caches/Homebrew - - when: - condition: - equal: [<< parameters.os >>, linux] - steps: - - run: - command: | - sudo apt-get update - sudo apt-get install -y ca-certificates lsof - - browser-tools/install-chrome - - browser-tools/install-chromedriver - - run-pnpm-install: - os: << parameters.os >> - # ------------------------- # JOBS # ------------------------- jobs: - # ------------------------- - # JOBS: Agent - # ------------------------- - agent: - parameters: - os: - type: string - default: 'linux' - pm: - type: string - default: 'pnpm' - executor: << parameters.os >> - environment: - GIT_AUTHOR_EMAIL: test@test.com - GIT_AUTHOR_NAME: Test - GIT_COMMITTER_EMAIL: test@test.com - GIT_COMMITTER_NAME: Test - NX_E2E_CI_CACHE_KEY: e2e-circleci-<< parameters.os >> - SELECTED_PM: << parameters.pm >> - NX_E2E_RUN_E2E: 'true' - NX_VERBOSE_LOGGING: 'false' - NX_NATIVE_LOGGING: 'false' - NX_PERF_LOGGING: 'false' - steps: - - run: - name: Configure git metadata (needed for lerna smoke tests) - command: | - git config --global user.email test@test.com - git config --global user.name "Test Test" - - run: - name: Set dynamic nx run variable - command: | - echo "export NX_CI_EXECUTION_ENV=\"<< parameters.os >>\";" >> $BASH_ENV - - setup: - os: << parameters.os >> - - run: - name: Agent - command: pnpm nx-cloud start-agent - no_output_timeout: 60m - # ------------------------- # JOBS: Main Linux # ------------------------- @@ -164,20 +83,24 @@ jobs: NX_DAEMON: 'true' NX_PERF_LOGGING: 'false' NX_NATIVE_LOGGING: 'false' + NX_CI_EXECUTION_ENV: 'linux' steps: + - checkout + - run: npx nx-cloud@latest start-ci-run --stop-agents-after="e2e" - run: - name: Set dynamic nx run variable command: | - echo "export NX_CI_EXECUTION_ENV=\"linux\";" >> $BASH_ENV - - setup: + sudo apt-get update + sudo apt-get install -y ca-certificates lsof + - browser-tools/install-chrome + - browser-tools/install-chromedriver + - run-pnpm-install: os: linux - nx/set-shas: main-branch-name: 'master' - - run: pnpm nx-cloud start-ci-run --stop-agents-after="e2e" - - run: - name: Check Documentation - command: pnpm nx documentation --no-dte - no_output_timeout: 20m + # - run: + # name: Check Documentation + # command: pnpm nx documentation --no-dte + # no_output_timeout: 20m - run: name: Run Checks/Lint/Test/Build no_output_timeout: 60m @@ -187,9 +110,6 @@ jobs: pnpm nx-cloud record -- nx format:check --base=$NX_BASE --head=$NX_HEAD & pids+=($!) - pnpm nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte & - pids+=($!) - pnpm nx affected --target=lint --base=$NX_BASE --head=$NX_HEAD --parallel=3 & pids+=($!) pnpm nx affected --target=test --base=$NX_BASE --head=$NX_HEAD --parallel=1 & @@ -209,13 +129,28 @@ jobs: environment: NX_E2E_CI_CACHE_KEY: e2e-circleci-macos NX_PERF_LOGGING: 'false' + NX_CI_EXECUTION_ENV: 'macos' SELECTED_PM: 'npm' # explicitly define npm for macOS tests steps: + - checkout + - restore_cache: + name: Restore Homebrew packages + keys: + - nrwl-nx-homebrew-packages - run: - name: Set dynamic nx run variable + name: Configure Detox Environment, Install applesimutils command: | - echo "export NX_CI_EXECUTION_ENV=\"macos\";" >> $BASH_ENV - - setup: + HOMEBREW_NO_AUTO_UPDATE=1 brew tap wix/brew >/dev/null + HOMEBREW_NO_AUTO_UPDATE=1 brew install applesimutils >/dev/null + xcrun simctl shutdown all && xcrun simctl erase all + no_output_timeout: 20m + - save_cache: + name: Save Homebrew Cache + key: nrwl-nx-homebrew-packages + paths: + - /usr/local/Homebrew + - ~/Library/Caches/Homebrew + - run-pnpm-install: os: macos - rust/install - nx/set-shas: @@ -234,22 +169,4 @@ workflows: build: jobs: - - agent: - name: 'agent1' - - agent: - name: 'agent2' - - agent: - name: 'agent3' - - agent: - name: 'agent4' - - agent: - name: 'agent5' - - agent: - name: 'agent6' - - agent: - name: 'agent7' - - agent: - name: 'agent8' - main-linux - - mainmacos: - name: main-macos-e2e diff --git a/.gitignore b/.gitignore index 1cbcf97238540e..dc2a4e36d48496 100644 --- a/.gitignore +++ b/.gitignore @@ -32,5 +32,6 @@ CHANGELOG.md # Local dev files .env .bashrc +.nx *.node diff --git a/.nx/workflows/agents.yaml b/.nx/workflows/agents.yaml new file mode 100644 index 00000000000000..61e356ceb826d7 --- /dev/null +++ b/.nx/workflows/agents.yaml @@ -0,0 +1,57 @@ +parallelism: 8 +env: + CI: 'true' + GIT_AUTHOR_EMAIL: test@test.com + GIT_AUTHOR_NAME: Test + GIT_COMMITTER_EMAIL: test@test.com + GIT_COMMITTER_NAME: Test + NX_E2E_CI_CACHE_KEY: e2e-circleci-linux + NX_VERBOSE_LOGGING: 'true' + NX_DAEMON: 'true' + NX_PERF_LOGGING: 'false' + NX_NATIVE_LOGGING: 'false' + SELECTED_PM: 'pnpm' + NX_E2E_RUN_E2E: 'true' + HOME: '/workspace' +steps: + - name: Git Clone + script: | + git init /workspace + git remote add origin $GIT_REPOSITORY_URL + git fetch --no-tags --prune --progress --no-recurse-submodules --depth=1 origin +{{nxCommitSha}}:{{nxCommitRef}} + git checkout --progress --force -B {{nxBranch}} {{nxCommitRef}} + + - name: Restore cache + script: | + nxw cache restore {{nxBranch}}-node_modules node_modules + nxw cache restore {{nxBranch}}-cypress ~/.cache/Cypress + nxw cache restore {{nxBranch}}-pnpm-store ~/.pnpm-store + + - name: Install Pnpm + script: | + npm install -g @pnpm/exe@8.3.1 + + - name: Pnpm Install + script: | + pnpm install --frozen-lockfile + + - name: Install Rust + script: | + apt install -y curl + curl --proto '=https' --tlsv1.3 https://sh.rustup.rs -sSf | sh + rustup toolchain install -y 1.70.0 + + - name: Configure git metadata (needed for lerna smoke tests) + script: | + git config --global user.email test@test.com + git config --global user.name "Test Test" + + - name: Run Agent + script: | + npx nx-cloud start-agent + + - name: Store to cache + script: | + nxw cache store {{nxBranch}}-node_modules node_modules + nxw cache store {{nxBranch}}-cypress ~/.cache/Cypress + nxw cache store {{nxBranch}}-pnpm-store ~/.pnpm-store diff --git a/docs/generated/cli/affected-graph.md b/docs/generated/cli/affected-graph.md deleted file mode 100644 index d2990a0d66da5a..00000000000000 --- a/docs/generated/cli/affected-graph.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: 'affected:graph - CLI command' -description: 'Graph dependencies affected by changes' ---- - -# affected:graph - -**Deprecated:** Use `nx graph --affected`, or `nx affected --graph` instead depending on which best suits your use case. The `affected:graph` command will be removed in Nx 18. - -Graph dependencies affected by changes - -## Usage - -```shell -nx affected:graph -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -Open the project graph of the workspace in the browser, and highlight the projects affected by changing the index.ts file: - -```shell - nx affected:graph --files=libs/mylib/src/index.ts -``` - -Open the project graph of the workspace in the browser, and highlight the projects affected by the changes between main and HEAD (e.g., PR): - -```shell - nx affected:graph --base=main --head=HEAD -``` - -Save the project graph of the workspace in a json file, and highlight the projects affected by the changes between main and HEAD (e.g., PR): - -```shell - nx affected:graph --base=main --head=HEAD --file=output.json -``` - -Generate a static website with project graph data in an html file, highlighting the projects affected by the changes between main and HEAD (e.g., PR): - -```shell - nx affected:graph --base=main --head=HEAD --file=output.html -``` - -Open the project graph of the workspace in the browser, and highlight the projects affected by the last commit on main: - -```shell - nx affected:graph --base=main~1 --head=main -``` - -Open the project graph of the workspace in the browser, highlight the projects affected, but exclude project-one and project-two: - -```shell - nx affected:graph --exclude=project-one,project-two -``` - -## Options - -### base - -Type: `string` - -Base of the current branch (usually main) - -### exclude - -Type: `string` - -Exclude certain projects from being processed - -### file - -Type: `string` - -Output file (e.g. --file=output.json or --file=dep-graph.html) - -### files - -Type: `string` - -Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces - -### focus - -Type: `string` - -Use to show the project graph for a particular project and every node that is either an ancestor or a descendant. - -### groupByFolder - -Type: `boolean` - -Group projects by folder in the project graph - -### head - -Type: `string` - -Latest commit of the current branch (usually HEAD) - -### help - -Type: `boolean` - -Show help - -### host - -Type: `string` - -Bind the project graph server to a specific ip address. - -### open - -Type: `boolean` - -Default: `true` - -Open the project graph in the browser. - -### port - -Type: `number` - -Bind the project graph server to a specific port. - -### targets - -Type: `string` - -The target to show tasks for in the task graph - -### uncommitted - -Type: `boolean` - -Uncommitted changes - -### untracked - -Type: `boolean` - -Untracked changes - -### version - -Type: `boolean` - -Show version number - -### view - -Type: `string` - -Choices: [projects, tasks] - -Default: `projects` - -Choose whether to view the projects or task graph - -### watch - -Type: `boolean` - -Default: `false` - -Watch for changes to project graph and update in-browser diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md deleted file mode 100644 index 0071512f33d59c..00000000000000 --- a/docs/generated/cli/affected.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: 'affected - CLI command' -description: 'Run target for affected projects' ---- - -# affected - -Run target for affected projects - -## Usage - -```shell -nx affected -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -Run custom target for all affected projects: - -```shell - nx affected -t custom-target -``` - -Run tests in parallel: - -```shell - nx affected -t test --parallel=5 -``` - -Run the test target for all projects: - -```shell - nx affected -t test --all -``` - -Run lint, test, and build targets for affected projects. Requires Nx v15.4+: - -```shell - nx affected -t lint test build -``` - -Run tests for all the projects affected by changing the index.ts file: - -```shell - nx affected -t test --files=libs/mylib/src/index.ts -``` - -Run tests for all the projects affected by the changes between main and HEAD (e.g., PR): - -```shell - nx affected -t test --base=main --head=HEAD -``` - -Run tests for all the projects affected by the last commit on main: - -```shell - nx affected -t test --base=main~1 --head=main -``` - -Run build for only projects with the tag `dotnet`: - -```shell - nx affected -t build --exclude '*,!tag:dotnet' -``` - -Use the currently executing project name in your command.: - -```shell - nx affected -t build --tag=$NX_TASK_TARGET_PROJECT:latest -``` - -## Options - -### ~~all~~ - -Type: `boolean` - -**Deprecated:** Use `nx run-many` instead - -### base - -Type: `string` - -Base of the current branch (usually main) - -### configuration - -Type: `string` - -This is the configuration to use when performing tasks on projects - -### exclude - -Type: `string` - -Exclude certain projects from being processed - -### files - -Type: `string` - -Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces - -### graph - -Type: `string` - -Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. - -### head - -Type: `string` - -Latest commit of the current branch (usually HEAD) - -### help - -Type: `boolean` - -Show help - -### nx-bail - -Type: `boolean` - -Default: `false` - -Stop command execution after the first failed task - -### nx-ignore-cycles - -Type: `boolean` - -Default: `false` - -Ignore cycles in the task graph - -### output-style - -Type: `string` - -Choices: [dynamic, static, stream, stream-without-prefixes] - -Defines how Nx emits outputs tasks logs - -### parallel - -Type: `string` - -Max number of parallel processes [default is 3] - -### runner - -Type: `string` - -This is the name of the tasks runner configured in nx.json - -### skip-nx-cache - -Type: `boolean` - -Default: `false` - -Rerun the tasks even when the results are available in the cache - -### targets - -Type: `string` - -Tasks to run for affected projects - -### uncommitted - -Type: `boolean` - -Uncommitted changes - -### untracked - -Type: `boolean` - -Untracked changes - -### verbose - -Type: `boolean` - -Prints additional information about the commands (e.g., stack traces) - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/connect.md b/docs/generated/cli/connect.md deleted file mode 100644 index 247c3df195843b..00000000000000 --- a/docs/generated/cli/connect.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: 'connect - CLI command' -description: 'Connect workspace to Nx Cloud' ---- - -# connect - -Connect workspace to Nx Cloud - -## Usage - -```shell -nx connect -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -## Options - -### help - -Type: `boolean` - -Show help - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/create-nx-workspace.md b/docs/generated/cli/create-nx-workspace.md deleted file mode 100644 index 1d129d85d048c8..00000000000000 --- a/docs/generated/cli/create-nx-workspace.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: 'create-nx-workspace - CLI command' -description: 'Create a new Nx workspace' ---- - -# create-nx-workspace - -Create a new Nx workspace - -## Usage - -```bash -create-nx-workspace [name] [options] -``` - -Install `create-nx-workspace` globally to invoke the command directly, or use `npx create-nx-workspace`, `yarn create nx-workspace`, or `pnpx create-nx-workspace`. - -## Options - -### allPrompts - -Type: `boolean` - -Default: `false` - -Show all prompts - -### appName - -Type: `string` - -The name of the app when using a monorepo with certain stacks - -### bundler - -Type: `string` - -Bundler to be used to build the app - -### ci - -Type: `string` - -Choices: [github, circleci, azure, bitbucket-pipelines, gitlab] - -Generate a CI workflow file - -### commit.email - -Type: `string` - -E-mail of the committer - -### commit.message - -Type: `string` - -Default: `Initial commit` - -Commit message - -### commit.name - -Type: `string` - -Name of the committer - -### defaultBase - -Type: `string` - -Default: `main` - -Default base to use for new projects - -### docker - -Type: `boolean` - -Generate a Dockerfile for the Node API - -### e2eTestRunner - -Type: `string` - -Choices: [cypress, playwright, none] - -Test runner to use for end to end (E2E) tests. - -### framework - -Type: `string` - -Framework option to be used with certain stacks - -### help - -Type: `boolean` - -Show help - -### interactive - -Type: `boolean` - -Default: `true` - -Enable interactive mode with presets - -### name - -Type: `string` - -Workspace name (e.g. org name) - -### nextAppDir - -Type: `boolean` - -Enable the App Router for Next.js - -### nxCloud - -Type: `boolean` - -Enable distributed caching to make your CI faster - -### packageManager - -Type: `string` - -Choices: [npm, pnpm, yarn] - -Default: `npm` - -Package manager to use - -### preset - -Type: `string` - -Customizes the initial content of your workspace. Default presets include: ["apps", "empty", "core", "npm", "ts", "web-components", "angular-monorepo", "angular-standalone", "react-monorepo", "react-standalone", "next", "nextjs-standalone", "react-native", "expo", "nest", "express", "react", "angular", "node-standalone", "node-monorepo", "ts-standalone"]. To build your own see https://nx.dev/extending-nx/recipes/create-preset - -### routing - -Type: `boolean` - -Add a routing setup for an Angular app - -### skipGit - -Type: `boolean` - -Default: `false` - -Skip initializing a git repository - -### standaloneApi - -Type: `boolean` - -Use Standalone Components if generating an Angular app - -### style - -Type: `string` - -Stylesheet type to be used with certain stacks - -### version - -Type: `boolean` - -Show version number - -### workspaceType - -Type: `string` - -Choices: [integrated, package-based, standalone] - -The type of workspace to create diff --git a/docs/generated/cli/daemon.md b/docs/generated/cli/daemon.md deleted file mode 100644 index d9f12325e57106..00000000000000 --- a/docs/generated/cli/daemon.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: 'daemon - CLI command' -description: 'Prints information about the Nx Daemon process or starts a daemon process' ---- - -# daemon - -Prints information about the Nx Daemon process or starts a daemon process - -## Usage - -```shell -nx daemon -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -## Options - -### help - -Type: `boolean` - -Show help - -### start - -Type: `boolean` - -Default: `false` - -### stop - -Type: `boolean` - -Default: `false` - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/exec.md b/docs/generated/cli/exec.md deleted file mode 100644 index 9c5b2825f940cf..00000000000000 --- a/docs/generated/cli/exec.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: 'exec - CLI command' -description: 'Executes any command as if it was a target on the project' ---- - -# exec - -Executes any command as if it was a target on the project - -## Usage - -```shell -nx exec -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -## Options - -### configuration - -Type: `string` - -This is the configuration to use when performing tasks on projects - -### exclude - -Type: `string` - -Exclude certain projects from being processed - -### graph - -Type: `string` - -Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. - -### nx-bail - -Type: `boolean` - -Default: `false` - -Stop command execution after the first failed task - -### nx-ignore-cycles - -Type: `boolean` - -Default: `false` - -Ignore cycles in the task graph - -### output-style - -Type: `string` - -Choices: [dynamic, static, stream, stream-without-prefixes, compact] - -Defines how Nx emits outputs tasks logs - -### parallel - -Type: `string` - -Max number of parallel processes [default is 3] - -### project - -Type: `string` - -Target project - -### runner - -Type: `string` - -This is the name of the tasks runner configured in nx.json - -### skip-nx-cache - -Type: `boolean` - -Default: `false` - -Rerun the tasks even when the results are available in the cache - -### verbose - -Type: `boolean` - -Prints additional information about the commands (e.g., stack traces) - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/format-check.md b/docs/generated/cli/format-check.md deleted file mode 100644 index 66886623b640d0..00000000000000 --- a/docs/generated/cli/format-check.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: 'format:check - CLI command' -description: 'Check for un-formatted files' ---- - -# format:check - -Check for un-formatted files - -## Usage - -```shell -nx format:check -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -## Options - -### all - -Type: `boolean` - -Format all projects - -### base - -Type: `string` - -Base of the current branch (usually main) - -### exclude - -Type: `string` - -Exclude certain projects from being processed - -### files - -Type: `string` - -Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces - -### head - -Type: `string` - -Latest commit of the current branch (usually HEAD) - -### help - -Type: `boolean` - -Show help - -### libs-and-apps - -Type: `boolean` - -Format only libraries and applications files. - -### projects - -Type: `string` - -Projects to format (comma/space delimited) - -### uncommitted - -Type: `boolean` - -Uncommitted changes - -### untracked - -Type: `boolean` - -Untracked changes - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/format-write.md b/docs/generated/cli/format-write.md deleted file mode 100644 index c7bfcf03ef154e..00000000000000 --- a/docs/generated/cli/format-write.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: 'format:write - CLI command' -description: 'Overwrite un-formatted files' ---- - -# format:write - -Overwrite un-formatted files - -## Usage - -```shell -nx format:write -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -## Options - -### all - -Type: `boolean` - -Format all projects - -### base - -Type: `string` - -Base of the current branch (usually main) - -### exclude - -Type: `string` - -Exclude certain projects from being processed - -### files - -Type: `string` - -Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces - -### head - -Type: `string` - -Latest commit of the current branch (usually HEAD) - -### help - -Type: `boolean` - -Show help - -### libs-and-apps - -Type: `boolean` - -Format only libraries and applications files. - -### projects - -Type: `string` - -Projects to format (comma/space delimited) - -### uncommitted - -Type: `boolean` - -Uncommitted changes - -### untracked - -Type: `boolean` - -Untracked changes - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/generate.md b/docs/generated/cli/generate.md deleted file mode 100644 index 82c6f114c88f15..00000000000000 --- a/docs/generated/cli/generate.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: 'generate - CLI command' -description: 'Runs a generator that creates and/or modifies files based on a generator from a collection.' ---- - -# generate - -Runs a generator that creates and/or modifies files based on a generator from a collection. - -## Usage - -```shell -nx generate -``` - -```shell -nx g -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`. - -### Examples - -Generate a new Angular application: - -```shell -nx generate @nx/angular:app myapp -``` - -Generate a new React application: - -```shell -nx generate @nx/react:app myapp -``` - -Generate a new web component application: - -```shell -nx generate @nx/web:app myapp -``` - -Generate a new Node application: - -```shell -nx generate @nx/node:app myapp -``` - -Generate a new Angular library application: - -```shell -nx generate @nx/angular:library mylibrary -``` - -Generate a new React library application: - -```shell -nx generate @nx/react:library mylibrary -``` - -Generate a new Node library application: - -```shell -nx generate @nx/node:library mylibrary -``` - -## Options - -### defaults - -Default: `false` - -When true, disables interactive input prompts for options with a default. - -### dryRun - -Default: `false` - -When true, preview the changes without updating files. - -### force - -Default: `false` - -When true, forces overwriting of existing files. - -### interactive - -Default: `true` - -When false, disables interactive input prompts. - -### help - -Show help and display available generators in the default collection. - -### version - -Show version number diff --git a/docs/generated/cli/graph.md b/docs/generated/cli/graph.md deleted file mode 100644 index 4dd438d1687842..00000000000000 --- a/docs/generated/cli/graph.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: 'graph - CLI command' -description: 'Graph dependencies within workspace' ---- - -# graph - -Graph dependencies within workspace - -## Usage - -```shell -nx graph -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -Open the project graph of the workspace in the browser: - -```shell - nx graph -``` - -Save the project graph into a json file: - -```shell - nx graph --file=output.json -``` - -Generate a static website with project graph into an html file, accompanied by an asset folder called static: - -```shell - nx graph --file=output.html -``` - -Show the graph where every node is either an ancestor or a descendant of todos-feature-main: - -```shell - nx graph --focus=todos-feature-main -``` - -Include project-one and project-two in the project graph: - -```shell - nx graph --include=project-one,project-two -``` - -Exclude project-one and project-two from the project graph: - -```shell - nx graph --exclude=project-one,project-two -``` - -Show the graph where every node is either an ancestor or a descendant of todos-feature-main, but exclude project-one and project-two: - -```shell - nx graph --focus=todos-feature-main --exclude=project-one,project-two -``` - -Watch for changes to project graph and update in-browser: - -```shell - nx graph --watch -``` - -## Options - -### affected - -Type: `boolean` - -Highlight affected projects - -### base - -Type: `string` - -Base of the current branch (usually main) - -### exclude - -Type: `string` - -Exclude certain projects from being processed - -### file - -Type: `string` - -Output file (e.g. --file=output.json or --file=dep-graph.html) - -### files - -Type: `string` - -Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces - -### focus - -Type: `string` - -Use to show the project graph for a particular project and every node that is either an ancestor or a descendant. - -### groupByFolder - -Type: `boolean` - -Group projects by folder in the project graph - -### head - -Type: `string` - -Latest commit of the current branch (usually HEAD) - -### help - -Type: `boolean` - -Show help - -### host - -Type: `string` - -Bind the project graph server to a specific ip address. - -### open - -Type: `boolean` - -Default: `true` - -Open the project graph in the browser. - -### port - -Type: `number` - -Bind the project graph server to a specific port. - -### targets - -Type: `string` - -The target to show tasks for in the task graph - -### uncommitted - -Type: `boolean` - -Uncommitted changes - -### untracked - -Type: `boolean` - -Untracked changes - -### version - -Type: `boolean` - -Show version number - -### view - -Type: `string` - -Choices: [projects, tasks] - -Default: `projects` - -Choose whether to view the projects or task graph - -### watch - -Type: `boolean` - -Default: `false` - -Watch for changes to project graph and update in-browser diff --git a/docs/generated/cli/init.md b/docs/generated/cli/init.md deleted file mode 100644 index 0bcf24a6776b1e..00000000000000 --- a/docs/generated/cli/init.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: 'init - CLI command' -description: 'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.' ---- - -# init - -Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx. - -## Usage - -```shell -nx init -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -## Options - -### addE2e - -Type: `boolean` - -Default: `false` - -Set up Cypress E2E tests in integrated workspaces. Only for CRA projects. - -### force - -Type: `boolean` - -Default: `false` - -Force the migration to continue and ignore custom webpack setup or uncommitted changes. Only for CRA projects. - -### help - -Type: `boolean` - -Show help - -### integrated - -Type: `boolean` - -Default: `false` - -Migrate to an Nx integrated layout workspace. Only for Angular CLI workspaces and CRA projects. - -### interactive - -Type: `boolean` - -Default: `true` - -When false disables interactive input prompts for options. - -### nxCloud - -Type: `boolean` - -Set up distributed caching with Nx Cloud. - -### useDotNxInstallation - -Type: `boolean` - -Default: `false` - -Initialize an Nx workspace setup in the .nx directory of the current repository. - -### version - -Type: `boolean` - -Show version number - -### vite - -Type: `boolean` - -Default: `true` - -Use Vite as the bundler. Only for CRA projects. diff --git a/docs/generated/cli/list.md b/docs/generated/cli/list.md deleted file mode 100644 index 3811bd9663fad2..00000000000000 --- a/docs/generated/cli/list.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: 'list - CLI command' -description: 'Lists installed plugins, capabilities of installed plugins and other available plugins.' ---- - -# list - -Lists installed plugins, capabilities of installed plugins and other available plugins. - -## Usage - -```shell -nx list [plugin] -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -List the plugins installed in the current workspace: - -```shell - nx list -``` - -List the generators and executors available in the `@nx/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace): - -```shell - nx list @nx/web -``` - -## Options - -### help - -Type: `boolean` - -Show help - -### plugin - -Type: `string` - -The name of an installed plugin to query - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/migrate.md b/docs/generated/cli/migrate.md deleted file mode 100644 index f4a2d0f50e973f..00000000000000 --- a/docs/generated/cli/migrate.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: 'migrate - CLI command' -description: - 'Creates a migrations file or runs migrations from the migrations file. - - Migrate packages and create migrations.json (e.g., nx migrate @nx/workspace@latest) - - Run migrations (e.g., nx migrate --run-migrations=migrations.json). Use flag --if-exists to run migrations only if the migrations file exists.' ---- - -# migrate - -Creates a migrations file or runs migrations from the migrations file. - -- Migrate packages and create migrations.json (e.g., nx migrate @nx/workspace@latest) -- Run migrations (e.g., nx migrate --run-migrations=migrations.json). Use flag --if-exists to run migrations only if the migrations file exists. - -## Usage - -```shell -nx migrate [packageAndVersion] -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -Update all Nx plugins to "latest". This will generate migrations.json: - -```shell - nx migrate latest -``` - -Update all Nx plugins to "9.0.0". This will generate migrations.json: - -```shell - nx migrate 9.0.0 -``` - -Update @nx/workspace and generate the list of migrations starting with version 8.0.0 of @nx/workspace and @nx/node, regardless of what is installed locally: - -```shell - nx migrate @nx/workspace@9.0.0 --from="@nx/workspace@8.0.0,@nx/node@8.0.0" -``` - -Update @nx/workspace to "9.0.0". If it tries to update @nx/react or @nx/angular, use version "9.0.1": - -```shell - nx migrate @nx/workspace@9.0.0 --to="@nx/react@9.0.1,@nx/angular@9.0.1" -``` - -Update another-package to "12.0.0". This will update other packages and will generate migrations.json file: - -```shell - nx migrate another-package@12.0.0 -``` - -Collect package updates and migrations in interactive mode. In this mode, the user will be prompted whether to apply any optional package update and migration: - -```shell - nx migrate latest --interactive -``` - -Collect package updates and migrations starting with version 14.5.0 of "nx" (and Nx first-party plugins), regardless of what is installed locally, while excluding migrations that should have been applied on previous updates: - -```shell - nx migrate latest --from=nx@14.5.0 --exclude-applied-migrations -``` - -Run migrations from the provided migrations.json file. You can modify migrations.json and run this command many times: - -```shell - nx migrate --run-migrations=migrations.json -``` - -Create a dedicated commit for each successfully completed migration. You can customize the prefix used for each commit by additionally setting --commit-prefix="PREFIX_HERE ": - -```shell - nx migrate --run-migrations --create-commits -``` - -## Options - -### commitPrefix - -Type: `string` - -Default: `chore: [nx migration] ` - -Commit prefix to apply to the commit for each migration, when --create-commits is enabled - -### createCommits - -Type: `boolean` - -Default: `false` - -Automatically create a git commit after each migration runs - -### excludeAppliedMigrations - -Type: `boolean` - -Default: `false` - -Exclude migrations that should have been applied on previous updates. To be used with --from - -### from - -Type: `string` - -Use the provided versions for packages instead of the ones installed in node_modules (e.g., --from="@nx/react@16.0.0,@nx/js@16.0.0") - -### help - -Type: `boolean` - -Show help - -### ifExists - -Type: `boolean` - -Default: `false` - -Run migrations only if the migrations file exists, if not continues successfully - -### interactive - -Type: `boolean` - -Default: `false` - -Enable prompts to confirm whether to collect optional package updates and migrations - -### packageAndVersion - -Type: `string` - -The target package and version (e.g, @nx/workspace@16.0.0) - -### runMigrations - -Type: `string` - -Execute migrations from a file (when the file isn't provided, execute migrations from migrations.json) - -### to - -Type: `string` - -Use the provided versions for packages instead of the ones calculated by the migrator (e.g., --to="@nx/react@16.0.0,@nx/js@16.0.0") - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/print-affected.md b/docs/generated/cli/print-affected.md deleted file mode 100644 index d92c41ec16d306..00000000000000 --- a/docs/generated/cli/print-affected.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: 'print-affected - CLI command' -description: 'Prints information about the projects and targets affected by changes' ---- - -# print-affected - -**Deprecated:** Use `nx show projects --affected`, `nx affected --graph -t build` or `nx graph --affected` depending on which best suits your use case. The `print-affected` command will be removed in Nx 18. - -Prints information about the projects and targets affected by changes - -## Usage - -```shell -nx print-affected -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -Print information about affected projects and the project graph: - -```shell - nx print-affected -``` - -Print information about the projects affected by the changes between main and HEAD (e.g,. PR): - -```shell - nx print-affected --base=main --head=HEAD -``` - -Prints information about the affected projects and a list of tasks to test them: - -```shell - nx print-affected -t test -``` - -Prints the projects property from the print-affected output: - -```shell - nx print-affected -t build --select=projects -``` - -Prints the tasks.target.project property from the print-affected output: - -```shell - nx print-affected -t build --select=tasks.target.project -``` - -## Options - -### base - -Type: `string` - -Base of the current branch (usually main) - -### configuration - -Type: `string` - -This is the configuration to use when performing tasks on projects - -### exclude - -Type: `string` - -Exclude certain projects from being processed - -### files - -Type: `string` - -Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces - -### head - -Type: `string` - -Latest commit of the current branch (usually HEAD) - -### help - -Type: `boolean` - -Show help - -### select - -Type: `string` - -Select the subset of the returned json document (e.g., --select=projects) - -### targets - -Type: `string` - -Tasks to run for affected projects - -### type - -Type: `string` - -Choices: [app, lib] - -Select the type of projects to be returned (e.g., --type=app) - -### uncommitted - -Type: `boolean` - -Uncommitted changes - -### untracked - -Type: `boolean` - -Untracked changes - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/repair.md b/docs/generated/cli/repair.md deleted file mode 100644 index ec8253216a81a1..00000000000000 --- a/docs/generated/cli/repair.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: 'repair - CLI command' -description: 'Repair any configuration that is no longer supported by Nx.' ---- - -# repair - -Repair any configuration that is no longer supported by Nx. - -## Usage - -```shell -nx repair -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -## Options - -### help - -Type: `boolean` - -Show help - -### verbose - -Type: `boolean` - -Prints additional information about the commands (e.g., stack traces) - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/report.md b/docs/generated/cli/report.md deleted file mode 100644 index 6b7e88a2901a72..00000000000000 --- a/docs/generated/cli/report.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 'report - CLI command' -description: 'Reports useful version numbers to copy into the Nx issue template' ---- - -# report - -Reports useful version numbers to copy into the Nx issue template - -## Usage - -```shell -nx report -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. diff --git a/docs/generated/cli/reset.md b/docs/generated/cli/reset.md deleted file mode 100644 index 7f036bb07d82d8..00000000000000 --- a/docs/generated/cli/reset.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 'reset - CLI command' -description: 'Clears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon.' ---- - -# reset - -Clears all the cached Nx artifacts and metadata about the workspace and shuts down the Nx Daemon. - -## Usage - -```shell -nx reset -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md deleted file mode 100644 index d525acdaddc6cf..00000000000000 --- a/docs/generated/cli/run-many.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -title: 'run-many - CLI command' -description: 'Run target for multiple listed projects' ---- - -# run-many - -Run target for multiple listed projects - -## Usage - -```shell -nx run-many -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -Test all projects: - -```shell - nx run-many -t test -``` - -Test proj1 and proj2 in parallel: - -```shell - nx run-many -t test -p proj1 proj2 -``` - -Test proj1 and proj2 in parallel using 5 workers: - -```shell - nx run-many -t test -p proj1 proj2 --parallel=5 -``` - -Test proj1 and proj2 in sequence: - -```shell - nx run-many -t test -p proj1 proj2 --parallel=false -``` - -Test all projects ending with `*-app` except `excluded-app`. Note: your shell may require you to escape the `*` like this: `\*`: - -```shell - nx run-many -t test --projects=*-app --exclude excluded-app -``` - -Test all projects with tags starting with `api-`. Note: your shell may require you to escape the `*` like this: `\*`: - -```shell - nx run-many -t test --projects=tag:api-* -``` - -Test all projects with a `type:ui` tag: - -```shell - nx run-many -t test --projects=tag:type:ui -``` - -Test all projects with a `type:feature` or `type:ui` tag: - -```shell - nx run-many -t test --projects=tag:type:feature,tag:type:ui -``` - -Run lint, test, and build targets for all projects. Requires Nx v15.4+: - -```shell - nx run-many --targets=lint,test,build --all -``` - -## Options - -### all - -Type: `boolean` - -Default: `true` - -[deprecated] Run the target on all projects in the workspace - -### configuration - -Type: `string` - -This is the configuration to use when performing tasks on projects - -### exclude - -Type: `string` - -Exclude certain projects from being processed - -### graph - -Type: `string` - -Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. - -### help - -Type: `boolean` - -Show help - -### nx-bail - -Type: `boolean` - -Default: `false` - -Stop command execution after the first failed task - -### nx-ignore-cycles - -Type: `boolean` - -Default: `false` - -Ignore cycles in the task graph - -### output-style - -Type: `string` - -Choices: [dynamic, static, stream, stream-without-prefixes] - -Defines how Nx emits outputs tasks logs - -### parallel - -Type: `string` - -Max number of parallel processes [default is 3] - -### projects - -Type: `string` - -Projects to run. (comma/space delimited project names and/or patterns) - -### runner - -Type: `string` - -This is the name of the tasks runner configured in nx.json - -### skip-nx-cache - -Type: `boolean` - -Default: `false` - -Rerun the tasks even when the results are available in the cache - -### targets - -Type: `string` - -Tasks to run for affected projects - -### verbose - -Type: `boolean` - -Prints additional information about the commands (e.g., stack traces) - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/run.md b/docs/generated/cli/run.md deleted file mode 100644 index 82c9688f27f4b3..00000000000000 --- a/docs/generated/cli/run.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: 'run - CLI command' -description: 'Runs a target defined for your project. Target definitions can be found in the `scripts` property of the project `package.json`, or in the `targets` property of the project `project.json` file.' ---- - -# run - -Runs a target defined for your project. Target definitions can be found in the `scripts` property of the project `package.json`, or in the `targets` property of the project `project.json` file. - -## Usage - -```shell -nx run [options] -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`. - -### Examples - -Run the `build` target for the `myapp` : - -```shell -nx run myapp:build -``` - -Run the `build` target for the `myapp` project with a `production` configuration: - -```shell -nx run myapp:build:production -``` - -## Options - -### configuration (-c) - -A named builder configuration, defined in the "configurations" section of the workspace configuration file. The builder uses the named configuration to run the given target. - -### help - -Show help - -### version - -Show version number diff --git a/docs/generated/cli/show.md b/docs/generated/cli/show.md deleted file mode 100644 index 0c22a989345c80..00000000000000 --- a/docs/generated/cli/show.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -title: 'show - CLI command' -description: 'Show information about the workspace (e.g., list of projects)' ---- - -# show - -Show information about the workspace (e.g., list of projects) - -## Usage - -```shell -nx show -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -Show all projects in the workspace: - -```shell - nx show projects -``` - -Show all projects with names starting with "api-". The "projects" option is useful to see which projects would be selected by run-many.: - -```shell - nx show projects --projects api-* -``` - -Show all projects with a serve target: - -```shell - nx show projects --with-target serve -``` - -Show affected projects in the workspace: - -```shell - nx show projects --affected -``` - -Show affected projects in the workspace, excluding end-to-end projects: - -```shell - nx show projects --affected --exclude *-e2e -``` - -Show detailed information about "my-app" in a json format.: - -```shell - nx show project my-app -``` - -Show information about "my-app" in a human readable format.: - -```shell - nx show project my-app --json false -``` - -## Options - -### help - -Type: `boolean` - -Show help - -### json - -Type: `boolean` - -Output JSON - -### version - -Type: `boolean` - -Show version number - -## Subcommands - -### projects - -Show a list of projects in the workspace - -```shell -nx show projects -``` - -#### Options - -##### affected - -Type: `boolean` - -Show only affected projects - -##### base - -Type: `string` - -Base of the current branch (usually main) - -##### exclude - -Type: `string` - -Exclude certain projects from being processed - -##### files - -Type: `string` - -Change the way Nx is calculating the affected command by providing directly changed files, list of files delimited by commas or spaces - -##### head - -Type: `string` - -Latest commit of the current branch (usually HEAD) - -##### help - -Type: `boolean` - -Show help - -##### projects - -Type: `string` - -Show only projects that match a given pattern. - -##### uncommitted - -Type: `boolean` - -Uncommitted changes - -##### untracked - -Type: `boolean` - -Untracked changes - -##### version - -Type: `boolean` - -Show version number - -##### withTarget - -Type: `string` - -Show only projects that have a specific target - -### project - -Shows resolved project configuration for a given project. - -```shell -nx show project -``` - -#### Options - -##### help - -Type: `boolean` - -Show help - -##### projectName - -Type: `string` - -Which project should be viewed? - -##### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/view-logs.md b/docs/generated/cli/view-logs.md deleted file mode 100644 index 0975edec251edb..00000000000000 --- a/docs/generated/cli/view-logs.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 'view-logs - CLI command' -description: 'Enables you to view and interact with the logs via the advanced analytic UI from Nx Cloud to help you debug your issue. To do this, Nx needs to connect your workspace to Nx Cloud and upload the most recent run details. Only the metrics are uploaded, not the artefacts.' ---- - -# view-logs - -Enables you to view and interact with the logs via the advanced analytic UI from Nx Cloud to help you debug your issue. To do this, Nx needs to connect your workspace to Nx Cloud and upload the most recent run details. Only the metrics are uploaded, not the artefacts. - -## Usage - -```shell -nx view-logs -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. diff --git a/docs/generated/cli/watch.md b/docs/generated/cli/watch.md deleted file mode 100644 index 5fb31bdeb6a8b6..00000000000000 --- a/docs/generated/cli/watch.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: 'watch - CLI command' -description: 'Watch for changes within projects, and execute commands' ---- - -# watch - -Watch for changes within projects, and execute commands - -## Usage - -```shell -nx watch -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -### Examples - -Watch the "app" project and echo the project name and the files that changed: - -```shell - nx watch --projects=app -- echo \$NX_PROJECT_NAME \$NX_FILE_CHANGES -``` - -Watch "app1" and "app2" and echo the project name whenever a specified project or its dependencies change: - -```shell - nx watch --projects=app1,app2 --includeDependentProjects -- echo \$NX_PROJECT_NAME -``` - -Watch all projects (including newly created projects) in the workspace: - -```shell - nx watch --all -- echo \$NX_PROJECT_NAME -``` - -## Options - -### all - -Type: `boolean` - -Watch all projects. - -### help - -Type: `boolean` - -Show help - -### includeDependentProjects - -Type: `boolean` - -When watching selected projects, include dependent projects as well. - -### projects - -Type: `string` - -Projects to watch (comma/space delimited). - -### verbose - -Type: `boolean` - -Run watch mode in verbose mode, where commands are logged before execution. - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/workspace-generator.md b/docs/generated/cli/workspace-generator.md deleted file mode 100644 index e09c418438748a..00000000000000 --- a/docs/generated/cli/workspace-generator.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: 'workspace-generator - CLI command' -description: 'Runs a workspace generator from the tools/generators directory' ---- - -# workspace-generator - -**Deprecated:** Use a local plugin instead. See: https://nx.dev/deprecated/workspace-generators - -Runs a workspace generator from the tools/generators directory - -## Usage - -```shell -nx workspace-generator [generator] -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. - -## Options - -### dryRun - -Type: `boolean` - -Default: `false` - -Preview the changes without updating files - -### generator - -Type: `string` - -Name of the generator (e.g., @nx/js:library, library) - -### help - -Type: `boolean` - -Show help - -### interactive - -Type: `boolean` - -Default: `true` - -When false disables interactive input prompts for options - -### quiet - -Type: `boolean` - -Hides logs from tree operations (e.g. `CREATE package.json`) - -### verbose - -Type: `boolean` - -Prints additional information about the commands (e.g., stack traces) - -### version - -Type: `boolean` - -Show version number diff --git a/docs/generated/cli/workspace-lint.md b/docs/generated/cli/workspace-lint.md deleted file mode 100644 index a77e61ffa2cba1..00000000000000 --- a/docs/generated/cli/workspace-lint.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 'workspace-lint - CLI command' -description: 'Lint nx specific workspace files (nx.json, workspace.json)' ---- - -# workspace-lint - -**Deprecated:** workspace-lint is deprecated, and will be removed in v17. The checks it used to perform are no longer relevant. See: https://nx.dev/deprecated/workspace-lint - -Lint nx specific workspace files (nx.json, workspace.json) - -## Usage - -```shell -nx workspace-lint [files..] -``` - -Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. diff --git a/nx.json b/nx.json index b2458ff77b3f59..634b164ecf778a 100644 --- a/nx.json +++ b/nx.json @@ -182,5 +182,6 @@ ] } }, - "plugins": ["@monodon/rust"] + "plugins": ["@monodon/rust"], + "buildTriggered": true }