Warning, in alpha. Subject to change at any time.

Blueprint CLI

Opinionated CLI for building reusable Web Components

API Docs Github

Getting Started

npm package version

Blueprint CLI provides an out-of-the-box tool kit for compiling and creating Web Component libraries. This project is still an experimental work in progress.

  • Development and Production Builds
  • Watch Mode
  • TypeScript
  • Lit element optimizations
  • Custom Elements Manifest generation
$ npm install -g @blueprintui/cli
$ bp new my-component
$ bp build
$ bp build --watch
$ bp build --config blueprint.config.js

Configuration

The blueprint.config.js can be used to customize certain aspects of the build. Below are the default values unless otherwise specified. 

// blueprint.config.js (defaults)
export default {
  library: {
    externals: [],
    assets: ['./README.md', './LICENSE.md', './package.json'],
    customElementsManifestLockFile: './custom-elements.lock.json',
    baseDir: './src',
    outDir: './dist/lib',
    entryPoints: ['./src/**/index.ts'],
    tsconfig: './tsconfig.lib.json',
    sourcemap: false,
  }
}