miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): add docs for new x-priority option (#15187)

Browse Source
This commit is contained in:
MaxKless 2023-02-23 17:28:24 +03:00 committed by GitHub
parent d35c75fa53
commit 16023ea679
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/shared/recipes/generators/generator-options.md
View File

@ -287,7 +287,8 @@ Any additional properties will be considered invalid.
"items": [], "items": [],
"multiselect": false "multiselect": false
}, },
"x-deprecated": false "x-deprecated": false,
"x-priority": "important"
} }
``` ```
@ -769,6 +770,20 @@ This indicates that the property `setupFile` is deprecated without a reason. The
This indicates that users should use the `tsconfig` property rather than specify this property. This indicates that users should use the `tsconfig` property rather than specify this property.
#### `x-priority`
Indicates the priority of a property. Can either be `important` or `internal`. This will be used to sort the properties on `nx.dev`, in Nx Console and when calling a generator with `--help`. `important` properties are displayed right after `required` ones while `internal` properties are shown at the end or hidden.
```json
{
"directory": {
"description": "The directory of the new application.",
"type": "string",
"x-priority": "important"
}
}
```
#### `number` specific: `multipleOf` #### `number` specific: `multipleOf`
Make sure that the number can be divided by the specified number. Example: Make sure that the number can be divided by the specified number. Example: