Skip to content

Commit 7d5b559

Browse files
alexander-akaitalexander-akait
authored
docs: update (#1841)
1 parent b548944 commit 7d5b559

File tree

3 files changed

+24
-23
lines changed

3 files changed

+24
-23
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ class MyPlugin {
581581
console.log('The compiler is starting a new compilation...')
582582

583583
// Static Plugin interface |compilation |HOOK NAME | register listener
584-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync(
584+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync(
585585
'MyPlugin', // <-- Set a meaningful name here for stacktraces
586586
(data, cb) => {
587587
// Manipulate the content

‎spec/basic.spec.js‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,7 +1151,7 @@ describe('HtmlWebpackPlugin', () => {
11511151
const examplePlugin = {
11521152
apply: function (compiler) {
11531153
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1154-
HtmlWebpackPlugin.getHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1154+
HtmlWebpackPlugin.getCompilationHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
11551155
expect(Object.keys(object.assetTags)).toEqual(['scripts', 'styles', 'meta']);
11561156
eventFired = true;
11571157
callback();
@@ -1185,7 +1185,7 @@ describe('HtmlWebpackPlugin', () => {
11851185
const examplePlugin = {
11861186
apply: function (compiler) {
11871187
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1188-
HtmlWebpackPlugin.getHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
1188+
HtmlWebpackPlugin.getCompilationHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
11891189
pluginArgs.assetTags.scripts = pluginArgs.assetTags.scripts.map(tag => {
11901190
if (tag.tagName === 'script') {
11911191
tag.attributes.specialAttribute = true;
@@ -1219,7 +1219,7 @@ describe('HtmlWebpackPlugin', () => {
12191219
const examplePlugin = {
12201220
apply: function (compiler) {
12211221
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1222-
HtmlWebpackPlugin.getHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
1222+
HtmlWebpackPlugin.getCompilationHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
12231223
pluginArgs.assetTags.scripts = pluginArgs.assetTags.scripts.map(tag => {
12241224
if (tag.tagName === 'script') {
12251225
tag.attributes.async = false;
@@ -1253,7 +1253,7 @@ describe('HtmlWebpackPlugin', () => {
12531253
const examplePlugin = {
12541254
apply: function (compiler) {
12551255
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1256-
HtmlWebpackPlugin.getHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
1256+
HtmlWebpackPlugin.getCompilationHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
12571257
pluginArgs.assetTags.scripts = pluginArgs.assetTags.scripts.map(tag => {
12581258
if (tag.tagName === 'script') {
12591259
tag.attributes.async = null;
@@ -1287,7 +1287,7 @@ describe('HtmlWebpackPlugin', () => {
12871287
const examplePlugin = {
12881288
apply: function (compiler) {
12891289
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1290-
HtmlWebpackPlugin.getHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
1290+
HtmlWebpackPlugin.getCompilationHooks(compilation).alterAssetTags.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
12911291
pluginArgs.assetTags.scripts = pluginArgs.assetTags.scripts.map(tag => {
12921292
if (tag.tagName === 'script') {
12931293
tag.attributes.async = undefined;
@@ -1322,7 +1322,7 @@ describe('HtmlWebpackPlugin', () => {
13221322
const examplePlugin = {
13231323
apply: function (compiler) {
13241324
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1325-
HtmlWebpackPlugin.getHooks(compilation).afterEmit.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
1325+
HtmlWebpackPlugin.getCompilationHooks(compilation).afterEmit.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
13261326
eventArgs = pluginArgs;
13271327
callback(null, pluginArgs);
13281328
});
@@ -1357,7 +1357,7 @@ describe('HtmlWebpackPlugin', () => {
13571357
const examplePlugin = {
13581358
apply: function (compiler) {
13591359
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1360-
HtmlWebpackPlugin.getHooks(compilation).afterEmit.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
1360+
HtmlWebpackPlugin.getCompilationHooks(compilation).afterEmit.tapAsync('HtmlWebpackPluginTest', (pluginArgs, callback) => {
13611361
eventArgs = pluginArgs;
13621362
callback(null, pluginArgs);
13631363
});
@@ -1390,7 +1390,7 @@ describe('HtmlWebpackPlugin', () => {
13901390
const examplePlugin = {
13911391
apply: function (compiler) {
13921392
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1393-
HtmlWebpackPlugin.getHooks(compilation).afterTemplateExecution.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1393+
HtmlWebpackPlugin.getCompilationHooks(compilation).afterTemplateExecution.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
13941394
eventFired = true;
13951395
callback();
13961396
});
@@ -1424,7 +1424,7 @@ describe('HtmlWebpackPlugin', () => {
14241424
const examplePlugin = {
14251425
apply: function (compiler) {
14261426
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1427-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1427+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
14281428
eventFired = true;
14291429
callback();
14301430
});
@@ -1457,7 +1457,7 @@ describe('HtmlWebpackPlugin', () => {
14571457
const examplePlugin = {
14581458
apply: function (compiler) {
14591459
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1460-
HtmlWebpackPlugin.getHooks(compilation).afterEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1460+
HtmlWebpackPlugin.getCompilationHooks(compilation).afterEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
14611461
eventFired = true;
14621462
callback();
14631463
});
@@ -1488,7 +1488,7 @@ describe('HtmlWebpackPlugin', () => {
14881488
const examplePlugin = {
14891489
apply: function (compiler) {
14901490
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1491-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1491+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
14921492
eventFired = true;
14931493
object.html += 'Injected by plugin';
14941494
callback();
@@ -1523,7 +1523,7 @@ describe('HtmlWebpackPlugin', () => {
15231523
const examplePlugin = {
15241524
apply: function (compiler) {
15251525
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1526-
hookNames = Object.keys(HtmlWebpackPlugin.getHooks(compilation)).sort();
1526+
hookNames = Object.keys(HtmlWebpackPlugin.getCompilationHooks(compilation)).sort();
15271527
});
15281528
}
15291529
};
@@ -1561,7 +1561,7 @@ describe('HtmlWebpackPlugin', () => {
15611561
const examplePlugin = {
15621562
apply: function (compiler) {
15631563
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1564-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1564+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
15651565
eventFiredForFirstPlugin = true;
15661566
object.html += 'Injected by first plugin';
15671567
callback(null, object);
@@ -1572,7 +1572,7 @@ describe('HtmlWebpackPlugin', () => {
15721572
const secondExamplePlugin = {
15731573
apply: function (compiler) {
15741574
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1575-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1575+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
15761576
eventFiredForSecondPlugin = true;
15771577
object.html += ' Injected by second plugin';
15781578
callback(null);
@@ -1610,7 +1610,7 @@ describe('HtmlWebpackPlugin', () => {
16101610
const examplePlugin = {
16111611
apply: function (compiler) {
16121612
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1613-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1613+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
16141614
eventFiredForFirstPlugin = true;
16151615
const result = _.extend(object, {
16161616
html: object.html + 'Injected by first plugin'
@@ -1623,7 +1623,7 @@ describe('HtmlWebpackPlugin', () => {
16231623
const secondExamplePlugin = {
16241624
apply: function (compiler) {
16251625
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1626-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1626+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
16271627
eventFiredForSecondPlugin = true;
16281628
object.html += ' Injected by second plugin';
16291629
callback(null);
@@ -1661,7 +1661,7 @@ describe('HtmlWebpackPlugin', () => {
16611661
const examplePlugin = {
16621662
apply: function (compiler) {
16631663
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1664-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1664+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
16651665
eventFiredForFirstPlugin = true;
16661666
const result = _.extend(object, {
16671667
html: object.html + 'Injected by first plugin'
@@ -1674,7 +1674,7 @@ describe('HtmlWebpackPlugin', () => {
16741674
const secondExamplePlugin = {
16751675
apply: function (compiler) {
16761676
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1677-
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1677+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeEmit.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
16781678
eventFiredForSecondPlugin = true;
16791679
const result = _.extend(object, {
16801680
html: object.html + ' Injected by second plugin'
@@ -1711,7 +1711,7 @@ describe('HtmlWebpackPlugin', () => {
17111711
const examplePlugin = {
17121712
apply: function (compiler) {
17131713
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1714-
HtmlWebpackPlugin.getHooks(compilation).afterTemplateExecution.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1714+
HtmlWebpackPlugin.getCompilationHooks(compilation).afterTemplateExecution.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
17151715
eventFired = true;
17161716
object.bodyTags.push(HtmlWebpackPlugin.createHtmlTagObject('script', { src: 'funky-script.js' }));
17171717
object.html += 'Injected by plugin';
@@ -1747,7 +1747,7 @@ describe('HtmlWebpackPlugin', () => {
17471747
const examplePlugin = {
17481748
apply: function (compiler) {
17491749
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1750-
HtmlWebpackPlugin.getHooks(compilation).beforeAssetTagGeneration.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1750+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeAssetTagGeneration.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
17511751
eventFired = true;
17521752
object.assets.js.push('funky-script.js');
17531753
callback();
@@ -1782,7 +1782,7 @@ describe('HtmlWebpackPlugin', () => {
17821782
const examplePlugin = {
17831783
apply: function (compiler) {
17841784
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1785-
HtmlWebpackPlugin.getHooks(compilation).beforeAssetTagGeneration.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
1785+
HtmlWebpackPlugin.getCompilationHooks(compilation).beforeAssetTagGeneration.tapAsync('HtmlWebpackPluginTest', (object, callback) => {
17861786
eventFired = true;
17871787
object.assets.js.push('funky-script.js');
17881788
callback();
@@ -1823,7 +1823,7 @@ describe('HtmlWebpackPlugin', () => {
18231823
const examplePlugin = {
18241824
apply: function (compiler) {
18251825
compiler.hooks.compilation.tap('HtmlWebpackPlugin', compilation => {
1826-
const hooks = HtmlWebpackPlugin.getHooks(compilation);
1826+
const hooks = HtmlWebpackPlugin.getCompilationHooks(compilation);
18271827
hookLength = hooks.length;
18281828
// Hook into all hooks
18291829
Object.keys(hooks).forEach((hookName) => {

‎typings.d.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ declare class HtmlWebpackPlugin {
2020
apply(compiler: Compiler): void;
2121

2222
static getHooks(compilation: Compilation): HtmlWebpackPlugin.Hooks;
23+
static getCompilationHooks(compilation: Compilation): HtmlWebpackPlugin.Hooks;
2324

2425
/**
2526
* Static helper to create a tag object to be get injected into the dom

0 commit comments

Comments
 (0)