feat: release 0.0.4

Author: sonofmagic

packages/unplugin-tailwindcss-mangle/README.md

@@ -13,6 +13,8 @@ mangle tailwindcss utilities plugin
     - [4. register this plugin](#4-register-this-plugin)
       - [vite](#vite)
       - [webpack](#webpack)
+  - [Options](#options)
+    - [classGenerator](#classgenerator)
   - [Notice](#notice)
 
 ## Features
@@ -74,6 +76,8 @@ You will see all class was renamed to `tw-*`
 
 #### webpack
 
+> Experiment, not work right now
+
 ```js
 // esm
 import { webpackPlugin as utwm } from 'unplugin-tailwindcss-mangle'
@@ -83,6 +87,24 @@ const { webpackPlugin: utwm } = require('unplugin-tailwindcss-mangle')
 utwm()
 ```
 
+## Options
+
+### classGenerator
+
+custom class generator, if you want to custom class name (default 'tw-*'), use this options
+
+```js
+export interface IClassGeneratorOptions {
+  reserveClassName?: (string | RegExp)[]
+  customGenerate?: (original: string, opts: IClassGeneratorOptions, context: Record<string, any>) => string | undefined
+  log?: boolean
+  exclude?: (string | RegExp)[]
+  include?: (string | RegExp)[]
+  ignoreClass?: (string | RegExp)[]
+  classPrefix?: string
+}
+```
+
 ## Notice
 
 This plugin only transform those classes which name contain `-` or `:`, like `w-32`, `before:h-[300px]`,`after:dark:via-[#0141ff]/40`. some classes like `flex`,`relative` will not be mangled.

packages/unplugin-tailwindcss-mangle/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unplugin-tailwindcss-mangle",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "mangle tailwindcss utilities class",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

packages/unplugin-tailwindcss-mangle/src/classGenerator.ts

@@ -1,15 +1,15 @@
 // import chalk from 'chalk'
-import type { IMangleOptions, IMangleContextClass, IClassGenerator } from './types'
+import type { IClassGeneratorOptions, IClassGeneratorContextItem, IClassGenerator } from './types'
 
 import { acceptChars, stripEscapeSequence, regExpTest } from './utils'
 
 class ClassGenerator implements IClassGenerator {
-  public newClassMap: Record<string, IMangleContextClass>
+  public newClassMap: Record<string, IClassGeneratorContextItem>
   public newClassSize: number
   public context: Record<string, any>
-  public opts: IMangleOptions
+  public opts: IClassGeneratorOptions
   public classPrefix: string
-  constructor(opts: IMangleOptions = {}) {
+  constructor(opts: IClassGeneratorOptions = {}) {
     this.newClassMap = {}
     this.newClassSize = 0
     this.context = {}
@@ -72,7 +72,7 @@ class ClassGenerator implements IClassGenerator {
     return className
   }
 
-  generateClassName(original: string): IMangleContextClass {
+  generateClassName(original: string): IClassGeneratorContextItem {
     const opts = this.opts
 
     original = stripEscapeSequence(original)
@@ -97,7 +97,7 @@ class ClassGenerator implements IClassGenerator {
     if (opts.log) {
       console.log(`Minify class name from ${original} to ${newClassName}`)
     }
-    const newClass: IMangleContextClass = {
+    const newClass: IClassGeneratorContextItem = {
       name: newClassName,
       usedBy: []
     }

packages/unplugin-tailwindcss-mangle/src/css/plugins.ts

@@ -1,15 +1,15 @@
-import { IMangleContextClass } from '@/types'
+import { IClassGeneratorContextItem } from '@/types'
 import type { PluginCreator } from 'postcss'
 import parser from 'postcss-selector-parser'
 export type PostcssMangleTailwindcssPlugin = PluginCreator<{
-  newClassMap: Record<string, IMangleContextClass>
+  newClassMap: Record<string, IClassGeneratorContextItem>
 }>
 
 const postcssPlugin = 'postcss-mangle-tailwindcss-plugin'
 
 const postcssMangleTailwindcssPlugin: PostcssMangleTailwindcssPlugin = (options) => {
   // must set newClassMap options
-  let newClassMap: Record<string, IMangleContextClass> = {}
+  let newClassMap: Record<string, IClassGeneratorContextItem> = {}
   if (options) {
     if (options.newClassMap) {
       newClassMap = options.newClassMap

packages/unplugin-tailwindcss-mangle/src/types.ts

@@ -1,16 +1,16 @@
 import type ClassGenerator from './classGenerator'
 
-export interface IMangleContextClass {
+export interface IClassGeneratorContextItem {
   name: string
   usedBy: any[]
 }
 
-export interface IMangleOptions {
+export interface IClassGeneratorOptions {
   // classNameRegExp?: string
   reserveClassName?: (string | RegExp)[]
   // ignorePrefix?: string[]
   // ignorePrefixRegExp?: string
-  customGenerate?: (original: string, opts: IMangleOptions, context: Record<string, any>) => string | undefined
+  customGenerate?: (original: string, opts: IClassGeneratorOptions, context: Record<string, any>) => string | undefined
   log?: boolean
   exclude?: (string | RegExp)[]
   include?: (string | RegExp)[]
@@ -19,7 +19,7 @@ export interface IMangleOptions {
 }
 
 export interface IClassGenerator {
-  newClassMap: Record<string, IMangleContextClass>
+  newClassMap: Record<string, IClassGeneratorContextItem>
   newClassSize: number
   context: Record<string, any>
 }
@@ -32,5 +32,5 @@ export interface IHandlerOptions {
 }
 
 export interface Options {
-  classGenerator?: IMangleOptions
+  classGenerator?: IClassGeneratorOptions
 }

packages/unplugin-tailwindcss-mangle/src/utils.ts

@@ -1,4 +1,4 @@
-import type { IMangleOptions, IClassGenerator } from './types'
+import type { IClassGeneratorOptions, IClassGenerator } from './types'
 
 export function groupBy<T>(arr: T[], cb: (arg: T) => string): Record<string, T[]> {
   if (!Array.isArray(arr)) {
@@ -60,7 +60,7 @@ export function stripEscapeSequence(words: string) {
   return words.replace(/\\/g, '')
 }
 
-export const validate = (opts: IMangleOptions, classGenerator: IClassGenerator) => {
+export const validate = (opts: IClassGeneratorOptions, classGenerator: IClassGenerator) => {
   if (!opts.log) return
   for (const className in classGenerator.newClassMap) {
     const c = classGenerator.newClassMap[className]

packages/unplugin-tailwindcss-mangle/test/utils/index.ts

@@ -4,7 +4,7 @@ import fs from 'fs'
 import path from 'path'
 
 export function getTestCase(caseName: string) {
-  return fs.readFileSync(path.resolve(__dirname, 'fixtures', caseName), 'utf-8')
+  return fs.readFileSync(path.resolve(__dirname, '../fixtures', caseName), 'utf-8')
 }
 // @tailwind base;
 // @tailwind components;