Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core): nx sync #27825

Merged
merged 8 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/generated/cli/sync-check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: 'sync:check - CLI command'
description: 'Check that no changes are required after running all sync generators.'
---

# sync:check

Check that no changes are required after running all sync generators.

## Usage

```shell
nx sync:check
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.

## Options

| Option | Type | Description |
| ----------- | ------- | ---------------------------------------------------------------------- |
| `--help` | boolean | Show help. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |
24 changes: 24 additions & 0 deletions docs/generated/cli/sync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: 'sync - CLI command'
description: 'Sync the workspace files by running all the sync generators.'
---

# sync

Sync the workspace files by running all the sync generators.

## Usage

```shell
nx sync
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.

## Options

| Option | Type | Description |
| ----------- | ------- | ---------------------------------------------------------------------- |
| `--help` | boolean | Show help. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |
22 changes: 22 additions & 0 deletions docs/generated/manifests/extending-nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,17 @@
"path": "/extending-nx/recipes/modifying-files",
"tags": ["generate-code"]
},
{
"id": "create-sync-generator",
"name": "Create a Sync Generator",
"description": "",
"mediaImage": "",
"file": "shared/recipes/generators/create-sync-generator",
"itemList": [],
"isExternal": false,
"path": "/extending-nx/recipes/create-sync-generator",
"tags": ["generate-code"]
},
{
"id": "migration-generators",
"name": "Write a Migration",
Expand Down Expand Up @@ -288,6 +299,17 @@
"path": "/extending-nx/recipes/modifying-files",
"tags": ["generate-code"]
},
"/extending-nx/recipes/create-sync-generator": {
"id": "create-sync-generator",
"name": "Create a Sync Generator",
"description": "",
"mediaImage": "",
"file": "shared/recipes/generators/create-sync-generator",
"itemList": [],
"isExternal": false,
"path": "/extending-nx/recipes/create-sync-generator",
"tags": ["generate-code"]
},
"/extending-nx/recipes/migration-generators": {
"id": "migration-generators",
"name": "Write a Migration",
Expand Down
48 changes: 48 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Sync Generators",
"path": "/concepts/sync-generators",
"id": "sync-generators",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Nx and Turborepo",
"path": "/concepts/turbo-and-nx",
Expand Down Expand Up @@ -827,6 +835,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Sync Generators",
"path": "/concepts/sync-generators",
"id": "sync-generators",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Nx and Turborepo",
"path": "/concepts/turbo-and-nx",
Expand Down Expand Up @@ -5123,6 +5139,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Create a Sync Generator",
"path": "/extending-nx/recipes/create-sync-generator",
"id": "create-sync-generator",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Write a Migration",
"path": "/extending-nx/recipes/migration-generators",
Expand Down Expand Up @@ -5222,6 +5246,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Create a Sync Generator",
"path": "/extending-nx/recipes/create-sync-generator",
"id": "create-sync-generator",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Write a Migration",
"path": "/extending-nx/recipes/migration-generators",
Expand Down Expand Up @@ -8713,6 +8745,22 @@
"children": [],
"disableCollapsible": false
},
{
"name": "sync",
"path": "/nx-api/nx/documents/sync",
"id": "sync",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "sync:check",
"path": "/nx-api/nx/documents/sync-check",
"id": "sync-check",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "exec",
"path": "/nx-api/nx/documents/exec",
Expand Down
22 changes: 22 additions & 0 deletions docs/generated/manifests/nx-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -1902,6 +1902,28 @@
"tags": [],
"originalFilePath": "generated/cli/repair"
},
"/nx-api/nx/documents/sync": {
"id": "sync",
"name": "sync",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/sync",
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/sync",
"tags": [],
"originalFilePath": "generated/cli/sync"
},
"/nx-api/nx/documents/sync-check": {
"id": "sync-check",
"name": "sync:check",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/sync-check",
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/sync-check",
"tags": [],
"originalFilePath": "generated/cli/sync-check"
},
"/nx-api/nx/documents/exec": {
"id": "exec",
"name": "exec",
Expand Down
22 changes: 22 additions & 0 deletions docs/generated/manifests/nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,17 @@
"path": "/concepts/nx-daemon",
"tags": []
},
{
"id": "sync-generators",
"name": "Sync Generators",
"description": "",
"mediaImage": "",
"file": "shared/concepts/sync-generators",
"itemList": [],
"isExternal": false,
"path": "/concepts/sync-generators",
"tags": []
},
{
"id": "turbo-and-nx",
"name": "Nx and Turborepo",
Expand Down Expand Up @@ -1130,6 +1141,17 @@
"path": "/concepts/nx-daemon",
"tags": []
},
"/concepts/sync-generators": {
"id": "sync-generators",
"name": "Sync Generators",
"description": "",
"mediaImage": "",
"file": "shared/concepts/sync-generators",
"itemList": [],
"isExternal": false,
"path": "/concepts/sync-generators",
"tags": []
},
"/concepts/turbo-and-nx": {
"id": "turbo-and-nx",
"name": "Nx and Turborepo",
Expand Down
7 changes: 7 additions & 0 deletions docs/generated/manifests/tags.json
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,13 @@
"name": "Modify Files",
"path": "/extending-nx/recipes/modifying-files"
},
{
"description": "",
"file": "shared/recipes/generators/create-sync-generator",
"id": "create-sync-generator",
"name": "Create a Sync Generator",
"path": "/extending-nx/recipes/create-sync-generator"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/generate",
Expand Down
22 changes: 22 additions & 0 deletions docs/generated/packages-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -1881,6 +1881,28 @@
"tags": [],
"originalFilePath": "generated/cli/repair"
},
{
"id": "sync",
"name": "sync",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/sync",
"itemList": [],
"isExternal": false,
"path": "nx/documents/sync",
"tags": [],
"originalFilePath": "generated/cli/sync"
},
{
"id": "sync-check",
"name": "sync:check",
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/sync-check",
"itemList": [],
"isExternal": false,
"path": "nx/documents/sync-check",
"tags": [],
"originalFilePath": "generated/cli/sync-check"
},
{
"id": "exec",
"name": "exec",
Expand Down
24 changes: 24 additions & 0 deletions docs/generated/packages/nx/documents/sync-check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: 'sync:check - CLI command'
description: 'Check that no changes are required after running all sync generators.'
---

# sync:check

Check that no changes are required after running all sync generators.

## Usage

```shell
nx sync:check
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.

## Options

| Option | Type | Description |
| ----------- | ------- | ---------------------------------------------------------------------- |
| `--help` | boolean | Show help. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |
24 changes: 24 additions & 0 deletions docs/generated/packages/nx/documents/sync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: 'sync - CLI command'
description: 'Sync the workspace files by running all the sync generators.'
---

# sync

Sync the workspace files by running all the sync generators.

## Usage

```shell
nx sync
```

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.

## Options

| Option | Type | Description |
| ----------- | ------- | ---------------------------------------------------------------------- |
| `--help` | boolean | Show help. |
| `--verbose` | boolean | Prints additional information about the commands (e.g., stack traces). |
| `--version` | boolean | Show version number. |
21 changes: 21 additions & 0 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,11 @@
"id": "nx-daemon",
"file": "shared/concepts/daemon"
},
{
"name": "Sync Generators",
"id": "sync-generators",
"file": "shared/concepts/sync-generators"
},
{
"name": "Nx and Turborepo",
"id": "turbo-and-nx",
Expand Down Expand Up @@ -1532,6 +1537,12 @@
"tags": ["generate-code"],
"file": "shared/recipes/generators/modifying-files"
},
{
"name": "Create a Sync Generator",
"id": "create-sync-generator",
"tags": ["generate-code"],
"file": "shared/recipes/generators/create-sync-generator"
},
{
"name": "Write a Migration",
"id": "migration-generators",
Expand Down Expand Up @@ -2090,6 +2101,16 @@
"id": "repair",
"file": "generated/cli/repair"
},
{
"name": "sync",
"id": "sync",
"file": "generated/cli/sync"
},
{
"name": "sync:check",
"id": "sync-check",
"file": "generated/cli/sync-check"
},
{
"name": "exec",
"id": "exec",
Expand Down
Loading