Skip to content

Commit

Permalink
docs(core): nx sync (nrwl#27825)
Browse files Browse the repository at this point in the history
- Adds nx sync to command reference
- Updates nx.json reference
- Update project configuration reference
- Adds a sync generators concept page
- Adds a Register a Sync Generator recipe under Extending Nx Recipes

---------

Co-authored-by: James Henry <[email protected]>
isaacplmann and JamesHenry authored Sep 12, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent b6140d4 commit 4517d9f
Showing 18 changed files with 514 additions and 2 deletions.
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
@@ -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",
@@ -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",
48 changes: 48 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
@@ -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",
@@ -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",
@@ -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",
@@ -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",
@@ -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",
22 changes: 22 additions & 0 deletions docs/generated/manifests/nx-api.json
Original file line number Diff line number Diff line change
@@ -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",
22 changes: 22 additions & 0 deletions docs/generated/manifests/nx.json
Original file line number Diff line number Diff line change
@@ -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",
@@ -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",
7 changes: 7 additions & 0 deletions docs/generated/manifests/tags.json
Original file line number Diff line number Diff line change
@@ -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",
22 changes: 22 additions & 0 deletions docs/generated/packages-metadata.json
Original file line number Diff line number Diff line change
@@ -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",
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
@@ -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",
@@ -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",
@@ -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",
Loading

0 comments on commit 4517d9f

Please sign in to comment.