dc67660fec
- Update artifact generator schemas: - Clarify `path` is the artifact file path relative to the current working directory - Clarify `name` is the artifact symbol name - Remove prompt for `name` and remove it from the important options (won't be displayed by default in Nx Console generation UI, it will be part of the collapsed options) given that most of the time, it's meant to match the filename (last segment of the `path`) - Remove some leftover options related to the name and path formats that were previously missed - Fix an issue with NestJS generators - Fix an issue with Next `page` generator <!-- 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` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
62 lines
2.2 KiB
JSON
62 lines
2.2 KiB
JSON
{
|
|
"name": "hook",
|
|
"factory": "./src/generators/hook/hook",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "NxReactHook",
|
|
"title": "Create a React Hook for Nx",
|
|
"description": "Create a React component using Hooks in a dedicated React project.",
|
|
"type": "object",
|
|
"examples": [
|
|
{
|
|
"description": "Generate a hook with the exported symbol matching the file name. It results in the hook `useFoo` at `mylib/src/lib/foo.ts`",
|
|
"command": "nx g @nx/react:hook mylib/src/lib/foo"
|
|
},
|
|
{
|
|
"description": "Generate a hook with the exported symbol different from the file name. It results in the hook `useCustom` at `mylib/src/lib/foo.ts`",
|
|
"command": "nx g @nx/react:hook mylib/src/lib/foo --name=useCustom"
|
|
}
|
|
],
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The file path to the hook without the file extension. Relative to the current working directory.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What is the hook file path?",
|
|
"x-priority": "important"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The hook symbol name. Defaults to the last segment of the file path."
|
|
},
|
|
"js": {
|
|
"type": "boolean",
|
|
"description": "Generate JavaScript files rather than TypeScript files.",
|
|
"default": false
|
|
},
|
|
"skipTests": {
|
|
"type": "boolean",
|
|
"description": "When true, does not create `spec.ts` test files for the new hook.",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
},
|
|
"export": {
|
|
"type": "boolean",
|
|
"description": "When true, the hook is exported from the project `index.ts` (if it exists).",
|
|
"alias": "e",
|
|
"default": false,
|
|
"x-prompt": "Should this hook be exported in the project?"
|
|
}
|
|
},
|
|
"required": ["path"],
|
|
"presets": []
|
|
},
|
|
"description": "Create a hook.",
|
|
"aliases": ["c"],
|
|
"implementation": "/packages/react/src/generators/hook/hook.ts",
|
|
"hidden": false,
|
|
"path": "/packages/react/src/generators/hook/schema.json",
|
|
"type": "generator"
|
|
}
|