@gld5000-cli/dependency-finder 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gareth L Devlin
+
+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 whom the Software is
+furnished 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,66 @@
+# [@gld5000-cli/dependency-finder](https://www.npmjs.com/package/@gld5000-cli/dependency-finder)
+
+Finds how many dependents your components have.
+
+## Install
+
+```
+npm i -D @gld5000-cli/dependency-finder
+```
+
+## Example Usage
+
+### Import (.mjs)
+
+```
+import * as dependencyFinder from '@gld5000-cli/dependency-finder'
+```
+
+### Example Input
+
+```
+Add your code here...
+```
+
+### Example Output
+
+```
+Add your code here...
+```
+
+## Update
+
+```
+npm update @gld5000-cli/dependency-finder
+```
+
+## Uninstall
+
+```
+npm uninstall @gld5000-cli/dependency-finder
+```
+
+
+## License
+
+MIT License
+
+Copyright (c) 2026 Gareth L Devlin
+
+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 whom the Software is
+furnished 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/bin/index.mjs

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+
+import { runDependencyFinder } from "../src/index.mjs";
+import { answerStringQuestion } from "@gld5000-cli/readline";
+
+const args = process.argv.slice(2);
+const defaultSearchPattern = "./components/**/*.tsx";
+const searchPattern =
+  args[0] ||
+  (await answerStringQuestion(
+    "Where are your components?",
+    defaultSearchPattern,
+  ));
+
+const defaultTargetPaths = "./components/**/*.tsx|./pages/**/*.tsx";
+const targetPaths = `${
+  args[1] ||
+  (await answerStringQuestion(
+    "Which folders should we check for imports (pipe-separated)?",
+    defaultTargetPaths,
+  ))
+}`.split("|");
+
+const defaultIgnorePatterns = ".test|.stories";
+const ignorePatterns = `${
+  args[2] ||
+  (await answerStringQuestion(
+    "Which filename patterns should be ignored (pipe-separated)?",
+    defaultIgnorePatterns,
+  ))
+}`.split("|");
+runDependencyFinder(searchPattern, targetPaths, ignorePatterns);

package/dependents-report.json

@@ -0,0 +1 @@
+{"noDependents":{"count":2,"results":[{"matches":[],"filePath":"test\\test-components\\index.tsx","dependents":[]},{"matches":["ComponentC"],"filePath":"test\\test-components\\folder-c\\test3.tsx","dependents":[]}]},"someDependents":{"count":2,"results":[{"matches":["ComponentB"],"filePath":"test\\test-components\\folder-b\\test2.tsx","dependents":[{"filePath":"test\\test-components\\index.tsx","matches":["import { ComponentB } from \"./folder-b/test2\""]}]},{"matches":["ComponentA"],"filePath":"test\\test-components\\folder-a\\test1.tsx","dependents":[{"filePath":"test\\test-components\\index.tsx","matches":["import ComponentA from \"./folder-a/test1\"","import { ComponentA } from \"./folder-a/test1\""]}]}]}}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@gld5000-cli/dependency-finder",
+  "version": "1.0.0",
+  "description": "Finds how many dependents your components have.",
+  "keywords": [
+    "CLI",
+    "NODE",
+    "Search",
+    "Local",
+    "Repo",
+    "Deprecation",
+    "Dependents"
+  ],
+  "homepage": "https://github.com/GLD5000/dependency-finder#readme",
+  "bugs": {
+    "url": "https://github.com/GLD5000/dependency-finder/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GLD5000/dependency-finder.git"
+  },
+  "license": "MIT",
+  "author": "GLD5000",
+  "type": "commonjs",
+  "main": "src/index.mjs",
+  "scripts": {
+    "test": "node test/test.mjs"
+  },
+  "dependencies": {
+    "@gld5000-cli/readline": "^1.0.6"
+  }
+}

package/src/filterDependents.mjs

@@ -0,0 +1,11 @@
+export function filterNoDependents(componentObjectArray) {
+  return componentObjectArray.filter(
+    (componentObject) => componentObject.dependents.length === 0
+  )
+}
+
+export function filterSomeDependents(componentObjectArray) {
+  return componentObjectArray.filter(
+    (componentObject) => componentObject.dependents.length > 0
+  )
+}

package/src/filterFiles.mjs

@@ -0,0 +1,11 @@
+/**
+ *
+ * @param {string[]} array
+ * @param {string[]} conditions
+ * @returns
+ */
+export function filterFilesNot(array, conditions) {
+  return array.filter(
+    (item) => !conditions.some((condition) => item.indexOf(condition) > -1)
+  )
+}

package/src/findComponents.mjs

@@ -0,0 +1,16 @@
+import { filterFilesNot } from "./filterFiles.mjs";
+import { findFiles } from "./findFiles.mjs";
+import { searchFiles } from "./searchFiles.mjs";
+
+/**
+ * Finds component exports within a folder's subfolders and returns an nested arrays of paths and component exports
+ * @param {string} inputPath
+ * @returns {[path: string, matches: string[]]}
+ */
+export function findComponents(inputPath, ignorePatterns) {
+  return searchFiles(
+    filterFilesNot(findFiles(inputPath), ignorePatterns),
+    /(export default function|export const|export default) ([a-zA-Z]+)/g,
+    2,
+  );
+}

package/src/findDependents.js

@@ -0,0 +1,73 @@
+import { readFileContent } from "./readFileContent.mjs";
+import { searchFileContent } from "./searchFileContent.mjs";
+import { findFiles } from "./findFiles.mjs";
+import { filterFilesNot } from "./filterFiles.mjs";
+
+export function findDependentsInTargetPaths(
+  componentObjectArray,
+  targetPaths = ["./components/**/*.tsx", "./pages/**/*.tsx"],
+) {
+  return targetPaths.reduce(targetPathReducer, componentObjectArray);
+}
+/**
+ * Finds dependents in each target path and creates a single object to represent them
+ * @param {*} accumulator
+ * @param {*} currentTargetPath
+ * @returns
+ */
+function targetPathReducer(componentObjectArray, currentTargetPath) {
+  return componentObjectArray.reduce(componentObjectArrayReducer, {
+    currentTargetPath,
+    componentObjectArray: [],
+  }).componentObjectArray;
+}
+/**
+ * Traverses componentObjectArray and checks for its exports in all relevant files in the current target path
+ * @param {*} componentObject
+ * @returns
+ */
+function componentObjectArrayReducer(acc, componentObject) {
+  const { matches, filePath, dependents } = componentObject;
+  const { currentTargetPath } = acc;
+  const targetFilelist = filterFilesNot(findFiles(currentTargetPath), [
+    ".test",
+    ".stories",
+  ]);
+  const { dependentsArray } = targetFilelist.reduce(targetFileListReducer, {
+    matches,
+    dependentsArray: [],
+  });
+  acc.componentObjectArray.push({
+    matches,
+    filePath,
+    dependents:
+      dependents !== undefined
+        ? [...dependents, ...dependentsArray]
+        : dependentsArray,
+  });
+  return acc;
+}
+/**
+ * For each target file, check against all match items and add details to dependents array if matches are found
+ * @param {*} acc
+ * @param {*} curr
+ * @returns
+ */
+function targetFileListReducer(acc, currentFilePath) {
+  const content = readFileContent(currentFilePath);
+  const dependentsCandidates = acc.matches
+    .flatMap((searchTerm) =>
+      searchFileContent(
+        content,
+        new RegExp(`import [^']*${searchTerm}[^a-zA-Z]([^']+'){2}`, "g"),
+      ),
+    )
+    .filter((currentArray) => currentArray.length > 0);
+  if (dependentsCandidates && dependentsCandidates.length > 0) {
+    acc.dependentsArray.push({
+      filePath: currentFilePath,
+      matches: dependentsCandidates,
+    });
+  }
+  return acc;
+}

package/src/findDependents.mjs

@@ -0,0 +1,74 @@
+import { readFileContent } from "./readFileContent.mjs";
+import { searchFileContent } from "./searchFileContent.mjs";
+import { findFiles } from "./findFiles.mjs";
+import { filterFilesNot } from "./filterFiles.mjs";
+
+export function findDependentsInTargetPaths(
+  componentObjectArray,
+  targetPaths,
+  ignorePatterns,
+) {
+  return targetPaths.reduce(targetPathReducer, componentObjectArray);
+  /**
+   * Finds dependents in each target path and creates a single object to represent them
+   * @param {*} accumulator
+   * @param {*} currentTargetPath
+   * @returns
+   */
+  function targetPathReducer(componentObjectArray, currentTargetPath) {
+    return componentObjectArray.reduce(componentObjectArrayReducer, {
+      currentTargetPath,
+      componentObjectArray: [],
+    }).componentObjectArray;
+  }
+  /**
+   * Traverses componentObjectArray and checks for its exports in all relevant files in the current target path
+   * @param {*} componentObject
+   * @returns
+   */
+  function componentObjectArrayReducer(acc, componentObject) {
+    const { matches, filePath, dependents } = componentObject;
+    const { currentTargetPath } = acc;
+    const targetFilelist = filterFilesNot(
+      findFiles(currentTargetPath),
+      ignorePatterns,
+    );
+    const { dependentsArray } = targetFilelist.reduce(targetFileListReducer, {
+      matches,
+      dependentsArray: [],
+    });
+    acc.componentObjectArray.push({
+      matches,
+      filePath,
+      dependents:
+        dependents !== undefined
+          ? [...dependents, ...dependentsArray]
+          : dependentsArray,
+    });
+    return acc;
+  }
+  /**
+   * For each target file, check against all match items and add details to dependents array if matches are found
+   * @param {*} acc
+   * @param {*} curr
+   * @returns
+   */
+  function targetFileListReducer(acc, currentFilePath) {
+    const content = readFileContent(currentFilePath);
+    const dependentsCandidates = acc.matches
+      .flatMap((searchTerm) =>
+        searchFileContent(
+          content,
+          new RegExp(`import [^'"]*${searchTerm}[^a-zA-Z]([^'"]+["']){2}`, "g"),
+        ),
+      )
+      .filter((currentArray) => currentArray.length > 0);
+    if (dependentsCandidates && dependentsCandidates.length > 0) {
+      acc.dependentsArray.push({
+        filePath: currentFilePath,
+        matches: dependentsCandidates,
+      });
+    }
+    return acc;
+  }
+}

package/src/findFiles.mjs

@@ -0,0 +1,10 @@
+import * as fs from 'fs'
+
+/**
+ *
+ * @param {string} pattern
+ * @returns {string[]}
+ */
+export function findFiles(pattern) {
+  return fs.globSync(pattern)
+}

package/src/index.mjs

@@ -0,0 +1,33 @@
+import { findComponents } from "./findComponents.mjs";
+import { writeFile } from "./writeFile.mjs";
+import {
+  filterNoDependents,
+  filterSomeDependents,
+} from "./filterDependents.mjs";
+import { findDependentsInTargetPaths } from "./findDependents.mjs";
+
+/**
+ *
+ * @param {string} searchPattern
+ * @param {string[]} targetPaths
+ * @param {string[]} ignorePatterns
+ */
+export function runDependencyFinder(
+  searchPattern,
+  targetPaths,
+  ignorePatterns,
+) {
+  // Get files with TSX exports
+  const allDependents = findDependentsInTargetPaths(
+    findComponents(searchPattern, ignorePatterns),
+    targetPaths,
+    ignorePatterns,
+  );
+  const noDependents = filterNoDependents(allDependents);
+  const someDependents = filterSomeDependents(allDependents);
+  const returnObject = {
+    noDependents: { count: noDependents.length, results: noDependents },
+    someDependents: { count: someDependents.length, results: someDependents },
+  };
+  writeFile(JSON.stringify(returnObject), "dependents-report.json");
+}

package/src/readFileContent.mjs

@@ -0,0 +1,10 @@
+import * as fs from 'fs'
+
+/**
+ *
+ * @param {string} filePath
+ * @returns {string}
+ */
+export function readFileContent(filePath) {
+  return fs.readFileSync(filePath, { encoding: 'utf8' })
+}

package/src/searchFileContent.mjs

@@ -0,0 +1,17 @@
+/**
+ *
+ * @param {string} content
+ * @param {RegExp} searchPattern
+ * @param {*} captureGroup
+ * @returns
+ */
+export function searchFileContent(content, searchPattern, captureGroup) {
+  const matches = content.match(searchPattern)
+  if (!matches) return []
+  if (captureGroup) {
+    return matches.map((matchString) =>
+      matchString.replace(searchPattern, `$${captureGroup}`)
+    )
+  }
+  return matches
+}

package/src/searchFiles.mjs

@@ -0,0 +1,30 @@
+import { readFileContent } from "./readFileContent.mjs";
+import { searchFileContent } from "./searchFileContent.mjs";
+
+/**
+ *
+ * @param {string[]} filePathArray
+ * @param {RegExp} searchPattern
+ * @param {number} captureGroup
+ * @returns {[path:string, matches: string[]]}
+ */
+export function searchFiles(filePathArray, searchPattern, captureGroup) {
+  return filePathArray.reduce(searchReducer, []);
+
+  function searchReducer(acc, curr) {
+    const matches = searchFile(curr, searchPattern, captureGroup);
+    acc.push({ filePath: curr, matches });
+    return acc;
+  }
+}
+/**
+ *
+ * @param {string} filePath
+ * @param {RegExp} searchPattern
+ * @param {number} captureGroup
+ * @returns {string[]}
+ */
+function searchFile(filePath, searchPattern, captureGroup) {
+  const content = readFileContent(filePath);
+  return searchFileContent(content, searchPattern, captureGroup);
+}

package/src/writeFile.mjs

@@ -0,0 +1,9 @@
+import * as fs from 'fs'
+/**
+ *
+ * @param {string} content
+ * @param {string} path
+ */
+export function writeFile(content, path) {
+  fs.writeFileSync(path, content)
+}

package/test/test-components/folder-a/test1.tsx

@@ -0,0 +1,3 @@
+export default function ComponentA() {
+  return <div>Test</div>;
+}

package/test/test-components/folder-b/test2.tsx

@@ -0,0 +1,3 @@
+export const ComponentB = () => {
+  return <div>Test</div>;
+};

package/test/test-components/folder-c/test3.tsx

@@ -0,0 +1,5 @@
+const ComponentC = () => {
+  return <div>Test</div>;
+};
+
+export default ComponentC;

package/test/test-components/index.tsx

@@ -0,0 +1,3 @@
+import ComponentA from "./folder-a/test1";
+import { ComponentA } from "./folder-a/test1";
+import { ComponentB } from "./folder-b/test2";

package/test/test.mjs

@@ -0,0 +1,39 @@
+import { runDependencyFinder } from "../src/index.mjs";
+import { answerStringQuestion } from "@gld5000-cli/readline";
+
+const args = process.argv.slice(2);
+const defaultSearchPattern = "./components/**/*.tsx";
+const searchPattern =
+  args[0] ||
+  (await answerStringQuestion(
+    "Where are your components?",
+    defaultSearchPattern,
+  ));
+
+const defaultTargetPaths = "./components/**/*.tsx|./pages/**/*.tsx";
+const targetPaths = `${
+  args[1] ||
+  (await answerStringQuestion(
+    "Which folders should we check for imports (pipe-separated)?",
+    defaultTargetPaths,
+  ))
+}`.split("|");
+
+const defaultIgnorePatterns = ".test|.stories";
+const ignorePatterns = `${
+  args[2] ||
+  (await answerStringQuestion(
+    "Which filename patterns should be ignored (pipe-separated)?",
+    defaultIgnorePatterns,
+  ))
+}`.split("|");
+// node test/test.mjs "test/test-components/**/*.tsx" "test/test-components/**/*.tsx" ".test|.stories"
+console.log(
+  "searchPattern:",
+  searchPattern,
+  "targetPaths:",
+  targetPaths,
+  "ignorePatterns:",
+  ignorePatterns,
+);
+runDependencyFinder(searchPattern, targetPaths, ignorePatterns);