@blueprintui/cli

0.7.1 • Public • Published

BlueprintUI CLI

npm version

Opinionated CLI for creating Web Component Libraries

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.

Documentation

Build

Command Description
build Build library for production
Options Description
--config Path for blueprint.config.js file
--watch Runs build in watch mode for development

Generate

Command Description
generate Generate Library Project

API

Command Description
api API lockfile management
Options Description
--test Compare custom-elements.json in build output to custom-elements.lock.json in source control
--update Update custom-elements.lock.json to latest build output of custom-elements.json

Configuration

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

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,
  }
}

Readme

Keywords

none

Package Sidebar

Install

npm i @blueprintui/cli

Weekly Downloads

2

Version

0.7.1

License

MIT

Unpacked Size

28.1 kB

Total Files

25

Last publish

Collaborators

  • coryrylan