{ "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": [ { "command": "nx g hook mylib/my-hook", "description": "Generate a hook `my-hook` in the `mylib` library" } ], "properties": { "path": { "type": "string", "description": "Path where the hook will be generated.", "$default": { "$source": "argv", "index": 0 }, "x-prompt": "Where should the hook be generated?", "x-priority": "important" }, "name": { "type": "string", "description": "The name of the hook.", "x-prompt": "What name would you like to use for the hook?", "x-priority": "important" }, "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" }, "directory": { "type": "string", "description": "The directory at which to create the hook file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the project root.", "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"] }, "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": ["name"], "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" }