summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-plugin/src/create.js
blob: 31edb858d821e8f3c116cf5493caa386eeb49378 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
const fs = require('fs-extra');
const path = require('path');
const GITBOOK_VERSION = require('../package.json').version;

const TEMPLATE_DIR = path.resolve(__dirname, '../template');

/**
 * Create a new plugin
 * @param  {String} outputDir
 * @param  {String} spec.title
 * @param  {String} spec.name
 * @param  {String} spec.desc
 * @param  {Array}  spec.keywords
 */
function create(outputDir, spec) {
    const pkg = {
        'title': `${spec.title}`,
        'name': `gitbook-plugin-${spec.name}`,
        'description': `${spec.desc}`,
        'version': '0.0.0',
        'main': 'index.js',
        'browser': './_assets/plugin.js',
        'ebook': './_assets/plugin.js',
        'dependencies': {
            'gitbook-core': '^' + GITBOOK_VERSION
        },
        'devDependencies': {
            'gitbook-plugin': '^' + GITBOOK_VERSION,
            'eslint': '3.7.1',
            'eslint-config-gitbook': '1.4.0'
        },
        'engines': {
            'gitbook': '>=4.0.0-alpha.0'
        },
        'scripts': {
            'lint': 'eslint ./',
            'build-website': 'gitbook-plugin build ./src/index.js ./_assets/plugin.js',
            'prepublish': 'npm run build-website',
            'test': 'gitbook-plugin test && npm run lint'
        },
        'homepage': `${spec.github}`,
        'keywords': spec.categories.map(category => `gitbook:${category}`),
        'repository': {
            'type': 'git',
            'url': `${spec.github}.git`
        },
        'bugs': {
            'url': `${spec.github}/issues`
        }
    };

    fs.copySync(TEMPLATE_DIR, outputDir, {
        clobber: true
    });

    fs.outputJsonSync(path.resolve(outputDir, 'package.json'), pkg, {
        spaces: 2
    });
}

module.exports = create;