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): deprecate workspaceLayout #19767

Merged
merged 2 commits into from
Oct 23, 2023
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
32 changes: 16 additions & 16 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -4948,6 +4948,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "workspace-layout",
"path": "/deprecated/workspace-layout",
"id": "workspace-layout",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Workspace Generators",
"path": "/deprecated/workspace-generators",
Expand Down Expand Up @@ -5072,6 +5080,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "workspace-layout",
"path": "/deprecated/workspace-layout",
"id": "workspace-layout",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Workspace Generators",
"path": "/deprecated/workspace-generators",
Expand Down Expand Up @@ -5279,14 +5295,6 @@
"children": [],
"disableCollapsible": false
},
{
"name": "nx.json workspaceLayout property",
"path": "/reference/nx-json#workspace-layout",
"id": "nxjson-workspaceLayout",
"isExternal": true,
"children": [],
"disableCollapsible": false
},
{
"name": "nx.json generator defaults",
"path": "/reference/nx-json#generators",
Expand Down Expand Up @@ -5346,14 +5354,6 @@
"children": [],
"disableCollapsible": false
},
{
"name": "nx.json workspaceLayout property",
"path": "/reference/nx-json#workspace-layout",
"id": "nxjson-workspaceLayout",
"isExternal": true,
"children": [],
"disableCollapsible": false
},
{
"name": "nx.json generator defaults",
"path": "/reference/nx-json#generators",
Expand Down
40 changes: 20 additions & 20 deletions docs/generated/manifests/nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -6170,6 +6170,16 @@
"path": "/deprecated/workspace-lint",
"tags": []
},
{
"id": "workspace-layout",
"name": "workspace-layout",
"description": "",
"file": "shared/deprecated/workspace-layout",
"itemList": [],
"isExternal": false,
"path": "/deprecated/workspace-layout",
"tags": []
},
{
"id": "workspace-generators",
"name": "Workspace Generators",
Expand Down Expand Up @@ -6326,6 +6336,16 @@
"path": "/deprecated/workspace-lint",
"tags": []
},
"/deprecated/workspace-layout": {
"id": "workspace-layout",
"name": "workspace-layout",
"description": "",
"file": "shared/deprecated/workspace-layout",
"itemList": [],
"isExternal": false,
"path": "/deprecated/workspace-layout",
"tags": []
},
"/deprecated/workspace-generators": {
"id": "workspace-generators",
"name": "Workspace Generators",
Expand Down Expand Up @@ -6583,16 +6603,6 @@
"path": "/reference/project-configuration#inputs-&-namedinputs",
"tags": ["cache-task-results"]
},
{
"id": "nxjson-workspaceLayout",
"name": "nx.json workspaceLayout property",
"description": "",
"file": "",
"itemList": [],
"isExternal": true,
"path": "/reference/nx-json#workspace-layout",
"tags": ["enforce-module-boundaries"]
},
{
"id": "nxjson-generator-defaults",
"name": "nx.json generator defaults",
Expand Down Expand Up @@ -6668,16 +6678,6 @@
"path": "/reference/project-configuration#inputs-&-namedinputs",
"tags": ["cache-task-results"]
},
"/reference/nx-json#workspace-layout": {
"id": "nxjson-workspaceLayout",
"name": "nx.json workspaceLayout property",
"description": "",
"file": "",
"itemList": [],
"isExternal": true,
"path": "/reference/nx-json#workspace-layout",
"tags": ["enforce-module-boundaries"]
},
"/reference/nx-json#generators": {
"id": "nxjson-generator-defaults",
"name": "nx.json generator defaults",
Expand Down
7 changes: 0 additions & 7 deletions docs/generated/manifests/tags.json
Original file line number Diff line number Diff line change
Expand Up @@ -369,13 +369,6 @@
"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.",
"file": "generated/packages/generated/packages/nx/documents/format-check",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@
},
"additionalProperties": false,
"required": ["name"],
"examplesFile": "## Examples\n\n{% tabs %}\n{% tab label=\"Simple Application\" %}\n\nCreate an application named `my-app`:\n\n```bash\nnx g @nx/angular:application my-app\n```\n\n{% /tab %}\n\n{% tab label=\"Specify directory and style extension\" %}\n\nCreate an application named `my-app` in the `my-dir` directory and use `scss` for styles:\n\n{% callout type=\"note\" title=\"Directory Flag Behavior Changes\" %}\nThe command below uses the `as-provided` directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the `derived` option, use `--directory=my-dir`. See the [workspace layout documentation](/reference/nx-json#workspace-layout) for more details.\n{% /callout %}\n\n```bash\nnx g @nx/angular:app my-app --directory=my-dir/my-app --style=scss\n```\n\n{% /tab %}\n\n{% tab label=\"Single File Components application\" %}\n\nCreate an application with Single File Components (inline styles and inline templates):\n\n```bash\nnx g @nx/angular:app my-app --inlineStyle --inlineTemplate\n```\n\n{% /tab %}\n\n{% tab label=\"Standalone Components application\" %}\n\nCreate an application that is setup to use standalone components:\n\n```bash\nnx g @nx/angular:app my-app --standalone\n```\n\n{% /tab %}\n\n{% tab label=\"Set custom prefix and tags\" %}\n\nSet the prefix to apply to generated selectors and add tags to the application (used for linting).\n\n```bash\nnx g @nx/angular:app my-app --prefix=admin --tags=scope:admin,type:ui\n```\n\n{% /tab %}\n{% /tabs %}\n",
"examplesFile": "## Examples\n\n{% tabs %}\n{% tab label=\"Simple Application\" %}\n\nCreate an application named `my-app`:\n\n```bash\nnx g @nx/angular:application my-app\n```\n\n{% /tab %}\n\n{% tab label=\"Specify directory and style extension\" %}\n\nCreate an application named `my-app` in the `my-dir` directory and use `scss` for styles:\n\n{% callout type=\"note\" title=\"Directory Flag Behavior Changes\" %}\nThe command below uses the `as-provided` directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the `derived` option, use `--directory=my-dir`. See the [workspace layout documentation](/deprecated/workspace-layout) for more details.\n{% /callout %}\n\n```bash\nnx g @nx/angular:app my-app --directory=my-dir/my-app --style=scss\n```\n\n{% /tab %}\n\n{% tab label=\"Single File Components application\" %}\n\nCreate an application with Single File Components (inline styles and inline templates):\n\n```bash\nnx g @nx/angular:app my-app --inlineStyle --inlineTemplate\n```\n\n{% /tab %}\n\n{% tab label=\"Standalone Components application\" %}\n\nCreate an application that is setup to use standalone components:\n\n```bash\nnx g @nx/angular:app my-app --standalone\n```\n\n{% /tab %}\n\n{% tab label=\"Set custom prefix and tags\" %}\n\nSet the prefix to apply to generated selectors and add tags to the application (used for linting).\n\n```bash\nnx g @nx/angular:app my-app --prefix=admin --tags=scope:admin,type:ui\n```\n\n{% /tab %}\n{% /tabs %}\n",
"presets": []
},
"aliases": ["app"],
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/angular/generators/library.json
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@
},
"additionalProperties": false,
"required": ["name"],
"examplesFile": "## Examples\n\n{% tabs %}\n{% tab label=\"Simple Library\" %}\n\nCreates the `my-ui-lib` library with an `ui` tag:\n\n```bash\nnx g @nx/angular:library my-ui-lib --tags=ui\n```\n\n{% /tab %}\n\n{% tab label=\"Publishable Library\" %}\n\nCreates the `my-lib` library that can be built producing an output following the Angular Package Format (APF) to be distributed as an NPM package:\n\n```bash\nnx g @nx/angular:library my-lib --publishable --import-path=@my-org/my-lib\n```\n\n{% /tab %}\n\n{% tab label=\"Buildable Library\" %}\n\nCreates the `my-lib` library with support for incremental builds:\n\n```bash\nnx g @nx/angular:library my-lib --buildable\n```\n\n{% /tab %}\n\n{% tab label=\"Nested Folder & Import\"%}\nCreates the `my-lib` library in the `nested` directory and sets the import path to `@myorg/nested/my-lib`:\n\n{% callout type=\"note\" title=\"Directory Flag Behavior Changes\" %}\nThe command below uses the `as-provided` directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the `derived` option, use `--directory=nested`. See the [workspace layout documentation](/reference/nx-json#workspace-layout) for more details.\n{% /callout %}\n\n```bash\nnx g @nx/angular:library --directory=libs/nested/my-lib --importPath=@myorg/nested/my-lib my-lib\n```\n\n{% /tab %}\n\n{% tab label=\"Standalone component\"%}\nCreates the `my-standalone-lib` library with a standalone component as an entry point instead of an ng-module. The component can be used via the `myorg-standalone-component` selector.\n\n```bash\nnx g @nx/angular:library --standalone --selector=myorg-standalone-component my-standalone-lib\n```\n\n{% /tab %}\n",
"examplesFile": "## Examples\n\n{% tabs %}\n{% tab label=\"Simple Library\" %}\n\nCreates the `my-ui-lib` library with an `ui` tag:\n\n```bash\nnx g @nx/angular:library my-ui-lib --tags=ui\n```\n\n{% /tab %}\n\n{% tab label=\"Publishable Library\" %}\n\nCreates the `my-lib` library that can be built producing an output following the Angular Package Format (APF) to be distributed as an NPM package:\n\n```bash\nnx g @nx/angular:library my-lib --publishable --import-path=@my-org/my-lib\n```\n\n{% /tab %}\n\n{% tab label=\"Buildable Library\" %}\n\nCreates the `my-lib` library with support for incremental builds:\n\n```bash\nnx g @nx/angular:library my-lib --buildable\n```\n\n{% /tab %}\n\n{% tab label=\"Nested Folder & Import\"%}\nCreates the `my-lib` library in the `nested` directory and sets the import path to `@myorg/nested/my-lib`:\n\n{% callout type=\"note\" title=\"Directory Flag Behavior Changes\" %}\nThe command below uses the `as-provided` directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the `derived` option, use `--directory=nested`. See the [workspace layout documentation](/deprecated/workspace-layout) for more details.\n{% /callout %}\n\n```bash\nnx g @nx/angular:library --directory=libs/nested/my-lib --importPath=@myorg/nested/my-lib my-lib\n```\n\n{% /tab %}\n\n{% tab label=\"Standalone component\"%}\nCreates the `my-standalone-lib` library with a standalone component as an entry point instead of an ng-module. The component can be used via the `myorg-standalone-component` selector.\n\n```bash\nnx g @nx/angular:library --standalone --selector=myorg-standalone-component my-standalone-lib\n```\n\n{% /tab %}\n",
"presets": []
},
"aliases": ["lib"],
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/esbuild/documents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ yarn add -D @nx/esbuild
### Creating a new JS library

{% callout type="note" title="Directory Flag Behavior Changes" %}
The command below uses the `as-provided` directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the `derived` option, omit the `--directory` flag. See the [workspace layout documentation](/reference/nx-json#workspace-layout) for more details.
The command below uses the `as-provided` directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the `derived` option, omit the `--directory` flag. See the [workspace layout documentation](/deprecated/workspace-layout) for more details.
{% /callout %}

You can add a new library that builds using esbuild with:
Expand Down
Loading