-
-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathgulpfile.js
458 lines (411 loc) · 12.6 KB
/
gulpfile.js
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
import fetch from "node-fetch"
import gulp from "gulp"
import webpack from "webpack"
import webpackStream from "webpack-stream"
import replace from "gulp-replace"
import rename from "gulp-rename"
import file from "gulp-file"
import path from "path"
import { deleteAsync } from "del"
import gulpNotify from "gulp-notify"
import fs from "fs/promises"
import url from "url"
import serve from "./server/index.js"
import paths, { getPath, getSrcPath } from "./paths.js"
import webpackConfig from "./webpack.config.js"
const requireJson = async (f) => JSON.parse(await fs.readFile(f))
const log = (...msg) => process.stderr.write(`${msg.join("\n")}\n`)
const copyrightYearOne = 2017
const { URL } = url
const { task, src, dest, parallel, series } = gulp
const escapeHTML = (text) =>
String(text).replace(
/[&<>"'`=/]/g,
(s) =>
({
"&": "&",
"<": "<",
">": ">",
'"': """,
"'": "'",
"/": "/",
"`": "`",
"=": "=",
}[s])
)
const { WEBPACK_MODE } = process.env
if (WEBPACK_MODE) {
if (!["production", "development"].includes(WEBPACK_MODE)) {
log(`ERROR: Invalid WEBPACK_MODE: ${WEBPACK_MODE}`)
process.exit(1)
}
webpackConfig.mode = WEBPACK_MODE
log(`Using webpack mode: ${WEBPACK_MODE}`)
}
const pkg = await requireJson(getPath(paths.pkgJson))
const getSources = (() => {
let sources = null
return async () => {
if (sources !== null) {
return sources
}
// Create stubs for document methods which are used by uhtml
const oldDocument = global.document
global.document = {
createDocumentFragment: function () {},
createElement: function () {},
createElementNS: function () {},
createTextNode: function () {},
createTreeWalker: function () {},
importNode: function () {},
}
sources = await Object.fromEntries(
await Promise.all(
Object.entries(paths.sources).map(async ([name, srcPath]) => [
name,
(await import(getSrcPath(srcPath))).default,
])
)
)
global.document = oldDocument
return sources
}
})()
let faviconsManifest
const loadFaviconsManifest = async () => {
if (
typeof faviconsManifest === "object" &&
Object.keys(faviconsManifest).length > 0
) {
return
}
try {
faviconsManifest = await requireJson(
getPath(paths.favicons, paths.faviconsManifest)
)
} catch (e) {
log(`Warning: couldn't load favicons manifest: ${e}`)
faviconsManifest = {}
}
}
const notify = Object.assign(
(opts, ...args) =>
gulpNotify(
{
icon: null,
onLast: true,
timeout: 2000,
...opts,
},
...args
),
gulpNotify
)
notify. ...args) =>
gulpNotify.onError(
{
onLast: true,
timeout: 7500,
...opts,
},
...args
)
task("clean", () => deleteAsync(["build", ".cache", ".tmp-gulp-compile-*"]))
task("clean-favicons", () => deleteAsync([paths.favicons]))
task("check-priv", async () => {
try {
await fs.stat(getSrcPath(paths.sources.priv))
} catch (e) {
log(
`Notice: Initializing ${paths.sources.confPriv}. Configure your API keys here.`
)
return fs.copyFile(
getPath(paths.confPrivExample),
getSrcPath(paths.sources.confPriv),
fs.constants.COPYFILE_EXCL
)
}
return Promise.resolve()
})
const parseContributor = (contributor) => {
let c = contributor
if (typeof contributor === "string") {
const m = contributor.match(
/^(?<name>.*?)\s*(<(?<email>.*?)>)?\s*(\((?<url>.*?)\))?$/
)
if (!m) {
throw new Error(`couldn't parse contributor '${contributor}'`)
}
c = m.groups
} else if (typeof contributor !== "object") {
throw new Error(
`expected contributor to be of type 'string' or 'object', got '${typeof contributor}'`
)
}
if (!c.name) {
return null
}
return `${c.url ? `<a href="${c.url}">` : ""}${c.name}${c.url ? "</a>" : ""}`
}
task(
"docs",
parallel(async () => {
const { searchEngines, conf, keys } = await getSources()
await loadFaviconsManifest()
const screens = {}
let screenshotList = ""
const screenshots = await fs.readdir(getPath(paths.screenshots))
screenshots.forEach((s) => {
const name = path.basename(s, ".png").split("-")
const alias = name[0]
if (!screens[alias]) {
screens[alias] = []
}
screens[alias].push(path.join(paths.screenshots, path.basename(s)))
})
let searchEnginesTable = Object.keys(searchEngines).sort((a, b) => {
if (a < b) return -1
if (a > b) return 1
return 0
})
let keysTable = Object.entries(keys.maps)
.map(([key, maps]) => [key, maps.filter((map) => !map.hide)])
.filter(([_, maps]) => maps.length > 0)
.map(([key]) => key)
.sort((a, b) => {
if (a === "global") return -1
if (b === "global") return 1
if (a < b) return -1
if (a > b) return 1
return 0
})
searchEnginesTable = await searchEnginesTable.reduce(async (acc1p, k) => {
const acc1 = await acc1p
const c = searchEngines[k]
const u = new URL(c.domain ? `https://${c.domain}` : c.search)
const domain = u.hostname
let s = ""
if (screens[c.alias]) {
screens[c.alias].forEach((ss, i) => {
const num = i > 0 ? ` ${i + 1}` : ""
s += `<a href="#${c.name.toLowerCase()}${num.replace(
" ",
"-"
)}">:framed_picture:</a>`
screenshotList += `##### ${c.name}${num}\n`
screenshotList += `\n\n`
})
}
const favicon = faviconsManifest[domain]
? `<img src="./assets/favicons/${faviconsManifest[domain]}" width="16px"> `
: ""
const privNote = c.priv
? ' <a title="requires private API key" href="#optional-private-api-key-configuration">∗</a>'
: ""
const localNote = c.local
? ' <a title="requires local web server" href="#running-the-local-web-server">†</a>'
: ""
return `${acc1}
<tr>
<td><a href="${u.protocol}//${domain}">${favicon}</a></td>
<td><code>${c.alias}</code></td>
<td>${c.name}${privNote}${localNote}</td>
<td><a href="${u.protocol}//${domain}">${domain}</a></td>
<td>${s}</td>
</tr>`
}, Promise.resolve(""))
keysTable = await keysTable.reduce(async (acc1p, domain) => {
const acc1 = await acc1p
const header =
"<tr><td><strong>Mapping</strong></td><td><strong>Description</strong></td></tr>"
const c = keys.maps[domain]
const maps = c.reduce((acc2, map) => {
let leader = ""
if (typeof map.leader !== "undefined") {
leader = map.leader
} else if (domain === "global") {
leader = ""
} else {
leader = conf.siteleader
}
const mapStr = escapeHTML(
`${leader}${map.alias}`.replace(" ", "<space>")
)
return `${acc2}<tr><td><code>${mapStr}</code></td><td>${map.description}</td></tr>\n`
}, "")
let domainStr = "<strong>global</strong>"
let favicon = ""
if (domain !== "global") {
favicon = faviconsManifest[domain]
? `<img src="./assets/favicons/${faviconsManifest[domain]}" width="16px"> `
: ""
domainStr = `<a href="//${domain}">${favicon}${domain}</a>`
}
return `${acc1}<tr><th colspan="2">${domainStr}</th></tr>${header}\n${maps}`
}, Promise.resolve(""))
const year = new Date().getFullYear()
const copyrightYears = `${
copyrightYearOne !== year
? `${copyrightYearOne}-${year}`
: copyrightYearOne
}`
let copyright = `<p><h4>Author</h4>© ${copyrightYears} ${parseContributor(
pkg.author
)}</p>`
if (Array.isArray(pkg.contributors) && pkg.contributors.length > 0) {
copyright += "<p><h4>Contributors</h4><ul>"
copyright += pkg.contributors.reduce(
(acc, c) => `${acc}<li>${parseContributor(c)}</li>`,
""
)
copyright += "</ul></p>"
}
copyright += `<p><h4>License</h4>Released under the <a href="./LICENSE">${pkg.license} License</a></p>`
const notice =
"<!-- NOTICE: This file is auto-generated. Do not edit directly. -->"
return src([getPath(paths.readme)])
.pipe(replace("<!--{{NOTICE}}-->", notice))
.pipe(
replace(
"<!--{{SEARCH_ENGINES_COUNT}}-->",
Object.keys(searchEngines).length
)
)
.pipe(replace("<!--{{SEARCH_ENGINES_TABLE}}-->", searchEnginesTable))
.pipe(
replace(
"<!--{{KEYS_MAPS_COUNT}}-->",
Object.values(keys.maps).reduce((acc, m) => acc + m.length, 0)
)
)
.pipe(
replace("<!--{{KEYS_SITES_COUNT}}-->", Object.keys(keys.maps).length)
)
.pipe(replace("<!--{{KEYS_TABLE}}-->", keysTable))
.pipe(replace("<!--{{SCREENSHOTS}}-->", screenshotList))
.pipe(replace("<!--{{COPYRIGHT}}-->", copyright))
.pipe(rename(paths.readmeOut))
.pipe(dest(paths.dirname))
})
)
const getFavicon = async ({ domain, favicon }, timeout = 5000) => {
const ss = favicon
let data
try {
const res = await fetch(ss, { timeout })
if (!res.ok) {
throw new Error(`request to ${ss} failed with code ${res.status}`)
}
data = await res.arrayBuffer()
} catch (e) {
process.stdout.write(`no favicon found for ${ss}: ${e}\n`)
// transparent pixel
data = Buffer.from(
"AAABAAEAAQEAAAEAIAAwAAAAFgAAACgAAAABAAAAAgAAAAEAIAAAAAAABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAAAA==",
"base64"
)
}
return {
domain,
name: `${domain}.ico`,
source: data,
}
}
const getDuckduckgoFaviconUrl = (domain) =>
new URL(`https://icons.duckduckgo.com/ip3/${domain}.ico`)
task(
"favicons",
series("clean-favicons", async () => {
const { searchEngines, keys } = await getSources()
const sites = []
.concat(
Object.entries(searchEngines).map(([, v]) => {
const domain = new URL(v.domain ? `https://${v.domain}` : v.search)
.hostname
return {
domain,
favicon: v.favicon ?? getDuckduckgoFaviconUrl(domain),
}
}),
Object.entries(keys.maps)
.map(([key, maps]) => [key, maps.filter((map) => !map.hide)])
.filter(([key, maps]) => key !== "global" && maps.length > 0)
.map(([key]) => ({
domain: key,
favicon: getDuckduckgoFaviconUrl(
new URL(`https://${key}`).hostname
),
}))
)
.filter((e, i, arr) => i === arr.indexOf(e))
const favicons = (
await Promise.all(sites.map(async (site) => getFavicon(site)))
).filter((e) => e !== undefined)
faviconsManifest = favicons.reduce((acc, e) => {
acc[e.domain] = e.name
return acc
}, {})
const files = [
{
name: paths.faviconsManifest,
source: JSON.stringify(faviconsManifest),
},
...favicons,
]
return file(files).pipe(dest(getPath(paths.favicons)))
})
)
task("docs-full", series("favicons", "docs"))
const build = () =>
src(getSrcPath(paths.sources.entrypoint))
.pipe(webpackStream(webpackConfig, webpack))
.on("error", (err) => {
notify.onError({
title: `Build failure [${pkg.name}]`,
message: `${err.message.split("\n").slice(0, 1)}`,
timeout: 10,
})(err)
throw err
})
.pipe(rename(paths.output))
.pipe(dest(getPath(paths.buildDir)))
.pipe(
notify({
title: `Build success [${pkg.name}]`,
message: "No issues",
timeout: 2,
})
)
task("build", build)
task("build-full", series(parallel("check-priv", "clean"), "build"))
task("dist", parallel("docs-full", "build-full"))
task(
"install",
series("build", () =>
src(getPath(paths.buildDir, paths.output)).pipe(dest(paths.installDir))
)
)
const watch = (g, t) => () =>
gulp.watch(g, { ignoreInitial: false, usePolling: true }, t)
const srcWatchPat = getSrcPath("*.(js|mjs|css)")
task("watch-build", watch(srcWatchPat, series("build")))
task("watch-install", watch(srcWatchPat, series("install")))
task(
"watch-docs",
watch(
[srcWatchPat, getPath(paths.readme), getPath(paths.assets, "**/*")],
series("docs")
)
)
task(
"watch-docs-full",
watch(
[srcWatchPat, getPath(paths.readme), getPath(paths.assets, "**/*")],
series("docs-full")
)
)
task("watch", series("watch-install"))
task("serve-simple", serve)
task("serve-build", parallel("watch-build", "serve-simple"))
task("serve", series("serve-build"))
task("default", series("build"))