Merge pull request #199 from docsbydoxdox/hotfix/move-pattern-match-util-to-core

[hotfix] Move pattern match util to core

Author: neogeek

packages/doxdox-core/src/utils.test.ts

@@ -9,6 +9,7 @@ import {
     getRootDirPath,
     isDirectory,
     isFile,
+    multiLinePatternMatch,
     parseConfigFromCLI,
     parseIgnoreConfig,
     slugify
@@ -98,6 +99,36 @@ describe('utils', () => {
         });
     });
 
+    describe('multiLinePatternMatch', () => {
+        it('find pattern in content', async () => {
+            expect(
+                multiLinePatternMatch(
+                    `/**
+ * Get the current working directory.
+ *
+ * @return {string} Directory path.
+ * @public
+ */
+
+function getCurrentWorkingDirectory() {}`,
+                    `/**
+ * Get the current working directory.
+ *
+ * @return {string} Directory path.
+ * @public
+ */`
+                )
+            ).toEqual(
+                expect.objectContaining({ matched: true, start: 0, end: 6 })
+            );
+        });
+        it('fail to find pattern', async () => {
+            expect(multiLinePatternMatch('', '// @ts-ignore')).toEqual(
+                expect.objectContaining({ matched: false })
+            );
+        });
+    });
+
     describe('parseConfigFromCLI', () => {
         it('parse config', () => {
             expect(

packages/doxdox-core/src/utils.ts

@@ -145,6 +145,49 @@ export const isFile = async (path: string): Promise<boolean> => {
     }
 };
 
+/**
+ * Return information about pattern if found within contents.
+ *
+ * @param {string} [content] Full contents to search for pattern in.
+ * @param {string} [pattern] Pattern to look for in contents.
+ * @return {{ start?: number; end?: number; matched: boolean }}
+ * @public
+ */
+
+export const multiLinePatternMatch = (
+    content: string,
+    pattern: string
+): { start?: number; end?: number; matched: boolean } => {
+    const matched = content.includes(pattern);
+
+    if (!matched) {
+        return { matched };
+    }
+
+    const contentLines = content.split(/\r?\n/);
+    const patternLines = pattern.split(/\r?\n/);
+
+    for (let i = 0; i < contentLines.length; i += 1) {
+        if (contentLines[i] === patternLines[0]) {
+            const contentGroup = contentLines
+                .slice(i, i + patternLines.length)
+                .join('\n');
+
+            const patternGroup = patternLines.join('\n');
+
+            if (contentGroup === patternGroup) {
+                return {
+                    start: i,
+                    end: i + patternLines.length,
+                    matched
+                };
+            }
+        }
+    }
+
+    return { matched: false };
+};
+
 /**
  * Parse config key/value pairs from raw CLI flags.
  *

packages/doxdox-parser-custom/src/index.ts

@@ -2,12 +2,10 @@ import { promises as fs } from 'fs';
 
 import { join } from 'path';
 
-import { File, Method, slugify } from 'doxdox-core';
+import { File, Method, multiLinePatternMatch, slugify } from 'doxdox-core';
 
 import { parse as commentParse } from 'comment-parser';
 
-import { multiLinePatternMatch } from './utils.js';
-
 const JSDOC_PATTERN = /[ \t]*\/\*\*\s*\n?([^*]*(\*[^/])?)*\*\//g;
 
 const IDENTIFIER_PATTERNS = [