# fis-scaffold-kernel

> fis-scaffold-kernel

Latest version **0.2.0** (published 2016-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install fis-scaffold-kernel
pnpm add fis-scaffold-kernel
yarn add fis-scaffold-kernel
bun add fis-scaffold-kernel
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2016-06-15 |
| First published | 2014-11-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+30 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | fansekey |
| Maintainers | fansekey, 2betop, hefangshi |
| Keywords | fis, scaffold |

## Links

- npm: https://www.npmjs.com/package/fis-scaffold-kernel
- Repository: https://github.com/xiangshouding/fis-scaffold-kernel
- Issues: https://github.com/xiangshouding/fis-scaffold-kernel/issues
- npm.io page: https://npm.io/package/fis-scaffold-kernel

## Dependencies (9)

- [tar](https://npm.io/package/tar.md) 2.2.1
- [debug](https://npm.io/package/debug.md) 2.1.0
- [lodash](https://npm.io/package/lodash.md) 4.12.0
- [prompt](https://npm.io/package/prompt.md) 0.2.14
- [adm-zip](https://npm.io/package/adm-zip.md) 0.4.4
- [glob.js](https://npm.io/package/glob.js.md) 0.1.0
- [is-utf8](https://npm.io/package/is-utf8.md) 0.2.0
- [iconv-lite](https://npm.io/package/iconv-lite.md) 0.4.4
- [fis-repo-client](https://npm.io/package/fis-repo-client.md) 0.1.14

## Recent versions

- 0.2.0 (latest) — 2016-06-15
- 0.1.2 — 2016-05-11
- 0.1.1 — 2015-12-15
- 0.1.0 — 2015-07-22
- 0.0.22 — 2015-07-22
- 0.0.21 — 2015-04-20
- 0.0.20 — 2015-02-09
- 0.0.19 — 2014-12-13
- 0.0.18 — 2014-12-12
- 0.0.17 — 2014-12-12
- 0.0.16 — 2014-12-12
- 0.0.15 — 2014-12-12
- 0.0.14 — 2014-12-02
- 0.0.13 — 2014-12-02
- 0.0.12 — 2014-12-02
- … 12 more at https://npm.io/package/fis-scaffold-kernel/versions

## README

fis-scaffold-kernel
===================

### INSTALL

```bash
$ npm install fis-scaffold-kernel --save
```

### API

```javascript
var options = {
    type: 'github', //default `lights`; support github,gitlab,lights
    log: {
        writer: stdout, //default `stdout`
        level: 0 //default show all log; set `0` == silent.
    }
}
var scaffold = new (require('fis-scaffold-kernel'))(options);
```

#### scaffold.download(id, cb)

download a component from the repos(github, gitlab, lights)

```javascript
scaffold.download('xiangshouding/glob.js@master', function (err, temp_path) {
    //balabalabala...
});
```

#### scaffold.prompt(schema, cb)

https://github.com/flatiron/prompt

```javascript
scaffold.prompt([{name: 'test'}], function (err, result) {
    //...
});
```

#### scaffold.deliver(from, to, roadmap)

deliver all files from `from` to `to`

```javascript
scaffold.deliver('./from', './to', [
    {
        reg: '*.js',
        release: 'js/$&'
    }, {
        reg: '**',
        release: false
    }
]);
```

#### scaffold.release(id, to, schema, roadmap, cb)

```javascript
scaffold.release(
    'xiangshouding/glob.js@master',
    __dirname + '/output',
    [],
    [
        {
            reg: '*glob.js',
            release: 'glob/$&'
        },
        {
            reg: '*',
            release: false
        }
    ],
    function (err) {
        console.log(err);
    }
);
```
or

new replacer

```javascript
scaffold.release(
    'xiangshouding/glob.js@master',
    __dirname + '/output',
    function (tmp_path, done) {
        var files = scaffold.util.find(tmp_path);
        scaffold.prompt([{name: 'glob'}], function (err, results) {
            if (err) {
                //if
                    //done()
                //else
                    //scaffold.deliver(tmp_path, to, roadmap);
                return;
            }
            
            //replace...
            //if
                //done()
            //else
                //scaffold.deliver(tmp_path, to, roadmap);
        });
    },
    [
        {
            reg: '*glob.js',
            release: 'glob/$&'
        },
        {
            reg: '*',
            release: false
        }
    ],
    function (err) {
        console.log(err);
    }
);
```

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