# buildkit

> A Front End Build Kit

Latest version **0.0.1** (published 2016-04-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install buildkit
pnpm add buildkit
yarn add buildkit
bun add buildkit
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2016-04-07 |
| First published | 2016-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | zhihuahuang |
| Keywords | frontend, fe, build, kit, buildkit, html, css, js |

## Links

- npm: https://www.npmjs.com/package/buildkit
- npm.io page: https://npm.io/package/buildkit

## Dependencies (6)

- [async](https://npm.io/package/async.md) ^2.0.0-rc.2
- [uncss](https://npm.io/package/uncss.md) ^0.13.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [clean-css](https://npm.io/package/clean-css.md) ^3.4.11
- [uglify-js](https://npm.io/package/uglify-js.md) ^2.6.2
- [html-minifier](https://npm.io/package/html-minifier.md) ^1.4.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.0.1 (latest) — 2016-04-07

## README

# buildkit
[![Build Status](https://travis-ci.org/zhihuahuang/buildkit.svg)](https://travis-ci.org/zhihuahuang/buildkit)

A front-end build kit.

## API
It's easy to use.

### HTML
#### minifyHTMLFile(src, dest, [options], [callback])

**src**

> Type: string

The source file or directory.

**dest**

> Type: string

The destination file or directory.

**options**

> Type: object

See [html-minifier](https://github.com/kangax/html-minifier#options-quick-reference) options.

**callback**

>  Type: function

```javascript
/*! Example */
// Minify File
minifyHTMLFile('index.html', 'index.min.html')
// Minify Directory
minifyHTMLFile('src/', 'build/');
```

### CSS

#### minifyCSSFile(src, dest, [options], [callback])

src**

> Type: string

The source file or directory.

**dest**

> Type: string

The destination file or directory.

**options**

> Type: object

See [clean-css](https://github.com/jakubpawlowicz/clean-css#how-to-use-clean-css-api) options.

**callback**

> Type: function

```javascript
/*! Example */
// Minify file
minifyCSSFile('style.js', 'style.min.js')
// Merge and minify multi files
minifyCSSFile('css/', 'style.min.js')
// Minify directory
minifyCSSFile('src/css/', 'build/css/');
```

### JS

#### minifyJSFile(src, dest, [options], [callback])

src**

> Type: string

The source file or directory.

**dest**

> Type: string

The destination file or directory.

**options**

> Type: object

See [UglifyJS2](https://github.com/mishoo/UglifyJS2#compressor-options) options.

**callback**

> Type: function

```javascript
/*! Example */
// Minify file
minifyJSFile('script.js', 'script.min.js')
// Merge and minify multi files
minifyJSFile('scr/js/', 'script.min.js')
// Minify directory
minifyJSFile('src/js/', 'build/js/')
```

---
_Source: https://npm.io/package/buildkit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._