https://github.com/philipbordallo/coscan

https://github.com/philipbordallo/coscan

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/philipbordallo/coscan
• Owner: philipbordallo
• Created: 2024-09-11T01:23:55.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-30T07:00:10.000Z (about 2 months ago)
• Last Synced: 2024-09-30T07:14:55.806Z (about 2 months ago)
• Language: TypeScript
• Size: 306 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# coscan

> A component scanner for React.

> [!NOTE]

> This project is in early development and the API will potentially change.

## Use cases

- Track a design system's usage across a codebase

- Identify where components are breaking out of design system constraints with props like `className` or `style`

## Getting Started

Check out the [coscan package documentation][coscan] for more information.

### Packages

| Name                                     | Description                          |

| ---------------------------------------- | ------------------------------------ |

| [`coscan`][coscan]                       | Main package for CLI and Node.js API |

| [`@coscan/json-reporter`][json-reporter] | JSON reporter                        |

| [`@coscan/jsx-scanner`][jsx-scanner]     | JSX scanner                          |

### Examples

| Name                                                   | Description              |

| ------------------------------------------------------ | ------------------------ |

| [`@coscan/react-simple-example`][react-simple-example] | Simple example for React |

[coscan]: ./packages/coscan/README.md

[json-reporter]: ./packages/json-reporter/README.md

[jsx-scanner]: ./packages/jsx-scanner/README.md

[react-simple-example]: ./examples/react-simple-example/README.md