https://github.com/blueprintui/cli
Opinionated CLI for building reusable Web Components
https://github.com/blueprintui/cli
ui ui-components web-components
Last synced: 12 months ago
JSON representation
Opinionated CLI for building reusable Web Components
- Host: GitHub
- URL: https://github.com/blueprintui/cli
- Owner: blueprintui
- License: mit
- Created: 2022-05-28T15:21:44.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-31T05:53:10.000Z (about 1 year ago)
- Last Synced: 2025-06-05T23:44:25.341Z (about 1 year ago)
- Topics: ui, ui-components, web-components
- Language: JavaScript
- Homepage: https://cli.blueprintui.dev
- Size: 790 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# BlueprintUI CLI
[](https://badge.fury.io/js/@blueprintui%2Fcli)
## Opinionated Minimal 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](https://cli.blueprintui.dev/)
## 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.
```javascript
export default {
library: {
externals: [],
assets: ['./README.md', './LICENSE.md'],
customElementsManifestLockFile: './custom-elements.lock.json',
baseDir: './src',
outDir: './dist',
entryPoints: ['./src/**/index.ts'],
tsconfig: './tsconfig.lib.json',
sourcemap: false,
}
}
```