Command line interface for CSSO
Clone or download
Latest commit e09cfdb Dec 28, 2018

README.md

NPM version Build Status Twitter

Command line interface for CSSO.

Install

npm install -g csso-cli

Usage

csso [input] [options]

Options:

      --comments <value>           Comments to keep: exclamation (default), first-exclamation or none
      --debug [level]              Output intermediate state of CSS during a compression
  -d, --declaration-list           Treat input as a declaration list
      --force-media-merge          Enable unsafe merge of @media rules
  -h, --help                       Output usage information
  -i, --input <filename>           Input file
      --input-source-map <source>  Input source map: none, auto (default) or <filename>
      --no-restructure             Disable structural optimisations
  -o, --output <filename>          Output file (result outputs to stdout if not set)
  -s, --source-map <destination>   Generate source map: none (default), inline, file or <filename>
      --stat                       Output statistics in stderr
  -u, --usage <filename>           Usage data file
  -v, --version                    Output version
      --watch                      Watch source file for changes

Some examples:

> csso in.css
...output result in stdout...

> csso in.css --output out.css

> echo '.test { color: #ff0000; }' | csso
.test{color:red}

> cat source1.css source2.css | csso | gzip -9 -c > production.css.gz

Source maps

Source map doesn't generate by default. To generate map use --map CLI option, that can be:

  • none (default) – don't generate source map
  • inline – add source map into result CSS (via /*# sourceMappingURL=application/json;base64,... */)
  • file – write source map into file with same name as output file, but with .map extension (in this case --output option is required)
  • any other values treat as filename for generated source map

Examples:

> csso my.css --map inline
> csso my.css --output my.min.css --map file
> csso my.css --output my.min.css --map maps/my.min.map

Use --input-source-map option to specify input source map if needed. Possible values for option:

  • auto (default) - attempt to fetch input source map by follow steps:
    • try to fetch inline map from input
    • try to fetch source map filename from input and read its content
    • (when --input is specified) check file with same name as input file but with .map extension exists and read its content
  • none - don't use input source map; actually it's using to disable auto-fetching
  • any other values treat as filename for input source map

Generally you shouldn't care about the input source map since defaults behaviour (auto) covers most use cases.

NOTE: Input source map is using only if output source map is generating.

Usage data

CSSO can use data about how CSS is using for better compression. File with this data (JSON format) can be set using --usage option. Read more about Usage data in CSSO repository.

Debugging

All debug information outputs to stderr.

To get brief info about compression use --stat option.

> echo '.test { color: #ff0000 }' | csso --stat >/dev/null
File:       <stdin>
Original:   25 bytes
Compressed: 16 bytes (64.00%)
Saving:     9 bytes (36.00%)
Time:       12 ms
Memory:     0.346 MB

To get details about compression steps use --debug option.

> echo '.test { color: green; color: #ff0000 } .foo { color: red }' | csso --debug
## parsing done in 10 ms

Compress block #1
(0.002ms) convertToInternal
(0.000ms) clean
(0.001ms) compress
(0.002ms) prepare
(0.000ms) initialRejoinRuleset
(0.000ms) rejoinAtrule
(0.000ms) disjoin
(0.000ms) buildMaps
(0.000ms) markShorthands
(0.000ms) processShorthand
(0.001ms) restructBlock
(0.000ms) rejoinRuleset
(0.000ms) restructRuleset
## compressing done in 9 ms

.foo,.test{color:red}

More details are providing when --debug option has a number greater than 1:

> echo '.test { color: green; color: #ff0000 } .foo { color: red }' | csso --debug 2
## parsing done in 8 ms

Compress block #1
(0.000ms) clean
  .test{color:green;color:#ff0000}.foo{color:red}

(0.001ms) compress
  .test{color:green;color:red}.foo{color:red}

...

(0.002ms) restructBlock
  .test{color:red}.foo{color:red}

(0.001ms) rejoinRuleset
  .foo,.test{color:red}

## compressing done in 13 ms

.foo,.test{color:red}

Using --debug option adds stack trace to CSS parse error output. That can help to find out problem in parser.

> echo '.a { color }' | csso --debug

Parse error <stdin>: Colon is expected
    1 |.a { color }
------------------^
    2 |

/usr/local/lib/node_modules/csso/lib/cli.js:243
                throw e;
                ^

Error: Colon is expected
    at parseError (/usr/local/lib/node_modules/csso/lib/parser/index.js:54:17)
    at eat (/usr/local/lib/node_modules/csso/lib/parser/index.js:88:5)
    at getDeclaration (/usr/local/lib/node_modules/csso/lib/parser/index.js:394:5)
    at getBlock (/usr/local/lib/node_modules/csso/lib/parser/index.js:380:27)
    ...

Related projects

License

MIT