https://github.com/component-driven/antbear

Analyze custom styles usage in the project
https://github.com/component-driven/antbear

Last synced: about 5 hours ago
JSON representation

Analyze custom styles usage in the project

• Host: GitHub
• URL: https://github.com/component-driven/antbear
• Owner: component-driven
• License: mit
• Created: 2020-07-29T19:51:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-03T06:18:41.000Z (about 1 year ago)
• Last Synced: 2024-11-08T09:45:11.887Z (7 days ago)
• Language: JavaScript
• Size: 869 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Contributing: Contributing.md
  • License: License.md

Awesome Lists containing this project

README

        
# [WIP] antbear

[![Build Status](https://travis-ci.org/component-driven/antbear.svg)](https://travis-ci.org/component-driven/antbear) [![npm](https://img.shields.io/npm/v/antbear.svg)](https://www.npmjs.com/package/antbear)

Analyze custom styles usage in the project.

## Motivation

We shouldn’t use custom styles on the application level. We should compose our user interfaces from primitive components. Sometimes, a component library isn’t flexible enough to make it possible, especially when it’s young.

By analyzing custom styles usage in the application and finding which component’s styles developers override the most, we can find what’s missing in the component library: missing component props, missing design tokens, and so on.

## Supports

- [x] JavaScript files

- [x] TypeScript and Flow files

- [x] styled-components and Emotion (`styled` factory)

- [ ] `sx` and `css` props ([Theme UI](https://theme-ui.com/sx-prop))

- [ ] CSS

- [ ] CSS Modules

- [ ] Sass

## Statistics

- [x] Custom styles per module

- [x] Overridden elements

- [x] Overridden components

- [x] CSS properties

- [x] CSS values

- [x] Custom colors (very basic, needs more work)

- [x] Custom spacing

- [x] Components and props

- [x] Components, props and values

## Installation

```

npm install antbear

```

### Usage

```

npx antbear 'src/**/*.{js,ts,tsx}'

```

## Changelog

The changelog can be found on the [Releases page](https://github.com/component-driven/antbear/releases).

## Contributing

Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](Contributing.md).

## Authors and license

[Artem Sapegin](https://sapegin.me) and [contributors](https://github.com/component-driven/antbear/graphs/contributors).

MIT License, see the included [License.md](License.md) file.