pattern-collector-anyjs-story 1.16.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KeshavSoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,155 @@
+# pattern-collector-anyjs-pull-lines 🔍
+
+> **A powerful, configurable tool to scan JavaScript/ESM files and pull structured line matches using custom regular expressions.**
+
+[![npm version](https://img.shields.io/npm/v/pattern-collector-anyjs-pull-lines.svg?style=flat-square&color=38bdf8)](https://www.npmjs.com/package/pattern-collector-anyjs-pull-lines)
+[![license](https://img.shields.io/npm/l/pattern-collector-anyjs-pull-lines.svg?style=flat-square&color=34d399)](LICENSE)
+
+🔗 **Quick Links:**
+*   📦 **NPM Registry**: [npmjs.com/package/pattern-collector-anyjs-pull-lines](https://www.npmjs.com/package/pattern-collector-anyjs-pull-lines)
+*   💻 **GitHub Repo**: [github.com/keshavsoft/pattern-collector-anyjs-pull-lines](https://github.com/keshavsoft/pattern-collector-anyjs-pull-lines)
+*   🌐 **Live Documentation**: [keshavsoft.github.io/pattern-collector-anyjs-pull-lines](https://keshavsoft.github.io/pattern-collector-anyjs-pull-lines/)
+
+
+---
+
+## 📖 Overview
+
+`pattern-collector-anyjs-pull-lines` is a modular ES module that allows you to static-analyze JavaScript or ESM source code. It scans file contents to identify specific patterns (such as `import` statements or routing configurations) and extracts line details, line numbers, variable names, and directory paths.
+
+This library is particularly useful for building automated routing trees, generating bundle maps, or auditing source code patterns.
+
+---
+
+## ✨ Features
+
+- **🧩 Modular Design**: Leveraging clean, focused sub-modules for flexible ESM pattern extraction.
+- **🏷️ Line Tracking**: Identifies exactly which line number each pattern appears on.
+- **🧩 Custom Extraction Regex**: Extracts variables, directories, and paths using flexible capturing groups in your regular expressions.
+- **📦 ESM Native**: Built for modern ES module environments.
+
+---
+
+## 🔗 Dependency Chain
+
+*   [`pattern-collector-anyjs-pull-lines-all`](https://www.npmjs.com/package/pattern-collector-anyjs-pull-lines-all) - listed in [`package.json`](package.json) as `^1.3.3`.
+*   [`pattern-collector-anyjs-pull-lines-consumption`](https://www.npmjs.com/package/pattern-collector-anyjs-pull-lines-consumption) - listed in [`package.json`](package.json) as `^1.2.1`.
+*   [`pattern-collector-anyjs-pull-lines-export`](https://www.npmjs.com/package/pattern-collector-anyjs-pull-lines-export) - listed in [`package.json`](package.json) as `^1.2.2`.
+*   [`pattern-collector-anyjs-pull-lines-import`](https://www.npmjs.com/package/pattern-collector-anyjs-pull-lines-import) - listed in [`package.json`](package.json) as `^1.9.3`.
+*   [`pattern-collector-anyjs-pull-lines-import-npm`](https://www.npmjs.com/package/pattern-collector-anyjs-pull-lines-import-npm) - listed in [`package.json`](package.json) as `^1.2.1`.
+
+---
+
+## 🚀 Installation
+
+```bash
+npm install pattern-collector-anyjs-pull-lines
+```
+
+---
+
+## 💻 Usage Example
+
+Here is a quick example showing how to extract import and route usage patterns:
+
+```javascript
+import pullLines from 'pattern-collector-anyjs-pull-lines';
+
+const code = `
+import express from 'express';
+import { router as routerFromv1 } from "./v1/routes.js";
+import { router as routerFromv2 } from "./v2/routes.js";
+
+const router = express.Router();
+router.use("/v1", routerFromv1);
+`;
+
+const result = pullLines({
+  fileContent: code,
+  importRegex: {
+    // Captures the router variable alias and the module folder name
+    parseRegex: /import\s*\{[^}]*router\s+as\s+(\w+)[^}]*\}\s*from\s*['"]\.\/([^/]+)\/.*['"]/,
+    // Search regex to identify import lines
+    searchString: /^[ \t]*import\b.*from\s+['"]\.[^'"]*['"];/gm
+  },
+  consumptionRegex: {
+    // Captures routing paths and the associated router variable names
+    parseRegex: /router\.use\s*\(\s*['"`]\/?([^'"`]+)['"`]\s*,\s*(\w+)/,
+    // Search regex to identify route usage lines
+    searchString: /^[ \t]*router\.use\b.*?;/gm
+  }
+});
+
+console.log(result);
+/*
+Output:
+{
+  importLines: [
+    {
+      variable: 'routerFromv1',
+      folderName: 'v1',
+      line: 'import { router as routerFromv1 } from "./v1/routes.js";',
+      lineNumber: 3
+    },
+    {
+      variable: 'routerFromv2',
+      folderName: 'v2',
+      line: 'import { router as routerFromv2 } from "./v2/routes.js";',
+      lineNumber: 4
+    }
+  ],
+  useLines: [
+    {
+      variable: 'v1',
+      folderName: 'routerFromv1',
+      line: 'router.use("/v1", routerFromv1);',
+      lineNumber: 7
+    }
+  ]
+}
+*/
+```
+
+---
+
+## 🛠️ API Reference
+
+### `default(options)`
+
+The default export is a function that parses the provided content and returns matching pattern details.
+
+#### Parameters
+
+An options object containing:
+
+* **`fileContent`** `(string)`: The raw javascript source code string to analyze.
+* **`importRegex`** `(object)`: Config for parsing import statements:
+  - `searchRegex` / `searchString` `(RegExp)`: Regular expression with `g` flag to search for import statements in the code.
+  - `parseRegex` `(RegExp)`: Regular expression with capture groups to extract specific variables (`variable`) and folder names (`folderName`).
+* **`consumptionRegex`** `(object)`: Config for parsing route consumption statements:
+  - `searchRegex` / `searchString` `(RegExp)`: Regular expression with `g` flag to search for route usage patterns.
+  - `parseRegex` `(RegExp)`: Regular expression with capture groups to extract paths and variables.
+* **`showLog`** `(boolean)` *(optional)*: When set to `true`, outputs intermediate matching arrays to the console.
+* **`showLogStep1`** `(boolean)` *(optional)*: When set to `true`, outputs step-by-step extraction details.
+
+#### Returns
+
+* **`Object`**:
+  - `importLines` `(Array<Object>)`: Extracted import matching objects.
+  - `useLines` `(Array<Object>)`: Extracted usage matching objects.
+
+Each item in the lists has the following shape:
+```typescript
+{
+  variable: string;    // Captured variable name from parseRegex
+  folderName: string;  // Captured directory or value from parseRegex
+  line: string;        // Full original line matching the search regex
+  lineNumber: number;  // 1-indexed line number in the source file
+}
+```
+
+---
+
+## ⚖️ License
+
+MIT License. Designed with ❤️ by [KeshavSoft](https://github.com/keshavsoft).

package/bin/core/getLatestVersion.js

@@ -0,0 +1,13 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export default function getLatestVersion() {
+    const versions = fs.readdirSync(path.join(__dirname, ".."))
+        .filter(n => /^v\d+$/.test(n))
+        .sort((a, b) => parseInt(a.slice(1)) - parseInt(b.slice(1)));
+
+    return versions.at(-1);
+};

package/bin/v15/index.js

@@ -0,0 +1,27 @@
+import pullLines from "pattern-collector-anyjs-pull-lines";
+import pullLinesStory from "pattern-collector-anyjs-pull-lines-story";
+
+const startFunc = ({ fileContent, searchRules, parseRules
+}) => {
+    let allLines;
+
+    const lines = pullLines({
+        fileContent,
+        consumptionSearchRegex: searchRules?.consumptionRegex?.searchRegex,
+        importSearchRegex: searchRules?.importRegex?.searchRegex,
+        exportSearchRegex: searchRules?.exportRegex?.searchRegex,
+        importSearchNpmRegex: searchRules?.importNpmRegex?.searchRegex
+    });
+
+    const linesStory = pullLinesStory({
+        inLines: lines,
+        importNpmRegex: parseRules?.parseRules?.importNpmRegex,
+        importRegex: parseRules?.parseRules?.importRegex,
+        consumptionRegex: parseRules?.parseRules?.consumptionRegex,
+        exportRegex: parseRules?.parseRules?.exportRegex,
+    });
+
+    return { lines, linesStory };
+};
+
+export default startFunc;

package/bin/v16/index.js

@@ -0,0 +1,29 @@
+// import pullLines from "pattern-collector-anyjs-pull-lines";
+// import pullLinesStory from "pattern-collector-anyjs-pull-lines-story";
+import pullLines from "./pullLines/index.js";
+import pullLinesStory from "./pullLinesStory/index.js";
+
+const startFunc = ({ fileContent, searchRules, parseRules
+}) => {
+    let allLines;
+
+    const lines = pullLines({
+        fileContent,
+        consumptionSearchRegex: searchRules?.consumptionRegex?.searchRegex,
+        importSearchRegex: searchRules?.importRegex?.searchRegex,
+        exportSearchRegex: searchRules?.exportRegex?.searchRegex,
+        importSearchNpmRegex: searchRules?.importNpmRegex?.searchRegex
+    });
+
+    const linesStory = pullLinesStory({
+        inLines: lines,
+        importNpmRegex: parseRules?.parseRules?.importNpmRegex,
+        importRegex: parseRules?.parseRules?.importRegex,
+        consumptionRegex: parseRules?.parseRules?.consumptionRegex,
+        exportRegex: parseRules?.parseRules?.exportRegex,
+    });
+
+    return { lines, linesStory };
+};
+
+export default startFunc;

package/bin/v16/patternCollector/index.js

@@ -0,0 +1,68 @@
+const getLine = ({ fileContent, inIndex }) => {
+    const start = fileContent.lastIndexOf('\n', inIndex) + 1;
+
+    let end = fileContent.indexOf('\n', inIndex);
+
+    if (end === -1) {
+        end = fileContent.length;
+    }
+
+    let line = fileContent.substring(start, end);
+
+    if (line.endsWith('\r')) {
+        line = line.slice(0, -1);
+    }
+
+    return line;
+};
+
+const getCurrentLineNumber = ({
+    fileContent,
+    inCurrentLine,
+    inLastPosition,
+    inCurrentPosition
+}) => {
+    let line = inCurrentLine;
+
+    for (let i = inLastPosition; i < inCurrentPosition; i++) {
+        if (fileContent[i] === '\n') {
+            line++;
+        }
+    }
+
+    return line;
+};
+
+const startFunc = ({ fileContent, searchRegex }) => {
+    const matches = [];
+    let match;
+
+    let currentLine = 1;
+    let lastPosition = 0;
+
+    while ((match = searchRegex.exec(fileContent)) !== null) {
+        currentLine = getCurrentLineNumber({
+            fileContent,
+            inCurrentLine: currentLine,
+            inLastPosition: lastPosition,
+            inCurrentPosition: match.index
+        });
+
+        lastPosition = match.index;
+
+        const line = getLine({
+            fileContent,
+            inIndex: match.index
+        });
+
+        matches.push({
+            match: match[0],
+            line,
+            lineNumber: currentLine
+        });
+    }
+
+    return matches;
+};
+
+export default startFunc;

package/bin/v16/pullLines/index.js

@@ -0,0 +1,37 @@
+import patternCollector from "../patternCollector/index.js";
+
+const startFunc = ({ fileContent, importSearchRegex, consumptionSearchRegex,
+    exportSearchRegex, importSearchNpmRegex
+}) => {
+    let allLines;
+
+    const importLinesFromNpm = patternCollector({
+        fileContent,
+        searchRegex: importSearchNpmRegex
+    });
+
+    const importLines = patternCollector({
+        fileContent,
+        searchRegex: importSearchRegex
+    });
+
+    let useLines = patternCollector({
+        fileContent,
+        searchRegex: consumptionSearchRegex
+    });
+
+    let exportLines = patternCollector({
+        fileContent,
+        searchRegex: exportSearchRegex
+    });
+
+    return {
+        allLines,
+        importLinesFromNpm,
+        importLines,
+        useLines,
+        exportLines
+    };
+};
+
+export default startFunc;

package/bin/v16/pullLinesStory/index.js

@@ -0,0 +1,45 @@
+import patternBase from "pattern-collector-base-regex-n-parts";
+
+const startFunc = ({ inLines, importNpmRegex, importRegex,
+    consumptionRegex, exportRegex
+}) => {
+    const importLinesFromNpm = inLines?.importLinesFromNpm.map(element => {
+        return patternBase({
+            matchLine: element?.match, parseRegex: importNpmRegex?.parseRegex,
+            nParts: importNpmRegex?.nParts
+        });
+    });
+
+
+    const importLines = inLines?.importLines.map(element => {
+        // console.log("a         : ", element, importRegex);
+
+        return patternBase({
+            matchLine: element.match, parseRegex: importRegex?.parseRegex,
+            nParts: importRegex?.nParts
+        });
+    });
+
+    const useLines = inLines?.useLines.map(element => {
+        return patternBase({
+            matchLine: element?.match, parseRegex: consumptionRegex?.parseRegex,
+            nParts: consumptionRegex?.nParts
+        });
+    });
+
+    const exportLines = inLines?.exportLines.map(element => {
+        return patternBase({
+            matchLine: element?.match, parseRegex: exportRegex?.parseRegex,
+            nParts: exportRegex?.nParts
+        });
+    });
+
+    return {
+        importLinesFromNpm,
+        importLines,
+        useLines,
+        exportLines
+    };
+};
+
+export default startFunc;

package/index.js

@@ -0,0 +1,14 @@
+import { createRequire } from "module";
+import getLatestVersion from "./bin/core/getLatestVersion.js";
+
+const require = createRequire(import.meta.url);
+
+const v = getLatestVersion();
+const latestModule = require(`./bin/${v}/index.js`);
+
+const load = (args) => {
+
+    return latestModule.default(args);
+};
+
+export default load;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "pattern-collector-anyjs-story",
+  "version": "1.16.2",
+  "description": "A powerful, configurable tool to scan JavaScript/ESM files and pull structured line matches using custom regular expressions.",
+  "keywords": [
+    "pattern",
+    "regex",
+    "parser",
+    "import",
+    "analyzer",
+    "esm",
+    "extractor"
+  ],
+  "dependencies": {
+    "pattern-collector-base-regex-n-parts": "^1.6.10"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
+  },
+  "files": [
+    "bin/",
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "homepage": "https://github.com/keshavsoft/pattern-collector-anyjs-story#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/keshavsoft/pattern-collector-anyjs-story.git"
+  },
+  "bugs": {
+    "url": "https://github.com/keshavsoft/pattern-collector-anyjs-story/issues"
+  }
+}