@gld5000-cli/dependency-finder 1.0.3 → 1.0.4

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]
+npx @gld5000-cli/dependency-finder [Component directory] [Dependents paths] [File ignore patterns] [PascalCase only]
 ```
 
 ### Arguments
@@ -45,6 +45,7 @@ npx @gld5000-cli/dependency-finder [Component directory] [Dependents paths] [Fil
 | **Component directory**  | Glob pattern for component files to analyze                  | `./components/**/*.tsx`                   | `./src/components/**/*.tsx`     |
 | **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)   | `n`                                       | `y` or `n`                      |
 
 ### Example Usage
 
@@ -57,6 +58,12 @@ npx @gld5000-cli/dependency-finder "./src/components/**/*.ts" "./src/**/*.ts" ".
 
 # Analyze React components including JSX
 npx @gld5000-cli/dependency-finder "./components/**/*.{tsx,jsx}" "./src/**/*.{tsx,jsx}|./pages/**/*.{tsx,jsx}" ".test|.stories|.mock"
+
+# Analyze TSX components with PascalCase filtering (for strict React component naming)
+npx @gld5000-cli/dependency-finder "./components/**/*.tsx" "./components/**/*.tsx|./pages/**/*.tsx" ".test|.stories" "y"
+
+# Analyze JSX components with PascalCase filtering enabled
+npx @gld5000-cli/dependency-finder "./src/components/**/*.jsx" "./src/**/*.jsx" ".test|.stories" "y"
 ```
 
 ## Output
@@ -117,11 +124,12 @@ The tool generates a `dependents-report.json` file in your project root with the
 
 1. **Discover Components** - Scans your codebase using the component directory pattern to find all component files
 2. **Extract Exports** - Identifies exported components in each file
-3. **Search for Imports** - Searches target paths for import statements referencing each component
-4. **Categorize Results** - Groups components into those with dependents and those without
-5. **Generate Report** - Creates a detailed JSON report with all findings
+3. **Filter Exports** - Optionally filters exports to include only PascalCase names (enforces React component naming conventions)
+4. **Search for Imports** - Searches target paths for import statements referencing each component
+5. **Categorize Results** - Groups components into those with dependents and those without
+6. **Generate Report** - Creates a detailed JSON report with all findings
 
-The tool uses glob patterns for flexible file matching and supports filtering to exclude test files, stories, and other non-production code.
+The tool uses glob patterns for flexible file matching and supports filtering to exclude test files, stories, and other non-production code. For TSX/JSX components, enable PascalCase filtering to strictly enforce React naming conventions and ignore helper functions and utilities.
 
 ## Examples
 

package/bin/index.mjs

@@ -29,4 +29,12 @@ const ignorePatterns = `${
     defaultIgnorePatterns,
   ))
 }`.split("|");
-runDependencyFinder(searchPattern, targetPaths, ignorePatterns);
+
+const isPascalCase =
+  (args[3] ||
+    (await answerStringQuestion(
+      "PascalCase exports only?",
+      defaultExportCase,
+    ))) === "y";
+
+runDependencyFinder(searchPattern, targetPaths, ignorePatterns, isPascalCase);

package/package.json

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

package/src/findComponents.mjs

@@ -7,10 +7,12 @@ import { searchFiles } from "./searchFiles.mjs";
  * @param {string} inputPath
  * @returns {[path: string, matches: string[]]}
  */
-export function findComponents(inputPath, ignorePatterns) {
+export function findComponents(inputPath, ignorePatterns, isPascalCase) {
   return searchFiles(
     filterFilesNot(findFiles(inputPath), ignorePatterns),
-    /(export default function|export const|export default|export declare const) ([a-zA-Z]+)/g,
+    isPascalCase
+      ? /(export default function|export const|export default|export declare const) ([A-Z][a-zA-Z]+)/g
+      : /(export default function|export const|export default|export declare const) ([a-zA-Z]+)/g,
     2,
   );
 }

package/src/index.mjs

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