feat(Nx20): fix generators to work in Nx20 where 'directory' is required option

L-X-T · L-X-T · commit 7c6380e300e8 · 2024-12-02T11:22:03.000+01:00
diff --git a/libs/ddd/README.md b/libs/ddd/README.md
@@ -86,6 +86,8 @@ ng g @angular-architects/ddd:feature search --domain booking --entity flight --s
 
 Don't mix Standalone Components and traditional ones within the same domain.
 
+**Since version 19**, standalone **defaults to true**.
+
 ## Generated Structure
 
 The included schematics generate a folder for each domain. This folder contains feature libs as well as a library with the domain logic:
diff --git a/libs/ddd/src/generators/api/index.ts b/libs/ddd/src/generators/api/index.ts
@@ -8,36 +8,34 @@ import { deleteDefaultComponent } from '../utils/delete-default-component';
 export default async function (tree: Tree, options: ApiOptions) {
   validateInputs(options);
 
-  const libName = options.name
-    ? `api-${strings.dasherize(options.name)}`
-    : 'api';
-
-  const domain = options.shared ? 'shared' : options.domain;
-  const libDirectory = options.directory
-    ? `${domain}/${options.directory}`
-    : domain;
+  const libName = options.name ? `api-${strings.dasherize(options.name)}` : 'api';
+  const libDirectory = options.directory ? strings.dasherize(options.directory) : libName;
+  const domainName = options.shared ? 'shared' : options.domain;
   const isPublishableLib = options.type === 'publishable';
 
+  // additions for Nx20 by LXT
+  const finalName = domainName + '-' + libName;
+  const finalDirectory = `libs/${domainName}/${libDirectory}`;
+
   await libraryGenerator(tree, {
-    name: `libs/${libDirectory}/${libName}`,
-    tags: `domain:${domain},domain:${domain}/${libName},type:api`,
-    prefix: options.name,
+    name: finalName,
+    prefix: finalName,
+    directory: finalDirectory,
+    tags: `domain:${domainName},domain:${domainName}/${libName},type:api`,
     publishable: isPublishableLib,
     buildable: options.type === 'buildable',
-    // directory: libDirectory,
     importPath: options.importPath,
     standalone: options.standalone,
   });
 
   deleteDefaultComponent(
     tree,
-    libDirectory,
-    libName,
-    options.name
+    finalDirectory,
+    finalName
   );
 
   console.info(
-    `\nHINT: Don\'t forget to extend the rules in your .eslintrc to allow selected domains to access this API.\nFor this, add the tag domain:${domain}/${libName} to the respective domains' rule sets.\n `
+    `\nHINT: Don\'t forget to extend the rules in your "eslint.config.js" to allow selected domains to access this API.\nFor this, add the tag domain:${domainName}/${libName} to the respective domains' rule sets.\n `
   );
 
   await formatFiles(tree);
diff --git a/libs/ddd/src/generators/domain/index.ts b/libs/ddd/src/generators/domain/index.ts
@@ -54,40 +54,39 @@ function convertToStandaloneApp(
 export default async function (tree: Tree, options: DomainOptions) {
   const appName = strings.dasherize(options.name);
   const appNameAndDirectory = options.appDirectory
-    ? `${options.appDirectory}/${appName}`
-    : appName;
-  const appNameAndDirectoryDasherized = strings
-    .dasherize(appNameAndDirectory)
+    ? `apps/${options.appDirectory}/${appName}`
+    : `apps/${appName}`;
+  const appNameSlug = strings
+    .dasherize(appName)
     .split('/')
     .join('-');
-  const appFolderPath = `apps/${appNameAndDirectory}`;
+  const appFolderPath = `${appNameAndDirectory}`;
   const appSrcFolder = `${appFolderPath}/src`;
   const appModuleFolder = `${appFolderPath}/src/app`;
   const appModuleFilepath = `${appModuleFolder}/app.module.ts`;
 
-  const libName = strings.dasherize(options.name);
-  const libNameAndDirectory = options.directory
-    ? `${options.directory}/${libName}`
-    : libName;
-  const libNameAndDirectoryDasherized = strings
-    .dasherize(libNameAndDirectory)
-    .split('/')
-    .join('-');
-  const libFolderPath = `libs/${libNameAndDirectory}`;
-  const libLibFolder = `${libFolderPath}/domain/src/lib`;
-  const libSrcFolder = `${libFolderPath}/domain/src`;
+  // additions for Nx20 by LXT
+  const domainName = strings.dasherize(options.name);
+  const domainNameAndDirectory = options.directory
+    ? `${options.directory}/${domainName}`
+    : domainName;
+
+  const finalName = domainName + '-domain';
+  const finalDirectory = `libs/${domainNameAndDirectory}/domain`;
+  const libSrcFolder = `${finalDirectory}/src`;
+  const libLibFolder = `${libSrcFolder}/lib`;
 
-  // if (options.ngrx && !options.addApp) {
-  //   throw new Error(
-  //     `The 'ngrx' option may only be used when the 'addApp' option is used.`
-  //   );
-  // }
+  /*if (options.ngrx && !options.addApp) {
+    throw new Error(
+      `The 'ngrx' option may only be used when the 'addApp' option is used.`
+    );
+  }*/
 
   await libraryGenerator(tree, {
-    name: `libs/${libNameAndDirectory}/domain`,
-    // directory: libNameAndDirectory,
-    tags: `domain:${libName},type:domain-logic`,
-    prefix: libName,
+    name: finalName,
+    prefix: finalName,
+    directory: finalDirectory,
+    tags: `domain:${domainName},type:domain-logic`,
     publishable: options.type === 'publishable',
     buildable: options.type === 'buildable',
     importPath: options.importPath,
@@ -96,8 +95,8 @@ export default async function (tree: Tree, options: DomainOptions) {
 
   updateDepConst(tree, (depConst) => {
     depConst.push({
-      sourceTag: `domain:${libName}`,
-      onlyDependOnLibsWithTags: [`domain:${libName}`, 'domain:shared'],
+      sourceTag: `domain:${domainName}`,
+      onlyDependOnLibsWithTags: [`domain:${domainName}`, 'domain:shared'],
     });
   });
 
@@ -114,8 +113,8 @@ export default async function (tree: Tree, options: DomainOptions) {
 
   if (options.addApp) {
     await applicationGenerator(tree, {
-      name: options.appDirectory ? `apps/${options.appDirectory}/${appName}` : `apps/${appName}`,
-      // directory: options.appDirectory,
+      name: appName,
+      directory: appNameAndDirectory,
       tags: `domain:${appName},type:app`,
       style: 'scss',
       standalone: options.standalone
@@ -125,7 +124,7 @@ export default async function (tree: Tree, options: DomainOptions) {
   const wsConfig = readNxJson(tree);
   const npmScope = getNpmScope(tree);
   // const wsConfig = readWorkspaceConfiguration(tree);
-  
+
   if (options.addApp && options.standalone) {
     convertToStandaloneApp(tree, {
       name: options.name,
@@ -146,7 +145,7 @@ export default async function (tree: Tree, options: DomainOptions) {
     );
 
     await generateStore(tree, {
-      project: appNameAndDirectoryDasherized,
+      project: appNameSlug,
       root: true,
       minimal: true,
       module: 'app.module.ts',
@@ -170,14 +169,14 @@ export default async function (tree: Tree, options: DomainOptions) {
 
   }
 
+  // fixed by LXT
   deleteDefaultComponent(
     tree,
-    libNameAndDirectory,
-    'domain',
-    libName,
+    finalDirectory,
+    finalName,
     !options.ngrx
   );
-  
+
   await formatFiles(tree);
   return () => {
     installPackagesTask(tree);
diff --git a/libs/ddd/src/generators/feature/index.ts b/libs/ddd/src/generators/feature/index.ts
@@ -56,9 +56,9 @@ export default async function (tree: Tree, options: FeatureOptions) {
   const appDirectoryAndName = appDirectory
     ? `${appDirectory}/${appName}`
     : appName;
-  const appDirectoryAndNameDasherized = `${appDirectoryAndName}`
+  /*const appDirectoryAndNameDasherized = `${appDirectoryAndName}`
     .split('/')
-    .join('-');
+    .join('-');*/
   const domainNameAndDirectoryPath = `libs/${domainNameAndDirectory}`;
   const domainFolderPath = `${domainNameAndDirectoryPath}/domain`;
   const domainLibFolderPath = `${domainFolderPath}/src/lib`;
@@ -80,7 +80,7 @@ export default async function (tree: Tree, options: FeatureOptions) {
   const featureModuleClassName = strings.classify(
     `${domainNameAndDirectoryDasherized}-${featureFolderName}Module`
   );
-  const featureImportPath = `${workspaceName}/${domainNameAndDirectory}/${featureFolderName}`;
+  const featureImportPath = `${workspaceName}/${featureFolderName}`; // /${domainNameAndDirectory}/ removed by LXT
   const featureIndexPath = `${domainNameAndDirectoryPath}/${featureDirectoryAndFolderName}/src/index.ts`;
   const entityName = options.entity ? strings.dasherize(options.entity) : '';
   const featureComponentImportPath = `./${featureDirectoryAndNameDasherized}.component`;
@@ -102,15 +102,17 @@ export default async function (tree: Tree, options: FeatureOptions) {
     );
   }
 
-  const dir = featureDirectory
-    ? `${domainNameAndDirectory}/${featureDirectory}`
-    : `${domainNameAndDirectory}`;
+  // additions for Nx20 by LXT
+  const finalName = domainName + '-' + featureFolderName;
+  const finalDirectory = featureDirectory
+    ? `libs/${domainNameAndDirectory}/${featureDirectory}`
+    : `libs/${domainNameAndDirectory}/${featureFolderName}`;
 
   await libraryGenerator(tree, {
-    name: `libs/${dir}/${featureFolderName}`,
-    // directory: dir,
+    name: finalName,
+    prefix: finalName,
+    directory: finalDirectory,
     tags: `domain:${domainName},type:feature`,
-    prefix: domainNameAndDirectoryDasherized,
     publishable: options.type === 'publishable',
     buildable: options.type === 'buildable',
     importPath: options.importPath,
@@ -176,9 +178,8 @@ export default async function (tree: Tree, options: FeatureOptions) {
 
   deleteDefaultComponent(
     tree,
-    dir,
-    featureFolderName,
-    domainNameAndDirectoryDasherized
+    finalDirectory,
+    finalName
   );
 
   await formatFiles(tree);
diff --git a/libs/ddd/src/generators/ui/index.ts b/libs/ddd/src/generators/ui/index.ts
@@ -9,28 +9,29 @@ export default async function (tree: Tree, options: UiOptions) {
   validateInputs(options);
 
   const libName = `ui-${strings.dasherize(options.name)}`;
-  const domain = options.shared ? 'shared' : options.domain;
-  const libDirectory = options.directory
-    ? `${domain}/${options.directory}`
-    : domain;
+  const libDirectory = options.directory ? strings.dasherize(options.directory) : libName;
+  const domainName = options.shared ? 'shared' : options.domain;
   const isPublishableLib = options.type === 'publishable';
 
+  // additions for Nx20 by LXT
+  const finalName = domainName + '-' + libName;
+  const finalDirectory = `libs/${domainName}/${libDirectory}`;
+
   await libraryGenerator(tree, {
-    name: `libs/${libDirectory}/${libName}`,
-    tags: `domain:${domain},type:ui`,
-    prefix: options.name,
+    name: finalName,
+    prefix: finalName,
+    directory: finalDirectory,
+    tags: `domain:${domainName},type:ui`,
     publishable: isPublishableLib,
     buildable: options.type === 'buildable',
-    // directory: libDirectory,
     importPath: options.importPath,
     standalone: options.standalone,
   });
 
   deleteDefaultComponent(
     tree,
-    libDirectory,
-    libName,
-    options.name
+    finalDirectory,
+    finalName
   );
 
   await formatFiles(tree);
diff --git a/libs/ddd/src/generators/util/index.ts b/libs/ddd/src/generators/util/index.ts
@@ -9,28 +9,29 @@ export default async function (tree: Tree, options: UtilOptions) {
   validateInputs(options);
 
   const libName = `util-${strings.dasherize(options.name)}`;
-  const domain = options.shared ? 'shared' : options.domain;
-  const libDirectory = options.directory
-    ? `${domain}/${options.directory}`
-    : domain;
+  const libDirectory = options.directory ? strings.dasherize(options.directory) : libName;
+  const domainName = options.shared ? 'shared' : options.domain;
   const isPublishableLib = options.type === 'publishable';
 
+  // additions for Nx20 by LXT
+  const finalName = domainName + '-' + libName;
+  const finalDirectory = `libs/${domainName}/${libDirectory}`;
+
   await libraryGenerator(tree, {
-    name: `libs/${libDirectory}/${libName}`,
-    tags: `domain:${domain},type:util`,
-    prefix: options.name,
+    name: finalName,
+    prefix: finalName,
+    directory: finalDirectory,
+    tags: `domain:${domainName},type:util`,
     publishable: isPublishableLib,
     buildable: options.type === 'buildable',
-    // directory: libDirectory,
     importPath: options.importPath,
     standalone: options.standalone,
   });
 
   deleteDefaultComponent(
     tree,
-    libDirectory,
-    libName,
-    options.name
+    finalDirectory,
+    finalName
   );
 
   await formatFiles(tree);
diff --git a/libs/ddd/src/generators/utils/delete-default-component.ts b/libs/ddd/src/generators/utils/delete-default-component.ts
@@ -1,20 +1,19 @@
 import { Tree } from '@nx/devkit';
-import { dasherize } from '@nx/devkit/src/utils/string-utils';
 import * as path from 'path';
 
-export function deleteDefaultComponent(tree: Tree, directory: string, libName: string, prefix: string, deleteIndex = true): void {
-    const dirToDel = path.join('libs', directory, dasherize(libName), 'src', 'lib', dasherize(directory + '-' + libName));
+export function deleteDefaultComponent(tree: Tree, finalDirectory: string, finalName: string, deleteIndex = true): void {
+    const dirToDel = path.join(finalDirectory, 'src', 'lib', finalName);
+    //console.log('dirToDel', dirToDel);
     let deleted = false;
     if (tree.exists(dirToDel)) {
         tree.delete(dirToDel);
         deleted = true;
     }
 
-    const index = path.join('libs', directory, dasherize(libName), 'src', 'index.ts');
+    const index = path.join(finalDirectory, 'src', 'index.ts');
     if (deleteIndex && deleted && tree.exists(index)) {
         const contents = tree.read(index, 'utf-8');
         const rest = contents.split('\n').slice(1);
         tree.write(index, (rest || []).join('\n'));
     }
-
-}
+}
