Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 3.84 KB

README.md

File metadata and controls

122 lines (87 loc) · 3.84 KB
Raw

ecstacy

NPM version Build status Test coverage Dependency Status License Downloads Gittip

The perfect middleware between your static file server and the browser. Minifies, compresses, and caches files served to the client. If it's JS or CSS, it also transpiles unsupported features of the target browser. You may also use this in your build process to create browser-specific builds. It's traceur and myth on steroids.

The goal of this project is to create a frontend flow where:

  • JS, CSS, and HTML are written using the latest specifications (ES6, HTML imports, etc.)
  • The server resolves the dependencies tree
  • The server uses Ecstacy to transpile each file according to the target client and caches
  • The server HTTP2 pushes the files to the client

Combined with polyfills, you can use most of the latest features of browsers with relative ease.

There's no:

  • Build step to transpile your JS/CSS
  • Build step to concatenate your assets
  • Deploy step to create builds for every supported platform
  • Very little difference between the development and production environments

Features:

  • Supports CSS and JS
  • Supports source maps, even inlined ones
  • Caching

API

var Ecstacy = require('ecstacy')

Builders

There are two builders.

  • Ecstacy.js
  • Ecstacy.css

Both inherit from Ecstacy, defined below.

Ecstacy.clean()

Delete the entire cache folder.

Ecstacy

All Ecstacy constructors have the following API:

var ecstacy = new Ecstacy(options)

Create a new instance. Some options are:

  • name - the name of the file, specifically for source maps
  • code - source code
  • map - the source map, if any

ecstacy.build(agents).then( data => )

"Builds" a version of the file according to agents. agents is simply passed tp polyfills-db. data is an object with the following properties:

  • hash - the build hash
  • code - the filename for the code
  • map - the filename for the map

var filename = ecstacy.filename(name)

Get the absolute filename of a file.

ecstacy.read(name, encoding).then( buf => )

Read a file by its name. Returns a Buffer, so you need to .toString() it yourself.

var ecstacy = Ecstacy.js({
  code: 'var a = b;'
})
ecstacy.build(useragent).then(function (data) {
  return ecstacy.read(data.code, 'utf8')
}).then(function (js) {

})

ecstacy.stream(name)

Create a read stream for a file and extension instead of buffering it. Useful when serving files to the client.