Feature/add more test case (#40)

sonofmagic · web-flow · commit 0f5ab7461eae · 2023-08-10T01:04:18.000+08:00
* chore: commit js case

* refact: type and plugin

* feat: use config to control plugin

* chore: allow test for tailwindcss patch

* chore: add ci codecov
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -42,5 +42,11 @@ jobs:
       - name: Build
         run: pnpm build
 
+      - name: Patch
+        working-directory: packages/tailwindcss-patch
+        run: pnpm run patch
+
       - name: Test
         run: pnpm test
+
+      - uses: codecov/codecov-action@v3
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -39,3 +39,5 @@ jobs:
           # NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - uses: codecov/codecov-action@v3
diff --git a/packages/config/package.json b/packages/config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tailwindcss-mangle/config",
-  "version": "1.0.1",
+  "version": "2.0.4",
   "description": "The config and load function of tailwindcss-mangle",
   "exports": {
     ".": {
@@ -25,7 +25,7 @@
   ],
   "scripts": {
     "build": "unbuild",
-    "test": "vitest run",
+    "test": "vitest run --coverage.enabled",
     "test:dev": "vitest"
   },
   "keywords": [
@@ -44,6 +44,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
+    "@tailwindcss-mangle/shared": "workspace:^",
     "c12": "^1.4.2",
     "dedent": "^1.5.1"
   },
diff --git a/packages/config/src/defaults.ts b/packages/config/src/defaults.ts
@@ -1,4 +1,5 @@
-import type { PatchUserConfig, UserConfig } from './types'
+import { defaultMangleClassFilter } from '@tailwindcss-mangle/shared'
+import type { PatchUserConfig, UserConfig, MangleUserConfig } from './types'
 
 export function getDefaultPatchConfig(): PatchUserConfig {
   return {
@@ -11,8 +12,24 @@ export function getDefaultPatchConfig(): PatchUserConfig {
   }
 }
 
+export function getDefaultMangleUserConfig(): MangleUserConfig {
+  return {
+    mangleClassFilter: defaultMangleClassFilter,
+    include: ['**/*.{js,jsx,ts,tsx,svelte,vue}'],
+    exclude: ['node_modules/**/*', '**/*.{css,scss,less,sass,postcss,html,htm}'],
+    disabled: process.env.NODE_ENV === 'development',
+    classListPath: '.tw-patch/tw-class-list.json',
+    classMapOutput: {
+      enable: false,
+      filename: '.tw-patch/tw-map-list.json',
+      loose: true
+    }
+  }
+}
+
 export function getDefaultUserConfig(): UserConfig {
   return {
-    patch: getDefaultPatchConfig()
+    patch: getDefaultPatchConfig(),
+    mangle: getDefaultMangleUserConfig()
   }
 }
diff --git a/packages/config/src/types.ts b/packages/config/src/types.ts
@@ -1,3 +1,21 @@
+import type { IClassGeneratorOptions } from '@tailwindcss-mangle/shared'
+
+export interface ClassMapOutputOptions {
+  enable?: boolean
+  filename?: string
+  loose?: boolean
+}
+
+export interface MangleUserConfig {
+  mangleClassFilter?: (className: string) => boolean
+  classGenerator?: IClassGeneratorOptions
+  exclude?: string[]
+  include?: string[]
+  classListPath?: string
+  classMapOutput?: ClassMapOutputOptions
+  disabled?: boolean
+}
+
 export interface PatchUserConfig {
   output?: {
     filename?: string
@@ -16,4 +34,5 @@ export interface PatchUserConfig {
 
 export interface UserConfig {
   patch?: PatchUserConfig
+  mangle?: MangleUserConfig
 }
diff --git a/packages/config/test/__snapshots__/defaults.test.ts.snap b/packages/config/test/__snapshots__/defaults.test.ts.snap
@@ -13,6 +13,23 @@ exports[`defaults > getDefaultPatchConfig 1`] = `
 
 exports[`defaults > getDefaultUserConfig 1`] = `
 {
+  "mangle": {
+    "classListPath": ".tw-patch/tw-class-list.json",
+    "classMapOutput": {
+      "enable": false,
+      "filename": ".tw-patch/tw-map-list.json",
+      "loose": true,
+    },
+    "disabled": false,
+    "exclude": [
+      "node_modules/**/*",
+      "**/*.{css,scss,less,sass,postcss,html,htm}",
+    ],
+    "include": [
+      "**/*.{js,jsx,ts,tsx,svelte,vue}",
+    ],
+    "mangleClassFilter": [Function],
+  },
   "patch": {
     "output": {
       "filename": ".tw-patch/tw-class-list.json",
diff --git a/packages/config/test/index.test.ts b/packages/config/test/index.test.ts
@@ -3,7 +3,7 @@ import { existsSync } from 'node:fs'
 import { deleteAsync } from 'del'
 import { fixturesRoot } from './utils'
 import { initConfig, getConfig } from '@/index'
-import { getDefaultUserConfig } from '@/defaults'
+import { getDefaultUserConfig, getDefaultMangleUserConfig } from '@/defaults'
 import { configName } from '@/constants'
 
 describe('config', () => {
@@ -34,7 +34,8 @@ describe('config', () => {
         tailwindcss: {
           cwd: 'aaa/bbb/cc'
         }
-      }
+      },
+      mangle: getDefaultMangleUserConfig()
     })
   })
 })
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tailwindcss-mangle/core",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "The core of tailwindcss-mangle",
   "exports": {
     ".": {
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -1,4 +1,4 @@
-import { ClassGenerator } from './shared'
+import type { ClassGenerator } from './shared'
 
 export interface IClassGeneratorContextItem {
   name: string
@@ -32,21 +32,3 @@ export interface ICssHandlerOptions extends IHandlerOptions {
   ignoreVueScoped?: boolean
   file?: string
 }
-
-export interface ClassSetOutputOptions {
-  filename: string
-  dir?: string
-  type: 'all' | 'partial'
-}
-
-export interface ClassMapOutputOptions {
-  filename: string
-  dir?: string
-}
-export interface Options {
-  classGenerator?: IClassGeneratorOptions
-  exclude?: string[]
-  include?: string[]
-  classSetOutput?: boolean | ClassSetOutputOptions
-  classMapOutput?: boolean | ClassMapOutputOptions
-}
diff --git a/packages/core/test/fixtures/prod/0.js b/packages/core/test/fixtures/prod/0.js
@@ -0,0 +1,11 @@
+// Unterminated string constant
+if (isSvg) {
+  let source = serializeString(svgNode);
+  // add xml declaration
+  source = '<?xml version="1.0" standalone="no"?>\r\n' + source;
+  // convert svg source to URI data scheme.
+  url = "data:image/svg+xml;charset=utf-8," + encodeURIComponent(source);
+  saveAs(url, "graph.svg");
+  onAlreadySerialized();
+  return;
+}
diff --git a/packages/core/test/fixtures/prod/1.js b/packages/core/test/fixtures/prod/1.js
@@ -0,0 +1,11 @@
+// Missing semicolon.
+if (typeof parent === 'string') {
+  parent = d.querySelectorAll(config.parent);
+  if (parent.length > 1) {
+      console.warn('WARNING: the given `parent` query(' + config.parent + ') matched more than one element, the first one will be used');
+  }
+  if (parent.length === 0) {
+      throw 'ERROR: the given `parent` doesn\'t exists!';
+  }
+  parent = parent[0];
+}
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tailwindcss-mangle/shared",
-  "version": "2.0.0",
+  "version": "2.0.4",
   "description": "The shared utils of tailwindcss-mangle",
   "exports": {
     ".": {
@@ -25,7 +25,7 @@
   ],
   "scripts": {
     "build": "unbuild",
-    "test": "vitest run",
+    "test": "vitest run --coverage.enabled",
     "test:dev": "vitest"
   },
   "keywords": [
diff --git a/packages/tailwindcss-patch/package.json b/packages/tailwindcss-patch/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tailwindcss-patch",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "patch tailwindcss for exposing context and extract classes",
   "exports": {
     ".": {
@@ -32,7 +32,7 @@
     "build": "unbuild",
     "test": "vitest run --coverage.enabled",
     "test:dev": "vitest",
-    "cli": "node bin/tw-patch.js install"
+    "patch": "node bin/tw-patch.js install"
   },
   "keywords": [
     "tailwindcss",
@@ -51,7 +51,7 @@
   },
   "peerDependenciesMeta": {
     "tailwindcss": {
-      "optional": false
+      "optional": true
     }
   },
   "devDependencies": {
diff --git a/packages/tailwindcss-patch/test/config.test.ts b/packages/tailwindcss-patch/test/config.test.ts
@@ -2,7 +2,7 @@ import { resolve } from 'node:path'
 import { existsSync } from 'node:fs'
 import { deleteAsync } from 'del'
 import { fixturesRoot } from './utils'
-import { initConfig, getConfig, getDefaultUserConfig } from '@/core/config'
+import { initConfig, getConfig, getDefaultUserConfig, getDefaultMangleUserConfig } from '@/core/config'
 
 describe('config', () => {
   it('0.default', async () => {
@@ -32,7 +32,8 @@ describe('config', () => {
         tailwindcss: {
           cwd: 'aaa/bbb/cc'
         }
-      }
+      },
+      mangle: getDefaultMangleUserConfig()
     })
   })
 })
diff --git a/packages/tailwindcss-patch/vitest.setup.ts b/packages/tailwindcss-patch/vitest.setup.ts
@@ -1,4 +0,0 @@
-// import 'tailwindcss-patch/cli'
-import { TailwindcssPatcher } from './dist'
-const twPatcher = new TailwindcssPatcher()
-twPatcher.patch()
diff --git a/packages/unplugin-tailwindcss-mangle/package.json b/packages/unplugin-tailwindcss-mangle/package.json
@@ -1,6 +1,6 @@
 {
   "name": "unplugin-tailwindcss-mangle",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "mangle tailwindcss utilities class plugin. support vite and webpack!",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -36,6 +36,11 @@
       "require": "./dist/nuxt.cjs",
       "import": "./dist/nuxt.mjs"
     },
+    "./utils": {
+      "types": "./dist/utils.d.ts",
+      "require": "./dist/utils.cjs",
+      "import": "./dist/utils.mjs"
+    },
     "./*": "./*"
   },
   "typesVersions": {
@@ -48,7 +53,7 @@
   },
   "scripts": {
     "build": "unbuild",
-    "test": "vitest run",
+    "test": "vitest run --coverage.enabled",
     "test:dev": "vitest"
   },
   "files": [
diff --git a/packages/unplugin-tailwindcss-mangle/src/constants.ts b/packages/unplugin-tailwindcss-mangle/src/constants.ts
@@ -1,3 +1 @@
 export const pluginName = 'unplugin-tailwindcss-mangle'
-
-export const webpackCacheKey = pluginName + '-sources-cache-key'
diff --git a/packages/unplugin-tailwindcss-mangle/src/core/context.ts b/packages/unplugin-tailwindcss-mangle/src/core/context.ts
@@ -0,0 +1,85 @@
+import fs from 'node:fs'
+import { resolve } from 'node:path'
+import { ClassGenerator } from '@tailwindcss-mangle/shared'
+import { getConfig, getDefaultMangleUserConfig } from '@tailwindcss-mangle/config'
+import type { MangleUserConfig } from '@tailwindcss-mangle/config'
+import { sort } from 'fast-sort'
+import defu from 'defu'
+import { createGlobMatcher, defaultMangleClassFilter } from '@/utils'
+
+export class Context {
+  options: MangleUserConfig
+  includeMatcher: (file: string) => boolean
+  excludeMatcher: (file: string) => boolean
+  classSet: Set<string>
+  replaceMap: Map<string, string>
+  classGenerator: ClassGenerator
+  constructor(opts: MangleUserConfig) {
+    this.options = defu(opts, getDefaultMangleUserConfig())
+    this.classSet = new Set()
+    this.replaceMap = new Map()
+    this.includeMatcher = createGlobMatcher(this.options.include, true)
+    this.excludeMatcher = createGlobMatcher(this.options.exclude, false)
+    this.classGenerator = new ClassGenerator(this.options.classGenerator)
+  }
+
+  mergeOptions(opts?: MangleUserConfig) {
+    // 插件选项优先
+    this.options = defu(this.options, opts)
+    this.includeMatcher = createGlobMatcher(this.options.include, true)
+    this.excludeMatcher = createGlobMatcher(this.options.exclude, false)
+    this.classGenerator = new ClassGenerator(this.options.classGenerator)
+  }
+
+  isInclude(file: string) {
+    return this.includeMatcher(file) && !this.excludeMatcher(file)
+  }
+
+  currentMangleClassFilter(className: string) {
+    return (this.options.mangleClassFilter ?? defaultMangleClassFilter)(className)
+  }
+
+  getClassSet() {
+    return this.classSet
+  }
+
+  getReplaceMap() {
+    return this.replaceMap
+  }
+
+  addToUsedBy(key: string, file: string) {
+    const hit = this.classGenerator.newClassMap[key]
+    if (hit) {
+      hit.usedBy.add(file)
+    }
+  }
+
+  async initConfig() {
+    const { config } = await getConfig()
+    const mangleConfig = config?.mangle
+    this.mergeOptions(mangleConfig)
+    const jsonPath = this.options.classListPath ?? resolve(process.cwd(), config?.patch?.output?.filename as string)
+
+    if (jsonPath && fs.existsSync(jsonPath)) {
+      const rawClassList = fs.readFileSync(jsonPath, 'utf8')
+      const list = JSON.parse(rawClassList) as string[]
+      // why?
+      // case bg-red-500 and bg-red-500/50
+      // transform bg-red-500/50 first
+      const classList = sort(list).desc((c) => c.length)
+      for (const className of classList) {
+        if (this.currentMangleClassFilter(className)) {
+          this.classSet.add(className)
+        }
+      }
+    }
+    for (const cls of this.classSet) {
+      this.classGenerator.generateClassName(cls)
+    }
+
+    for (const x of Object.entries(this.classGenerator.newClassMap)) {
+      this.replaceMap.set(x[0], x[1].name)
+    }
+    return config
+  }
+}
diff --git a/packages/unplugin-tailwindcss-mangle/src/core/index.ts b/packages/unplugin-tailwindcss-mangle/src/core/index.ts
@@ -1,2 +1,2 @@
 export * from './plugin'
-export * from './options'
+export * from './context'
diff --git a/packages/unplugin-tailwindcss-mangle/src/core/options.ts b/packages/unplugin-tailwindcss-mangle/src/core/options.ts
diff --git a/packages/unplugin-tailwindcss-mangle/src/core/plugin.ts b/packages/unplugin-tailwindcss-mangle/src/core/plugin.ts
diff --git a/packages/unplugin-tailwindcss-mangle/src/nuxt.ts b/packages/unplugin-tailwindcss-mangle/src/nuxt.ts
diff --git a/packages/unplugin-tailwindcss-mangle/src/types.ts b/packages/unplugin-tailwindcss-mangle/src/types.ts
diff --git a/packages/unplugin-tailwindcss-mangle/src/utils.ts b/packages/unplugin-tailwindcss-mangle/src/utils.ts
diff --git a/packages/unplugin-tailwindcss-mangle/test/pre.test.ts b/packages/unplugin-tailwindcss-mangle/test/pre.test.ts
diff --git a/packages/unplugin-tailwindcss-mangle/vitest.setup.ts b/packages/unplugin-tailwindcss-mangle/vitest.setup.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/vitest.workspace.ts b/vitest.workspace.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@tailwindcss-mangle/core",`
`3`		`- "version": "2.0.2",`
	`3`	`+ "version": "2.0.4",`
`4`	`4`	`"description": "The core of tailwindcss-mangle",`
`5`	`5`	`"exports": {`
`6`	`6`	`".": {`