spinne
| Crates.io | spinne |
| lib.rs | spinne |
| version | 0.2.0 |
| source | src |
| created_at | 2024-08-15 18:19:10.734415 |
| updated_at | 2024-11-10 18:11:10.882195 |
| description | spinne is a cli tool that analyzes design system usage for react projects. |
| homepage | |
| repository | https://github.com/tim-richter/spinne |
| max_upload_size | |
| id | 1339081 |
| size | 139,615 |
Tim Richter (tim-richter)
documentation
README
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 | error, warn, info, debug, trace |
info |
--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 |