bootstrap: add option to remove needles

Author: mshima

.blueprint/generate-sample/templates/test-integration/workflow-samples/angular.json

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

.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,
         "clientTestFramework": "vitest",
         "clientBundler": "webpack"
       },

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
   --jhi-prefix <value>                     Add prefix before services, controllers and states name
   --entity-suffix <value>                  Add suffix after entities name
@@ -836,6 +837,7 @@ exports[`generator - app with default config should match snapshot 1`] = `
   "reactorBlock": "",
   "reactorBlockOptional": "",
   "rememberMeKey": undefined,
+  "removeNeedles": undefined,
   "requiresDeleteAllUsers": false,
   "routes": undefined,
   "sampleWritten": undefined,
@@ -1526,6 +1528,7 @@ exports[`generator - app with gateway should match snapshot 1`] = `
   "reactorBlock": ".block()",
   "reactorBlockOptional": ".blockOptional()",
   "rememberMeKey": undefined,
+  "removeNeedles": undefined,
   "requiresDeleteAllUsers": true,
   "routes": undefined,
   "sampleWritten": undefined,
@@ -2129,6 +2132,7 @@ exports[`generator - app with microservice should match snapshot 1`] = `
   "reactorBlock": "",
   "reactorBlockOptional": "",
   "rememberMeKey": undefined,
+  "removeNeedles": undefined,
   "requiresDeleteAllUsers": false,
   "routes": undefined,
   "sampleWritten": undefined,

generators/base-core/support/needles.ts

@@ -18,7 +18,9 @@
  */
 import assert from 'node:assert';
 
+import { transformContents } from '@yeoman/transform';
 import { escapeRegExp, kebabCase } from 'lodash-es';
+import type { MemFsEditorFile } from 'mem-fs-editor';
 
 import type { CascatedEditFileCallback, EditFileCallback } from '../api.ts';
 import type CoreGenerator from '../index.ts';
@@ -27,6 +29,10 @@ import { joinCallbacks } from './write-files.ts';
 
 export type NeedleCallback = (content: string) => string;
 
+const needlesWhiteList = [
+  'liquibase-add-incremental-changelog', // mandatory for incremental changelogs
+];
+
 type NeedleContentToAddCallback = {
   /**
    * Position of the needle start.
@@ -86,6 +92,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
  *
@@ -135,7 +162,7 @@ export const insertContentBeforeNeedle = ({ content, contentToAdd, needle, autoI
 
   needle = addNeedlePrefix(needle);
 
-  const regexp = new RegExp(`(?://|<!--|\\{?/\\*|#) ${needle}(?:$|\n| )`, 'g');
+  const regexp = createNeedleRegexp(needle);
   let firstMatch = regexp.exec(content);
   if (!firstMatch) {
     return null;
@@ -307,3 +334,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

@@ -27,6 +27,17 @@ const command = {
       },
       scope: 'storage',
     },
+    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',
+    },
     skipPrettier: {
       description: 'Skip prettier transformation',
       cli: {

generators/bootstrap/generator.ts

@@ -26,11 +26,13 @@ import { isFilePending, isFileStateModified } from 'mem-fs-editor/state';
 import { createCommitTransform } from 'mem-fs-editor/transform';
 import type { Options as PrettierOptions } from 'prettier';
 
-import BaseGenerator from '../base/index.ts';
+import BaseGenerator, { CommandBaseGenerator } from '../base/index.ts';
 import type { Features as BaseFeatures, Options as BaseOptions } from '../base/types.d.ts';
 import { PRIORITY_NAMES, QUEUES } from '../base-application/priorities.ts';
+import { createNeedleTransform } from '../base-core/support/needles.ts';
 import { PRETTIER_EXTENSIONS } from '../generator-constants.js';
 
+import type command from './command.ts';
 import {
   autoCrlfTransform,
   createESLintTransform,
@@ -48,7 +50,7 @@ const { MULTISTEP_TRANSFORM_QUEUE, PRE_CONFLICTS_QUEUE } = QUEUES;
 const MULTISTEP_TRANSFORM_PRIORITY = BaseGenerator.asPriority(MULTISTEP_TRANSFORM);
 const PRE_CONFLICTS_PRIORITY = BaseGenerator.asPriority(PRE_CONFLICTS);
 
-export default class BootstrapGenerator extends BaseGenerator {
+export default class BootstrapGenerator extends CommandBaseGenerator<typeof command> {
   static MULTISTEP_TRANSFORM = MULTISTEP_TRANSFORM_PRIORITY;
 
   static PRE_CONFLICTS = PRE_CONFLICTS_PRIORITY;
@@ -240,11 +242,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.conflicterOptions, customizeActions }),

generators/ci-cd/__snapshots__/generator.spec.ts.snap

@@ -360,6 +360,7 @@ exports[`generator - ci-cd cli with multiples values should match context snapsh
   "reactorBlock": "",
   "reactorBlockOptional": "",
   "rememberMeKey": undefined,
+  "removeNeedles": undefined,
   "routes": undefined,
   "sampleWritten": undefined,
   "searchEngine": "no",

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