Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cognitom/felt
On-demand bundler for ES6 / CSS Next
https://github.com/cognitom/felt
Last synced: about 1 month ago
JSON representation
On-demand bundler for ES6 / CSS Next
- Host: GitHub
- URL: https://github.com/cognitom/felt
- Owner: cognitom
- License: mit
- Created: 2016-07-09T17:09:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-27T07:13:16.000Z (over 7 years ago)
- Last Synced: 2024-04-25T03:43:15.523Z (7 months ago)
- Language: JavaScript
- Homepage: https://cognitom.github.io/felt/
- Size: 195 KB
- Stars: 118
- Watchers: 10
- Forks: 8
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Build Status][travis-image]][travis-url]
On-demand bundler for ES6 / CSS Next.
- [Use Felt as a webserver via CLI](#cli-usages)
- [Use Felt as a middleware of Express](#with-express)
See also its [options](#options), [plugins](#plugins) and [recipes](#recipes).
*Note: Felt runs on Node 6.x or above.*
## CLI usages
In short, install Felt globally:
```bash
$ npm install -g felt felt-recipe-minimal
```
*Note: `felt-recipe-minimal` is a recipe for Felt. You may install other recipes, too.*
And run Felt:
```bash
$ cd path/to/project/
$ felt
```
Then, open your site in browser: `http://localhost:3000`.
*Note: type `Ctrl + C` to stop the server*
### Run Felt
Assume that you have a project like this:
- project/
- public/
- index.html
- main.js
- style.css
- cache/
- package.json
Then run Felt:
```bash
$ cd path/to/project/
$ felt --recipe minimal --src public
```
There're some [official recipes](#recipes). Check them, too.
### Use config files
Assume that you have a project like this:
- project/
- public/
- index.html
- main.js
- style.css
- cache/
- package.json
- felt.config.js
Or choose your own config file:
```bash
$ felt --config felt.config.js
```
The default name of `config` is `felt.config.js`, so it's also fine:
```bash
$ felt --config
```
The config file could be like this:
```javascript
'use strict'
const
rollup = require('felt-rollup'),
buble = require('rollup-plugin-buble'),
resolve = require('rollup-plugin-node-resolve'),
commonjs = require('rollup-plugin-commonjs')
module.exports = {
src: 'public',
handlers: {
'.js': rollup({
plugins: [
resolve({ jsnext: true, main: true, browser: true }),
commonjs(),
buble()
],
sourceMap: true
})
}
}
```
See more detail about [options](#options)
### Change port
The default port is `3000`. If you want to change it, use `--port` option:
```bash
$ felt --port 3333
```
*Note: you can set the port option in your config file, too.*
### Watch changes
```bash
$ felt --src public --watch
```
### Export static files
This is handy to upload the contents to amazon S3 or GitHub Pages. Felt exports not only compiled files but also other assets like HTML, PNG, ...etc, too.
```bash
$ felt --src public --export dist
```
*Note: with export option, Felt is not run as a server. It works as just a bundler.*
## With Express
Install Felt and use it as an `express` middleware.
```bash
$ npm install --save felt
```
Add `server.js` to the project:
```javascript
const
express = require('express'),
felt = require('felt'),
recipe = require('felt-recipe-minimal')
const app = express()
app.use(felt(recipe, { src: 'public' }))
app.use(express.static('public'))
app.listen(3000)
```
### Separated config files
It's a good idea to separate the config from `server.js`:
```javascript
const
express = require('express'),
felt = require('felt')
config = require('./felt.config.js')
app.use(felt(config))
app.use(express.static('public'))
app.listen(3000)
```
`felt.config.js` could be like this:
```javascript
const
rollup = require('felt-rollup'),
buble = require('rollup-plugin-buble'),
resolve = require('rollup-plugin-node-resolve'),
commonjs = require('rollup-plugin-commonjs')
module.exports = {/* options */}
```
## Options
property | default | descriptions
:-- | :-- | :--
**opts.src** | `.` | the document directory to serve
**opts.cache** | `'cache'` | if it's located inside `src`, ignored on requests
**opts.root** | `process.cwd()` | usually no need to set it
**opts.handlers** | `{}` | see the section below
**opts.patterns** | `[]` | see the section below
**opts.excludes** | `[]` | see the section below
**opts.external** | `{}` | see the section below
**opts.update** | `'once'` | `'never'` or `'always'`
**opts.refresh** | `true` | set `false` to skip refreshing on starting
**opts.watch** | `false` | set `true` to detect changes
**opts.debug** | `false` | set `true` to show debug comments on the terminal
### opts.handlers
Default handlers for each extension.
```javascript
{
handlers: {
'*.js': rollup({
plugins: [
resolve({ jsnext: true }),
commonjs(),
buble()
],
sourceMap: true
})
}
}
```
### opts.patterns
This option limits the target which Felt works with. This is handy when you want to use Felt for only a few files like this:
```javascript
{
patterns: ['index.js', 'components/*.js']
}
```
Which handler will be used is depends on the extension. If no handler for the extension, Felt will throw exceptions.
You can also specify the custom handler for the pattern:
```javascript
{
patterns: [
'index.js',
{
pattern: 'components/*.js',
handler: rollup({
plugins: [babel()],
sourceMap: true
})
}
]
}
```
### opts.excludes
This option excludes the files from compiling and copying (when exporting). Cache directory and `'node_modules/**'` are always excluded. For example:
```javascript
{
excludes: ['no-compile/**']
}
```
### opts.external
This option makes copies from deeper files typically in `node_modules`. For example, if you need to access `node_modules/pouchdb/dist/pouchdb.min.js`, you may write like this:
```javascript
{
external: {
'pouchdb.js': 'node_modules/pouchdb/dist/pouchdb.min.js'
// 'where/to/expose': 'path/from/opts.root'
}
}
```
Then you can access it by `http://localhost:3000/pouchdb.js`. This option is convenient to directly expose a JavaScript or CSS file which comes from `npm` or `bower`.
**Note**: The files will not be processed by `opts.handlers`. This means that the file will skip compiling by `rollup` and so on.
## Plugins
Plugins are the interface to compilers like Rollup or PostCSS. Actually, these are the thin wrapper of these libraries:
- [felt-rollup](https://github.com/cognitom/felt-rollup): JavaScript bundler
- [felt-postcss](https://github.com/cognitom/felt-postcss): CSS bundler
## Recipes
Recipes are pre-made configurations. You can use these recipes with some overwrite with ease.
- [felt-recipe-minimal](https://github.com/cognitom/felt-recipe-minimal): PostCSS and Rollup with Bublé
- [felt-recipe-standard](https://github.com/cognitom/felt-recipe-standard): PostCSS and Rollup with Babel
- [felt-recipe-riot](https://github.com/cognitom/felt-recipe-riot): PostCSS and Rollup with Bublé + Riot
- [felt-recipe-react](https://github.com/cognitom/felt-recipe-react): PostCSS and Rollup with Bublé + JSX
- [felt-recipe-preact](https://github.com/ezekielchentnik/felt-recipe-preact): PostCSS and Rollup with Bublé + Preact *by [@ezekielchentnik](https://github.com/ezekielchentnik)*
*Note: the repository name of the recipe supposed to have prefix `felt-recipe-`.*
## License
MIT © Tsutomu Kawamura
[travis-image]:https://img.shields.io/travis/cognitom/felt.svg?style=flat-square
[travis-url]:https://travis-ci.org/cognitom/felt