-
-
Notifications
You must be signed in to change notification settings - Fork 375
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
1 parent
e448592
commit c7993d7
Showing
8 changed files
with
331 additions
and
19 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,214 @@ | ||
/** | ||
* Copyright 2018 Google LLC | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
* use this file except in compliance with the License. You may obtain a copy of | ||
* the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
* License for the specific language governing permissions and limitations under | ||
* the License. | ||
* | ||
* https://github.com/GoogleChromeLabs/critters/blob/main/packages/critters-webpack-plugin/src/index.js | ||
*/ | ||
|
||
/** | ||
* Critters does not (yet) support `html-webpack-plugin` v5, so we vendor it. | ||
*/ | ||
|
||
const path = require('path'); | ||
const minimatch = require('minimatch'); | ||
const { sources } = require('webpack'); | ||
const Critters = require('critters'); | ||
const HtmlWebpackPlugin = require('html-webpack-plugin'); | ||
|
||
function tap(inst, hook, pluginName, async, callback) { | ||
if (inst.hooks) { | ||
const camel = hook.replace(/-([a-z])/g, (_s, i) => i.toUpperCase()); | ||
inst.hooks[camel][async ? 'tapAsync' : 'tap'](pluginName, callback); | ||
} else { | ||
inst.plugin(hook, callback); | ||
} | ||
} | ||
|
||
// Used to annotate this plugin's hooks in Tappable invocations | ||
const PLUGIN_NAME = 'critters-webpack-plugin'; | ||
|
||
/** | ||
* Create a Critters plugin instance with the given options. | ||
* @public | ||
* @param {import('critters').Options} options Options to control how Critters inlines CSS. See https://github.com/GoogleChromeLabs/critters#usage | ||
* @example | ||
* // webpack.config.js | ||
* module.exports = { | ||
* plugins: [ | ||
* new Critters({ | ||
* // Outputs: <link rel="preload" onload="this.rel='stylesheet'"> | ||
* preload: 'swap', | ||
* | ||
* // Don't inline critical font-face rules, but preload the font URLs: | ||
* preloadFonts: true | ||
* }) | ||
* ] | ||
* } | ||
*/ | ||
module.exports = class CrittersWebpackPlugin extends Critters { | ||
/** | ||
* @param {import('critters').Options} options | ||
*/ | ||
constructor(options) { | ||
super(options); | ||
} | ||
|
||
/** | ||
* Invoked by Webpack during plugin initialization | ||
*/ | ||
apply(compiler) { | ||
// hook into the compiler to get a Compilation instance... | ||
tap(compiler, 'compilation', PLUGIN_NAME, false, compilation => { | ||
this.options.path = compiler.options.output.path; | ||
this.options.publicPath = compiler.options.output.publicPath; | ||
|
||
const handleHtmlPluginData = (htmlPluginData, callback) => { | ||
this.fs = compilation.outputFileSystem; | ||
this.compilation = compilation; | ||
this.process(htmlPluginData.html) | ||
.then(html => { | ||
callback(null, { html }); | ||
}) | ||
.catch(callback); | ||
}; | ||
|
||
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync( | ||
PLUGIN_NAME, | ||
handleHtmlPluginData | ||
); | ||
}); | ||
} | ||
|
||
/** | ||
* Given href, find the corresponding CSS asset | ||
*/ | ||
async getCssAsset(href, style) { | ||
const outputPath = this.options.path; | ||
const publicPath = this.options.publicPath; | ||
|
||
// CHECK - the output path | ||
// path on disk (with output.publicPath removed) | ||
let normalizedPath = href.replace(/^\//, ''); | ||
const pathPrefix = (publicPath || '').replace(/(^\/|\/$)/g, '') + '/'; | ||
if (normalizedPath.indexOf(pathPrefix) === 0) { | ||
normalizedPath = normalizedPath | ||
.substring(pathPrefix.length) | ||
.replace(/^\//, ''); | ||
} | ||
const filename = path.resolve(outputPath, normalizedPath); | ||
|
||
// try to find a matching asset by filename in webpack's output (not yet written to disk) | ||
const relativePath = path | ||
.relative(outputPath, filename) | ||
.replace(/^\.\//, ''); | ||
const asset = this.compilation.assets[relativePath]; // compilation.assets[relativePath]; | ||
|
||
// Attempt to read from assets, falling back to a disk read | ||
let sheet = asset && asset.source(); | ||
|
||
if (!sheet) { | ||
try { | ||
sheet = await this.readFile(this.compilation, filename); | ||
this.logger.warn( | ||
`Stylesheet "${relativePath}" not found in assets, but a file was located on disk.${ | ||
this.options.pruneSource | ||
? ' This means pruneSource will not be applied.' | ||
: '' | ||
}` | ||
); | ||
} catch (e) { | ||
this.logger.warn(`Unable to locate stylesheet: ${relativePath}`); | ||
return; | ||
} | ||
} | ||
|
||
style.$$asset = asset; | ||
style.$$assetName = relativePath; | ||
// style.$$assets = this.compilation.assets; | ||
|
||
return sheet; | ||
} | ||
|
||
checkInlineThreshold(link, style, sheet) { | ||
const inlined = super.checkInlineThreshold(link, style, sheet); | ||
|
||
if (inlined) { | ||
const asset = style.$$asset; | ||
if (asset) { | ||
delete this.compilation.assets[style.$$assetName]; | ||
} else { | ||
this.logger.warn( | ||
` > ${style.$$name} was not found in assets. the resource may still be emitted but will be unreferenced.` | ||
); | ||
} | ||
} | ||
|
||
return inlined; | ||
} | ||
|
||
/** | ||
* Inline the stylesheets from options.additionalStylesheets (assuming it passes `options.filter`) | ||
*/ | ||
async embedAdditionalStylesheet(document) { | ||
const styleSheetsIncluded = []; | ||
(this.options.additionalStylesheets || []).forEach(cssFile => { | ||
if (styleSheetsIncluded.includes(cssFile)) { | ||
return; | ||
} | ||
styleSheetsIncluded.push(cssFile); | ||
const webpackCssAssets = Object.keys(this.compilation.assets).filter( | ||
file => minimatch(file, cssFile) | ||
); | ||
webpackCssAssets.map(asset => { | ||
const style = document.createElement('style'); | ||
style.$$external = true; | ||
style.textContent = this.compilation.assets[asset].source(); | ||
document.head.appendChild(style); | ||
}); | ||
}); | ||
} | ||
|
||
/** | ||
* Prune the source CSS files | ||
*/ | ||
pruneSource(style, before, sheetInverse) { | ||
const isStyleInlined = super.pruneSource(style, before, sheetInverse); | ||
const asset = style.$$asset; | ||
const name = style.$$name; | ||
|
||
if (asset) { | ||
// if external stylesheet would be below minimum size, just inline everything | ||
const minSize = this.options.minimumExternalSize; | ||
if (minSize && sheetInverse.length < minSize) { | ||
// delete the webpack asset: | ||
delete this.compilation.assets[style.$$assetName]; | ||
return true; | ||
} | ||
this.compilation.assets[style.$$assetName] = | ||
new sources.LineToLineMappedSource( | ||
sheetInverse, | ||
style.$$assetName, | ||
before | ||
); | ||
} else { | ||
this.logger.warn( | ||
'pruneSource is enabled, but a style (' + | ||
name + | ||
') has no corresponding Webpack asset.' | ||
); | ||
} | ||
|
||
return isStyleInlined; | ||
} | ||
}; |
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.