Add typescript (#18)

Signed-off-by: David <4661784+retyui@users.noreply.github.com>

Author: retyui

.eslintrc.js

@@ -10,6 +10,9 @@ on:
 jobs:
   test_and_lint:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [10, 12, 14, 16]
     steps:
       - uses: actions/checkout@v2
 

.github/workflows/nodejs.yml

@@ -2,6 +2,14 @@
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 4.0.0
+
+- Migrate to the latest [`clean-css`](https://clean-css.github.io/) version `5.x.x`
+- Add Schema validation
+- Add new option `disable: boolean`
+- Drop support `webpack@1.x.x`
+- Add Typescript
+
 ## 3.0.0
 
 - Drop support node v8

CHANGELOG.md

@@ -11,114 +11,72 @@ A [clean-css](https://github.com/jakubpawlowicz/clean-css) loader for [webpack](
 # clean-css-loader
 
 [![npm](https://img.shields.io/npm/v/clean-css-loader.svg)](https://www.npmjs.com/package/clean-css-loader)
+[![CI](https://github.com/retyui/clean-css-loader/actions/workflows/nodejs.yml/badge.svg)](https://github.com/retyui/clean-css-loader/actions/workflows/nodejs.yml)
 [![npm clean-css-loader](https://img.shields.io/npm/dm/clean-css-loader.svg)](https://www.npmjs.com/package/clean-css-loader)
-[![AppVeyor](https://img.shields.io/appveyor/ci/retyui/clean-css-loader.svg?label=windows)](https://ci.appveyor.com/project/retyui/clean-css-loader)
-[![Travis](https://img.shields.io/travis/retyui/clean-css-loader.svg?label=unix)](https://travis-ci.org/retyui/clean-css-loader)
 
-## Install
+## Getting Started
+
+To begin, you'll need to install clean-css-loader:
 
 ```bash
 yarn add -D clean-css-loader
 ```
 
-## Usage
-
-Use the loader either via your webpack config, CLI or inline.
-
-### Via webpack config (recommended)
-
-**webpack.config.js**
+Then add the plugin to your webpack config. For example:
 
-```js
-const isProductionMode = process.env.NODE_ENV === "production";
-
-const cssLoaders = ["style-loader", "css-loader"];
-
-if (isProductionMode) {
-  // push loader for production mode only
-  cssLoaders.push("clean-css-loader");
-
-  // exmaple with options
-  cssLoaders.push({
-    loader: "clean-css-loader",
-    options: {
-      compatibility: "ie9",
-      level: 2,
-      inline: ["remote"],
-    },
-  });
-}
+```tsx
+// webpack.config.js
+const isProduction = process.env.NODE_ENV === "production";
 
 module.exports = {
-  mode: isProductionMode ? "production" : "development",
+  mode: isProduction ? "production" : "development",
   module: {
     rules: [
       {
         test: /\.css$/,
-        use: cssLoaders,
+        use: [
+          "style-loader",
+          "css-loader",
+          {
+            loader: "clean-css-loader",
+            options: {
+              // Loader options
+              disable: !isProduction,
+              skipWarn: false,
+
+              // CleasCSS options
+              compatibility: "ie9",
+              level: 2,
+              inline: ["remote"],
+              //...
+            },
+          },
+        ],
       },
     ],
   },
 };
 ```
 
-**In your application**
+Or using plugin [inline](https://webpack.js.org/concepts/loaders/#inline):
 
-```js
-import cssMin from "style.css";
-```
-
-### CLI
-
-```bash
-webpack --module-bind 'css=style-loader!css-loader!clean-css-loader'
-```
-
-**In your application**
-
-```js
-import cssMin from "style.css";
-```
-
-### Inline
-
-**In your application**
-
-```js
-import cssMin from "style-loader!css-loader!clean-css-loader!./style.css";
+```tsx
+// default
+import "style-loader!css-loader!clean-css-loader!./style.css";
+// with options
+import "style-loader!css-loader!clean-css-loader?level=2!./style.css";
 ```
 
 ## Options
 
-### `skipWarn` default: `false`
+#### `disable: boolean`
 
-This option disable output warnings
+This option enables/disables minify, useful to easily disable on development mode (default: `false`)
 
-More option: [https://github.com/jakubpawlowicz/clean-css#constructor-options](https://github.com/jakubpawlowicz/clean-css#constructor-options)
+#### `skipWarn: boolean`
 
-## Webpack 1.x
+This option enables/disables output warnings (default: `false`)
 
-**Example config (for webpack 1.x):**
+## `CleanCSS` module options
 
-```js
-module.exports = {
-  module: {
-    loaders: [
-      {
-        test: /\.css$/,
-        loader: "css!clean-css",
-      },
-      {
-        test: /\.styl$/,
-        loader: "css!clean-css!stylus?reslve url",
-      },
-      //...
-    ],
-    // Example Set options (Key "clean-css" or cleancss or CleanCSS):
-    "clean-css": {
-      debug: true,
-      mediaMerging: true,
-    },
-  },
-};
-```
+- [clean-css/clean-css#constructor-options](https://github.com/jakubpawlowicz/clean-css#constructor-options)

README.md

@@ -1,24 +1,33 @@
 {
 	"name": "clean-css-loader",
-	"version": "3.0.0",
+	"version": "4.0.0",
 	"main": "lib/index.js",
-	"dependencies": {
-		"clean-css": "^4.2.3",
-		"loader-utils": "^2.0.0"
+  "types": "lib/index.d.ts",
+  "dependencies": {
+		"clean-css": "^5.0.0"
 	},
 	"peerDependencies": {
-		"webpack": ">=1.0.0"
+		"loader-utils": "^1.0.0 || ^2.0.0",
+		"webpack": ">=2.0.0"
+	},
+	"peerDependenciesMeta": {
+		"webpack": {
+			"optional": true
+		},
+		"loader-utils": {
+			"optional": true
+		}
 	},
 	"scripts": {
-		"e2e": "yarn build && yarn update-e2e && yarn test",
+    "pree2e": "yarn build",
+		"e2e": "yarn update-e2e && yarn test",
 		"force-clean": "rimraf ./test/e2e/webpack*/node_modules/ ./test/e2e/webpack*/tests/**/*.test.js",
-		"install-sub": "yarn link && cd ./test/e2e/webpack1 && yarn && yarn link clean-css-loader && yarn build && cd ../webpack5 && yarn && yarn link clean-css-loader && yarn build && cd ../../..",
+		"install-sub": "yarn link && cd test/e2e/webpack5 && yarn && yarn build && cd ../../..",
 		"update-e2e": "yarn force-clean && yarn install-sub",
 		"prebuild": "rimraf ./lib",
-		"build": "babel src --out-dir lib",
-		"pretest": "yarn build",
-		"test": "jest",
-		"precommit": "lint-staged"
+		"build": "tsc",
+		"postbuild": "prettier --write ./lib",
+		"test": "jest"
 	},
 	"description": "CleanCSS loader module for webpack",
 	"keywords": [
@@ -27,31 +36,24 @@
 		"loader"
 	],
 	"repository": "https://github.com/retyui/clean-css-loader",
-	"author": "David <vamnemne@gmail.com>",
+  "author": "David <4661784+retyui@users.noreply.github.com>",
 	"license": "MIT",
-	"files": [
-		"lib"
-	],
+	"files": ["lib"],
 	"engines": {
-		"node": ">= 10.13.0"
+		"node": ">= 10.0.0"
 	},
 	"devDependencies": {
-		"@babel/cli": "^7.15.4",
-		"@babel/core": "^7.15.5",
-		"@babel/preset-env": "^7.15.4",
-		"babel-eslint": "^10.1.0",
-		"babel-jest": "^27.1.0",
-		"babel-plugin-add-module-exports": "^1.0.4",
-		"eslint": "^7.32.0",
-		"eslint-config-prettier": "^8.3.0",
-		"eslint-config-webpack": "^1.2.5",
-		"eslint-plugin-import": "^2.24.2",
-		"eslint-plugin-prettier": "^4.0.0",
-		"husky": "^7.0.2",
+		"@tsconfig/node10": "^1.0.8",
+		"@types/clean-css": "^4.2.5",
+		"@types/loader-utils": "^2.0.3",
+		"@types/node": "^16.9.6",
+		"@types/schema-utils": "^2.4.0",
 		"jest": "^27.1.0",
-		"lint-staged": "^11.1.2",
-		"npm-run-all": "^4.1.5",
-		"prettier": "^2.3.2",
-		"rimraf": "^3.0.2"
+		"loader-utils": "^2.0.0",
+		"prettier": "^2.4.1",
+		"rimraf": "^3.0.2",
+		"schema-utils": "^3.1.1",
+		"typescript": "^4.4.3",
+		"webpack": "^5.53.0"
 	}
 }