|
| 1 | +'use strict'; |
| 2 | + |
| 3 | +const debug = require('debug')('egad'); |
| 4 | +const promisify = require('es6-promisify'); |
| 5 | +const fs = require('fs'); |
| 6 | +const readFile = promisify(fs.readFile); |
| 7 | +const stat = promisify(fs.stat); |
| 8 | +const writeFile = promisify(fs.writeFile); |
| 9 | +const mkdirp = promisify(require('mkdirp')); |
| 10 | +const path = require('path'); |
| 11 | +const xdgBasedir = require('xdg-basedir'); |
| 12 | +const Walker = require('walker'); |
| 13 | +const _ = require('lodash/fp'); |
| 14 | +const render = promisify(require('consolidate').handlebars.render); |
| 15 | +const isBinaryPath = require('is-binary-path'); |
| 16 | +const git = require('simple-git'); |
| 17 | +const rimraf = promisify(require('rimraf')); |
| 18 | + |
| 19 | +const xdgCachedir = xdgBasedir.cache || require('os') |
| 20 | + .tmpdir(); |
| 21 | + |
| 22 | +const cachedir = _.partial(path.join, [ |
| 23 | + xdgCachedir, |
| 24 | + '.egad-templates' |
| 25 | +]); |
| 26 | +const destPath = _.pipe(_.kebabCase, cachedir); |
| 27 | + |
| 28 | +/** |
| 29 | + * Downloads (clones) a Git repo |
| 30 | + * @param {string} url - URL of Git repo |
| 31 | + * @param {Object} [opts] - Options |
| 32 | + * @param {string} [opts.dest] - Destination path; default is a user cache dir |
| 33 | + * @param {boolean} [opts.offline=false] - If true, just check for existence of |
| 34 | + * working copy |
| 35 | + * @param {string} [opts.remote=origin] - Git remote |
| 36 | + * @param {string} [opts.branch=master] - Git branch |
| 37 | + * @returns {Promise.<string>} Destination path |
| 38 | + */ |
| 39 | +function download (url, opts = {}) { |
| 40 | + opts = _.defaults({ |
| 41 | + dest: destPath(url), |
| 42 | + offline: false, |
| 43 | + remote: 'origin', |
| 44 | + branch: 'master' |
| 45 | + }, opts); |
| 46 | + debug(`Download target at ${opts.dest}`); |
| 47 | + return mkdirp(cachedir()) |
| 48 | + .then(() => stat(opts.dest)) |
| 49 | + .then(stats => { |
| 50 | + if (!stats.isDirectory()) { |
| 51 | + throw new Error(`File exists at ${opts.dest}`); |
| 52 | + } |
| 53 | + const wc = git(opts.dest); |
| 54 | + return new Promise((resolve, reject) => { |
| 55 | + debug(`Updating working copy at ${opts.dest}`); |
| 56 | + wc.pull(opts.remote, opts.branch, {'--rebase': 'true'}, err => { |
| 57 | + if (err) { |
| 58 | + return reject(err); |
| 59 | + } |
| 60 | + resolve(); |
| 61 | + }); |
| 62 | + }); |
| 63 | + }) |
| 64 | + .catch(err => { |
| 65 | + if (opts.offline) { |
| 66 | + throw new Error(`No cache of ${url} exists in ${opts.dest}`); |
| 67 | + } |
| 68 | + debug(err); |
| 69 | + return rimraf(opts.dest) |
| 70 | + .then(() => { |
| 71 | + debug(`Cloning repo ${url}`); |
| 72 | + const wc = git(); |
| 73 | + return new Promise((resolve, reject) => { |
| 74 | + wc.clone(url, opts.dest, err => { |
| 75 | + if (err) { |
| 76 | + return reject(err); |
| 77 | + } |
| 78 | + resolve(); |
| 79 | + }); |
| 80 | + }); |
| 81 | + }); |
| 82 | + }) |
| 83 | + .then(() => opts.dest); |
| 84 | +} |
| 85 | + |
| 86 | +/** |
| 87 | + * Renders files containing Handlebars templates recursively from one path to |
| 88 | + * another. |
| 89 | + * @param {string} source - Source directory, containing templates |
| 90 | + * @param {string} dest - Destination (output) directory |
| 91 | + * @param {Object} [data] - Data for template(s) |
| 92 | + * @param {Object} [opts] - Options |
| 93 | + * @param {boolean} [opts.overwrite=true] - Set to `false` to avoid overwriting |
| 94 | + * existing files |
| 95 | + * @returns {Promise.<string[]>} Destination filepaths successfully written to |
| 96 | + */ |
| 97 | +function generate (source, dest, data = {}, opts = {}) { |
| 98 | + opts = _.defaults({ |
| 99 | + overwrite: true |
| 100 | + }, opts); |
| 101 | + debug(`Generating from ${source} to ${dest}`); |
| 102 | + return mkdirp(dest) |
| 103 | + .then(() => new Promise((resolve, reject) => { |
| 104 | + const queue = []; |
| 105 | + Walker(source) |
| 106 | + .filterDir(_.negate(_.endsWith('.git'))) |
| 107 | + .on('file', sourceFilepath => { |
| 108 | + debug(`Trying ${sourceFilepath}`); |
| 109 | + if (!isBinaryPath(sourceFilepath)) { |
| 110 | + debug(`Queuing ${sourceFilepath}`); |
| 111 | + return queue.push(sourceFilepath); |
| 112 | + } |
| 113 | + debug(`Skipping ${sourceFilepath}; binary`); |
| 114 | + }) |
| 115 | + .on('error', reject) |
| 116 | + .on('end', () => resolve(queue)); |
| 117 | + })) |
| 118 | + .then(queue => Promise.all(queue.map(sourceFilepath => { |
| 119 | + const destFilepath = path.join(dest, |
| 120 | + path.relative(source, sourceFilepath)); |
| 121 | + return Promise.all([ |
| 122 | + readFile(sourceFilepath, 'utf8') |
| 123 | + .then(str => { |
| 124 | + if (/{{([^{}]+)}}/g.test(str)) { |
| 125 | + debug(`Rendering template ${sourceFilepath}`); |
| 126 | + return render(str, data); |
| 127 | + } |
| 128 | + return str; |
| 129 | + }), |
| 130 | + mkdirp(path.dirname(destFilepath)) |
| 131 | + ]) |
| 132 | + .then(([str]) => writeFile(destFilepath, str, { |
| 133 | + encoding: 'utf8', |
| 134 | + // This is rather crude |
| 135 | + flag: opts.overwrite |
| 136 | + ? 'w' |
| 137 | + : 'wx' |
| 138 | + }) |
| 139 | + .then(() => { |
| 140 | + debug(`Wrote ${destFilepath}`); |
| 141 | + return destFilepath; |
| 142 | + }) |
| 143 | + .catch(err => { |
| 144 | + if (err.code === 'EEXIST') { |
| 145 | + debug(`Skipping ${destFilepath}; already exists`); |
| 146 | + return; |
| 147 | + } |
| 148 | + throw err; |
| 149 | + })); |
| 150 | + }))) |
| 151 | + .then(_.compact); |
| 152 | +} |
| 153 | + |
| 154 | +/** |
| 155 | + * Combines download() & generate() |
| 156 | + * @param {string} url - Git repo url |
| 157 | + * @param {string} [dest] - Destination path; defaults to current working dir |
| 158 | + * @param {Object} [data] - Data for template(s) |
| 159 | + * @param {Object} [opts] - Options for both `download()` & `generate()` |
| 160 | + * @returns {Promise.<string[]>} Destination filepaths successfully written to |
| 161 | + */ |
| 162 | +function scaffold (url, dest = process.cwd(), data = {}, opts = {}) { |
| 163 | + return download(url, opts) |
| 164 | + .then(templateDir => { |
| 165 | + debug(`${url} cloned into ${templateDir}`); |
| 166 | + return generate(templateDir, dest, data, opts); |
| 167 | + }); |
| 168 | +} |
| 169 | + |
| 170 | +module.exports = { |
| 171 | + generate, |
| 172 | + download, |
| 173 | + scaffold |
| 174 | +}; |
0 commit comments