Skip to content

pangolinjs/core

Repository files navigation

Front End Styleguide

JavaScript Style Guide

NPM version Dependencies

Installation

For global CLI access run npm install -g front-end-styleguide-cli.
For local installation run npm install front-end-styleguide --save-dev.

Project Creation

Create a new project with front-end-styleguide init.

If you didn't install the CLI package you have to run ./node_modules/.bin/front-end-styleguide init.

Usage

The following tasks are available:

  • front-end-styleguide to start the default task.
    • Watches for file changes.
    • Starts Browsersync.
  • front-end-styleguide development to start the default task
    • No file watching / Browsersync.
  • front-end-styleguide preview to create a prototype preview.
    • Minifies CSS, JavaScript and images.
    • Doesn't generate component HTML.
    • Errors break pipe.
  • front-end-styleguide production to create production ready files.
    • Minifies CSS, JavaScript and images.
    • Doesn't generate any HTML.
    • Errors break pipe.

Custom configuration files can be specified:

  • front-end-styleguide [task] --config=path/to/config.json --paths=path/to/paths.json

For more information take a look at the readme of the init package.

If you didn't install the CLI package you have to run ./node_modules/.bin/front-end-styleguide [task] [options].