7 releases
| new 0.2.6 | Jan 15, 2025 |
|---|---|
| 0.2.5 | Jan 15, 2025 |
| 0.2.0 | Nov 10, 2024 |
| 0.1.0 | Aug 15, 2024 |
#476 in Command line utilities
257 downloads per month
105KB
2K
SLoC
Spinne
Spins a web of components and analyzes component/prop usage in your react project
Installation
Spinne is a command line tool written in rust, so you need to have rust/cargo installed.
cargo install spinne
Usage
To scan for components in your current directory:
spinne
This command will output the results in a file 'spinne-report.json' by default.
If you want to output it directly to the console you can use -o console:
spinne -o console
To output the results in a html format with a visualization of the component graph:
spinne -f html
Options
| Option | Description | Options | Default |
|---|---|---|---|
-e, --entry <path> |
entry point directory | Path | current directory (./) |
-f, --format <format> |
define the output format | file, console, html |
file |
-i, --ignore <path> |
define ignored folders | comma separated glob patterns | **/node_modules/**,**/dist/**,**/build/** |
--file-name <file-name> |
define the output file name | String | spinne-report |
-l, --log-level <log-level> |
define the log level | the amount of -l used will define the log level | 0 |
--include <include> |
define a glob pattern to include | comma separated glob patterns | **/*.tsx |
--exclude <exclude> |
define a glob pattern to exclude | comma separated glob patterns | **/node_modules/**,**/dist/**,**/build/**,**/*.stories.tsx,**/*.test.tsx |
Dependencies
~18–27MB
~409K SLoC