@projectwallace/format-css
v1.5.1
Published
Fast, small, zero-config library to format CSS with basic rules.
Downloads
614
Maintainers
Readme
format-css
Fast, small, zero-config library to format CSS with basic rules. The design goal is to format CSS in a way that makes it easy to inspect. Bundle size and runtime speed are more important than versatility and extensibility.
Example output
/* TURN THIS: */
@layer base.normalize{@media (dynamic-range:high) or (color-gamut:p3){@supports (color:color(display-p3 0 0 0)){:where(html){--link:color(display-p3 .1 .4 1);--link-visited:color(display-p3 .6 .2 1)}}}}@layer base.normalize{:where(html) :where(dialog){background-color:var(--surface-1)}}
/* INTO THIS: */
@layer base.normalize {
@media (dynamic-range: high) or (color-gamut: p3) {
@supports (color: color(display-p3 0 0 0)) {
:where(html) {
--link: color(display-p3 .1 .4 1);
--link-visited: color(display-p3 .6 .2 1);
}
}
}
}
@layer base.normalize {
:where(html) :where(dialog) {
background-color: var(--surface-1);
}
}
/* AND BACK AGAIN! */
Installation
npm install @projectwallace/format-css
Usage
import { format } from "@projectwallace/format-css";
let old_css = "/* Your old CSS here */";
let new_css = format(old_css);
Need more examples?
Formatting rules
- Every AtRule starts on a new line
- Every Rule starts on a new line
- Every Selector starts on a new line
- A comma is placed after every Selector that’s not the last in the SelectorList
- Every Block is indented with 1 tab more than the previous indentation level
- Every Declaration starts on a new line
- Every Declaration ends with a semicolon (;)
- An empty line is placed after a Block unless it’s the last in the surrounding Block
- Multiline tokens like Selectors, Values, etc. are rendered on a single line
- Unknown syntax is rendered as-is, with multi-line formatting kept intact
Minify CSS
This package also exposes a minifier function since minifying CSS follows many of the same rules as formatting.
import { format, minify } from "@projectwallace/format-css";
let minified = minify("a {}");
// which is an alias for
let formatted_mini = format("a {}", { minify: true });
Acknowledgements
- Thanks to CSSTree for providing the necessary parser and the interfaces for our CSS Types (the bold elements in the list above)
Related projects
- Format CSS online - See this formatter in action online!
- Minify CSS online - See this minifier in action online!
- CSS Analyzer - The best CSS analyzer that powers all analysis on projectwallace.com