minimalist-notation/cli/README.md

Minimalist Notation

# Minimalist Notation CLI


## Install
```sh
npm install -g minimalist-notation
```

## Usage


#### For directory
```sh
mn --compile ./src --output ./dist/styles.css --watch
```


#### For one file
```sh
mn --compile ./index.html --output ./dist/styles.css --watch
```


### Run with configuration
```sh
mn --config ./mn-config.js --watch
```

#### Configuration example

```js
// mn-config.js
module.exports = {
  entry: {
    styles: { // for output file: styles.css
      path: './',
      attrs: [
        'class'
      ],
      include: [
        /^.*\.(php|html?|(js|ts)x?|vue)$/
      ],
      exclude: [
        /\/node_modules\/|(.*\.tmp)/
      ],
      metrics: './mn-metrics.json'
    }
    // other...
  },
  // global options:
  /*
  path: './'
  output: './styles.css',
  */
  // altColor: 'off' // disable alternate color generation
  attrs: [ 'class' ],
  include: [
    /^.*\.(php|html?|(js|ts)x?|vue)$/
  ],
  exclude: [
    /\/node_modules\/|(.*\.tmp)/
  ],
  presets: [
    require('minimalist-notation/presets/medias'),
    require('minimalist-notation/presets/prefixes'),
    require('minimalist-notation/presets/styles'),
    require('minimalist-notation/presets/synonyms'),
    // require('minimalist-notation/presets/main'),
    // require('minimalist-notation/presets/normalize'), // normalize.css v8.0.1
    // require('./mn-my-preset'), // custom handlers
  ]
};

```

## Interface
```ts
interface compileSourceOptions {
  path: string,
  altColor?: string | null,
  selectorPrefix?: string,
  entry?: string | {
    [outputName: string]: string | compileSourceOptions
  },
  output?: string | null,
  include?: RegExp | RegExp[],
  exclude?: RegExp | RegExp[],
  attrs?: string | string[] | {[fromName:string]: string},
  presets?: MnPreset[]
}
```


## Default options

| option   | value                             |
| -------- | --------------------------------- |
| config   | './mn-config.js'                  |
| prefix   | ''                                |
| altColor | 'on'                              |
| path     | './'                              |
| entry    | './'                              |
| output   | './mn.styles.css'                 |
| metrics  | './mn-metrics.json' if true       |
| attrs    | [ 'm' ]                           |
| presets  | [ require('minimalist-notation/presets/medias'), require('minimalist-notation/presets/prefixes'), require('minimalist-notation/presets/styles'), require('minimalist-notation/presets/states'), require('minimalist-notation/presets/main') ] |

* include: ``` /^.*\.(php|html?|(js|ts)x?|vue)$/ ```
* exclude: ``` /\/node_modules\/|(\.tmp\.)/  ```