@gld5000-cli/dependency-finder 1.0.11 → 1.0.13

package/README.md

@@ -35,7 +35,7 @@ npx @gld5000-cli/dependency-finder
 ## Run with arguments
 
 ```
-npx @gld5000-cli/dependency-finder [Component directory] [Dependents paths] [File ignore patterns] [PascalCase only] [Import path filter]
+npx @gld5000-cli/dependency-finder [Component directory] [Dependents paths] [File ignore patterns] [PascalCase only] [Import path includes]
 ```
 
 ### Arguments
@@ -46,7 +46,7 @@ npx @gld5000-cli/dependency-finder [Component directory] [Dependents paths] [Fil
 | **Dependents paths**     | Pipe-separated glob patterns for where to search for imports | `./components/**/*.tsx\|./pages/**/*.tsx` | `./src/**/*.tsx\|./app/**/*.ts` |
 | **File ignore patterns** | Pipe-separated patterns to exclude from analysis             | `.test\|.stories`                         | `.test\|.spec\|.mock`           |
 | **PascalCase only**      | Filter exports to PascalCase names only (React components)   | `y`                                       | `y` or `n`                      |
-| **Import path filter**   | Filter imports to only those containing this substring       | (none)                                    | `folder-a` or `@components`     |
+| **Import path includes** | Filter imports to only those containing this substring       | (none)                                    | `folder-a` or `@components`     |
 
 ### Example Usage
 
@@ -151,7 +151,7 @@ After running, check `dependents-report.json` and review the `noDependents` sect
 ### Audit Before Deprecating a Component Library
 
 ```bash
-npx @gld5000-cli/dependency-finder "./components/**/*.tsx" "./pages/**/*.tsx|./features/**/*.tsx|./layouts/**/*.tsx" ".test"
+npx @gld5000-cli/dependency-finder "./node_modules/my_package/build/components/**/index.d.ts" "./components/**/*.tsx|./pages/**/*.tsx" ".test|.stories" "y" "my_package"
 ```
 
 Review the `someDependents` section to see exactly where each component is used before deprecating or refactoring.
@@ -163,6 +163,40 @@ Review the `someDependents` section to see exactly where each component is used
 npx @gld5000-cli/dependency-finder
 ```
 
+### Run in CI pipeline for repo files
+
+```yaml
+dependency_report:
+  stage: test
+  image: node:latest
+  script:
+    # Run the command; file is created automatically by the package: npx @gld5000-cli/dependency-finder [Component directory] [Dependents paths] [File ignore patterns] [PascalCase only] [Import path includes]
+    - npx @gld5000-cli/dependency-finder "./components/**/*.tsx" "./components/**/*.tsx|./pages/**/*.tsx" ".test|.stories" "y"
+  artifacts:
+    paths:
+      - dependents-report.json
+    when: always # Optional: uploads the report even if the job fails
+    expire_in: 1 week # Optional: defines how long to keep the file
+```
+
+### Run in CI pipeline for project dependencies
+
+```yaml
+my_package_dependency_report:
+  stage: test
+  image: node:latest
+  script:
+    # Install node_modules
+    - npm install
+    # Run the command; file is created automatically by the package: npx @gld5000-cli/dependency-finder [Component directory] [Dependents paths] [File ignore patterns] [PascalCase only] [Import path includes]
+    - npx @gld5000-cli/dependency-finder "./node_modules/my_package/build/components/**/index.d.ts" "./components/**/*.tsx|./pages/**/*.tsx" ".test|.stories" "y" "my_package"
+  artifacts:
+    paths:
+      - dependents-report.json
+    when: always # Optional: uploads the report even if the job fails
+    expire_in: 1 week # Optional: defines how long to keep the file
+```
+
 Follow the prompts to customize paths for your project structure.
 
 ## Contributing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gld5000-cli/dependency-finder",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "Finds how many dependents your components have.",
   "keywords": [
     "CLI",

package/src/findDependents.mjs

@@ -7,7 +7,7 @@ export function findDependentsInTargetPaths(
   componentObjectArray,
   targetPaths,
   ignorePatterns,
-  importPathSubstring,
+  importPathIncludes,
 ) {
   return targetPaths.reduce(targetPathReducer, componentObjectArray);
   /**
@@ -67,13 +67,13 @@ export function findDependentsInTargetPaths(
         ),
       )
       .filter((currentString) => {
-        // console.log("importPathSubstring", importPathSubstring);
+        // console.log("importPathIncludes", importPathIncludes);
         // console.log("currentsSring", currentString);
         return (
-          (currentString.length > 0 && !importPathSubstring) ||
-          (importPathSubstring &&
+          (currentString.length > 0 && !importPathIncludes) ||
+          (importPathIncludes &&
             currentString.length > 0 &&
-            currentString.indexOf(importPathSubstring) !== -1)
+            currentString.indexOf(importPathIncludes) !== -1)
         );
       });
     if (dependentsCandidates && dependentsCandidates.length > 0) {

package/src/index.mjs

@@ -17,14 +17,14 @@ export function runDependencyFinder(
   targetPaths,
   ignorePatterns,
   isPascalCase,
-  importPathSubstring,
+  importPathIncludes,
 ) {
   // Get files with TSX exports
   const allDependents = findDependentsInTargetPaths(
     findComponents(searchPattern, ignorePatterns, isPascalCase),
     targetPaths,
     ignorePatterns,
-    importPathSubstring,
+    importPathIncludes,
   );
   const noDependents = filterNoDependents(allDependents);
   const someDependents = filterSomeDependents(allDependents);