hermex 1.2.0 → 1.3.0-beta.2

package/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Gal Levy
-
-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.
+MIT License
+
+Copyright (c) 2025 Gal Levy
+
+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

@@ -1,59 +1,59 @@
-# hermex
-
-SWC-based AST parser for analyzing code and React component usage patterns across entire codebases
-
-## Quick Start
-
-```bash
-# No installation required - use npx (scans current directory)
-npx hermex scan
-
-# Or install globally
-npm install -g hermex
-hermex scan
-
-# Scan specific directory
-npx hermex scan "src/**/*.tsx"
-```
-
-## Requirements
-
-- Node.js 20+
-
-## Key Features
-
-- **Fast SWC-based Parsing**: Lightning-fast static analysis using SWC's Rust-based parser
-- **Comprehensive Pattern Detection**: Identifies 10+ React usage patterns including:
-  - Direct imports (default, named, namespace, aliased)
-  - JSX element usage
-  - Variable assignments and destructuring
-  - Conditional usage (ternary operators)
-  - Collection mappings (arrays and objects)
-  - Lazy and dynamic imports
-  - Advanced patterns (HOC, memo, forwardRef, portals)
-- **Version Tracking**: Components reported with exact package versions from lockfiles
-- **Multi-Lockfile Support**: Parses package-lock.json, yarn.lock, and pnpm-lock.yaml
-- **Flexible Output**: Table and chart visualization formats
-- **Zero Configuration**: Works out of the box with sensible defaults
-
-## Installation
-
-```bash
-# Global installation
-npm install -g hermex
-
-# Or with pnpm
-pnpm add -g hermex
-
-# Or with yarn
-yarn global add hermex
-```
-
-## CLI Usage
-
-### Main CLI
-
-```bash
+# hermex
+
+SWC-based AST parser for analyzing code and React component usage patterns across entire codebases
+
+## Quick Start
+
+```bash
+# No installation required - use npx (scans current directory)
+npx hermex scan
+
+# Or install globally
+npm install -g hermex
+hermex scan
+
+# Scan specific directory
+npx hermex scan "src/**/*.tsx"
+```
+
+## Requirements
+
+- Node.js 20+
+
+## Key Features
+
+- **Fast SWC-based Parsing**: Lightning-fast static analysis using SWC's Rust-based parser
+- **Comprehensive Pattern Detection**: Identifies 10+ React usage patterns including:
+  - Direct imports (default, named, namespace, aliased)
+  - JSX element usage
+  - Variable assignments and destructuring
+  - Conditional usage (ternary operators)
+  - Collection mappings (arrays and objects)
+  - Lazy and dynamic imports
+  - Advanced patterns (HOC, memo, forwardRef, portals)
+- **Version Tracking**: Components reported with exact package versions from lockfiles
+- **Multi-Lockfile Support**: Parses package-lock.json, yarn.lock, and pnpm-lock.yaml
+- **Flexible Output**: Table and chart visualization formats
+- **Zero Configuration**: Works out of the box with sensible defaults
+
+## Installation
+
+```bash
+# Global installation
+npm install -g hermex
+
+# Or with pnpm
+pnpm add -g hermex
+
+# Or with yarn
+yarn global add hermex
+```
+
+## CLI Usage
+
+### Main CLI
+
+```bash
 Usage: hermex [options] [command]
 
 Analyze React component usage patterns in your codebase
@@ -64,14 +64,14 @@ Options:
 
 Commands:
   scan [options] [pattern]  Scan and analyze local files
-  help [command]            display help for command
-```
-
-### Scan Command
-
-The `scan` command analyzes local files for React component usage patterns.
-
-```bash
+  help [command]            display help for command
+```
+
+### Scan Command
+
+The `scan` command analyzes local files for React component usage patterns.
+
+```bash
 Usage: hermex scan [options] [pattern]
 
 Scan and analyze local files
@@ -99,14 +99,14 @@ Options:
   --no-patterns                Do not show patterns
   --ignore-errors              Continue scanning even if some files fail to
                                parse
-  -h, --help                   display help for command
-```
-
-## Example Output
-
-Running a basic scan (uses default pattern `**/*.{tsx,jsx,ts,js}`):
-
-```bash
+  -h, --help                   display help for command
+```
+
+## Example Output
+
+Running a basic scan (uses default pattern `**/*.{tsx,jsx,ts,js}`):
+
+```bash
 📦 Packages
 
   No packages found
@@ -155,45 +155,45 @@ Total: 272 patterns detected
 │ External Components │ 0     │
 ├─────────────────────┼───────┤
 │ Total Usages        │ 0     │
-└─────────────────────┴───────┘
-```
-
-## Use Cases
-
-1. **Dependency Audits** - Understand library usage before migrations
-2. **Version Tracking** - Know exactly which component versions are in use
-3. **Migration Planning** - Identify components that need updating when migrating UI libraries
-4. **Component Analytics** - Track most-used components and usage patterns
-5. **Code Quality** - Identify complex usage patterns that may need refactoring
-6. **Team Insights** - Understand how your team uses component libraries
-7. **Documentation** - Generate usage reports for component library documentation
-
-## Documentation
-
-- **[Examples](./docs/examples.md)** - Comprehensive examples and command usage
-- **[Patterns Guide](./docs/patterns.md)** - All detectable React usage patterns
-
-## Tech Stack
-
-- **Runtime**: Node.js 24
-- **Parser**: [@swc/core](https://swc.rs/)
-- **CLI**: [Commander.js](https://github.com/tj/commander.js)
-- **Build**: [tsup](https://tsup.egoist.dev/)
-- **Language**: [TypeScript](https://www.typescriptlang.org/)
-- **Formatter**: [Biome](https://biomejs.dev/)
-- **Linter**: [oxlint](https://oxc-project.github.io/)
-- **Tests**: [Vitest](https://vitest.dev/)
-
-## Contributing
-
-Contributions are welcome! Please read our [Contributing Guide](./CONTRIBUTING.md) for details.
-
-## License
-
-MIT License - see [LICENSE.md](./LICENSE.md)
-
-## Links
-
-- [GitHub Repository](https://github.com/Gallevy/hermex.git)
-- [npm Package](https://www.npmjs.com/package/hermex)
-- [Report Issues](https://github.com/Gallevy/hermex.git/issues)
+└─────────────────────┴───────┘
+```
+
+## Use Cases
+
+1. **Dependency Audits** - Understand library usage before migrations
+2. **Version Tracking** - Know exactly which component versions are in use
+3. **Migration Planning** - Identify components that need updating when migrating UI libraries
+4. **Component Analytics** - Track most-used components and usage patterns
+5. **Code Quality** - Identify complex usage patterns that may need refactoring
+6. **Team Insights** - Understand how your team uses component libraries
+7. **Documentation** - Generate usage reports for component library documentation
+
+## Documentation
+
+- **[Examples](./docs/examples.md)** - Comprehensive examples and command usage
+- **[Patterns Guide](./docs/patterns.md)** - All detectable React usage patterns
+
+## Tech Stack
+
+- **Runtime**: Node.js 24
+- **Parser**: [@swc/core](https://swc.rs/)
+- **CLI**: [Commander.js](https://github.com/tj/commander.js)
+- **Build**: [tsup](https://tsup.egoist.dev/)
+- **Language**: [TypeScript](https://www.typescriptlang.org/)
+- **Formatter**: [Biome](https://biomejs.dev/)
+- **Linter**: [oxlint](https://oxc-project.github.io/)
+- **Tests**: [Vitest](https://vitest.dev/)
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](./CONTRIBUTING.md) for details.
+
+## License
+
+MIT License - see [LICENSE.md](./LICENSE.md)
+
+## Links
+
+- [GitHub Repository](https://github.com/Gallevy/hermex.git)
+- [npm Package](https://www.npmjs.com/package/hermex)
+- [Report Issues](https://github.com/Gallevy/hermex.git/issues)