Skip to content

Commit bcf00ec

Browse files
bartvenemanbartveneman
authored
update readme to reflect latest feature additions (#91)
1 parent 7aa7913 commit bcf00ec

File tree

1 file changed

+102
-185
lines changed

1 file changed

+102
-185
lines changed

‎readme.md‎

Lines changed: 102 additions & 185 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ like the amount of rules, the amount of `!important`s, unique colors, and so on.
88
## Install
99

1010
```sh
11-
npm install --save @projectwallace/css-analyzer
11+
npm install @projectwallace/css-analyzer
1212
```
1313

1414
or
@@ -22,202 +22,119 @@ yarn add @projectwallace/css-analyzer
2222
```js
2323
const analyze = require('css-analyzer');
2424

25-
analyze('foo {}')
25+
analyze('foo{}')
2626
.then(result => console.log(result))
2727
.catch(err => console.error(err))
2828
}
2929

3030
//=>
3131
// {
32-
// atrules: {
33-
// charsets: {
34-
// total: 0,
35-
// totalUnique: 0,
36-
// unique: []
37-
// },
38-
// documents: {
39-
// total: 0,
40-
// totalUnique: 0,
41-
// unique: []
42-
// },
43-
// fontfaces: {
44-
// total: 0,
45-
// totalUnique: 0,
46-
// unique: []
47-
// },
48-
// imports: {
49-
// total: 0,
50-
// totalUnique: 0,
51-
// unique: []
52-
// },
53-
// keyframes: {
54-
// total: 0,
55-
// totalUnique: 0,
56-
// unique: []
57-
// },
58-
// mediaqueries: {
59-
// total: 0,
60-
// totalUnique: 0,
61-
// unique: [],
62-
// browserhacks: {
63-
// total: 0,
64-
// unique: [],
65-
// totalUnique: 0
66-
// }
67-
// },
68-
// namespaces: {
69-
// total: 0,
70-
// totalUnique: 0,
71-
// unique: []
72-
// },
73-
// pages: {
74-
// total: 0,
75-
// totalUnique: 0,
76-
// unique: []
77-
// },
78-
// supports: {
79-
// total: 0,
80-
// totalUnique: 0,
81-
// unique: [],
82-
// browserhacks: {
83-
// total: 0,
84-
// unique: [],
85-
// totalUnique: 0
86-
// }
87-
// }
88-
// },
89-
// declarations: {
90-
// importants: {
91-
// share: 0,
92-
// total: 0
93-
// },
94-
// total: 0,
95-
// totalUnique: 0
96-
// },
97-
// properties: {
98-
// prefixed: {
99-
// share: 0,
100-
// total: 0,
101-
// totalUnique: 0,
102-
// unique: []
103-
// },
104-
// total: 0,
105-
// totalUnique: 0,
106-
// unique: [],
107-
// browserhacks: {
108-
// total: 0,
109-
// unique: [],
110-
// totalUnique: 0
111-
// }
112-
// },
113-
// rules: {
114-
// total: 1,
115-
// empty: {
116-
// total: 1
117-
// }
118-
// },
119-
// selectors: {
120-
// accessibility: {
121-
// total: 0,
122-
// totalUnique: 0,
123-
// unique: []
124-
// },
125-
// id: {
126-
// total: 0,
127-
// totalUnique: 0,
128-
// unique: []
129-
// },
130-
// identifiers: {
131-
// average: 1,
132-
// top: [
133-
// {
134-
// identifiers: 1,
135-
// selector: 'foo'
136-
// }
137-
// ]
138-
// },
139-
// js: {
140-
// total: 0,
141-
// totalUnique: 0,
142-
// unique: []
143-
// },
144-
// specificity: {
145-
// top: [
146-
// {
147-
// selector: 'foo',
148-
// specificity: {
149-
// a: 0,
150-
// b: 0,
151-
// c: 0,
152-
// d: 1
153-
// }
154-
// }
155-
// ]
156-
// },
157-
// total: 1,
158-
// totalUnique: 1,
159-
// universal: {
160-
// total: 0,
161-
// totalUnique: 0,
162-
// unique: []
163-
// },
164-
// browserhacks: {
165-
// total: 0,
166-
// unique: [],
167-
// totalUnique: 0
168-
// }
169-
// },
170-
// stylesheets: {
171-
// cohesion: {
172-
// average: 0
173-
// },
174-
// simplicity: 1,
175-
// size: 5,
176-
// browserhacks: {
177-
// total: 0,
178-
// totalUnique: 0
179-
// }
180-
// },
181-
// values: {
182-
// colors: {
183-
// total: 0,
184-
// totalUnique: 0,
185-
// unique: [],
186-
// duplicates: []
187-
// },
188-
// fontfamilies: {
189-
// total: 0,
190-
// totalUnique: 0,
191-
// unique: []
192-
// },
193-
// fontsizes: {
194-
// total: 0,
195-
// totalUnique: 0,
196-
// unique: []
197-
// },
198-
// prefixed: {
199-
// share: 0,
200-
// total: 0,
201-
// totalUnique: 0,
202-
// unique: []
203-
// },
204-
// browserhacks: {
205-
// total: 0,
206-
// unique: [],
207-
// totalUnique: 0
208-
// },
209-
// total: 0
210-
// }
32+
// 'atrules.charsets.total': 0,
33+
// 'atrules.charsets.totalUnique': 0,
34+
// 'atrules.charsets.unique': [],
35+
// 'atrules.documents.total': 0,
36+
// 'atrules.documents.totalUnique': 0,
37+
// 'atrules.documents.unique': [],
38+
// 'atrules.fontfaces.total': 0,
39+
// 'atrules.fontfaces.totalUnique': 0,
40+
// 'atrules.fontfaces.unique': [],
41+
// 'atrules.imports.total': 0,
42+
// 'atrules.imports.totalUnique': 0,
43+
// 'atrules.imports.unique': [],
44+
// 'atrules.keyframes.total': 0,
45+
// 'atrules.keyframes.totalUnique': 0,
46+
// 'atrules.keyframes.unique': [],
47+
// 'atrules.mediaqueries.total': 0,
48+
// 'atrules.mediaqueries.totalUnique': 0,
49+
// 'atrules.mediaqueries.unique': [],
50+
// 'atrules.mediaqueries.browserhacks.total': 0,
51+
// 'atrules.mediaqueries.browserhacks.unique': [],
52+
// 'atrules.mediaqueries.browserhacks.totalUnique': 0,
53+
// 'atrules.namespaces.total': 0,
54+
// 'atrules.namespaces.totalUnique': 0,
55+
// 'atrules.namespaces.unique': [],
56+
// 'atrules.pages.total': 0,
57+
// 'atrules.pages.totalUnique': 0,
58+
// 'atrules.pages.unique': [],
59+
// 'atrules.supports.total': 0,
60+
// 'atrules.supports.totalUnique': 0,
61+
// 'atrules.supports.unique': [],
62+
// 'atrules.supports.browserhacks.total': 0,
63+
// 'atrules.supports.browserhacks.unique': [],
64+
// 'atrules.supports.browserhacks.totalUnique': 0,
65+
// 'declarations.importants.share': 0,
66+
// 'declarations.importants.total': 0,
67+
// 'declarations.total': 0,
68+
// 'declarations.totalUnique': 0,
69+
// 'properties.prefixed.share': 0,
70+
// 'properties.prefixed.total': 0,
71+
// 'properties.prefixed.totalUnique': 0,
72+
// 'properties.prefixed.unique': [],
73+
// 'properties.browserhacks.total': 0,
74+
// 'properties.browserhacks.unique': [],
75+
// 'properties.browserhacks.totalUnique': 0,
76+
// 'properties.total': 0,
77+
// 'properties.totalUnique': 0,
78+
// 'properties.unique': [],
79+
// 'rules.total': 1,
80+
// 'rules.empty.total': 1,
81+
// 'selectors.accessibility.total': 0,
82+
// 'selectors.accessibility.totalUnique': 0,
83+
// 'selectors.accessibility.unique': [],
84+
// 'selectors.id.total': 0,
85+
// 'selectors.id.totalUnique': 0,
86+
// 'selectors.id.unique': [],
87+
// 'selectors.identifiers.average': 1,
88+
// 'selectors.identifiers.top': [{count: 1, value: 'foo'}],
89+
// 'selectors.identifiers.max.count': 1,
90+
// 'selectors.identifiers.max.value': 'foo',
91+
// 'selectors.js.total': 0,
92+
// 'selectors.js.totalUnique': 0,
93+
// 'selectors.js.unique': [],
94+
// 'selectors.specificity.top': [
95+
// {value: 'foo', specificity: {a: 0, b: 0, c: 0, d: 1}}
96+
// ],
97+
// 'selectors.total': 1,
98+
// 'selectors.totalUnique': 1,
99+
// 'selectors.universal.total': 0,
100+
// 'selectors.universal.totalUnique': 0,
101+
// 'selectors.universal.unique': [],
102+
// 'selectors.browserhacks.total': 0,
103+
// 'selectors.browserhacks.unique': [],
104+
// 'selectors.browserhacks.totalUnique': 0,
105+
// 'stylesheets.cohesion.average': 0,
106+
// 'stylesheets.simplicity': 1,
107+
// 'stylesheets.size': 5,
108+
// 'stylesheets.browserhacks.total': 0,
109+
// 'stylesheets.browserhacks.totalUnique': 0,
110+
// 'values.browserhacks.total': 0,
111+
// 'values.browserhacks.unique': [],
112+
// 'values.browserhacks.totalUnique': 0,
113+
// 'values.colors.total': 0,
114+
// 'values.colors.totalUnique': 0,
115+
// 'values.colors.unique': [],
116+
// 'values.colors.duplicates.total': 0,
117+
// 'values.colors.duplicates.totalUnique': 0,
118+
// 'values.colors.duplicates.unique': [],
119+
// 'values.fontfamilies.total': 0,
120+
// 'values.fontfamilies.totalUnique': 0,
121+
// 'values.fontfamilies.unique': [],
122+
// 'values.fontsizes.total': 0,
123+
// 'values.fontsizes.totalUnique': 0,
124+
// 'values.fontsizes.unique': [],
125+
// 'values.prefixed.share': 0,
126+
// 'values.prefixed.total': 0,
127+
// 'values.prefixed.totalUnique': 0,
128+
// 'values.prefixed.unique': [],
129+
// 'values.total': 0
211130
// }
212131
```
213132

214133
## Related projects
215134

216-
- [Wallace](https://github.com/bartveneman/wallace-cli) - CLI tool for
135+
- [Wallace CLI](https://github.com/bartveneman/wallace-cli) - CLI tool for
217136
@projectwallace/css-analyzer
218-
- [CSS Analyzer Diff](https://github.com/bartveneman/css-analyzer-diff) -
219-
Calculates the diff between two sets of CSS analysis
220-
- [Gromit](https://github.com/bartveneman/gromit-cli) - A test framework to assert
137+
- [Gromit CLI](https://github.com/bartveneman/gromit-cli) - A test framework to assert
221138
that CSS doesn't exceeds certain thresholds
222139
- [Color Sorter](https://github.com/bartveneman/color-sorter) - Sort CSS colors
223140
by hue, saturation, lightness and opacity

0 commit comments

Comments
 (0)