brygga v0.3.2

Brygga is a set of opinionated Gulp tasks for building web sites and applications. Brygga aims to support future standards and syntaxes in todays browsers.

Using

In your project install Brygga and Gulp:

npm install --save-dev gulp brygga

In your gulpfile.js use require to expose the Gulp tasks that Brygga define:

var brygga = require('brygga');

Running gulp without any tasks will output all of the available tasks. The most used tasks are dev and build that start a development server and build all of the assets.

Default structure

build/ - where all of the built assets end up
src/ - the source files
  css/ - CSS files
    main.css - the default CSS file
  data/ - data made available to HTML templates
    site.json - shared data available under data object key site

A lot of things in Brygga can be configured via the brygga object. You can change the build folder and source folder using these config properties:

brygga.config.shared.dest = 'build';
brygga.config.shared.src = 'src';

Browser support

Every project should set which browsers it targets as this is used in several tasks. Brygga uses browserslist for this. The default value is set to last 2 versions.

brygga.config.shared.browsers = [ 'last 2 versions' ];

CSS

Brygga uses PostCSS with plugins for inlining imports, nesting and future CSS syntax.

Task: css Config:

// CSS is stored in a subfolder for both source and destination
brygga.config.css.root = 'css';
 // Set one or more source files to use
brygga.config.css.src = [ 'main.css' ];

JavaScript

JavaScript is supported via JSPM and can be activated via brygga-jspm.

HTML

HTML support can be activated via brygga-nunjucks.

Data

Brygga will load JSON files in the data folder and make it available to plugins. The name of the JSON file is mapped on the data object, so a file named site.json will have its data available as site.

Config:

// Use data as root folder
brygga.config.data.root = 'data';
// Use all JSON files found
brygga.config.data.src = [ '**/*.json' ];