Catalyst Elements' Build Process

The build process for catalyst elements and other such components.

Installation

Install with npm:

npm install --save-dev @catalyst-elements/build-process

Install with yarn:

yarn add --dev @catalyst-elements/build-process

Usage

Step 1. Configure your gulpfile.js

Example gulpfile.js file:

const gulp = require('gulp');
const buildProcess = require('@catalyst-elements/build-process');

// Set the config for my componenet.
buildProcess.setConfig('./package.json', {
  componenet: {
    // The name of the component
    name: 'catalyst-componenet'
  },

  src: {
    // Paths are relative to src.path
    entrypoint: 'componenet.js',
    template: {
      html: 'template.html',
      css: 'style.css'
    }
  }
});

// Register all the exported tasks.
for (const [name, func] of Object.entries(buildProcess.tasks)) {
  gulp.task(name, func(gulp));
}

Step 2. Set up your package.json

Example package.json file:

{
  "name": "my-element",
  "scripts": {
    "analyze": "./node_modules/.bin/gulp analyze",
    "build": "./node_modules/.bin/gulp build",
    "build-docs": "./node_modules/.bin/gulp build-docs",
    "clean": "./node_modules/.bin/gulp clean",
    "lint": "./node_modules/.bin/gulp lint",
    "test": "./node_modules/.bin/gulp test",
    "do-publish": "./node_modules/.bin/gulp lint && ./node_modules/.bin/gulp build && ./node_modules/.bin/gulp test && ./node_modules/.bin/gulp publish",
    "postinstall": "./node_modules/.bin/gulp fix-dependencies",
    "prepublishOnly": "echo \"Error: use the 'do-publish' script to publish.\" && exit 1"
  },
  "devDependencies": {
    "@catalyst-elements/build-process": "*",
    "@polymer/iron-component-page": "^3.0.0-pre.1",
    "@polymer/iron-demo-helpers": "^3.0.0-pre.1",
    "@polymer/test-fixture": "^3.0.0-pre.1",
    "@webcomponents/shadycss": "^1.1.1",
    "@webcomponents/webcomponentsjs": "^1.1.0",
    "web-component-tester": "^6.5.0"
  }
}

Contributions

Contributions are most welcome.

Please read our contribution guidelines.