forked from josdejong/mathjs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gulpfile.cjs
282 lines (235 loc) · 7.2 KB
/
gulpfile.cjs
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
// @ts-nocheck
const fs = require('fs')
const path = require('path')
const gulp = require('gulp')
const del = require('del')
const log = require('fancy-log')
const webpack = require('webpack')
const babel = require('gulp-babel')
const { mkdirp } = require('mkdirp')
const docgenerator = require('./tools/docgenerator')
const entryGenerator = require('./tools/entryGenerator')
const validateAsciiChars = require('./tools/validateAsciiChars')
const SRC_DIR = path.join(__dirname, '/src')
const BUNDLE_ENTRY = `${SRC_DIR}/defaultInstance.js`
const HEADER = `${SRC_DIR}/header.js`
const VERSION = `${SRC_DIR}/version.js`
const COMPILE_SRC = `${SRC_DIR}/**/*.?(c)js`
const COMPILE_ENTRY_SRC = `${SRC_DIR}/entry/**/*.js`
const COMPILE_DIR = path.join(__dirname, '/lib')
const COMPILE_BROWSER = `${COMPILE_DIR}/browser`
const COMPILE_CJS = `${COMPILE_DIR}/cjs`
const COMPILE_ESM = `${COMPILE_DIR}/esm` // es modules
const COMPILE_ENTRY_LIB = `${COMPILE_CJS}/entry`
const FILE = 'math.js'
const REF_SRC = SRC_DIR + '/'
const REF_DIR = path.join(__dirname, '/docs')
const REF_DEST = `${REF_DIR}/reference/functions`
const REF_ROOT = `${REF_DIR}/reference`
const MATH_JS = `${COMPILE_BROWSER}/${FILE}`
const COMPILED_HEADER = `${COMPILE_CJS}/header.js`
const PACKAGE_JSON_COMMONJS = '{\n "type": "commonjs"\n}\n'
const AUTOGENERATED_WARNING = `
// Note: This file is automatically generated when building math.js.
// Changes made in this file will be overwritten.
`
// read the version number from package.json
function getVersion () {
return JSON.parse(String(fs.readFileSync('./package.json'))).version
}
// generate banner with today's date and correct version
function createBanner () {
const today = new Date().toISOString().substr(0, 10) // today, formatted as yyyy-mm-dd
const version = getVersion()
return String(fs.readFileSync(HEADER))
.replace('@@date', today)
.replace('@@version', version)
}
// generate a js file containing the version number
function updateVersionFile (done) {
const version = getVersion()
fs.writeFileSync(VERSION, `export const version = '${version}'${AUTOGENERATED_WARNING}`)
done()
}
const bannerPlugin = new webpack.BannerPlugin({
banner: createBanner(),
entryOnly: true,
raw: true
})
const babelConfig = JSON.parse(String(fs.readFileSync('./.babelrc')))
const webpackConfig = {
entry: BUNDLE_ENTRY,
mode: 'production',
performance: { hints: false }, // to hide the "asset size limit" warning
output: {
library: 'math',
libraryTarget: 'umd',
libraryExport: 'default',
path: COMPILE_BROWSER,
globalObject: 'this',
filename: FILE
},
node: false, // to make sure Webpack doesn't generate 'new Function("return this")' in the bundle output, see https://github.com/josdejong/mathjs/issues/3001
plugins: [
bannerPlugin
// new webpack.optimize.ModuleConcatenationPlugin()
// TODO: ModuleConcatenationPlugin seems not to work. https://medium.com/webpack/webpack-3-official-release-15fd2dd8f07b
],
module: {
rules: [
{
test: /\.js$/,
exclude: /node_modules/,
use: {
loader: 'babel-loader',
options: {
...babelConfig,
presets: [
['@babel/preset-env', {
useBuiltIns: 'usage',
corejs: '3.15'
}]
]
}
}
}
]
},
devtool: 'source-map',
cache: true
}
// create a single instance of the compiler to allow caching
const compiler = webpack(webpackConfig)
function bundle (done) {
// update the banner contents (has a date in it which should stay up to date)
bannerPlugin.banner = createBanner()
compiler.run(function (err, stats) {
if (err) {
log(err)
done(err)
}
const info = stats.toJson()
if (stats.hasWarnings()) {
log('Webpack warnings:\n' + info.warnings.join('\n'))
}
if (stats.hasErrors()) {
log('Webpack errors:\n' + info.errors.join('\n'))
done(new Error('Compile failed'))
}
// create commonjs package.json file
fs.writeFileSync(path.join(COMPILE_BROWSER, 'package.json'), PACKAGE_JSON_COMMONJS)
log(`bundled ${MATH_JS}`)
done()
})
}
function compileCommonJs () {
// create a package.json file in the commonjs folder
mkdirp.sync(COMPILE_CJS)
fs.writeFileSync(path.join(COMPILE_CJS, 'package.json'), PACKAGE_JSON_COMMONJS)
return gulp.src(COMPILE_SRC)
.pipe(babel())
.pipe(gulp.dest(COMPILE_CJS))
}
function compileESModules () {
return gulp.src(COMPILE_SRC)
.pipe(babel({
...babelConfig,
presets: [
['@babel/preset-env', {
modules: false,
targets: {
esmodules: true
}
}]
]
}))
.pipe(gulp.dest(COMPILE_ESM))
}
function compileEntryFiles () {
return gulp.src(COMPILE_ENTRY_SRC)
.pipe(babel())
.pipe(gulp.dest(COMPILE_ENTRY_LIB))
}
function writeCompiledHeader (cb) {
fs.writeFileSync(COMPILED_HEADER, createBanner())
cb()
}
function validateAscii (done) {
const Reset = '\x1b[0m'
const BgRed = '\x1b[41m'
validateAsciiChars.getAllFiles(SRC_DIR)
.map(validateAsciiChars.validateChars)
.forEach(function (invalidChars) {
invalidChars.forEach(function (res) {
console.log(res.insideComment ? '' : BgRed,
'file:', res.filename,
'ln:' + res.ln,
'col:' + res.col,
'inside comment:', res.insideComment,
'code:', res.c,
'character:', String.fromCharCode(res.c),
Reset
)
})
})
done()
}
async function generateDocs (done) {
const all = (await import('file://' + REF_SRC + 'defaultInstance.js')).default
const functionNames = Object.keys(all)
.filter(key => typeof all[key] === 'function')
if (functionNames.length === 0) {
throw new Error('No function names found, is the doc generator broken?')
}
docgenerator.cleanup(REF_DEST, REF_ROOT)
docgenerator.iteratePath(functionNames, REF_SRC, REF_DEST, REF_ROOT)
done()
}
function generateEntryFiles (done) {
entryGenerator.generateEntryFiles().then(() => {
done()
})
}
/**
* Remove generated files
*
* @returns {Promise<string[]> | *}
*/
function clean () {
return del([
// legacy compiled files
'./es/',
// generated browser bundle, esm code, and commonjs code
'./lib/',
// generated source files
'src/**/*.generated.js'
])
}
gulp.task('browser', bundle)
gulp.task('clean', clean)
gulp.task('docs', generateDocs)
// check whether any of the source files contains non-ascii characters
gulp.task('validate:ascii', validateAscii)
// The watch task (to automatically rebuild when the source code changes)
gulp.task('watch', function watch () {
const files = ['package.json', 'src/**/*.js']
const options = {
// ignore version.js else we get an infinite loop since it's updated during bundle
ignored: /version\.js/,
ignoreInitial: false,
delay: 100
}
gulp.watch(files, options, gulp.parallel(bundle, compileCommonJs))
})
// The default task (called when you run `gulp`)
gulp.task('default', gulp.series(
clean,
updateVersionFile,
generateEntryFiles,
compileCommonJs,
compileEntryFiles,
compileESModules, // Must be after generateEntryFiles
writeCompiledHeader,
bundle,
generateDocs
))