Skip to content

Commit aabf2d3

Browse files
author
Mike Evans
committed
Add end of life message to README.md
1 parent e8a36fe commit aabf2d3

File tree

2 files changed

+35
-7
lines changed

2 files changed

+35
-7
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,29 @@ Script Extension for HTML Webpack Plugin
44

55
[![NPM](https://nodei.co/npm/script-ext-html-webpack-plugin.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/script-ext-html-webpack-plugin/)
66

7-
7+
Deprecation Warning
8+
-------------------
9+
**tl;dr**
10+
This project is no longer maintained. It does not support Webpack 5.
11+
12+
**A bit more detail**
13+
Any look at the [project activity](https://github.com/numical/script-ext-html-webpack-plugin/pulse) will show that I have not been able to maintain this project adequately.
14+
The advent of version 5 of Webpack requires another bout of refactoring that I simply have no time for.
15+
Consequently v2.15.0 will be the last version of this plugin.
16+
My thanks to all users, and especially to all contributors, of this plugin over the years.
17+
My apologies to all those whose webpack 5 migration has been made more complicated by this decision.
18+
19+
**But I still want to use the plugin...**
20+
Feel free!
21+
My last update works with versions of v4.44.2 of webpack and v4.5.0 of html-webpack-plugin.
22+
Forkers feel free! That's what the licence is for.
23+
In fact, if you fork with an intention to support on-going development, let me know!
24+
I'll happily link to your repository here and offer some tips (main one: ditch backward compatibility - it's a pain).
25+
I will formally archive this repository at the end of the 2020.
26+
27+
28+
Summary
29+
-------
830
Enhances [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin)
931
functionality with different deployment options for your scripts including:
1032
- [`async`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#Attributes) attribute;
@@ -27,13 +49,13 @@ Installation
2749
You must be running webpack (1.x, 2.x, 3.x, 4.x) on node 6+.
2850
Install the plugin with npm:
2951
```shell
30-
$ npm install script-ext-html-webpack-plugin
52+
$ npm install --save-dev script-ext-html-webpack-plugin
3153
```
3254
Not that you will need v3.0.6+ or v4.x of [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin)
3355

3456
For those requiring earlier versions of node, please use the [last 1.x version](https://github.com/numical/script-ext-html-webpack-plugin/tree/v1.8.8) of this plugin. However please note this does not have webpack 4.x support:
3557
```shell
36-
$ npm install script-ext-html-webpack-plugin@1.8.8
58+
$ npm install --save-dev script-ext-html-webpack-plugin@1.8.8
3759
```
3860

3961
You may see an `UNMET PEER DEPENDENCY` warnings for webpack and various plugins.
@@ -135,7 +157,7 @@ All scripts with 'important' in their name are sync and all others set to `defer
135157
plugins: [
136158
new HtmlWebpackPlugin(),
137159
new ScriptExtHtmlWebpackPlugin({
138-
sync: 'important'
160+
sync: 'important',
139161
defaultAttribute: 'defer'
140162
})
141163
]
@@ -184,7 +206,7 @@ plugins: [
184206
test: /\.js$/,
185207
attribute: 'crossorigin',
186208
value: 'anonymous'
187-
}
209+
},
188210
preload: {
189211
test: /\.js$/
190212
}
@@ -197,7 +219,7 @@ All asynchronous scripts are added as `preload` resource hints. All other scrip
197219
plugins: [
198220
new HtmlWebpackPlugin(),
199221
new ScriptExtHtmlWebpackPlugin({
200-
async: /\.js$/
222+
async: /\.js$/,
201223
preload: {
202224
test: /\.js$/,
203225
chunks: 'async'
@@ -311,6 +333,12 @@ Notes:
311333
Change History
312334
--------------
313335

336+
v2.1.5
337+
* end of life version
338+
* updated all dependencies
339+
* fixes some tests to accomodate change in html-webpack-plugin output
340+
* added end-of-life section to README.
341+
314342
v2.1.x
315343
* support for changes in html-webpack-plugin 4.x since alpha and beta
316344
* custom attributes now added to resource hints too (see [pull request 53](https://github.com/numical/script-ext-html-webpack-plugin/pull/53) for discussion)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "script-ext-html-webpack-plugin",
3-
"version": "2.1.4",
3+
"version": "2.1.5",
44
"description": "Enhances html-webpack-plugin functionality with async and defer attributes for script elements",
55
"main": "index.js",
66
"files": [

0 commit comments

Comments
 (0)