client: adjust readme (#28335)

jhipster · Jan 8, 2025 · a862a1c · a862a1c
1 parent 91143ac
commit a862a1c
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 6 deletions.
diff --git a/generators/app/__snapshots__/generator.spec.ts.snap b/generators/app/__snapshots__/generator.spec.ts.snap
@@ -260,6 +260,7 @@ exports[`generator - app with default config should match snapshot 1`] = `
   "clientBundler": "webpack",
   "clientBundlerAny": true,
   "clientBundlerExperimentalEsbuild": false,
+  "clientBundlerName": "Webpack",
   "clientBundlerVite": false,
   "clientBundlerWebpack": true,
   "clientDistDir": "target/classes/static/",
@@ -275,6 +276,8 @@ exports[`generator - app with default config should match snapshot 1`] = `
   "clientRootDir": "",
   "clientSrcDir": "src/main/webapp/",
   "clientTestDir": "src/test/javascript/",
+  "clientTestFramework": "jest",
+  "clientTestFrameworkName": "Jest",
   "clientTestFrameworks": undefined,
   "clientTestFrameworksAny": false,
   "clientTestFrameworksCypress": false,
@@ -929,6 +932,7 @@ exports[`generator - app with gateway should match snapshot 1`] = `
   "clientBundler": "webpack",
   "clientBundlerAny": true,
   "clientBundlerExperimentalEsbuild": false,
+  "clientBundlerName": "Webpack",
   "clientBundlerVite": false,
   "clientBundlerWebpack": true,
   "clientDistDir": "target/classes/static/",
@@ -944,6 +948,8 @@ exports[`generator - app with gateway should match snapshot 1`] = `
   "clientRootDir": "",
   "clientSrcDir": "src/main/webapp/",
   "clientTestDir": "src/test/javascript/",
+  "clientTestFramework": "jest",
+  "clientTestFrameworkName": "Jest",
   "clientTestFrameworks": undefined,
   "clientTestFrameworksAny": false,
   "clientTestFrameworksCypress": false,
@@ -1592,6 +1598,7 @@ exports[`generator - app with microservice should match snapshot 1`] = `
   "clientBundler": undefined,
   "clientBundlerAny": false,
   "clientBundlerExperimentalEsbuild": false,
+  "clientBundlerName": undefined,
   "clientBundlerVite": false,
   "clientBundlerWebpack": false,
   "clientDistDir": "target/classes/static/",
@@ -1607,6 +1614,8 @@ exports[`generator - app with microservice should match snapshot 1`] = `
   "clientRootDir": "",
   "clientSrcDir": "src/main/webapp/",
   "clientTestDir": "src/test/javascript/",
+  "clientTestFramework": undefined,
+  "clientTestFrameworkName": undefined,
   "clientTestFrameworks": undefined,
   "clientTestFrameworksAny": false,
   "clientTestFrameworksCypress": false,

diff --git a/generators/client/command.ts b/generators/client/command.ts
@@ -85,6 +85,18 @@ const command = {
       choices: ['webpack', 'vite', 'experimentalEsbuild'],
       scope: 'storage',
     },
+    clientBundlerName: {
+      cli: { type: String, hide: true },
+      scope: 'storage',
+    },
+    clientTestFramework: {
+      cli: { type: String, hide: true },
+      scope: 'storage',
+    },
+    clientTestFrameworkName: {
+      cli: { type: String, hide: true },
+      scope: 'storage',
+    },
     devServerPort: {
       cli: {
         type: Number,

diff --git a/generators/client/generator.ts b/generators/client/generator.ts
@@ -16,6 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { startCase } from 'lodash-es';
 
 import BaseApplicationGenerator from '../base-application/index.js';
 
@@ -137,6 +138,13 @@ export default class JHipsterClientGenerator extends BaseApplicationGenerator {
   // Public API method used by the getter and also by Blueprints
   get preparing() {
     return this.asPreparingTaskGroup({
+      preparing({ applicationDefaults }) {
+        applicationDefaults({
+          clientBundlerName: ctx => (ctx.clientBundlerExperimentalEsbuild ? 'esbuild' : startCase(ctx.clientBundler)),
+          clientTestFramework: ctx => (ctx.clientFrameworkVue ? 'vitest' : 'jest'),
+          clientTestFrameworkName: ctx => startCase(ctx.clientTestFramework),
+        });
+      },
       microservice({ application }) {
         if (application.applicationTypeMicroservice) {
           application.withAdminUi = false;

diff --git a/generators/client/templates/README.md.jhi.client.ejs b/generators/client/templates/README.md.jhi.client.ejs
@@ -52,7 +52,7 @@ You will only need to run this command when dependencies change in [package.json
 <%= clientPackageMngrWrapper %> install
 ```
 
-We use <%= clientPackageManager %> scripts and <&- fragments.customCliSection(' ') &>[Webpack][] as our build system.
+We use <%= clientPackageManager %> scripts and <&- fragments.customCliSection(' ') &>[<%= clientBundlerName %>][] as our build system.
 
   <%_ if (cacheProviderRedis || cacheProviderHazelcast || cacheProviderMemcached) { _%>
 If you are using <%= cacheProvider %> as a cache, you will have to launch a cache server.
@@ -139,7 +139,7 @@ To benefit from TypeScript type definitions from [DefinitelyTyped][] repository
 <%= clientPackageMngrWrapper %> <%= clientPackageMngrAddDev %> @types/leaflet
 ```
 
-Then you would import the JS and CSS files specified in library's installation instructions so that [Webpack][] knows about them:
+Then you would import the JS and CSS files specified in library's installation instructions so that [<%= clientBundlerName %>][] knows about them:
   <%_ if (clientFrameworkAngular) { _%>
 Edit [<%= clientSrcDir %>app/app.config.ts](<%= clientSrcDir %>app/app.config.ts) file:
 
@@ -196,7 +196,7 @@ cd microfrontend
 <&_ if (fragment.testingSection) { -&>
 ### Client tests
 
-Unit tests are run by [Jest][]. They're located in [<%= clientTestDir %>](<%= clientTestDir %>) and can be run with:
+Unit tests are run by [<%= clientTestFrameworkName %>][]. They're located near components and can be run with:
 
 ```
 <%= clientPackageMngrWrapper %> test
@@ -214,12 +214,18 @@ The lighthouse report is created in <% if (buildToolMaven) { %>`target/cypress/l
   <%_ } _%>
 <&_ } -&>
 <&_ if (fragment.referenceSection) { -&>
+<%_ if (clientBundlerWebpack) { _%>
 [Webpack]: https://webpack.github.io/
+<%_ } -%>
+<%_ if (clientFrameworkReact || clientFrameworkAngular || microfrontend) { _%>
 [BrowserSync]: https://www.browsersync.io/
-[Jest]: https://facebook.github.io/jest/
-  <%_ if (cypressTests) { _%>
+<%_ } -%>
+<%_ if (clientFrameworkAngular || clientFrameworkReact) { _%>
+[Jest]: https://jestjs.io
+<%_ } -%>
+<%_ if (cypressTests) { _%>
 [Cypress]: https://www.cypress.io/
-  <%_ } -%>
+<%_ } -%>
 [Leaflet]: https://leafletjs.com/
 [DefinitelyTyped]: https://definitelytyped.org/
 <&_ } -&>