#component #react #graph #projects #html #tool #system

bin+lib spinne

spinne is a cli tool that analyzes design system usage for react projects

2 unstable releases

0.2.0 Nov 10, 2024
0.1.0 Aug 15, 2024

#1339 in Parser implementations

Download history 92/week @ 2024-08-12 10/week @ 2024-09-16 7/week @ 2024-09-23 35/week @ 2024-09-30 2/week @ 2024-10-07 51/week @ 2024-11-04 57/week @ 2024-11-11

108 downloads per month

MIT license

73KB
1.5K SLoC

Spinne

Spins a web of components and analyzes component/prop usage in your react project

Crates.io Version

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

Dependencies

~22–33MB
~530K SLoC