-
Notifications
You must be signed in to change notification settings - Fork 332
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Load templates via plugin * Refactor assets build script * Remove [watch] log prefix * Remove unneeded npx prefixes in package scripts
- Loading branch information
1 parent
cb937ca
commit 8c763fa
Showing
17 changed files
with
110 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,155 +1,89 @@ | ||
| const path = require('node:path') | ||
| const process = require('node:process') | ||
| const child_process = require('node:child_process') | ||
| const cp = require('node:child_process') | ||
| const esbuild = require('esbuild') | ||
| const util = require('./utilities') | ||
|
|
||
| const watchMode = Boolean(process.env.npm_config_watch) | ||
|
|
||
|
|
||
| /** | ||
| * Configuration variables | ||
| */ | ||
|
|
||
| // Basic build configuration and values | ||
| const commonOptions = { | ||
| entryNames: '[name]-[hash]', | ||
| bundle: true, | ||
| minify: true, | ||
| logLevel: watchMode ? 'warning' : 'info', | ||
| } | ||
| const epubOutDir = path.resolve('../formatters/epub/dist') | ||
| const htmlOutDir = path.resolve('../formatters/html/dist') | ||
|
|
||
| // Handlebars template paths | ||
| const templates = { | ||
| sourceDir: path.resolve('js/handlebars/templates'), | ||
| compiledDir: path.resolve('../tmp/handlebars'), | ||
| filename: 'handlebars.templates.js', | ||
| } | ||
| templates.compiledPath = path.join(templates.compiledDir, templates.filename) | ||
|
|
||
|
|
||
| /** | ||
| * Build: Plugins | ||
| */ | ||
|
|
||
| // Empty outdir directories before both normal and watch-mode builds | ||
| const epubOnStartPlugin = { | ||
| name: 'epubOnStart', | ||
| setup(build) { build.onStart(() => util.ensureEmptyDirsExistSync([epubOutDir])) }, | ||
| } | ||
| const htmlOnStartPlugin = { | ||
| name: 'htmlOnStart', | ||
| setup(build) { build.onStart(() => util.ensureEmptyDirsExistSync([htmlOutDir])) }, | ||
| } | ||
| const fsExtra = require('fs-extra') | ||
| const fs = require('node:fs/promises') | ||
| const handlebars = require('handlebars') | ||
| const util = require('node:util') | ||
|
|
||
| const exec = util.promisify(cp.exec) | ||
|
|
||
| /** | ||
| * Build | ||
| */ | ||
|
|
||
| // ePub: esbuild options | ||
| const epubBuildOptions = { | ||
| ...commonOptions, | ||
| outdir: epubOutDir, | ||
| plugins: [epubOnStartPlugin], | ||
| entryPoints: [ | ||
| 'js/entry/epub.js', | ||
| 'css/entry/epub-elixir.css', | ||
| 'css/entry/epub-erlang.css', | ||
| ], | ||
| } | ||
|
|
||
| // ePub: esbuild (conditionally configuring watch mode and rebuilding of docs) | ||
| if (!watchMode) { | ||
| esbuild.build(epubBuildOptions).catch(() => process.exit(1)) | ||
| } else { | ||
| esbuild.build({ | ||
| ...epubBuildOptions, | ||
| watch: { | ||
| onRebuild(error, result) { | ||
| if (error) { | ||
| console.error('[watch] epub build failed:', error) | ||
| } else { | ||
| console.log('[watch] epub assets rebuilt') | ||
| if (result.errors.length > 0) console.log('[watch] epub build errors:', result.errors) | ||
| if (result.warnings.length > 0) console.log('[watch] epub build warnings:', result.warnings) | ||
| generateDocs("epub") | ||
| } | ||
| }, | ||
| }, | ||
| }).then(() => generateDocs("epub")).catch(() => process.exit(1)) | ||
| } | ||
|
|
||
| // HTML: Precompile Handlebars templates | ||
| util.runShellCmdSync(`npx handlebars ${templates.sourceDir} --output ${templates.compiledPath}`) | ||
| const watchMode = Boolean(process.env.npm_config_watch) | ||
|
|
||
| // HTML: esbuild options | ||
| const htmlBuildOptions = { | ||
| ...commonOptions, | ||
| outdir: htmlOutDir, | ||
| plugins: [htmlOnStartPlugin], | ||
| entryPoints: [ | ||
| templates.compiledPath, | ||
| 'js/entry/html.js', | ||
| 'css/entry/html-elixir.css', | ||
| 'css/entry/html-erlang.css', | ||
| ], | ||
| loader: { | ||
| '.woff2': 'file', | ||
| // TODO: Remove when @fontsource/* removes legacy .woff | ||
| '.woff': 'file', | ||
| /** @type {import('esbuild').BuildOptions[]} */ | ||
| const formatters = [ | ||
| { | ||
| formatter: 'epub', | ||
| outdir: path.resolve('../formatters/epub/dist'), | ||
| entryPoints: [ | ||
| 'js/entry/epub.js', | ||
| 'css/entry/epub-elixir.css', | ||
| 'css/entry/epub-erlang.css' | ||
| ] | ||
| }, | ||
| } | ||
|
|
||
| // HTML: esbuild (conditionally configuring watch mode and rebuilding of docs) | ||
| if (!watchMode) { | ||
| esbuild.build(htmlBuildOptions).then(() => buildTemplatesRuntime()).catch(() => process.exit(1)) | ||
| } else { | ||
| esbuild.build({ | ||
| ...htmlBuildOptions, | ||
| watch: { | ||
| onRebuild(error, result) { | ||
| if (error) { | ||
| console.error('[watch] html build failed:', error) | ||
| } else { | ||
| console.log('[watch] html assets rebuilt') | ||
| if (result.errors.length > 0) console.log('[watch] html build errors:', result.errors) | ||
| if (result.warnings.length > 0) console.log('[watch] html build warnings:', result.warnings) | ||
| buildTemplatesRuntime() | ||
| generateDocs("html") | ||
| { | ||
| formatter: 'html', | ||
| outdir: path.resolve('../formatters/html/dist'), | ||
| entryPoints: [ | ||
| 'js/entry/html.js', | ||
| 'css/entry/html-elixir.css', | ||
| 'css/entry/html-erlang.css' | ||
| ], | ||
| loader: { | ||
| '.woff2': 'file', | ||
| // TODO: Remove when @fontsource/* removes legacy .woff | ||
| '.woff': 'file' | ||
| } | ||
| } | ||
| ] | ||
|
|
||
| Promise.all(formatters.map(async ({formatter, ...options}) => { | ||
| // Clean outdir. | ||
| await fsExtra.emptyDir(options.outdir) | ||
|
|
||
| await esbuild.build({ | ||
| entryNames: watchMode ? '[name]-dev' : '[name]-[hash]', | ||
| bundle: true, | ||
| minify: !watchMode, | ||
| logLevel: watchMode ? 'warning' : 'info', | ||
| watch: watchMode, | ||
| ...options, | ||
| plugins: [{ | ||
| name: 'ex_doc', | ||
| setup (build) { | ||
| // Pre-compile handlebars templates. | ||
| build.onLoad({ | ||
| filter: /\.handlebars$/ | ||
| }, async ({ path: filename }) => { | ||
| try { | ||
| const source = await fs.readFile(filename, 'utf-8') | ||
| const template = handlebars.precompile(source) | ||
| const contents = [ | ||
| "import * as Handlebars from 'handlebars/runtime'", | ||
| "import '../helpers'", | ||
| `export default Handlebars.template(${template})` | ||
| ].join('\n') | ||
| return { contents } | ||
| } catch (error) { | ||
| return { errors: [{ text: error.message }] } | ||
| } | ||
| }) | ||
|
|
||
| // Generate docs with new assets (watch mode only). | ||
| if (watchMode) { | ||
| build.onEnd(async result => { | ||
| if (result.errors.length) return | ||
| console.log(`${formatter} assets built`) | ||
| await exec('mix compile --force', {cwd: '../'}) | ||
| await exec(`mix docs --formatter ${formatter}`, {cwd: '../'}) | ||
| console.log(`${formatter} docs built`) | ||
| }) | ||
| } | ||
| }, | ||
| }, | ||
| }).then(() => { | ||
| buildTemplatesRuntime() | ||
| generateDocs("html") | ||
| }).catch(() => process.exit(1)) | ||
| } | ||
|
|
||
| /** | ||
| * Functions | ||
| */ | ||
|
|
||
| // HTML: Handlebars runtime | ||
| // The Handlebars runtime from the local module dist directory is used to ensure | ||
| // the version matches that which was used to compile the templates. | ||
| // 'bundle' must be false in order for 'Handlebar' to be available at runtime. | ||
| function buildTemplatesRuntime() { | ||
| esbuild.build({ | ||
| ...commonOptions, | ||
| outdir: htmlOutDir, | ||
| entryPoints: ['node_modules/handlebars/dist/handlebars.runtime.js'], | ||
| bundle: false, | ||
| }).catch(() => process.exit(1)) | ||
| } | ||
|
|
||
| // Docs generation (used in watch mode only) | ||
| function generateDocs(formatter) { | ||
| console.log(`Building ${formatter} docs`) | ||
| process.chdir('../') | ||
| child_process.execSync('mix compile --force') | ||
| child_process.execSync(`mix docs --formatter ${formatter}`) | ||
| process.chdir('./assets/') | ||
| } | ||
| } | ||
| }] | ||
| }) | ||
| })).catch((error) => { | ||
| console.error(error) | ||
| process.exit(1) | ||
| }) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.