internal: add support to array of content and contentToCheck to createNeedleCallback

Author: mshima

generators/base/support/needles.spec.ts

@@ -317,6 +317,34 @@ content to add2
 `);
     });
 
+    it('returned function should add contentToAdd array of objects', () => {
+      const log = test.mock.fn(createJHipsterLogger());
+      const needleCallback = createNeedleCallback({
+        contentToAdd: [
+          { content: contentToAdd },
+          { content: `${contentToAdd}2` },
+          { content: 'existing content' },
+          { content: 'test', contentToCheck: 'another existing' },
+        ],
+        needle,
+      });
+      expect(
+        needleCallback.call(
+          { log } as any,
+          `existing content
+another existing
+// jhipster-needle-${needle}`,
+          'any-file',
+        ),
+      ).toMatchInlineSnapshot(`
+"existing content
+another existing
+content to add
+content to add2
+// jhipster-needle-a-needle"
+`);
+    });
+
     it('contentToAdd should be called', () => {
       const log = test.mock.fn(createJHipsterLogger());
       const contentToAdd = test.mock.fn((_arg0: string, _arg1: any) => 'result content');

generators/base/support/needles.ts

@@ -35,12 +35,14 @@ type NeedleContentToAddCallback = {
   indentPrefix: string;
 };
 
+type ContentToAdd = { content: string; contentToCheck?: string | RegExp };
+
 export type NeedleInsertion = {
   needle: string;
   /**
    * Content to add.
    */
-  contentToAdd: string | string[] | ((content: string, options: NeedleContentToAddCallback) => string);
+  contentToAdd: string | string[] | ContentToAdd[] | ((content: string, options: NeedleContentToAddCallback) => string);
   contentToCheck?: string | RegExp;
   /**
    * check existing content ignoring white spaces and new lines.
@@ -56,7 +58,7 @@ export type NeedleInsertion = {
   autoIndent?: boolean;
 };
 
-type NeedleFileInsertion = NeedleInsertion & {
+type NeedleFileInsertion = Omit<NeedleInsertion, 'needle' | 'contentToAdd'> & {
   /**
    * Path to file.
    * The generator context must be passed.
@@ -68,8 +70,9 @@ type NeedleFileInsertion = NeedleInsertion & {
   needlesPrefix?: string;
 };
 
-type NeedleContentInsertion = NeedleInsertion & {
+type NeedleContentInsertion = Pick<NeedleInsertion, 'needle' | 'autoIndent'> & {
   content: string;
+  contentToAdd: string | string[] | ((content: string, options: NeedleContentToAddCallback) => string);
 };
 
 /**
@@ -81,6 +84,10 @@ export const convertToPrettierExpressions = (str: string): string =>
     .replace(/(?! )(>|\\\))/g, ',?\\n?[\\s]*$1')
     .replace(/\s+/g, '[\\s\\n]*');
 
+const isArrayOfContentToAdd = (value: unknown): value is ContentToAdd[] => {
+  return Array.isArray(value) && value.every(item => typeof item === 'object' && 'content' in item);
+};
+
 /**
  * Check if contentToCheck existing in content
  *
@@ -200,6 +207,15 @@ export const createNeedleCallback = <Generator extends CoreGenerator = CoreGener
   assert(contentToAdd, 'contentToAdd is required');
 
   return function (content, filePath) {
+    if (isArrayOfContentToAdd(contentToAdd)) {
+      contentToAdd = contentToAdd.filter(({ content: itemContent, contentToCheck }) => {
+        return !checkContentIn(contentToCheck ?? itemContent, content, ignoreWhitespaces);
+      });
+      if (contentToAdd.length === 0) {
+        return content;
+      }
+      contentToAdd = contentToAdd.map(({ content }) => content);
+    }
     if (contentToCheck && checkContentIn(contentToCheck, content, ignoreWhitespaces)) {
       return content;
     }
@@ -238,19 +254,16 @@ export const createNeedleCallback = <Generator extends CoreGenerator = CoreGener
  *
  * @param this - generator if provided, editFile will be executed
  */
-export function createBaseNeedle(
-  options: Omit<NeedleFileInsertion, 'filePath' | 'needle' | 'contentToAdd'>,
-  needles: Record<string, string>,
-): NeedleCallback;
+export function createBaseNeedle(options: Omit<NeedleFileInsertion, 'filePath'>, needles: Record<string, string>): NeedleCallback;
 export function createBaseNeedle(needles: Record<string, string>): NeedleCallback;
 export function createBaseNeedle<Generator extends CoreGenerator = CoreGenerator>(
   this: Generator,
-  options: Omit<NeedleFileInsertion, 'filePath' | 'needle' | 'contentToAdd'> & { filePath: string },
+  options: NeedleFileInsertion,
   needles: Record<string, string>,
 ): CascatedEditFileCallback<Generator>;
 export function createBaseNeedle<Generator extends CoreGenerator = CoreGenerator>(
   this: Generator | void,
-  options: Omit<NeedleFileInsertion, 'filePath' | 'needle' | 'contentToAdd'> | Record<string, string>,
+  options: NeedleFileInsertion | Record<string, string>,
   needles?: Record<string, string>,
 ): EditFileCallback<Generator> | CascatedEditFileCallback<Generator> {
   const actualNeedles = needles === undefined ? (options as Record<string, string>) : needles;