bootstrap: add option to remove needles

Author: mshima

.blueprint/generate-sample/generator.mts

@@ -16,7 +16,7 @@ export default class extends BaseGenerator {
   sampleYorcFolder;
 
   constructor(args, options, features) {
-    super(args, options, { queueCommandTasks: true, ...features });
+    super(args, options, { jhipsterBootstrap: false, queueCommandTasks: true, ...features });
   }
 
   get [BaseGenerator.INITIALIZING]() {
@@ -92,7 +92,7 @@ export default class extends BaseGenerator {
           if (sample.jdlFiles) {
             await this.composeWithJHipster(GENERATOR_JDL, {
               generatorArgs: sample.jdlFiles,
-              generatorOptions: { jsonOnly: true, destinationRoot: this.projectFolder },
+              generatorOptions: { jsonOnly: true, destinationRoot: this.projectFolder, ...generatorOptions },
             });
           }
           await this.composeWithJHipster(GENERATOR_APP, { generatorOptions });

.blueprint/github-build-matrix/__snapshots__/generator.spec.ts.snap

@@ -41,6 +41,7 @@ exports[`generator - github-build-matrix with angular should match matrix value
       "app-sample": "ng-default",
       "jdl-entity": "*",
       "generatorOptions": {
+        "removeNeedles": true,
         "clientBundler": "experimentalEsbuild"
       },
       "workspaces": "false",

generators/app/__snapshots__/generator.spec.ts.snap

@@ -7,6 +7,7 @@ exports[`generator - app help should print expected information 1`] = `
 
 Options:
   --auto-crlf                              Detect line endings
+  --remove-needles                         Remove needles, needles are used by entity and language generators to inject code
   --defaults                               Execute jhipster with default config
   --skip-client                            Skip the client-side application generation
   --skip-server                            Skip the server-side application generation
@@ -813,6 +814,7 @@ exports[`generator - app with default config should match snapshot 1`] = `
   "reactorBlock": "",
   "reactorBlockOptional": "",
   "rememberMeKey": undefined,
+  "removeNeedles": undefined,
   "requiresDeleteAllUsers": false,
   "routes": undefined,
   "searchEngine": "no",
@@ -1482,6 +1484,7 @@ exports[`generator - app with gateway should match snapshot 1`] = `
   "reactorBlock": ".block()",
   "reactorBlockOptional": ".blockOptional()",
   "rememberMeKey": undefined,
+  "removeNeedles": undefined,
   "requiresDeleteAllUsers": true,
   "routes": undefined,
   "searchEngine": "no",
@@ -2082,6 +2085,7 @@ exports[`generator - app with microservice should match snapshot 1`] = `
   "reactorBlock": "",
   "reactorBlockOptional": "",
   "rememberMeKey": undefined,
+  "removeNeedles": undefined,
   "requiresDeleteAllUsers": false,
   "routes": undefined,
   "searchEngine": "no",

generators/base/support/needles.ts

@@ -18,10 +18,16 @@
  */
 import assert from 'assert';
 import { escapeRegExp, kebabCase } from 'lodash-es';
+import { transformContents } from '@yeoman/transform';
+import type { MemFsEditorFile } from 'mem-fs-editor';
 import type CoreGenerator from '../../base-core/index.js';
 import type { CascatedEditFileCallback, EditFileCallback, NeedleCallback } from '../api.js';
 import { joinCallbacks } from './write-files.js';
 
+const needlesWhiteList = [
+  'liquibase-add-incremental-changelog', // mandatory for incremental changelogs
+];
+
 type NeedleContentToAddCallback = {
   /**
    * Position of the needle start.
@@ -81,6 +87,27 @@ export const convertToPrettierExpressions = (str: string): string =>
     .replace(/(?! )(>|\\\))/g, ',?\\n?[\\s]*$1')
     .replace(/\s+/g, '[\\s\\n]*');
 
+export const createNeedleRegexp = (needle: string): RegExp => new RegExp(`(?://|<!--|/\\*|#) ${needle}(?: [^$\\n]*)?(?:$|\\n)`, 'g');
+
+type NeedleLinePosition = {
+  start: number;
+  end: number;
+};
+
+export const getNeedlesPositions = (content: string, needle = 'jhipster-needle-(?:[-\\w]*)'): NeedleLinePosition[] => {
+  const regexp = createNeedleRegexp(needle);
+  const positions: NeedleLinePosition[] = [];
+  let match: RegExpExecArray | null;
+  while ((match = regexp.exec(content))) {
+    if (needlesWhiteList.some(whileList => match![0].includes(whileList))) {
+      continue;
+    }
+    const needleLineIndex = content.lastIndexOf('\n', match.index) + 1;
+    positions.unshift({ start: needleLineIndex, end: regexp.lastIndex });
+  }
+  return positions;
+};
+
 /**
  * Check if contentToCheck existing in content
  *
@@ -120,7 +147,7 @@ export const insertContentBeforeNeedle = ({ content, contentToAdd, needle, autoI
 
   needle = needle.includes('jhipster-needle-') ? needle : `jhipster-needle-${needle}`;
 
-  const regexp = new RegExp(`(?://|<!--|/\\*|#) ${needle}(?:$|\n| )`, 'g');
+  const regexp = createNeedleRegexp(needle);
   const firstMatch = regexp.exec(content);
   if (!firstMatch) {
     return null;
@@ -279,3 +306,18 @@ export function createBaseNeedle<Generator extends CoreGenerator = CoreGenerator
 
   return callback;
 }
+
+export const createNeedleTransform = () =>
+  transformContents<MemFsEditorFile>(content => {
+    if (content) {
+      let contentAsString = content.toString();
+      const positions = getNeedlesPositions(contentAsString);
+      if (positions.length > 0) {
+        for (const position of positions) {
+          contentAsString = contentAsString.slice(0, position.start) + contentAsString.slice(position.end);
+        }
+        return Buffer.from(contentAsString);
+      }
+    }
+    return content;
+  });

generators/bootstrap/command.ts

@@ -50,6 +50,19 @@ const command: JHipsterCommandDefinition = {
       scope: 'generator',
     },
   },
+  configs: {
+    removeNeedles: {
+      description: 'Remove needles, needles are used by entity and language generators to inject code',
+      cli: {
+        type: Boolean,
+      },
+      jdl: {
+        tokenType: 'BOOLEAN',
+        type: 'boolean',
+      },
+      scope: 'storage',
+    },
+  },
 };
 
 export default command;

generators/bootstrap/generator.ts

@@ -31,6 +31,7 @@ import { GENERATOR_UPGRADE } from '../generator-list.js';
 import { PRIORITY_NAMES, QUEUES } from '../base-application/priorities.js';
 import { loadStoredAppOptions } from '../app/support/index.js';
 import type { GenericTaskGroup, TaskParamWithControl } from '../../lib/types/base/tasks.js';
+import { createNeedleTransform } from '../base/support/needles.js';
 import {
   autoCrlfTransform,
   createESLintTransform,
@@ -259,11 +260,17 @@ export default class BootstrapGenerator extends BaseGenerator {
       };
     }
 
+    const removeNeedlesTransforms: FileTransform<MemFsEditorFile>[] = [];
+    if (this.jhipsterConfig.removeNeedles) {
+      removeNeedlesTransforms.push(createNeedleTransform());
+    }
+
     const transformStreams = [
       ...skipYoResolveTransforms,
       forceYoFiles(),
       createSortConfigFilesTransform(),
       createForceWriteConfigFilesTransform(),
+      ...removeNeedlesTransforms,
       ...prettierTransforms,
       ...autoCrlfTransforms,
       createConflicterTransform(this.env.adapter, { ...(this.env as any).conflicterOptions, customizeActions }),

generators/init/__snapshots__/generator.spec.ts.snap

@@ -7,6 +7,7 @@ Init project (alpha)
 
 Options:
   --auto-crlf                   Detect line endings
+  --remove-needles              Remove needles, needles are used by entity and language generators to inject code
   --skip-cache                  Do not remember prompt answers (default: false)
   --skip-install                Do not automatically install dependencies (default: false)
   --force-install               Fail on install dependencies error (default: false)

generators/jdl/__snapshots__/generator.spec.ts.snap

@@ -159,6 +159,7 @@ Create entities from the JDL file/URL/content passed in argument.
 
 Options:
   --auto-crlf                              Detect line endings
+  --remove-needles                         Remove needles, needles are used by entity and language generators to inject code
   --interactive                            Generate multiple applications in series so that questions can be interacted with. This is the default when there is an existing application configuration in any of the folders
   --json-only                              Generate only the JSON files and skip entity regeneration
   --ignore-application                     Ignores application generation

test-integration/workflow-samples/angular.json

@@ -13,6 +13,7 @@
       "app-sample": "ng-default",
       "jdl-entity": "*",
       "generatorOptions": {
+        "removeNeedles": true,
         "clientBundler": "experimentalEsbuild"
       }
     },