@nx/react 22.7.0-beta.7 → 22.7.0-beta.9

package/src/generators/component-story/schema.json

@@ -1,42 +1,42 @@
 {
-  "$schema": "https://json-schema.org/schema",
-  "cli": "nx",
-  "$id": "NxReactComponentStory",
-  "title": "Create component story",
-  "description": "Generate storybook story for a react component.",
-  "type": "object",
-  "properties": {
-    "project": {
-      "type": "string",
-      "aliases": ["name", "projectName"],
-      "description": "The project where to add the components.",
-      "examples": ["shared-ui-component"],
-      "$default": {
-        "$source": "projectName",
-        "index": 0
-      },
-      "x-prompt": "What's name of the project where the component lives?",
-      "x-priority": "important"
+    "$schema": "https://json-schema.org/schema",
+    "cli": "nx",
+    "$id": "NxReactComponentStory",
+    "title": "Create component story",
+    "description": "Generate storybook story for a react component.",
+    "type": "object",
+    "properties": {
+        "project": {
+            "type": "string",
+            "aliases": ["name", "projectName"],
+            "description": "The project where to add the components.",
+            "examples": ["shared-ui-component"],
+            "$default": {
+                "$source": "projectName",
+                "index": 0
+            },
+            "x-prompt": "What's name of the project where the component lives?",
+            "x-priority": "important"
+        },
+        "componentPath": {
+            "type": "string",
+            "description": "Relative path to the component file from the library root.",
+            "examples": ["lib/components"],
+            "x-prompt": "What's path of the component relative to the project's lib root?",
+            "x-priority": "important"
+        },
+        "skipFormat": {
+            "description": "Skip formatting files.",
+            "type": "boolean",
+            "default": false,
+            "x-priority": "internal"
+        },
+        "interactionTests": {
+            "type": "boolean",
+            "description": "Set up Storybook interaction tests.",
+            "default": true,
+            "x-priority": "important"
+        }
     },
-    "componentPath": {
-      "type": "string",
-      "description": "Relative path to the component file from the library root.",
-      "examples": ["lib/components"],
-      "x-prompt": "What's path of the component relative to the project's lib root?",
-      "x-priority": "important"
-    },
-    "skipFormat": {
-      "description": "Skip formatting files.",
-      "type": "boolean",
-      "default": false,
-      "x-priority": "internal"
-    },
-    "interactionTests": {
-      "type": "boolean",
-      "description": "Set up Storybook interaction tests.",
-      "default": true,
-      "x-priority": "important"
-    }
-  },
-  "required": ["project", "componentPath"]
+    "required": ["project", "componentPath"]
 }

package/src/generators/component-test/schema.json

@@ -1,31 +1,31 @@
 {
-  "$schema": "https://json-schema.org/schema",
-  "cli": "nx",
-  "$id": "NxReactCypressComponentTest",
-  "title": "Add Cypress component test",
-  "description": "Add a Cypress component test for a component.",
-  "type": "object",
-  "examples": [
-    {
-      "command": "nx g @nx/react:component-test --project=my-react-project --component-path=src/lib/fancy-component.tsx",
-      "description": "Create a cypress component test for FancyComponent"
-    }
-  ],
-  "properties": {
-    "project": {
-      "type": "string",
-      "description": "The name of the project the component is apart of",
-      "x-dropdown": "projects",
-      "x-prompt": "What project is this component apart of?",
-      "x-priority": "important"
+    "$schema": "https://json-schema.org/schema",
+    "cli": "nx",
+    "$id": "NxReactCypressComponentTest",
+    "title": "Add Cypress component test",
+    "description": "Add a Cypress component test for a component.",
+    "type": "object",
+    "examples": [
+        {
+            "command": "nx g @nx/react:component-test --project=my-react-project --component-path=src/lib/fancy-component.tsx",
+            "description": "Create a cypress component test for FancyComponent"
+        }
+    ],
+    "properties": {
+        "project": {
+            "type": "string",
+            "description": "The name of the project the component is apart of",
+            "x-dropdown": "projects",
+            "x-prompt": "What project is this component apart of?",
+            "x-priority": "important"
+        },
+        "componentPath": {
+            "type": "string",
+            "description": "Path to component, from the project source root",
+            "x-prompt": "What is the path to the component?",
+            "x-priority": "important"
+        }
     },
-    "componentPath": {
-      "type": "string",
-      "description": "Path to component, from the project source root",
-      "x-prompt": "What is the path to the component?",
-      "x-priority": "important"
-    }
-  },
-  "required": ["project", "componentPath"],
-  "examplesFile": "../../../docs/component-test-examples.md"
+    "required": ["project", "componentPath"],
+    "examplesFile": "../../../docs/component-test-examples.md"
 }

package/src/generators/cypress-component-configuration/schema.json

@@ -1,54 +1,54 @@
 {
-  "$schema": "https://json-schema.org/schema",
-  "cli": "nx",
-  "$id": "NxReactCypressComponentTestConfiguration",
-  "title": "Add Cypress component testing",
-  "description": "Add a Cypress component testing configuration to an existing project.",
-  "type": "object",
-  "examples": [
-    {
-      "command": "nx g @nx/react:cypress-component-configuration --project=my-react-project",
-      "description": "Add component testing to your react project"
+    "$schema": "https://json-schema.org/schema",
+    "cli": "nx",
+    "$id": "NxReactCypressComponentTestConfiguration",
+    "title": "Add Cypress component testing",
+    "description": "Add a Cypress component testing configuration to an existing project.",
+    "type": "object",
+    "examples": [
+        {
+            "command": "nx g @nx/react:cypress-component-configuration --project=my-react-project",
+            "description": "Add component testing to your react project"
+        },
+        {
+            "command": "nx g @nx/react:cypress-component-configuration --project=my-react-project --generate-tests",
+            "description": "Add component testing to your react project and generate component tests for your existing components"
+        }
+    ],
+    "properties": {
+        "project": {
+            "type": "string",
+            "description": "The name of the project to add cypress component testing configuration to",
+            "x-dropdown": "projects",
+            "x-prompt": "What project should we add Cypress component testing to?",
+            "x-priority": "important"
+        },
+        "generateTests": {
+            "type": "boolean",
+            "description": "Generate default component tests for existing components in the project",
+            "x-prompt": "Automatically generate tests for components declared in this project?",
+            "default": false,
+            "x-priority": "important"
+        },
+        "buildTarget": {
+            "type": "string",
+            "description": "A build target used to configure Cypress component testing in the format of `project:target[:configuration]`. The build target should be from a React app. If not provided we will try to infer it from your projects usage.",
+            "pattern": "^[^:\\s]+:[^:\\s]+(:\\S+)?$"
+        },
+        "skipFormat": {
+            "type": "boolean",
+            "description": "Skip formatting files",
+            "default": false,
+            "x-priority": "internal"
+        },
+        "bundler": {
+            "description": "The bundler to use for Cypress Component Testing.",
+            "type": "string",
+            "enum": ["vite", "webpack"],
+            "hidden": true,
+            "x-priority": "internal"
+        }
     },
-    {
-      "command": "nx g @nx/react:cypress-component-configuration --project=my-react-project --generate-tests",
-      "description": "Add component testing to your react project and generate component tests for your existing components"
-    }
-  ],
-  "properties": {
-    "project": {
-      "type": "string",
-      "description": "The name of the project to add cypress component testing configuration to",
-      "x-dropdown": "projects",
-      "x-prompt": "What project should we add Cypress component testing to?",
-      "x-priority": "important"
-    },
-    "generateTests": {
-      "type": "boolean",
-      "description": "Generate default component tests for existing components in the project",
-      "x-prompt": "Automatically generate tests for components declared in this project?",
-      "default": false,
-      "x-priority": "important"
-    },
-    "buildTarget": {
-      "type": "string",
-      "description": "A build target used to configure Cypress component testing in the format of `project:target[:configuration]`. The build target should be from a React app. If not provided we will try to infer it from your projects usage.",
-      "pattern": "^[^:\\s]+:[^:\\s]+(:\\S+)?$"
-    },
-    "skipFormat": {
-      "type": "boolean",
-      "description": "Skip formatting files",
-      "default": false,
-      "x-priority": "internal"
-    },
-    "bundler": {
-      "description": "The bundler to use for Cypress Component Testing.",
-      "type": "string",
-      "enum": ["vite", "webpack"],
-      "hidden": true,
-      "x-priority": "internal"
-    }
-  },
-  "required": ["project"],
-  "examplesFile": "../../../docs/cypress-component-configuration-examples.md"
+    "required": ["project"],
+    "examplesFile": "../../../docs/cypress-component-configuration-examples.md"
 }

package/src/generators/federate-module/schema.json

@@ -1,90 +1,90 @@
 {
-  "$schema": "https://json-schema.org/schema",
-  "cli": "nx",
-  "$id": "NxReactFederateModule",
-  "title": "Federate Module",
-  "description": "Create a federated module, which can be loaded by a Consumer (host) via a Producer (remote).",
-  "examples": [
-    {
-      "command": "nx g federate-module MyModule --path=./src/component/my-cmp.ts --remote=myRemote --remoteDirectory=apps/myRemote",
-      "description": "Create a federated module from myRemote, that exposes my-cmp from ./src/component/my-cmp.ts as MyModule."
+    "$schema": "https://json-schema.org/schema",
+    "cli": "nx",
+    "$id": "NxReactFederateModule",
+    "title": "Federate Module",
+    "description": "Create a federated module, which can be loaded by a Consumer (host) via a Producer (remote).",
+    "examples": [
+        {
+            "command": "nx g federate-module MyModule --path=./src/component/my-cmp.ts --remote=myRemote --remoteDirectory=apps/myRemote",
+            "description": "Create a federated module from myRemote, that exposes my-cmp from ./src/component/my-cmp.ts as MyModule."
+        },
+        {
+            "command": "nx g federate-module MyModule --path=./src/component/my-cmp.ts --producer=myProducer --producerDirectory=apps/myProducer",
+            "description": "Create a federated module from myProducer, that exposes my-cmp from ./src/component/my-cmp.ts as MyModule."
+        }
+    ],
+    "type": "object",
+    "properties": {
+        "path": {
+            "type": "string",
+            "$default": {
+                "$source": "argv",
+                "index": 0
+            },
+            "description": "The path to locate the federated module. This path should be relative to the workspace root and the file should exist.",
+            "x-prompt": "What is the path to the module to be federated?"
+        },
+        "name": {
+            "description": "The name of the module.",
+            "type": "string",
+            "x-prompt": "What name would you like to use for the module?",
+            "pattern": "^[a-zA-Z][^:]*$",
+            "x-priority": "important"
+        },
+        "remote": {
+            "type": "string",
+            "description": "The name of the Producer (remote).",
+            "x-prompt": "What is/should the Producer (remote) be named?",
+            "alias": "producer"
+        },
+        "remoteDirectory": {
+            "description": "The directory of the new Producer (remote) application if one needs to be created.",
+            "type": "string",
+            "alias": "producerDirectory"
+        },
+        "style": {
+            "description": "The file extension to be used for style files.",
+            "type": "string",
+            "default": "none",
+            "alias": "s"
+        },
+        "linter": {
+            "description": "The tool to use for running lint checks.",
+            "type": "string",
+            "enum": ["eslint"],
+            "default": "eslint"
+        },
+        "skipFormat": {
+            "description": "Skip formatting files.",
+            "type": "boolean",
+            "default": false,
+            "x-priority": "internal"
+        },
+        "unitTestRunner": {
+            "type": "string",
+            "enum": ["jest", "none"],
+            "description": "Test runner to use for unit tests.",
+            "default": "jest"
+        },
+        "e2eTestRunner": {
+            "type": "string",
+            "enum": ["cypress", "playwright", "none"],
+            "description": "Test runner to use for end to end (E2E) tests.",
+            "x-prompt": "Which E2E test runner would you like to use?",
+            "default": "cypress"
+        },
+        "host": {
+            "type": "string",
+            "description": "The Consumer (host) application for this Producer (remote)."
+        },
+        "bundler": {
+            "description": "The bundler to use.",
+            "type": "string",
+            "enum": ["rspack", "webpack"],
+            "default": "rspack"
+        }
     },
-    {
-      "command": "nx g federate-module MyModule --path=./src/component/my-cmp.ts --producer=myProducer --producerDirectory=apps/myProducer",
-      "description": "Create a federated module from myProducer, that exposes my-cmp from ./src/component/my-cmp.ts as MyModule."
-    }
-  ],
-  "type": "object",
-  "properties": {
-    "path": {
-      "type": "string",
-      "$default": {
-        "$source": "argv",
-        "index": 0
-      },
-      "description": "The path to locate the federated module. This path should be relative to the workspace root and the file should exist.",
-      "x-prompt": "What is the path to the module to be federated?"
-    },
-    "name": {
-      "description": "The name of the module.",
-      "type": "string",
-      "x-prompt": "What name would you like to use for the module?",
-      "pattern": "^[a-zA-Z][^:]*$",
-      "x-priority": "important"
-    },
-    "remote": {
-      "type": "string",
-      "description": "The name of the Producer (remote).",
-      "x-prompt": "What is/should the Producer (remote) be named?",
-      "alias": "producer"
-    },
-    "remoteDirectory": {
-      "description": "The directory of the new Producer (remote) application if one needs to be created.",
-      "type": "string",
-      "alias": "producerDirectory"
-    },
-    "style": {
-      "description": "The file extension to be used for style files.",
-      "type": "string",
-      "default": "none",
-      "alias": "s"
-    },
-    "linter": {
-      "description": "The tool to use for running lint checks.",
-      "type": "string",
-      "enum": ["eslint"],
-      "default": "eslint"
-    },
-    "skipFormat": {
-      "description": "Skip formatting files.",
-      "type": "boolean",
-      "default": false,
-      "x-priority": "internal"
-    },
-    "unitTestRunner": {
-      "type": "string",
-      "enum": ["jest", "none"],
-      "description": "Test runner to use for unit tests.",
-      "default": "jest"
-    },
-    "e2eTestRunner": {
-      "type": "string",
-      "enum": ["cypress", "playwright", "none"],
-      "description": "Test runner to use for end to end (E2E) tests.",
-      "x-prompt": "Which E2E test runner would you like to use?",
-      "default": "cypress"
-    },
-    "host": {
-      "type": "string",
-      "description": "The Consumer (host) application for this Producer (remote)."
-    },
-    "bundler": {
-      "description": "The bundler to use.",
-      "type": "string",
-      "enum": ["rspack", "webpack"],
-      "default": "rspack"
-    }
-  },
-  "required": ["name", "path", "remote"],
-  "additionalProperties": false
+    "required": ["name", "path", "remote"],
+    "additionalProperties": false
 }

package/src/generators/hook/schema.json

@@ -1,57 +1,57 @@
 {
-  "$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"
+    "$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?"
+        }
     },
-    {
-      "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"]
+    "required": ["path"]
 }