generate-blueprint: adjusts (#27424)

jhipster · Sep 26, 2024 · 988e792 · 988e792
1 parent a8fa515
commit 988e792
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 42 deletions.
diff --git a/cli/program.mts b/cli/program.mts
@@ -54,9 +54,9 @@ type BuildCommands = {
   loadCommand?: (key: string) => Promise<(...args: any[]) => Promise<any>>;
   defaultCommand?: string;
   entrypointGenerator?: string;
-  printLogo?: () => void;
   silent?: boolean;
-  printBlueprintLogo?: () => void;
+  printLogo?: () => void | Promise<void>;
+  printBlueprintLogo?: () => void | Promise<void>;
   createEnvBuilder: (options?: BaseEnvironmentOptions) => Promise<EnvironmentBuilder>;
 };
 
@@ -270,8 +270,8 @@ export const buildCommands = ({
         }
 
         if (!silent) {
-          printLogo();
-          printBlueprintLogo();
+          await printLogo();
+          await printBlueprintLogo();
         }
 
         const command = this;

diff --git a/generators/app/__snapshots__/generator.spec.ts.snap b/generators/app/__snapshots__/generator.spec.ts.snap
@@ -252,6 +252,7 @@ exports[`generator - app with default config should match snapshot 1`] = `
   "cacheProviderRedis": false,
   "camelizedBaseName": "jhipster",
   "capitalizedBaseName": "Jhipster",
+  "caret": undefined,
   "cjsExtension": ".cjs",
   "clientDistDir": "target/classes/static/",
   "clientFramework": "angular",
@@ -891,6 +892,7 @@ exports[`generator - app with gateway should match snapshot 1`] = `
   "cacheProviderRedis": false,
   "camelizedBaseName": "jhipster",
   "capitalizedBaseName": "Jhipster",
+  "caret": undefined,
   "cjsExtension": ".cjs",
   "clientDistDir": "target/classes/static/",
   "clientFramework": "angular",
@@ -1525,6 +1527,7 @@ exports[`generator - app with microservice should match snapshot 1`] = `
   "cacheProviderRedis": false,
   "camelizedBaseName": "jhipster",
   "capitalizedBaseName": "Jhipster",
+  "caret": undefined,
   "cjsExtension": ".cjs",
   "clientDistDir": "target/classes/static/",
   "clientFramework": "no",

diff --git a/generators/generate-blueprint/__snapshots__/generator.spec.ts.snap b/generators/generate-blueprint/__snapshots__/generator.spec.ts.snap
@@ -26,6 +26,9 @@ exports[`generator - generate-blueprint with all option should match snapshot 1`
   "README.md": {
     "stateCleared": "modified",
   },
+  "cli/cli-customizations.cjs": {
+    "stateCleared": "modified",
+  },
   "cli/cli.cjs": {
     "stateCleared": "modified",
   },
@@ -889,6 +892,9 @@ exports[`generator - generate-blueprint with default config should write files a
   "README.md": {
     "stateCleared": "modified",
   },
+  "cli/cli-customizations.cjs": {
+    "stateCleared": "modified",
+  },
   "cli/cli.cjs": {
     "stateCleared": "modified",
   },

diff --git a/generators/generate-blueprint/command.ts b/generators/generate-blueprint/command.ts
@@ -33,6 +33,13 @@ import {
 
 const command = {
   configs: {
+    caret: {
+      cli: {
+        description: 'Use caret in package.json engines',
+        type: Boolean,
+      },
+      scope: 'storage',
+    },
     recreatePackageLock: {
       description: 'Recreate package lock',
       cli: {

diff --git a/generators/generate-blueprint/files.ts b/generators/generate-blueprint/files.ts
@@ -36,18 +36,21 @@ export const files = asWriteFilesSection<any>({
         '.blueprint/generate-sample/index.mjs',
         // Always write cli for devBlueprint usage
         'cli/cli.cjs',
+        { sourceFile: 'cli/cli-customizations.cjs', override: false },
       ],
     },
     {
-      condition: ctx => !ctx[LOCAL_BLUEPRINT_OPTION] && ctx.githubWorkflows && !ctx.skipWorkflows,
+      condition: ctx => !ctx[LOCAL_BLUEPRINT_OPTION] && ctx.githubWorkflows,
       templates: [
         '.blueprint/github-build-matrix/build-matrix.mjs',
         '.blueprint/github-build-matrix/generator.mjs',
         '.blueprint/github-build-matrix/index.mjs',
-        '.github/workflows/build-cache.yml',
-        '.github/workflows/samples.yml',
       ],
     },
+    {
+      condition: ctx => !ctx[LOCAL_BLUEPRINT_OPTION] && ctx.githubWorkflows && !ctx.skipWorkflows,
+      templates: ['.github/workflows/build-cache.yml', '.github/workflows/samples.yml'],
+    },
     {
       condition: ctx => !ctx[LOCAL_BLUEPRINT_OPTION] && !ctx.sampleWritten,
       templates: ['.blueprint/generate-sample/templates/samples/sample.jdl'],
@@ -88,7 +91,7 @@ export const generatorFiles = asWriteFilesSection<any>({
       path: 'generators/generator',
       to: ctx => `${ctx.application.blueprintsPath}${ctx.generator}`,
       condition(ctx) {
-        return ((this as any).options.force || !ctx.written) && ctx.priorities.find(priority => priority.name === 'writing');
+        return !ctx.written && ctx.priorities.find(priority => priority.name === 'writing');
       },
       transform: false,
       templates: [

diff --git a/generators/generate-blueprint/generator.ts b/generators/generate-blueprint/generator.ts
@@ -354,26 +354,22 @@ export default class extends BaseGenerator {
       addGeneratorJHipsterDependency() {
         if (this.jhipsterConfig[LOCAL_BLUEPRINT_OPTION]) return;
         const { packagejs } = this.application;
+        const exactDependency = {
+          'generator-jhipster': `${packagejs.version}`,
+        };
+        const caretDependency = {
+          'generator-jhipster': `^${packagejs.version}`,
+        };
         if (this.jhipsterConfig.dynamic) {
           this.packageJson.merge({
-            devDependencies: {
-              'generator-jhipster': `${packagejs.version}`,
-            },
-            peerDependencies: {
-              'generator-jhipster': `^${packagejs.version}`,
-            },
-            engines: {
-              'generator-jhipster': `^${packagejs.version}`,
-            },
+            devDependencies: exactDependency,
+            peerDependencies: caretDependency,
+            engines: caretDependency,
           });
         } else {
           this.packageJson.merge({
-            dependencies: {
-              'generator-jhipster': `${packagejs.version}`,
-            },
-            engines: {
-              'generator-jhipster': `${packagejs.version}`,
-            },
+            dependencies: exactDependency,
+            engines: this.jhipsterConfig.caret ? caretDependency : exactDependency,
           });
         }
       },

diff --git a/generators/generate-blueprint/templates/README.md.ejs b/generators/generate-blueprint/templates/README.md.ejs
@@ -46,13 +46,23 @@ npm install -g generator-jhipster-<%= baseName %>
 
 To use this blueprint, run the below command
 
-```bash
 <%_ if (cli) { _%>
+```bash
 <%= cliName %>
+  <%_ if (caret) { _%>
+```
+
+or
+
+```bash
+jhipster --blueprints <%= baseName %>
+```
+  <%_ } _%>
 <%_ } else { _%>
+```bash
 jhipster --blueprints <%= baseName %>
-<%_ } _%>
 ```
+<%_ } _%>
 
 You can look for updated <%= baseName %> blueprint specific options by running
 

diff --git a/generators/generate-blueprint/templates/cli/cli-customizations.cjs.ejs b/generators/generate-blueprint/templates/cli/cli-customizations.cjs.ejs
@@ -0,0 +1,2 @@
+// This file will not be overwritten by generate-blueprint
+module.exports = {};
diff --git a/generators/generate-blueprint/templates/cli/cli.cjs.ejs b/generators/generate-blueprint/templates/cli/cli.cjs.ejs
@@ -23,10 +23,11 @@ const blueprint = packageFolderName.startsWith('jhipster-') ? `generator-${packa
       [blueprint]: version,
     },
     printBlueprintLogo: () => {
-      console.log('===================== JHipster <%= baseName %> =====================');
+      console.log('===================== JHipster <%= humanizedBaseName %> =====================');
       console.log('');
     },
     lookups: [{ packagePaths: [packagePath] }],
+    ...require('./cli-customizations.cjs'),
   }).catch(done);
 
   process.on('unhandledRejection', up => {

diff --git a/test-integration/generate-blueprint-samples/default/.yo-rc.json b/test-integration/generate-blueprint-samples/default/.yo-rc.json
@@ -26,8 +26,7 @@
           "install",
           "end"
         ],
-        "sbs": false,
-        "written": true
+        "sbs": false
       },
       "common": {
         "command": false,
@@ -50,8 +49,7 @@
           "install",
           "end"
         ],
-        "sbs": false,
-        "written": true
+        "sbs": false
       },
       "cypress": {
         "command": false,
@@ -74,8 +72,7 @@
           "install",
           "end"
         ],
-        "sbs": false,
-        "written": true
+        "sbs": false
       },
       "server": {
         "command": false,
@@ -98,8 +95,7 @@
           "install",
           "end"
         ],
-        "sbs": false,
-        "written": true
+        "sbs": false
       },
       "jdl": {
         "command": true,
@@ -126,8 +122,7 @@
           "postInstall",
           "end"
         ],
-        "sbs": false,
-        "written": true
+        "sbs": false
       },
       "spring-data-relational": {
         "command": true,
@@ -154,8 +149,7 @@
           "postInstall",
           "end"
         ],
-        "sbs": false,
-        "written": true
+        "sbs": false
       },
       "languages": {
         "command": true,
@@ -182,8 +176,7 @@
           "postInstall",
           "end"
         ],
-        "sbs": false,
-        "written": true
+        "sbs": false
       },
       "angular": {
         "command": true,
@@ -210,8 +203,7 @@
           "postInstall",
           "end"
         ],
-        "sbs": false,
-        "written": true
+        "sbs": false
       }
     },
     "jhipsterVersion": "7.5.0",