feat(qwik-nx): make directory a required option for generators

dmitry-stepanenko · dmitry-stepanenko · commit 767838eb41c1 · 2024-10-20T22:59:25.000+03:00
diff --git a/packages/qwik-nx/src/generators/application/generator.spec.ts b/packages/qwik-nx/src/generators/application/generator.spec.ts
@@ -14,7 +14,7 @@ describe('qwik-nx generator', () => {
 
   let appTree: Tree;
   const defaultOptions: QwikAppGeneratorSchema = {
-    name: 'myapp',
+    directory: 'myapp',
     style: 'css',
     linter: Linter.None,
     skipFormat: false,
diff --git a/packages/qwik-nx/src/generators/application/schema.d.ts b/packages/qwik-nx/src/generators/application/schema.d.ts
@@ -2,9 +2,9 @@ import type { Linter } from '@nx/eslint';
 import type { ProjectNameAndRootFormat } from '@nx/devkit/src/generators/project-name-and-root-utils';
 
 export interface QwikAppGeneratorSchema {
-  name: string;
+  directory: string;
+  name?: string;
   tags?: string;
-  directory?: string;
   style?: 'css' | 'scss' | 'styl' | 'less' | 'none';
   linter?: Linter;
   skipFormat?: boolean;
@@ -14,10 +14,10 @@ export interface QwikAppGeneratorSchema {
   e2eTestRunner?: 'playwright' | 'cypress' | 'none';
   devServerPort?: number;
   previewServerPort?: number;
-  projectNameAndRootFormat?: ProjectNameAndRootFormat;
 }
 
 export interface NormalizedSchema extends QwikAppGeneratorSchema {
+  name: string;
   devServerPort: number;
   previewServerPort: number;
   projectName: string;
@@ -27,7 +27,6 @@ export interface NormalizedSchema extends QwikAppGeneratorSchema {
   setupVitest: boolean;
   parsedTags: string[];
   styleExtension: Exclude<QwikAppGeneratorSchema['style'], 'none'> | null;
-  projectNameAndRootFormat: ProjectNameAndRootFormat;
   e2eProjectName: string;
   e2eProjectRoot: string;
 }
diff --git a/packages/qwik-nx/src/generators/application/schema.json b/packages/qwik-nx/src/generators/application/schema.json
@@ -6,12 +6,9 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "",
-      "$default": {
-        "$source": "argv",
-        "index": 0
-      },
-      "x-prompt": "What name would you like to use?"
+      "description": "The name of the application.",
+      "pattern": "^[a-zA-Z][^:]*$",
+      "x-priority": "important"
     },
     "tags": {
       "type": "string",
@@ -20,7 +17,9 @@
     },
     "directory": {
       "type": "string",
-      "description": "A directory where the project is placed"
+      "description": "A directory where the project is placed",
+      "$default": { "$source": "argv", "index": 0 },
+      "x-prompt": "Which directory do you want to create the application in?"
     },
     "style": {
       "description": "The file extension to be used for style files.",
@@ -51,11 +50,6 @@
         "default": "css"
       }
     },
-    "projectNameAndRootFormat": {
-      "description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
-      "type": "string",
-      "enum": ["as-provided", "derived"]
-    },
     "linter": {
       "description": "The tool to use for running lint checks.",
       "type": "string",
@@ -100,5 +94,5 @@
       "default": 4173
     }
   },
-  "required": ["name"]
+  "required": ["directory"]
 }
diff --git a/packages/qwik-nx/src/generators/application/utils/normalize-options.ts b/packages/qwik-nx/src/generators/application/utils/normalize-options.ts
@@ -1,23 +1,23 @@
 import { offsetFromRoot, Tree } from '@nx/devkit';
 import { getRelativePathToRootTsConfig } from '@nx/js';
 import { NormalizedSchema, QwikAppGeneratorSchema } from '../schema';
-import { determineProjectNameAndRootOptions } from '@nx/devkit/src/generators/project-name-and-root-utils';
+import {
+  determineProjectNameAndRootOptions,
+  ensureProjectName,
+} from '@nx/devkit/src/generators/project-name-and-root-utils';
 
 export async function normalizeOptions(
   host: Tree,
   options: QwikAppGeneratorSchema
 ): Promise<NormalizedSchema> {
-  const {
-    projectName: appProjectName,
-    projectRoot: appProjectRoot,
-    projectNameAndRootFormat,
-  } = await determineProjectNameAndRootOptions(host, {
-    name: options.name,
-    projectType: 'application',
-    callingGenerator: 'qwik-nx:application',
-    directory: options.directory,
-    projectNameAndRootFormat: options.projectNameAndRootFormat,
-  });
+  await ensureProjectName(host, options, 'application');
+
+  const { projectName: appProjectName, projectRoot: appProjectRoot } =
+    await determineProjectNameAndRootOptions(host, {
+      name: options.name,
+      projectType: 'application',
+      directory: options.directory,
+    });
 
   const parsedTags = options.tags
     ? options.tags.split(',').map((s) => s.trim())
@@ -34,6 +34,7 @@ export async function normalizeOptions(
 
   return {
     ...options,
+    name: options.name!, // defined by "ensureProjectName"
     projectName: appProjectName,
     projectRoot: appProjectRoot,
     offsetFromRoot: offsetFromRoot(appProjectRoot),
@@ -43,7 +44,6 @@ export async function normalizeOptions(
     parsedTags,
     devServerPort: options.devServerPort ?? 5173,
     previewServerPort: options.previewServerPort ?? 4173,
-    projectNameAndRootFormat,
     e2eProjectName,
     e2eProjectRoot,
   };
diff --git a/packages/qwik-nx/src/generators/host/schema.d.ts b/packages/qwik-nx/src/generators/host/schema.d.ts
@@ -2,9 +2,9 @@ import { ProjectNameAndRootFormat } from '@nx/devkit/src/generators/project-name
 import { Linter } from '@nx/eslint';
 
 export interface HostGeneratorSchema {
-  name: string;
+  name?: string;
   tags?: string;
-  directory?: string;
+  directory: string;
   style?: 'css' | 'scss' | 'styl' | 'less' | 'none';
   linter?: Linter;
   skipFormat?: boolean;
diff --git a/packages/qwik-nx/src/generators/host/schema.json b/packages/qwik-nx/src/generators/host/schema.json
@@ -7,23 +7,21 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "",
-      "$default": {
-        "$source": "argv",
-        "index": 0
-      },
-      "x-prompt": "What name would you like to use?"
+      "description": "The name of the application.",
+      "pattern": "^[a-zA-Z][^:]*$",
+      "x-priority": "important"
+    },
+    "directory": {
+      "type": "string",
+      "description": "A directory where the project is placed",
+      "$default": { "$source": "argv", "index": 0 },
+      "x-prompt": "Which directory do you want to create the application in?"
     },
     "tags": {
       "type": "string",
       "description": "Add tags to the project (used for linting)",
       "alias": "t"
     },
-    "directory": {
-      "type": "string",
-      "description": "A directory where the project is placed",
-      "x-priority": "important"
-    },
     "projectNameAndRootFormat": {
       "description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
       "type": "string",
@@ -102,5 +100,5 @@
       "x-priority": "important"
     }
   },
-  "required": ["name"]
+  "required": ["directory"]
 }
diff --git a/packages/qwik-nx/src/generators/integrations/react-library/generator.ts b/packages/qwik-nx/src/generators/integrations/react-library/generator.ts
@@ -18,6 +18,7 @@ import {
 } from '../../../utils/react/init';
 
 interface NormalizedSchema extends ReactLibraryGeneratorSchema {
+  name: string;
   installMUIExample: boolean;
   targetApps: string[];
   projectName: string;
diff --git a/packages/qwik-nx/src/generators/integrations/react-library/schema.json b/packages/qwik-nx/src/generators/integrations/react-library/schema.json
@@ -8,16 +8,16 @@
     "name": {
       "type": "string",
       "description": "Library name.",
+      "x-priority": "important"
+    },
+    "directory": {
+      "type": "string",
+      "description": "A directory where the lib is placed.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What name would you like to use for the library?",
-      "pattern": "^[a-zA-Z].*$"
-    },
-    "directory": {
-      "type": "string",
-      "description": "A directory where the lib is placed."
+      "x-prompt": "Which directory do you want to create the library in?"
     },
     "projectNameAndRootFormat": {
       "description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
@@ -90,5 +90,5 @@
       "default": false
     }
   },
-  "required": ["name"]
+  "required": ["directory"]
 }
diff --git a/packages/qwik-nx/src/generators/library/generator-internal.ts b/packages/qwik-nx/src/generators/library/generator-internal.ts
@@ -70,7 +70,6 @@ async function addLibrary(
     includeBabelRc: false,
     buildable: false,
     bundler: 'none',
-    projectNameAndRootFormat: options.projectNameAndRootFormat,
   });
   tasks.push(libGeneratorTask);
 
diff --git a/packages/qwik-nx/src/generators/library/schema.d.ts b/packages/qwik-nx/src/generators/library/schema.d.ts
@@ -1,8 +1,8 @@
 import { Linter } from '@nx/eslint';
 
 export interface LibraryGeneratorSchema {
-  name: string;
-  directory?: string;
+  name?: string;
+  directory: string;
   skipFormat?: boolean;
   style?: 'css' | 'scss' | 'styl' | 'less' | 'none';
   tags?: string;
@@ -13,16 +13,15 @@ export interface LibraryGeneratorSchema {
   buildable?: boolean;
   storybookConfiguration?: boolean;
   generateComponent?: boolean;
-  projectNameAndRootFormat?: ProjectNameAndRootFormat;
 }
 
 type NormalizedRequiredPropsNames =
+  | 'name'
   | 'style'
   | 'unitTestRunner'
   | 'linter'
   | 'storybookConfiguration'
   | 'generateComponent'
-  | 'projectNameAndRootFormat'
   | 'buildable';
 type NormalizedRequiredProps = Required<
   Pick<LibraryGeneratorSchema, NormalizedRequiredPropsNames>
diff --git a/packages/qwik-nx/src/generators/library/schema.json b/packages/qwik-nx/src/generators/library/schema.json
@@ -7,16 +7,16 @@
     "name": {
       "type": "string",
       "description": "Library name.",
+      "x-priority": "important"
+    },
+    "directory": {
+      "type": "string",
+      "description": "A directory where the lib is placed.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What name would you like to use for the library?",
-      "pattern": "^[a-zA-Z].*$"
-    },
-    "directory": {
-      "type": "string",
-      "description": "A directory where the lib is placed."
+      "x-prompt": "Which directory do you want to create the library in?"
     },
     "buildable": {
       "type": "boolean",
@@ -30,11 +30,6 @@
       "enum": ["eslint", "none"],
       "default": "eslint"
     },
-    "projectNameAndRootFormat": {
-      "description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
-      "type": "string",
-      "enum": ["as-provided", "derived"]
-    },
     "unitTestRunner": {
       "type": "string",
       "enum": ["vitest", "none"],
@@ -103,5 +98,5 @@
       "default": true
     }
   },
-  "required": ["name"]
+  "required": ["directory"]
 }
diff --git a/packages/qwik-nx/src/generators/library/utils/normalize-options.ts b/packages/qwik-nx/src/generators/library/utils/normalize-options.ts
@@ -1,20 +1,25 @@
 import { offsetFromRoot, Tree } from '@nx/devkit';
 import { Linter } from '@nx/eslint';
 import { LibraryGeneratorSchema, NormalizedSchema } from '../schema';
-import { determineProjectNameAndRootOptions } from '@nx/devkit/src/generators/project-name-and-root-utils';
+import {
+  determineProjectNameAndRootOptions,
+  ensureProjectName,
+} from '@nx/devkit/src/generators/project-name-and-root-utils';
 
 export async function normalizeOptions(
   tree: Tree,
   schema: LibraryGeneratorSchema
 ): Promise<NormalizedSchema> {
-  const { projectName, projectRoot, projectNameAndRootFormat } =
-    await determineProjectNameAndRootOptions(tree, {
+  await ensureProjectName(tree, schema, 'library');
+
+  const { projectName, projectRoot } = await determineProjectNameAndRootOptions(
+    tree,
+    {
       name: schema.name,
       projectType: 'library',
-      callingGenerator: 'qwik-nx:library',
       directory: schema.directory,
-      projectNameAndRootFormat: schema.projectNameAndRootFormat,
-    });
+    }
+  );
 
   const parsedTags = schema.tags
     ? schema.tags.split(',').map((s) => s.trim())
@@ -32,10 +37,10 @@ export async function normalizeOptions(
 
   return {
     ...withDefaultValues,
+    name: schema.name!, // defined by the "ensureProjectName"
     projectName,
     projectRoot,
     parsedTags,
-    projectNameAndRootFormat,
     setupVitest: withDefaultValues.unitTestRunner === 'vitest',
     offsetFromRoot: offsetFromRoot(projectRoot),
   };
diff --git a/packages/qwik-nx/src/generators/preset/generator.ts b/packages/qwik-nx/src/generators/preset/generator.ts
@@ -5,10 +5,9 @@ export default async function (
   tree: Tree,
   options: QwikWorkspacePresetGeneratorSchema
 ) {
-  options.directory = 'apps';
   options.name = options.qwikAppName ?? options.name;
   options.style = options.qwikAppStyle ?? options.style;
   return await import('../application/generator').then(({ appGenerator }) =>
-    appGenerator(tree, { ...options, projectNameAndRootFormat: 'derived' })
+    appGenerator(tree, { ...options, directory: 'apps' })
   );
 }
diff --git a/packages/qwik-nx/src/generators/remote/schema.d.ts b/packages/qwik-nx/src/generators/remote/schema.d.ts
@@ -1,9 +1,9 @@
 import { ProjectNameAndRootFormat } from '@nx/devkit/src/generators/project-name-and-root-utils';
 
 export interface RemoteGeneratorSchema {
-  name: string;
+  name?: string;
   tags?: string;
-  directory?: string;
+  directory: string;
   style?: 'css' | 'scss' | 'styl' | 'less' | 'none';
   linter?: Linter;
   skipFormat?: boolean;
@@ -13,5 +13,4 @@ export interface RemoteGeneratorSchema {
   e2eTestRunner?: 'playwright' | 'cypress' | 'none';
   port?: number;
   host?: string;
-  projectNameAndRootFormat?: ProjectNameAndRootFormat;
 }
diff --git a/packages/qwik-nx/src/generators/remote/schema.json b/packages/qwik-nx/src/generators/remote/schema.json
