-
Notifications
You must be signed in to change notification settings - Fork 627
/
metalsmith
executable file
·227 lines (193 loc) · 6.69 KB
/
metalsmith
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
#!/usr/bin/env node
/* eslint-disable no-console */
const exists = require('fs').existsSync
const readFileSync = require('fs').readFileSync
const Metalsmith = require('..')
const { pathToFileURL } = require('url')
const { Command } = require('commander')
const program = new Command()
const { resolve, isAbsolute, dirname, extname } = require('path')
const { isString, isObject } = require('../lib/helpers')
const color = {
error: '\x1b[31m',
warn: '\x1b[33m',
info: '\x1b[36m',
success: '\x1b[32m',
log: '\x1b[0m'
}
program
.name('metalsmith')
.description('Metalsmith CLI')
.version(require('../package.json').version)
.addHelpText('after', `
Examples:
# build from metalsmith.json:
metalsmith
# build from lib/config.json:
metalsmith --config lib/config.json
# override env vars
metalsmith --env NODE_ENV=production TZ=Europe/London
# override DEBUG env var (shortcut)
metalsmith --debug @metalsmith/*
`)
program
.command('build', { isDefault: true })
.description('Run a metalsmith build')
.option('-c, --config <path>', 'configuration file location', 'metalsmith.json')
.option('--env <setting...>', 'Set or override one or more metalsmith environment variables.')
.option('--debug', 'Set or override debug namespaces')
.option('--dry-run', 'Process metalsmith files without outputting to the file system')
.action(buildCommand)
program.parse(process.argv)
async function buildCommand({ config, ...cliOptions }) {
const dir = process.cwd()
let path = isAbsolute(config) ? config : resolve(dir, config)
// Important addition of 2.5.x. Given local plugins with a relative path are written with __dirname in mind,
// having a config-relative dir path makes sure the CLI runs properly
// when the command is executed from a subfolder or outside of the ms directory
const confRelativeDir = dirname(path)
if (!exists(path)) {
// commander only supports a single default, so we must set default manually here
if (exists(resolve(confRelativeDir, 'metalsmith.js'))) {
path = resolve(confRelativeDir, 'metalsmith.js')
} else {
fatal(`could not find a configuration file '${config}'.`)
}
}
const format = extname(path).slice(1)
// avoid ESM dynamic import error with absolute paths on Windows:
// Only URLs with a scheme in: file and data are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs.
// cf also https://github.com/nuxt/nuxt/issues/15500#issuecomment-1451619865
path = pathToFileURL(path);
let spec
try {
if (format.match(/^[cm]*js$/)) {
spec = (await import(path)).default
// when a JS file is required that forgets to export using exports or module.exports,
// node instead returns an empty object. Though Metalsmith should in theory consider this a valid config
// for a simple copy -> paste it is highly likely that this was not the user's intention
if (!(spec instanceof Metalsmith) && isObject(spec) && Object.keys(spec).length === 0) {
fatal(`it seems like ${config} is empty. Make sure it exports a metalsmith config object.`)
}
} else {
spec = JSON.parse(readFileSync(path, 'utf-8'))
}
} catch (e) {
fatal(`it seems like ${config} is malformed or unsupported. Encountered error: ${e.message}`)
}
/** First suppose a JS config file that exports new Metalsmith() */
let metalsmith = spec
/** if it's not suppose a metalsmith.json-style config object */
if (!(metalsmith instanceof Metalsmith)) {
metalsmith = new Metalsmith(confRelativeDir)
if (spec.source) metalsmith.source(spec.source)
if (spec.destination) metalsmith.destination(spec.destination)
if (spec.concurrency) metalsmith.concurrency(spec.concurrency)
if (spec.metadata) metalsmith.metadata(spec.metadata)
if (spec.clean != null) metalsmith.clean(spec.clean)
if (spec.frontmatter != null) metalsmith.frontmatter(spec.frontmatter)
if (spec.ignore != null) metalsmith.ignore(spec.ignore)
if (isObject(spec.env)) metalsmith.env(expandEnvVars(spec.env, process.env))
}
/* CLI --<option> overrides configs */
if (cliOptions.env) cliOptions.env.forEach(envVar => {
const [name, value] = envVar.split('=')
metalsmith.env(name, value)
})
if (cliOptions.debug) metalsmith.env('DEBUG', cliOptions.debug)
// set a flag plugins can check to target CLI-specific behavior
metalsmith.env('CLI', true)
/**
* Plugins.
*/
if (!(spec instanceof Metalsmith)) {
normalize(spec.plugins).forEach(function (plugin) {
for (const name in plugin) {
const opts = plugin[name]
let mod
try {
const local = resolve(confRelativeDir, name)
const npm = resolve(confRelativeDir, 'node_modules', name)
if (exists(local) || exists(`${local}.js`)) {
mod = require(local)
} else if (exists(npm)) {
mod = require(npm)
} else {
mod = require(name)
}
} catch (e) {
fatal(`failed to require plugin "${name}".`)
}
try {
metalsmith.use(mod(opts))
} catch (e) {
fatal(`error using plugin "${name}"...`, `${e.message}\n\n${e.stack}`)
}
}
})
}
function onBuild(message) {
return (err) => {
if (err) fatal(err.message, err.stack)
log('success', message)
}
}
if (cliOptions.dryRun) {
metalsmith.process(onBuild(`successfully ran a dry-run of the ${config} build`))
} else {
metalsmith.build(onBuild(`successfully built to ${metalsmith.destination()}`))
}
}
/**
* Log an error and then exit the process.
*
* @param {String} msg
* @param {String} [stack] Optional stack trace to print.
*/
function fatal(msg, stack) {
log('error', msg)
if (stack) {
log('error', stack)
}
// eslint-disable-next-line n/no-process-exit
process.exit(1)
}
function log(type, msg) {
if (!msg) {
msg = type
}
const fn = console[type] || console.log
let args = [`Metalsmith · ${msg}`, '\x1b[0m']
if (color[type]) args = [color[type], ...args]
fn(...args)
}
/**
* Normalize an `obj` of plugins.
*
* @param {Array or Object} obj
* @return {Array}
*/
function normalize(obj) {
if (obj instanceof Array) return obj
const ret = []
for (const key in obj) {
const plugin = {}
plugin[key] = obj[key]
ret.push(plugin)
}
return ret
}
/**
* Expand env var values in env with values in expansionSource
* @param {Object} env
* @param {Object} expansionSource
* @returns {Object}
*/
function expandEnvVars(env, expansionSource) {
Object.entries(env).forEach(([name, value]) => {
if (isString(value) && value.startsWith('$')) {
env[name] = expansionSource[value.slice(1)]
}
}, env)
return env
}