# compilers

> Universal preprocessor loader for templating and transpiling

Latest version **2.0.0** (published 2021-09-23) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-09-23 |
| First published | 2016-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 22.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Brandon Carl |
| Maintainers | brandoncarl |

## Links

- npm: https://www.npmjs.com/package/compilers
- Repository: https://github.com/brandoncarl/compilers
- Homepage: https://github.com/brandoncarl/compilers#readme
- Issues: https://github.com/brandoncarl/compilers/issues
- npm.io page: https://npm.io/package/compilers

## Dependencies (1)

- [desires](https://npm.io/package/desires.md) ^0.4.0

## Recent versions

- 2.0.0 (latest) — 2021-09-23
- 1.2.0 — 2016-11-28
- 1.1.1 — 2016-03-19
- 1.1.0 — 2016-03-17
- 1.0.2 — 2016-03-01
- 1.0.0 — 2016-02-29
- 0.3.4 — 2016-02-28
- 0.3.3 — 2016-02-27
- 0.3.2 — 2016-02-27
- 0.3.1 — 2016-02-27
- 0.3.0 — 2016-02-26

## README

# compilers

<a href="https://circleci.com/gh/brandoncarl/compilers/tree/master"><img src="https://img.shields.io/circleci/project/brandoncarl/compilers/master.svg" alt="Build Status"></a>
[![codecov.io](https://codecov.io/github/brandoncarl/compilers/coverage.svg?branch=master)](https://codecov.io/github/brandoncarl/compilers?branch=master)

Given a request for a preprocessor/transpiler/templating engine/postprocessor,
spits back a function of the form `function(err, compiled)`.

The [specifications](#specifications) are highly extensible. Initial specs
support wide range of functions (from Typescript to ES2015 to minification
and cleaning). Pull requests and tests welcome! See instructions on writing
a specification below.

## Installation

```
$ npm install compilers
```

## Examples

```js
var compileHandlebars = compilers("handlebars");

compileHandlebars("<div>Hello, {{ name }}!</div>", { name : "Mickey" }, function(err, compiled) {
  console.log(compiled);
  // <div>Hello, Mickey!</div>
});

// Don't "npm install" missing modules (defaults to installing)
var compileHandlebars = compilers("handlebars", { fetch : false });
// => Throws error if handlebars is missing

// "npm install" to different directory
var compileHandlebars = compilers("handlebars", { dir : process.cwd() });
```


## API

[compilers](#compilers) ⇒ <code>function</code>  
[.defaultCompilerForExtension(ext)](#compilers.defaultCompilerForExtension) ⇒ <code>String</code>  

<a name="compilers"></a>
### compilers ⇒ <code>function</code>
Loads a processor (templating, transpiler, minification), and standardizes
callback to be fn(err, compiled). Defaults to `npm install` packages if they
are missing. To disable, set `context.fetch` to `false`;

Most packages are referenced by their npm name, common exceptions include:
javascript, html, css, es2015, and react.

Note that the callback is node style (err, compiled).

**Returns**: <code>function</code> - Processor of format `fn(str, context, next)`  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | Name of module (npm install name). |
| context | <code>Object</code> | Options include {fetch} and {dir} (install directory). |

**Example**  
```js
compilers("typescript")
  // => fn(str, context, next) for typescript
```

<a name="compilers.defaultCompilerForExtension"></a>
### compilers.defaultCompilerForExtension(ext) ⇒ <code>String</code>
Returns the default compiler for an extension. Leading "." is removed.

**Returns**: <code>String</code> - Name of the default compiler.  

| Param | Type | Description |
| --- | --- | --- |
| ext | <code>String</code> | The file extension. |

**Example**  
```js
compilers.defaultCompilerForExtension("ts");
  // => "typescript"
```


## Specifications

Specifications make use of JavaScript's `eval`. While using `eval` is typically
considered to be bad form, when calling another function the performance does
not appear suffer in V8. See http://jsperf.com/eval-function-call.

A specification consists of the following:  

| Param | Type | Description |
| --- | --- | --- |
| name | String | Name of compiler (by convention we use npm package name) |
| ext | String | Typical file extension (e.g. handlebars uses hbs) |
| type | String | Type of output file (html, css, js) |
| modules | Array | Array of required modules |
| syntax | String | The function to be evaluated |
| options | Object | Optional options to be accessed via `options` |
| suffix  | String | Optional suffix to call on results (sync or async) |

### Example specification
```js
{
  "name"    : "handlebars",
  "ext"     : "hbs",
  "type"    : "html",
  "modules" : ["consolidate", "handlebars"],
  "syntax"  : "handlebars.render(str, context, next)"
}
```

### Looking up a specification by extension
Specifications is processed as an array. The first specification with `ext` is
assumed to be the default for extension `ext`. This is why `css`, `html` and `js`
are located at the top of the specification.

### Writing a specification
The syntax processor does the following:
1. Prepends `$0` to the string if string doesn't contain `$0`.  
2. Replaces all `$x` with `modules[x]`. This allows incorporate of modules array.  
3. Creates function that evaluates command. Note that `str`, `context` and `next`
   have special meanings.  

Using Handlebars as an example:
```js
// Input
"handlebars.render(str, context, next)"

// Interim
modules[0].handlebars.render(str, context, next)

// Equivalent function
function(str, context, next) { consolidate.handlebars.render(str, context, next); }
```

## License
MIT

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