mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-26 04:57:50 +02:00
refactor(v2): precompile ETA templates (#3238)
* compile ETA templates ahead of time * handle PR review
This commit is contained in:
parent
51f07608fa
commit
d17df954b5
3 changed files with 50 additions and 22 deletions
|
@ -7,15 +7,25 @@
|
||||||
|
|
||||||
import * as eta from 'eta';
|
import * as eta from 'eta';
|
||||||
import redirectPageTemplate from './templates/redirectPage.template.html';
|
import redirectPageTemplate from './templates/redirectPage.template.html';
|
||||||
|
import {memoize} from 'lodash';
|
||||||
|
|
||||||
type CreateRedirectPageOptions = {
|
type CreateRedirectPageOptions = {
|
||||||
toUrl: string;
|
toUrl: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const getCompiledRedirectPageTemplate = memoize(() => {
|
||||||
|
return eta.compile(redirectPageTemplate.trim());
|
||||||
|
});
|
||||||
|
|
||||||
|
function renderRedirectPageTemplate(data: object) {
|
||||||
|
const compiled = getCompiledRedirectPageTemplate();
|
||||||
|
return compiled(data, eta.defaultConfig);
|
||||||
|
}
|
||||||
|
|
||||||
export default function createRedirectPageContent({
|
export default function createRedirectPageContent({
|
||||||
toUrl,
|
toUrl,
|
||||||
}: CreateRedirectPageOptions) {
|
}: CreateRedirectPageOptions) {
|
||||||
return eta.render(redirectPageTemplate.trim(), {
|
return renderRedirectPageTemplate({
|
||||||
toUrl: encodeURI(toUrl),
|
toUrl: encodeURI(toUrl),
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
|
@ -11,6 +11,16 @@ const eta = require('eta');
|
||||||
const {normalizeUrl} = require('@docusaurus/utils');
|
const {normalizeUrl} = require('@docusaurus/utils');
|
||||||
const openSearchTemplate = require('./templates/opensearch');
|
const openSearchTemplate = require('./templates/opensearch');
|
||||||
const {validateThemeConfig} = require('./validateThemeConfig');
|
const {validateThemeConfig} = require('./validateThemeConfig');
|
||||||
|
const {memoize} = require('lodash');
|
||||||
|
|
||||||
|
const getCompiledOpenSearchTemplate = memoize(() => {
|
||||||
|
return eta.compile(openSearchTemplate.trim());
|
||||||
|
});
|
||||||
|
|
||||||
|
function renderOpenSearchTemplate(data) {
|
||||||
|
const compiled = getCompiledOpenSearchTemplate();
|
||||||
|
return compiled(data, eta.defaultConfig);
|
||||||
|
}
|
||||||
|
|
||||||
const OPEN_SEARCH_FILENAME = 'opensearch.xml';
|
const OPEN_SEARCH_FILENAME = 'opensearch.xml';
|
||||||
|
|
||||||
|
@ -44,13 +54,14 @@ function theme(context) {
|
||||||
try {
|
try {
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
path.join(outDir, OPEN_SEARCH_FILENAME),
|
path.join(outDir, OPEN_SEARCH_FILENAME),
|
||||||
eta.render(openSearchTemplate.trim(), {
|
renderOpenSearchTemplate({
|
||||||
title,
|
title,
|
||||||
url,
|
url,
|
||||||
favicon: normalizeUrl([url, favicon]),
|
favicon: normalizeUrl([url, favicon]),
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
throw new Error(`Generating OpenSearch file failed: ${err}`);
|
throw new Error(`Generating OpenSearch file failed: ${err}`);
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
|
@ -28,6 +28,20 @@ import {
|
||||||
} from './LinksCollector';
|
} from './LinksCollector';
|
||||||
import ssrTemplate from './templates/ssr.html.template';
|
import ssrTemplate from './templates/ssr.html.template';
|
||||||
|
|
||||||
|
// eslint-disable-next-line no-restricted-imports
|
||||||
|
import {memoize} from 'lodash';
|
||||||
|
|
||||||
|
const getCompiledSSRTemplate = memoize(() => {
|
||||||
|
return eta.compile(ssrTemplate.trim(), {
|
||||||
|
rmWhitespace: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
function renderSSRTemplate(data) {
|
||||||
|
const compiled = getCompiledSSRTemplate();
|
||||||
|
return compiled(data, eta.defaultConfig);
|
||||||
|
}
|
||||||
|
|
||||||
// Renderer for static-site-generator-webpack-plugin (async rendering via promises).
|
// Renderer for static-site-generator-webpack-plugin (async rendering via promises).
|
||||||
export default async function render(locals) {
|
export default async function render(locals) {
|
||||||
const {
|
const {
|
||||||
|
@ -76,9 +90,7 @@ export default async function render(locals) {
|
||||||
const stylesheets = (bundles.css || []).map((b) => b.file);
|
const stylesheets = (bundles.css || []).map((b) => b.file);
|
||||||
const scripts = (bundles.js || []).map((b) => b.file);
|
const scripts = (bundles.js || []).map((b) => b.file);
|
||||||
|
|
||||||
const renderedHtml = eta.render(
|
const renderedHtml = renderSSRTemplate({
|
||||||
ssrTemplate.trim(),
|
|
||||||
{
|
|
||||||
appHtml,
|
appHtml,
|
||||||
baseUrl,
|
baseUrl,
|
||||||
htmlAttributes: htmlAttributes || '',
|
htmlAttributes: htmlAttributes || '',
|
||||||
|
@ -90,12 +102,7 @@ export default async function render(locals) {
|
||||||
scripts,
|
scripts,
|
||||||
stylesheets,
|
stylesheets,
|
||||||
version: packageJson.version,
|
version: packageJson.version,
|
||||||
},
|
});
|
||||||
{
|
|
||||||
name: 'ssr-template',
|
|
||||||
rmWhitespace: true,
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
// Minify html with https://github.com/DanielRuf/html-minifier-terser
|
// Minify html with https://github.com/DanielRuf/html-minifier-terser
|
||||||
return minify(renderedHtml, {
|
return minify(renderedHtml, {
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue