@nx/react/src/generators/hook/schema.json

The React plugin for Nx contains executors and generators for managing React applications and libraries within an Nx workspace. It provides: - Integration with libraries such as Jest, Vitest, Playwright, Cypress, and Storybook. - Generators for applica

{
  "$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.ts"
    },
    {
      "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.ts --name=useCustom"
    },
    {
      "description": "Generate a hook without providing the file extension. It results in the hook `useFoo` at `mylib/src/lib/foo.ts`",
      "command": "nx g @nx/react:hook mylib/src/lib/foo"
    }
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "The file path to the hook. 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.",
      "x-deprecated": "Provide the full file path including the file extension in the `path` option. This option will be removed in Nx v21."
    },
    "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"]
}