Merge pull request #31 from IvanovRoman/master

Got rid of (loader-utils).getOptions in favor loaderContext.getOptions (loaderContext is this inside loader function)

Author: IvanovRoman

README.md

@@ -1,6 +1,10 @@
 # dts-css-modules-loader
 A small Webpack loader to generate typings for your CSS-Modules. Created as a replacement for the frozend [typings-for-css-modules-loader](https://github.com/Jimdo/typings-for-css-modules-loader). This loader does not make any changes in content of styles, just creates `*.d.ts` file during the work. It is assumed that the content will be preprocessed first by [css-loader](https://github.com/webpack-contrib/css-loader).
 
+### ⚠ BREAKING CHANGES
+
+* Since version 2.x only supports `webpack` version is `5`
+
 ## Installation
 ```bash
 npm i -D dts-css-modules-loader

index.js

@@ -1,9 +1,25 @@
 // @ts-check
 const fs = require('fs');
 const fp = require('path');
-const loaderUtils = require('loader-utils');
+const schema = require("./options.json");
 
-/** @type {import('webpack').loader.Loader} */
+/**
+ * @template T
+ * @typedef {Object} LoaderOptions<T>
+ * @type {{
+ *    banner?: string,
+ *    namedExport?: boolean,
+ *    customTypings?: (classes: string[]) => string,
+ *    dropEmptyFile?: boolean
+ * }}
+ * @property {string} [severityError] Allows to choose how errors are displayed.
+ */
+
+/**
+ * @template T
+ * @this {import("webpack").LoaderContext<LoaderOptions<T>>}
+ * @param {Buffer} content
+ */
 module.exports = function (content) {
   this.cacheable && this.cacheable();
 
@@ -15,7 +31,7 @@ module.exports = function (content) {
    *   dropEmptyFile?: boolean
    * }}
    */
-  const options = loaderUtils.getOptions(this) || {};
+  const options = this.getOptions(schema) || {};
   const callback = this.async();
 
   const classes = getClasses(content);
@@ -85,7 +101,7 @@ function getClasses(content) {
   }
 
   if (~from) {
-    content = content.substr(from);
+    content = content.slice(from);
 
     /** @type {RegExpExecArray} */
     let match;

options.json

@@ -0,0 +1,20 @@
+{
+  "defintions": {
+    "banner": {
+      "description": "When the option is switched on classes exported as variables.",
+      "type": "string"
+    },
+    "namedExport": {
+      "description": "Adds a 'banner' prefix to each generated file",
+      "type": "boolean"
+    },
+    "customTypings": {
+      "description": "Function that accepts classes (an array of string) and returns the content of declaration file",
+      "instanceof": "Function"
+    },
+    "dropEmptyFile": {
+      "description": "If there are no classes, the typings file will not be generated, and the existing will be deleted",
+      "type": "boolean"
+    }
+  }
+}

package.json

@@ -1,10 +1,7 @@
 {
   "name": "dts-css-modules-loader",
-  "version": "1.2.5",
+  "version": "2.0.0",
   "description": "webpack loader to generate typings for css modules",
-  "dependencies": {
-    "loader-utils": "^2.0.0"
-  },
   "peerDependencies": {
     "css-loader": "^2.0.0 || ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0"
   },
@@ -18,6 +15,6 @@
   "license": "MIT",
   "homepage": "https://github.com/Megaputer/dts-css-modules-loader",
   "devDependencies": {
-    "@types/webpack": "^4.41.26"
+    "@types/webpack": "^5.28.0"
   }
 }