Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/projectwallace/css-code-quality
Calculate the Code Quality score of your CSS based on a range of different quality guards.
https://github.com/projectwallace/css-code-quality
code-quality css wallace
Last synced: 3 months ago
JSON representation
Calculate the Code Quality score of your CSS based on a range of different quality guards.
- Host: GitHub
- URL: https://github.com/projectwallace/css-code-quality
- Owner: projectwallace
- License: mit
- Created: 2022-01-02T21:00:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T11:07:41.000Z (8 months ago)
- Last Synced: 2024-04-13T22:26:45.329Z (7 months ago)
- Topics: code-quality, css, wallace
- Language: JavaScript
- Homepage: https://www.projectwallace.com/css-code-quality
- Size: 152 KB
- Stars: 65
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-ccamel - projectwallace/css-code-quality - Calculate the Code Quality score of your CSS based on a range of different quality guards. (JavaScript)
README
# CSS Code Quality calculator
Calculate the Code Quality score of your CSS based on a range of different quality guards.
---
This package analyzes your CSS on a high level and comes up with a score, divided into three areas:
- **Maintainability**: how difficult is it for someone looking at the CSS from a high level to find the exact spot to fix a bug?
- **Complexity**: how difficult is it for someone to make a change and be confident that they can make that change without side effects?
- **Performance**: How likely is the CSS to have a negative impact on performance, based on high-level metrics? (Not including using hardware accelerated transforms and the like, because other tools are more suited for that.)
## Installation
```bash
npm install @projectwallace/css-code-quality
```
## Usage
```js
import { calculate } from "@projectwallace/css-code-quality";
let css = `my_css { /* ... */ }`;
let result = calculate(css);
/*
The result shape looks something like this:
{
"violations": [ ],
"passes": [ ],
"performance": {
"score": 90,
"violations": [ ],
"passes": [ ]
},
"maintainability": {
"score": 100,
"violations": [ ],
"passes": [ ]
},
"complexity": {
"score": 97,
"violations": [ ],
"passes": [ ]
}
}
Each `passes` or `violations` array contains an object that looks like this:
{
"id": "EmptyRules",
"score": 0,
"value": 0
},
{
"id": "AverageSelectorsPerRule",
"score": 0,
"value": 1.5,
"actuals": [
2,
1
]
}
etc. etc.
*/
```
## Related projects
- [CSS Analyzer](https://github.com/projectwallace/css-analyzer) -
A CSS Analyzer that goes through your CSS to find all kinds of relevant statistics.
- [Wallace CLI](https://github.com/projectwallace/wallace-cli) - CLI tool for
@projectwallace/css-analyzer
- [Constyble](https://github.com/projectwallace/constyble) - CSS Complexity linter
- [Color Sorter](https://github.com/projectwallace/color-sorter) - Sort CSS colors
by hue, saturation, lightness and opacity