Miss any of our Open RFC calls?Watch the recordings here! »

ho

1.2.0 • Public • Published

Ho ho ho

The jolly css/less system

Getting started

npm i ho

You can install as a global if you like, either way you’ll end up with the ho executable which can be used to perform various stylesheet related festive (or not) shenanigans.

Compiling

Just want to compile your less, no problem, just give it entry and output paths

ho compile -e src/main.less -o dist/styles.css

Ho will output a few bits and bobs to the console while it’s working so no streaming just yet (it’s getting there).

Ho has a load of built-in help for more options—for compiles just specify parameters for less to use

ho compile -h

Watching

Watching is pretty handy, it’d be useful if there was a shorthand for it, oh wait a sec...

ho watch -w 'src/**/*.less' -e src/main.less -o dist/styles.css

Watch will fire a compile on file change event so it accepts the same parameters as compile plus the glob to watch for. If your shell auto-expands globs (which is likely) then pass it through as a string, ho will expand it.

Help

Ho tries to be self documenting, but if you’re really stuck then open an issue

ho <command> --help

Transforms and configuration

Specify a custom set of transforms and their configuration using an external file and the -c flag

ho <command> -c .horc

You can specify a custom file if you like but using the package.json will work just as well, just add a ho key for your configuration

ho <command> -c package.json
...,
"ho"{
  "autoprefixer-transform": {
    "browsers": [
      "last 2 versions"
    ]
  }
},
...

The configuration block should specify a list of modules as keys to include in the transform pipeline, each module will be instantiated using the values in the config as their constructor params. So, the previous example will work out something like this in code:

let Transform = require( 'autoprefixer-transform' )
let transform = new Transform({
  browsers: [
    'last 2 versions'
  ]
})

This transform will then get appended to the transform pipeline and will end up outputted to a write stream pointed wherever you specified with -o.

Custom transforms

There are a few caveats to creating custom transforms

  • They should extend Stream.Transform or a comparable stream abstraction
  • Use the module name as the key in the configuration
  • The module declaration should specify a constructor function which will be invoked with the options set out in the configuration file

Thats about it, eventually we’ll let Ho output to a stdout which would make this sort of thing more robust but for now if you want something else just wrap it in a transform stream and you’re good to go (example)

Install

npm i ho

DownloadsWeekly Downloads

1

Version

1.2.0

License

ISC

Last publish

Collaborators

  • avatar