https://github.com/busterc/distiller
:droplet: Extracts only the dist resources from various packages
https://github.com/busterc/distiller
deps dist distribution libs modules
Last synced: about 1 year ago
JSON representation
:droplet: Extracts only the dist resources from various packages
- Host: GitHub
- URL: https://github.com/busterc/distiller
- Owner: busterc
- License: isc
- Created: 2016-10-25T19:27:28.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-08-25T21:49:21.000Z (over 7 years ago)
- Last Synced: 2025-04-10T03:39:45.995Z (about 1 year ago)
- Topics: deps, dist, distribution, libs, modules
- Language: JavaScript
- Size: 34.2 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# distiller [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> Extracts only the dist files from packages
## Installation
```sh
$ npm install distiller --global
```
## CLI Usage
```sh
$ distiller -h
Usage
$ distiller [options]
Options
-l, --list lists locally defined custom packages
-o, --output-dir destination for output
-t, --temp-dir destination for temporary build files
-k, --keep-temp do not remove the temporary directory
-h, --help shows usage help
```
## CLI Environment Variables
- Use `DISTILLER_DIST` to override the default output location `$HOME/.distiller/dist`
- Use `DISTILLER_TEMP` to override the default temporary build location `$HOME/.distiller/temp`
- the temp directory is removed after every execution
## CLI Example
```sh
$ distiller react
Distilled into: ~/.distiller/dist/react
$ tree ~/.distiller/dist/react
~/.distiller/dist/react/
├── react.js
├── react-with-addons.js
├── react-with-addons.min.js
└── react.min.js
```
## Module Usage
```js
var distill = require('distiller').distill;
distill({
package: 'react', // can be any NPM discoverable package
outputDir: '/Users/hotdog/Desktop/react-dist/', // defaults to $HOME/.distiller/dist/${package}
tempDir: '/Users/hotdog/.temp-folder-for-distiller' // defaults to $HOME/.distiller/temp
}, error => {
if (error) {
return console.log('error', error);
}
console.log('carry on');
});
```
## API
### distiller.distill(options, callback)
- #### options
*Required*
Type `object`
- #### package
*Required*
Type `string`
The official NPM package name.
- #### outputDir
Type: `string`
Default: `$HOME/.distiller/dist/${package}`
The absolute path to place output files.
- #### tempDir
Type: `string`
Default: `$HOME/.distiller/temp/distilled-${package}`
The absolute path to use for building the package.
- #### keepTemp
Type: `boolean`
Default: `false`
Can prevent the `tempDir` from being removed after execution.
## TODO
- [x] Document API
- [ ] Document custom package creation
- [ ] More test coverage
- [ ] Allow multiple packages on CLI
- [ ] Consider other sources, e.g. bower
## License
ISC © [Buster Collings](https://about.me/buster)
[npm-image]: https://badge.fury.io/js/distiller.svg
[npm-url]: https://npmjs.org/package/distiller
[travis-image]: https://travis-ci.org/busterc/distiller.svg?branch=master
[travis-url]: https://travis-ci.org/busterc/distiller
[daviddm-image]: https://david-dm.org/busterc/distiller.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/busterc/distiller