Compile, Minify, Lint

multic attempts to fix the compilation, minification, linting inconsistancies by providing:

• simple, consistent API
• consistent error and warning level objects
• sane defaults for errors and warnings
• converged lint rules

Supported sources

• Jade
• HTML
• SASS via libsass / node-sass
• CSS
• Coffee script
• ECMAScript6 via Babel (ex: 6to5)
• JavaScript
• Angular module scripts from HTML/JADE templates via ng-html2js

Install for your app

cd /path/to/your/app
npm install multic --save

Usage

Pattern

var multic = require('multic');

multic(source|path[, options])[.file].coffee|css|es6|html|jade|sass[.css|html|js][.min](callback);

Examples

JavaScript string minification

multic(script, {file: 'my/file/name.js'}).js.min( function (err, res) {}) ;

Jade file->HTML compilation

multic('my/jade/file.jade').file.jade.html( function (err, res) {} );

Compile SASS file to CSS + minify

multic('my/sass/file.scss').file.sass.css.min( function (err, res) {} );

Jade to Angular module JavaScript

multic('my/sass/file.scss').file.sass.css.min( function (err, res) {
  if (err) {
    console.error(err);
  } else {
    console.log('source:', res.source);
    console.log('compiled:', res.compiled);
    console.log('minified:', res.minified);
  }
} );

Lint only (syntax errors and warnings, no processing)

multic('my/js/file.js').file.js( function (err, res) { }

Callback signiture

• err: null or Error instance (same as the first item in res.errors)
• res: response object

Response object properties

{
  source:   '#id1.class1\n  h1 Hello\n  include templates/_hi\n',
  compiled: '<div id='id1' class='class1'>\n  <h1>Hello</h1>\n  <h2>Hi</h2>\n</div>\n',
  minified: '<div id='id1' class='class1'> <h1>Hello</h1> <h2>Hi</h2></div>',
  includes: ['/home/johndoe/Projects/testapp/markup/templates/_hi.jade'],
  errors:   [],
  warnings: []
}

• source: (string) only exists if file is read
• compiled:
  • content: compiled, unminified code
  • type: string
  • optional: only exists if compilation was requested
• minified:
  • content: minified code
  • type: string
  • optional: only exists if minification was requested
• includes
  • content: included files for jade and sass files with includes/import
  • type: Array object
  • default value: empty Array
  • always created
• errors: Array of errors (always exists)
  • content: errors in consistent Error objects (see below)
  • type: Array object
  • default value: empty Array
  • always created
• warnings:
  • content: warnings in consistent Error objects (see below)
  • type: Array object
  • default value: empty Array
  • always created

Consequent Errors and Warnings

{
  title:   'Syntax Error',
  message: 'Unexpected <',
  file:    'src/test.coffee',
  line:    2,
  column:  6,
  sourceLines: {
    0: 'x = (a) ->',
    1: '  a + 1',
    2: '  x = <-',
    3: ''
  }
}

multic attempts to provide a unified interface for all errors and warnings. You get these properties on the errors/warnings:

• message: (string) literal description of the error/warning
• title: (string) short description of the error/warning
• file: (string) file path of error
• line: (number) indication of error/warning line (0-based index, i.e. first line is line 0)
• column: (number) indication of error/warning column in line (0-based index, i.e. first column is column 0)
• sourceLines: (number) a snippet of the source code around the error/warning. Keys are 0-based line numbers, values are the lines (without the \n character at the end). 11 lines (error/warning line + 5 previous + 5 following lines) or less (when the line is near the start or end of file).

WARNING! Although these properties are available most of the time, keep in mind that:

• jade related errors and warnings usually will not have column property
• file property is only added if
  • source is loaded from file, or
  • you have specified {file: '/my/file/name.ext'} as option with your source string (see below)
• some exotic errors may not have anything but message (and file if source is loaded from file or you sp)

Options

• file - file path for source string // This is useful for error messages and to // define include path start point for jade and sass includes/imports multic(source_string, {file: 'path/to/my/source/file.ext'}).min(callback);
• Configurable lint rules (comprehensive list of rules) multic(source_file_path, { max_line_length: 80, file_end_newline: false // ... }).file.min(callback);

Utilized minifiers

• html: html-minifier
• javascript: uglify-js
• css: clean-css

Utilized external linters

• coffee: coffee-lint
• css: csslint
• html: htmllint
• js & es6: jshint

Coming soon (TODO)

• Output to file
• Missing lint rule implementations, added descriptions and links for rules