Merge pull request #14 from vordgi/ncm-13

ncm-13 add custom mode instead of detailed

README.md

@@ -43,9 +43,9 @@ module.exports = withPlugins([
 ## Configuration
 next-classname-minifier has 3 types of changing classnames:
 
-* minified - the main option. It is highly not recommended to use this option for development mode (_it is too unstable in dev mode_);
-* detailed - can be used for debugging, default for development mode;
-* none — use the default CSS modules option;
+* minified — the main option. It is highly not recommended to use this option for development mode (_it is too unstable in dev mode_);
+* custom — create a class using a [template string](https://webpack.js.org/configuration/output/#template-strings) rule, can be used for debugging;
+* none — use the default CSS modules option, default for development mode;
 
 You can choose different options for development and production. 
 
@@ -56,6 +56,13 @@ module.exports = withPlugins([
 ], nextConfig);
 ```
 
+Custom mode example:
+```js
+module.exports = withPlugins([
+    [withClassnamesMinifier({ { type: 'custom', templateString: '[path][name]__[local]_[hash:base64:5]' }, prod: 'minified' })]
+], nextConfig);
+```
+
 ## License
 
 [MIT](https://github.com/vordgi/next-classnames-minifier/blob/main/LICENSE)

deps.d.ts

@@ -0,0 +1 @@
+declare module 'css-loader/dist/utils';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-classnames-minifier",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Library for configuring style modules to generate compressed classes",
   "main": "dist/withClassnamesMinifier.js",
   "types": "dist/withClassnamesMinifier.d.ts",
@@ -36,6 +36,10 @@
   "devDependencies": {
     "@types/node": "16.11.12",
     "@types/webpack": "5.28.0",
+    "css-loader": "6.8.1",
     "typescript": "4.5.4"
+  },
+  "peerDependencies": {
+    "css-loader": ">=4.0.0"
   }
 }

src/lib/constants/minifiers.ts

@@ -1,4 +1,4 @@
 export const MINIFIED = 'minified';
-export const DETAILED = 'detailed';
 export const NONE = 'none';
-export const VALID_MINIFIERS_KEYS = [MINIFIED, DETAILED, NONE] as const;
+export const CUSTOM = 'custom';
+export const VALID_MINIFIERS_KEYS = [MINIFIED, NONE, CUSTOM] as const;

src/lib/converters/ConverterBase.ts

@@ -1,9 +1,9 @@
 import type { LoaderContext } from 'webpack/types';
 
 abstract class BaseConverter {
-  cache: {[resource: string]: {[className: string]: string}} = {};
+  cache: { [resource: string]: { [className: string]: string } } = {};
 
-  abstract getLocalIdent({ resourcePath }: LoaderContext<any>, _localIdent: string, origName: string): string;
+  abstract getLocalIdent({ resourcePath }: LoaderContext<any>, _localIdent: string, origName: string, options: unknown): string;
 };
 
 export default BaseConverter;