# bikeshed-js

> Run bikeshed from node.js

Latest version **1.0.7** (published 2016-12-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install bikeshed-js
pnpm add bikeshed-js
yarn add bikeshed-js
bun add bikeshed-js
```

Provides the command `bikeshed-js`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2016-12-26 |
| First published | 2016-09-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Koji Ishii |
| Maintainers | kojii |
| Keywords | bikeshed |

## Links

- npm: https://www.npmjs.com/package/bikeshed-js
- Repository: https://github.com/kojiishi/bikeshed-js
- Homepage: https://github.com/kojiishi/bikeshed-js#readme
- Issues: https://github.com/kojiishi/bikeshed-js/issues
- npm.io page: https://npm.io/package/bikeshed-js

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.74.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0

## Recent versions

- 1.0.7 (latest) — 2016-12-26
- 1.0.6 — 2016-12-10
- 1.0.5 — 2016-12-10
- 1.0.4 — 2016-12-10
- 1.0.3 — 2016-12-09
- 1.0.2 — 2016-09-17
- 1.0.1 — 2016-09-13
- 1.0.0 — 2016-09-10

## README

This package runs [bikeshed] from node.js.

Uses the online service if [bikeshed] is not locally installed.

```javascript
var bikeshed = require('bikeshed');
bikeshed().then(
  file => console.log('Output: ' + file),
  err => console.log(err));
```

or from gulp:

```javascript
var bikeshed = require('bikeshed');

gulp.task("bikeshed", function () {
  return bikeshed('Overview.bs');
});

gulp.task("watch", function () {
  gulp.watch("*.bs", function (event) {
    bikeshed(event.path);
  });
});
```

## Install

```
npm install bikeshed-js
```
or from [github](https://github.com/kojiishi/bikeshed-js):
```
npm install kojiishi/bikeshed-js
```

## Reference

### `function bikeshed(infile, outfile)`

Returns a Promise that resolves on the completion
with the output file path.

The `infile` specifies the [bikeshed] source file path.

The `outfile` specifies the output file path.
If omitted, the extension of `infile` is replaced with `'.html'`.

If `outfile` is an array,
the output chunks are appended to the array as [Buffer].
In this case, the Promise resolves to the array.

```javascript
bikeshed('test.bs', []).then(buffers =>
  Buffer.concat(buffers).toString('utf8'));
```

[bikeshed]: https://github.com/tabatkins/bikeshed
[Buffer]: https://nodejs.org/api/buffer.html

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