nx/docs/generated/packages/remix/generators/error-boundary.json
Jason Jean 8f705e31e2
fix(misc): adjust deprecation messages to v20 (#23223)
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

## Breaking Changes:


BREAKING CHANGE: `nx print-affected` was deprecated in 16.4.0 and has
been removed.
BREAKING CHANGE: `nx affected:graph` was deprecated in 16.4.0 and has
been removed.
BREAKING CHANGE: The `criticalPath` and `affectedProjects` properties of
the JSON created by `nx graph --file graph.json` was deprecated in
16.2.0 and has been removed.

## Current Behavior
<!-- This is the behavior we have today -->

Some deprecation messages still reference v19.

`nx print-affected` was deprecated in 16.4.0 to be removed in Nx 19 but
was not removed.
`nx affected:graph` was deprecated in 16.4.0 to be removed in Nx 19 but
was not removed.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Deprecation messages reference v20 now.

`nx print-affected` is removed.
`nx affected:graph` is removed.

There are redirects to a `deprecated` page describing those commands for
Nx users using Nx <19

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
2024-05-08 21:54:41 -04:00

48 lines
1.8 KiB
JSON

{
"name": "error-boundary",
"implementation": "/packages/remix/src/generators/error-boundary/error-boundary.impl.ts",
"schema": {
"$schema": "https://json-schema.org/schema",
"$id": "NxRemixErrorBoundary",
"title": "Create an ErrorBoundary for a Route",
"description": "Generate an ErrorBoundary for a given route.",
"type": "object",
"examples": [
{
"command": "g error-boundary --routePath=apps/demo/app/routes/my-route.tsx",
"description": "Generate an ErrorBoundary for my-route.tsx"
}
],
"properties": {
"path": {
"type": "string",
"description": "The path to route file relative to the project root."
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the error boundary in the path as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
"type": "string",
"enum": ["as-provided", "derived"]
},
"project": {
"type": "string",
"description": "The name of the project.",
"pattern": "^[a-zA-Z].*$",
"x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v20."
},
"skipFormat": {
"type": "boolean",
"description": "Skip formatting files after generation.",
"default": false,
"x-priority": "internal"
}
},
"required": ["path"],
"presets": []
},
"description": "Add an ErrorBoundary to an existing route",
"aliases": [],
"hidden": false,
"path": "/packages/remix/src/generators/error-boundary/schema.json",
"type": "generator"
}