simplify git options and config

Author: Tcharl

generators/base-application/types.d.ts

@@ -412,7 +412,6 @@ export type Application<E extends Entity> = BaseSimpleApplicationApplication &
 
     skipClient?: boolean;
     skipServer?: boolean;
-    monorepository?: boolean;
 
     blueprints?: { name: string; version: string }[];
     testFrameworks?: string[];

generators/base-core/types.d.ts

@@ -60,7 +60,6 @@ export type Options = YeomanOptions & {
   generateApplications?: boolean | (() => Promise<void>);
   generateWorkspaces?: boolean;
   generateWith?: string;
-  monorepository?: boolean;
   workspaces?: boolean;
   workspacesFolders?: string[];
 };

generators/git/generator.ts

@@ -26,33 +26,44 @@ import type { Config as GitConfig, Options as GitOptions } from './types.js';
 
 export default class GitGenerator extends BaseGenerator<GitConfig, GitOptions> {
   gitInitialized!: boolean;
-  skipGit!: boolean;
-  forceGit!: boolean;
   existingRepository!: boolean;
-  commitMsg!: string;
 
   async beforeQueue() {
     if (!this.fromBlueprint) {
       await this.composeWithBlueprints();
     }
   }
 
+  async initializeGitRepository() {
+    try {
+      const git = this.createGit();
+      if (await git.checkIsRepo()) {
+        if (await git.checkIsRepo('root' as any)) {
+          this.log.info('Using existing git repository.');
+        } else {
+          this.log.info('Using existing git repository at parent folder.');
+        }
+        this.existingRepository = true;
+      } else if (await git.init()) {
+        this.log.ok('Git repository initialized.');
+      }
+      this.gitInitialized = true;
+    } catch (error) {
+      this.log.warn(`Failed to initialize Git repository.\n ${error}`);
+    }
+  }
+
   get initializing() {
     return this.asInitializingTaskGroup({
       async checkGit() {
-        if (!this.skipGit) {
+        if (!this.options.skipGit) {
           const gitInstalled = (await this.createGit().version()).installed;
           if (!gitInstalled) {
             this.log.warn('Git repository will not be created, as Git is not installed on your system');
-            this.skipGit = true;
+            this.options.skipGit = true;
           }
         }
       },
-      async initializeMonorepository() {
-        if (!this.skipGit && this.jhipsterConfig.monorepository) {
-          await this.initializeGitRepository();
-        }
-      },
     });
   }
 
@@ -63,7 +74,7 @@ export default class GitGenerator extends BaseGenerator<GitConfig, GitOptions> {
   get preparing() {
     return this.asPreparingTaskGroup({
       async preparing() {
-        if (!this.skipGit) {
+        if (!this.options.skipGit) {
           // Force write .yo-rc.json to disk, it's used to check if the application is regenerated
           this.jhipsterConfig.monorepository ??= undefined;
         }
@@ -91,7 +102,7 @@ export default class GitGenerator extends BaseGenerator<GitConfig, GitOptions> {
     return this.asPostWritingTaskGroup({
       /** Husky commit hook install at install priority requires git to be initialized */
       async initGitRepo() {
-        if (!this.skipGit && !this.jhipsterConfig.monorepository) {
+        if (!this.options.skipGit && !this.jhipsterConfig.monorepository) {
           await this.initializeGitRepository();
         }
       },
@@ -106,25 +117,26 @@ export default class GitGenerator extends BaseGenerator<GitConfig, GitOptions> {
     return this.asEndTaskGroup({
       /** Initial commit to git repository after package manager install for package-lock.json */
       async gitCommit() {
-        if (this.skipGit) return;
+        if (this.options.skipGit) return;
         if (!this.gitInitialized) {
           this.log.warn('The generated application could not be committed to Git, as a Git repository could not be initialized.');
           return;
         }
 
         const commitFiles = async () => {
-          this.debug('Committing files to git');
+          this.log.debug('Committing files to git');
           const git = this.createGit();
           const repositoryRoot = await git.revparse(['--show-toplevel']);
+          const msg = await git.log(['-n', '1']).catch(() => ({ total: 0 }));
           const result = await git.log(['-n', '1', '--', '.yo-rc.json']).catch(() => ({ total: 0 }));
           const existingApplication = result.total > 0;
-          if (existingApplication && !this.forceGit) {
+          if (existingApplication && !this.options.forceGit) {
             this.log.info(
               `Found .yo-rc.json in Git from ${repositoryRoot}. So we assume this is application regeneration. Therefore automatic Git commit is not done. You can do Git commit manually.`,
             );
             return;
           }
-          if (!this.forceGit) {
+          if (!this.options.forceGit) {
             const statusResult = await git.status();
             if (statusResult.staged.length > 0) {
               this.log.verboseInfo(`The repository ${repositoryRoot} has staged files, skipping commit.`);
@@ -133,7 +145,7 @@ export default class GitGenerator extends BaseGenerator<GitConfig, GitOptions> {
           }
           try {
             let commitMsg =
-              this.commitMsg ??
+              this.options.commitMsg ??
               (existingApplication
                 ? `Regenerated ${this.jhipsterConfig.baseName} using generator-jhipster@${this.jhipsterConfig.jhipsterVersion}`
                 : `Initial version of ${this.jhipsterConfig.baseName} generated by generator-jhipster@${this.jhipsterConfig.jhipsterVersion}`);
@@ -163,23 +175,4 @@ export default class GitGenerator extends BaseGenerator<GitConfig, GitOptions> {
   get [BaseGenerator.END]() {
     return this.delegateTasksToBlueprint(() => this.end);
   }
-
-  async initializeGitRepository() {
-    try {
-      const git = this.createGit();
-      if (await git.checkIsRepo()) {
-        if (await git.checkIsRepo('root' as any)) {
-          this.log.info('Using existing git repository.');
-        } else {
-          this.log.info('Using existing git repository at parent folder.');
-        }
-        this.existingRepository = true;
-      } else if (await git.init()) {
-        this.log.ok('Git repository initialized.');
-      }
-      this.gitInitialized = true;
-    } catch (error) {
-      this.log.warn(`Failed to initialize Git repository.\n ${error}`);
-    }
-  }
 }

generators/git/types.d.ts

@@ -16,7 +16,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { HandleCommandTypes } from '../../lib/command/types.js';
+import type { Simplify } from 'type-fest';
+import type { ExportGeneratorOptionsFromCommand, HandleCommandTypes } from '../../lib/command/types.js';
 import type { Config as ProjectNameConfig, Options as ProjectNameOptions, Source as ProjectNameSource } from '../project-name/types.js';
 import type { Application as BaseApplicationApplication, Entity as BaseApplicationEntity } from '../base-application/types.js';
 import type command from './command.ts';
@@ -25,7 +26,10 @@ type Command = HandleCommandTypes<typeof command>;
 
 export type Config = Command['Config'] & ProjectNameConfig;
 
-export type Options = Command['Options'] & ProjectNameOptions;
+export type Options = Command['Options'] &
+  ProjectNameOptions &
+  // eslint-disable-next-line @typescript-eslint/consistent-type-imports
+  Simplify<ExportGeneratorOptionsFromCommand<typeof import('../../generators/git/command.ts').default>>;
 
 export { ProjectNameSource as Source, BaseApplicationEntity as Entity };
 

generators/jdl/types.d.ts

@@ -1,6 +1,7 @@
 import type { HandleCommandTypes } from '../../lib/command/types.js';
 import type { ApplicationType } from '../../lib/core/application-types.ts';
 import type { Config as BaseConfig, Options as BaseOptions } from '../base/types.js';
+import type { Options as GitOptions } from '../git/types.js';
 import type command from './command.js';
 
 type Command = HandleCommandTypes<typeof command>;
@@ -13,4 +14,4 @@ type JdlOptions = {
 
 export type Config = BaseConfig & JdlOptions & Command['Config'];
 
-export type Options = BaseOptions & JdlOptions & Command['Options'];
+export type Options = BaseOptions & JdlOptions & Command['Options'] & GitOptions;

generators/workspaces/generator.ts

@@ -56,7 +56,7 @@ export default class WorkspacesGenerator extends BaseWorkspacesGenerator<any, Wo
     return this.asInitializingTaskGroup({
       loadConfig() {
         // Generate workspaces file if workspace option is passed, or if workspace option is ommitted and monorepository is enabled, or if regenerating.
-        this.generateWorkspaces = (this.workspaces ?? this.jhipsterConfig.monorepository) || Boolean(this.packageJson?.get('workspaces'));
+        this.generateWorkspaces = (this.workspaces ?? this.options.monorepository) || Boolean(this.packageJson?.get('workspaces'));
 
         // When generating workspaces, save to .yo-rc.json. Use a dummy config otherwise.
         this.workspacesConfig = this.generateWorkspaces ? this.jhipsterConfig : {};
@@ -92,7 +92,7 @@ export default class WorkspacesGenerator extends BaseWorkspacesGenerator<any, Wo
   get composing() {
     return this.asComposingTaskGroup({
       async composeGit() {
-        if (this.options.monorepository || this.jhipsterConfig.monorepository) {
+        if (this.options.monorepository) {
           await this.composeWithJHipster(GENERATOR_GIT);
           await this.composeWithJHipster('jhipster:javascript:prettier', { generatorOptions: { monorepositoryRoot: true } });
         }
@@ -122,7 +122,7 @@ export default class WorkspacesGenerator extends BaseWorkspacesGenerator<any, Wo
   get loading() {
     return this.asLoadingTaskGroup({
       checkWorkspaces() {
-        if (this.generateWorkspaces && !this.jhipsterConfig.monorepository) {
+        if (this.generateWorkspaces && !this.options.monorepository) {
           throw new Error('Workspaces option is only supported with monorepositories.');
         }
       },

generators/workspaces/types.d.ts

@@ -17,7 +17,8 @@
  * limitations under the License.
  */
 import type { Config as BaseWorkspacesConfig, Options as BaseWorkspacesOptions } from '../base-workspaces/types.d.ts';
+import type { Options as GitOptions } from '../git/types.d.ts';
 export type { WorkspacesApplication } from '../base-workspaces/types.js';
 
-export type Config = BaseWorkspacesConfig & { baseName: string; monorepository: boolean };
-export type Options = BaseWorkspacesOptions & { monorepository: boolean };
+export type Config = BaseWorkspacesConfig & { baseName: string };
+export type Options = BaseWorkspacesOptions & GitOptions;

lib/types/application-config-all.d.ts

@@ -22,7 +22,6 @@ export type ConfigAll = Simplify<
       microfrontends?: { baseName: string }[];
     } & ExportStoragePropertiesFromCommand<typeof import('../../generators/app/command.ts').default> &
     ExportStoragePropertiesFromCommand<typeof import('../../generators/bootstrap-application-base/command.ts').default> &
-    ExportStoragePropertiesFromCommand<typeof import('../../generators/git/command.ts').default> &
     ExportStoragePropertiesFromCommand<typeof import('../../generators/jdl/command.ts').default> &
     ExportStoragePropertiesFromCommand<typeof import('../../generators/languages/command.ts').default> &
     ExportStoragePropertiesFromCommand<typeof import('../../generators/liquibase/command.ts').default> &

lib/types/application-options-all.d.ts

@@ -15,7 +15,6 @@ export type OptionsAll = Simplify<
     ExportGeneratorOptionsFromCommand<typeof import('../../generators/base/command.ts').default> &
     ExportGeneratorOptionsFromCommand<typeof import('../../generators/bootstrap-application-base/command.ts').default> &
     ExportGeneratorOptionsFromCommand<typeof import('../../generators/client/command.ts').default> &
-    ExportGeneratorOptionsFromCommand<typeof import('../../generators/git/command.ts').default> &
     ExportGeneratorOptionsFromCommand<typeof import('../../generators/java/generators/bootstrap/command.ts').default> &
     ExportGeneratorOptionsFromCommand<typeof import('../../generators/java/generators/build-tool/command.ts').default> &
     ExportGeneratorOptionsFromCommand<typeof import('../../generators/java/generators/graalvm/command.ts').default> &

lib/types/application-properties-all.d.ts

@@ -29,6 +29,5 @@ export type ApplicationAll<E extends EntityAll = EntityAll> = BaseApplication<E>
   ClientApplication<E> &
   DockerApplication &
   LiqbuibaseApplication<E> &
-  ExportApplicationPropertiesFromCommand<typeof import('../../generators/git/command.ts').default> &
   ExportApplicationPropertiesFromCommand<typeof import('../../generators/project-name/command.ts').default> &
   ExportApplicationPropertiesFromCommand<typeof import('../../generators/spring-boot/command.ts').default>;