nx/docs/generated/packages/angular/generators/scam-directive.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

98 lines
3.9 KiB
JSON

{
"name": "scam-directive",
"factory": "./src/generators/scam-directive/scam-directive",
"schema": {
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "SCAMDirectiveGenerator",
"cli": "nx",
"title": "SCAM Directive Generator Options Schema",
"type": "object",
"examples": [
{
"command": "nx g @nx/angular:scam-directive my-sample --directory=my-lib/src/lib/my-sample",
"description": "Generate a `MySampleDirective` directive in a `my-sample` folder in the `my-lib` library"
}
],
"description": "Creates a new, generic Angular directive definition in the given or default project.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "The name of the directive.",
"$default": { "$source": "argv", "index": 0 },
"x-prompt": "What name would you like to use for the directive?",
"x-priority": "important"
},
"directory": {
"type": "string",
"description": "The directory at which to create the SCAM Directive files. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
"aliases": ["dir", "path"],
"x-priority": "important"
},
"nameAndDirectoryFormat": {
"description": "Whether to generate the component in the directory 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.",
"$default": { "$source": "projectName" },
"x-dropdown": "projects",
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v20."
},
"skipTests": {
"type": "boolean",
"description": "Do not create `spec.ts` test files for the new directive.",
"default": false
},
"inlineScam": {
"type": "boolean",
"description": "Create the `NgModule` in the same file as the Directive.",
"default": true,
"x-priority": "important"
},
"flat": {
"type": "boolean",
"description": "Create the new files at the top level of the current project.",
"default": true,
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20."
},
"selector": {
"type": "string",
"format": "html-selector",
"description": "The `HTML` selector to use for this directive."
},
"prefix": {
"type": "string",
"description": "The prefix to apply to the generated directive selector.",
"alias": "p",
"oneOf": [
{ "maxLength": 0 },
{ "minLength": 1, "format": "html-selector" }
]
},
"export": {
"type": "boolean",
"description": "Specifies if the SCAM should be exported from the project's entry point (normally `index.ts`). It only applies to libraries.",
"default": true,
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false,
"x-priority": "internal"
}
},
"required": ["name"],
"presets": []
},
"description": "Generate a directive with an accompanying Single Component Angular Module (SCAM).",
"implementation": "/packages/angular/src/generators/scam-directive/scam-directive.ts",
"aliases": [],
"hidden": false,
"path": "/packages/angular/src/generators/scam-directive/schema.json",
"type": "generator"
}