-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(core): faster HTML minimizer - `siteConfig.future.experimental_f…
…aster.swcHtmlMinimizer` (#10554)
- Loading branch information
Showing
16 changed files
with
416 additions
and
102 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
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 |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import logger from '@docusaurus/logger'; | ||
| import {minify as terserHtmlMinifier} from 'html-minifier-terser'; | ||
| import {importSwcHtmlMinifier} from './importFaster'; | ||
| import type {DocusaurusConfig} from '@docusaurus/types'; | ||
|
|
||
| // Historical env variable | ||
| const SkipHtmlMinification = process.env.SKIP_HTML_MINIFICATION === 'true'; | ||
|
|
||
| export type HtmlMinifier = { | ||
| minify: (html: string) => Promise<string>; | ||
| }; | ||
|
|
||
| const NoopMinifier: HtmlMinifier = { | ||
| minify: async (html: string) => html, | ||
| }; | ||
|
|
||
| type SiteConfigSlice = { | ||
| future: { | ||
| experimental_faster: Pick< | ||
| DocusaurusConfig['future']['experimental_faster'], | ||
| 'swcHtmlMinimizer' | ||
| >; | ||
| }; | ||
| }; | ||
|
|
||
| export async function getHtmlMinifier({ | ||
| siteConfig, | ||
| }: { | ||
| siteConfig: SiteConfigSlice; | ||
| }): Promise<HtmlMinifier> { | ||
| if (SkipHtmlMinification) { | ||
| return NoopMinifier; | ||
| } | ||
| if (siteConfig.future.experimental_faster.swcHtmlMinimizer) { | ||
| return getSwcMinifier(); | ||
| } else { | ||
| return getTerserMinifier(); | ||
| } | ||
| } | ||
|
|
||
| // Minify html with https://github.com/DanielRuf/html-minifier-terser | ||
| async function getTerserMinifier(): Promise<HtmlMinifier> { | ||
| return { | ||
| minify: async function minifyHtmlWithTerser(html) { | ||
| try { | ||
| return await terserHtmlMinifier(html, { | ||
| removeComments: false, | ||
| removeRedundantAttributes: true, | ||
| removeEmptyAttributes: true, | ||
| removeScriptTypeAttributes: true, | ||
| removeStyleLinkTypeAttributes: true, | ||
| useShortDoctype: true, | ||
| minifyJS: true, | ||
| }); | ||
| } catch (err) { | ||
| throw new Error(`HTML minification failed (Terser)`, { | ||
| cause: err as Error, | ||
| }); | ||
| } | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| // Minify html with @swc/html | ||
| // Not well-documented but fast! | ||
| // See https://github.com/swc-project/swc/discussions/9616 | ||
| async function getSwcMinifier(): Promise<HtmlMinifier> { | ||
| const swcHtmlMinifier = await importSwcHtmlMinifier(); | ||
| return { | ||
| minify: async function minifyHtmlWithSwc(html) { | ||
| try { | ||
| const result = await swcHtmlMinifier(Buffer.from(html), { | ||
| // Removing comments can lead to React hydration errors | ||
| // See https://x.com/sebastienlorber/status/1841966927440478577 | ||
| removeComments: false, | ||
| // TODO maybe it's fine to only keep <!-- --> React comments? | ||
| preserveComments: [], | ||
|
|
||
| // Sorting these attributes (class) can lead to React hydration errors | ||
| sortSpaceSeparatedAttributeValues: false, | ||
| sortAttributes: false, | ||
|
|
||
| // @ts-expect-error: bad type https://github.com/swc-project/swc/pull/9615 | ||
| removeRedundantAttributes: 'all', | ||
| removeEmptyAttributes: true, | ||
| minifyJs: true, | ||
| minifyJson: true, | ||
| minifyCss: true, | ||
| }); | ||
|
|
||
| // Escape hatch because SWC is quite aggressive to report errors | ||
| // TODO figure out what to do with these errors: throw or swallow? | ||
| // See https://github.com/facebook/docusaurus/pull/10554 | ||
| // See https://github.com/swc-project/swc/discussions/9616#discussioncomment-10846201 | ||
| const ignoreSwcMinifierErrors = | ||
| process.env.DOCUSAURUS_IGNORE_SWC_HTML_MINIFIER_ERRORS === 'true'; | ||
| if (!ignoreSwcMinifierErrors && result.errors) { | ||
| const ignoredErrors: string[] = [ | ||
| // TODO Docusaurus seems to emit NULL chars, and minifier detects it | ||
| // see https://github.com/facebook/docusaurus/issues/9985 | ||
| 'Unexpected null character', | ||
| ]; | ||
| result.errors = result.errors.filter( | ||
| (diagnostic) => !ignoredErrors.includes(diagnostic.message), | ||
| ); | ||
| if (result.errors.length) { | ||
| throw new Error( | ||
| `HTML minification diagnostic errors: | ||
| - ${result.errors | ||
| .map( | ||
| (diagnostic) => | ||
| `[${diagnostic.level}] ${ | ||
| diagnostic.message | ||
| } - ${JSON.stringify(diagnostic.span)}`, | ||
| ) | ||
| .join('\n- ')} | ||
| Note: please report the problem to the Docusaurus team | ||
| In the meantime, you can skip this error with ${logger.code( | ||
| 'DOCUSAURUS_IGNORE_SWC_HTML_MINIFIER_ERRORS=true', | ||
| )}`, | ||
| ); | ||
| } | ||
| /* | ||
| if (result.errors.length) { | ||
| throw new AggregateError( | ||
| result.errors.map( | ||
| (diagnostic) => new Error(JSON.stringify(diagnostic, null, 2)), | ||
| ), | ||
| ); | ||
| } | ||
| */ | ||
| } | ||
| return result.code; | ||
| } catch (err) { | ||
| throw new Error(`HTML minification failed (SWC)`, { | ||
| cause: err as Error, | ||
| }); | ||
| } | ||
| }, | ||
| }; | ||
| } |
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.