tailwindcss-patch 2.1.0 → 2.2.0

package/README.md

@@ -1,17 +1,21 @@
 # tailwindcss-patch
 
+\[[中文(zh-cn)](./README-cn.md)\]
+
 get tailwindcss context at runtime ! extract all classes into file!
 
 - [tailwindcss-patch](#tailwindcss-patch)
   - [Setup](#setup)
   - [Usage](#usage)
   - [Cli](#cli)
-    - [Init Config File](#init-config-file)
     - [Extract all class into a json](#extract-all-class-into-a-json)
-    - [Nodejs](#nodejs)
+  - [Nodejs API](#nodejs-api)
+  - [Config](#config)
+    - [Init Config File](#init-config-file)
   - [Migration form v1 to v2](#migration-form-v1-to-v2)
     - [0. cli command change](#0-cli-command-change)
     - [1. default remove `*` in json array result](#1-default-remove--in-json-array-result)
+  - [What's next?](#whats-next)
 
 > Nodejs version should >= `16.6.0`
 
@@ -20,7 +24,7 @@ get tailwindcss context at runtime ! extract all classes into file!
 1. Install package
 
 ```sh
-<yarn|npm|pnpm> add -D ts-patch
+<yarn|npm|pnpm> add -D tailwindcss-patch
 ```
 
 2. Patch tailwindcss
@@ -46,36 +50,68 @@ npx tw-patch install
 
 ## Cli
 
-### Init Config File
-
-```sh
-tw-patch init
-```
-
-Then there will be a ts file called `tailwindcss-mangle.config.ts` exist in your `cwd`.
-
 ### Extract all class into a json
 
 ```sh
-tw-patch extract
+npx tw-patch extract
 ```
 
 default there will be a json in `.tw-patch/tw-class-list.json` in your project.
 
 you can custom this behavior by config `tailwindcss-mangle.config.ts`
 
-### Nodejs
+## Nodejs API
 
 ```js
 import { TailwindcssPatcher } from 'tailwindcss-patch'
 
 const twPatcher = new TailwindcssPatcher(/* options */)
+// do patch
+twPatcher.patch()
 // get all contexts at runtime
 twPatcher.getContexts()
 // get all class generated by tailwindcss utilities
 twPatcher.getClassSet()
 ```
 
+## Config
+
+### Init Config File
+
+```sh
+npx tw-patch init
+```
+
+Then there will be a ts file called `tailwindcss-mangle.config.ts` exist in your `cwd`.
+
+The config as follows:
+
+```ts
+import { defineConfig } from 'tailwindcss-patch'
+
+export default defineConfig({})
+```
+
+you can custom `tw-patch` behavior by `patch` option:
+
+```ts
+import { defineConfig } from 'tailwindcss-patch'
+
+export default defineConfig({
+  patch: {
+    output: {
+      filename: 'xxx.json',
+      loose: true,
+      removeUniversalSelector: true
+    },
+    tailwindcss: {
+      config: 'path/to/your-tailwind.config.js',
+      cwd: 'project/cwd'
+    }
+  }
+})
+```
+
 ## Migration form v1 to v2
 
 ### 0. cli command change
@@ -96,3 +132,11 @@ twPatcher.getClassSet()
   "text-[100px]"
 ]
 ```
+
+## What's next?
+
+At the moment I just extracted all the tool classes to actually get the context of `tailwindcss` to analyze. You can add more functionality to this project by giving me `issue` or `pr`.
+
+Of course, the extracted `JSON` isn't just for you to look at. You can analyze it, and I use it as a data file for my `tailwindcss-mangle`.
+
+The `tailwindcss-mangle` itself is an obfuscation tool to obfuscate the tools generated by `tailwindcss`, see the next article for more details on how to use it.

package/dist/cli.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.mts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.ts

@@ -1,2 +1,2 @@
 
-export { }
+export {  }

package/dist/index.cjs

@@ -109,6 +109,12 @@ function log(message, ...optionalParams) {
   return console.log(`[${pkgName}]:` + message, ...optionalParams);
 }
 
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 function getCacheOptions(options) {
   let cache;
   switch (typeof options) {
@@ -133,6 +139,7 @@ function getCacheOptions(options) {
 }
 class CacheManager {
   constructor(options = {}) {
+    __publicField$1(this, "options");
     this.options = this.getOptions(options);
   }
   mkdir(cacheDirectory) {
@@ -473,8 +480,19 @@ async function processTailwindcss(options) {
   });
 }
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 class TailwindcssPatcher {
   constructor(options = {}) {
+    __publicField(this, "rawOptions");
+    __publicField(this, "cacheOptions");
+    __publicField(this, "patchOptions");
+    __publicField(this, "patch");
+    __publicField(this, "cacheManager");
     this.rawOptions = options;
     this.cacheOptions = getCacheOptions(options.cache);
     this.patchOptions = getPatchOptions(options.patch);

package/dist/index.d.cts

@@ -0,0 +1,149 @@
+import { Rule, Node } from 'postcss';
+import { Config } from 'tailwindcss';
+import { UserConfig } from '@tailwindcss-mangle/config';
+export * from '@tailwindcss-mangle/config';
+import { SyncOpts } from 'resolve';
+
+type CacheStrategy = 'merge' | 'overwrite';
+interface CacheOptions {
+    dir?: string;
+    cwd?: string;
+    file?: string;
+    strategy?: CacheStrategy;
+}
+type InternalCacheOptions = CacheOptions & {
+    enable?: boolean;
+};
+interface PatchOptions {
+    overwrite?: boolean;
+    paths?: string[];
+    basedir?: string;
+    custom?: (dir: string, ctx: Record<string, any>) => void;
+}
+interface InternalPatchOptions {
+    overwrite: boolean;
+    paths?: string[];
+    basedir?: string;
+    custom?: (dir: string, ctx: Record<string, any>) => void;
+    version?: string;
+}
+interface TailwindcssPatcherOptions {
+    cache?: CacheOptions | boolean;
+    patch?: PatchOptions;
+}
+type TailwindcssClassCache = Map<string, ({
+    layer: string;
+    options: Record<string, any>;
+    sort: Record<string, any>;
+} | Rule)[]>;
+type TailwindcssRuntimeContext = {
+    applyClassCache: Map<any, any>;
+    candidateRuleCache: Map<string | string, Set<[
+        {
+            arbitrary: any;
+            index: any;
+            layer: string;
+            options: any[];
+            parallelIndex: any;
+            parentLayer: string;
+            variants: any;
+        },
+        Node
+    ]>>;
+    candidateRuleMap: Map<string | string, [object, Node][]>;
+    changedContent: any[];
+    classCache: TailwindcssClassCache;
+    disposables: any[];
+    getClassList: Function;
+    getClassOrder: Function;
+    getVariants: Function;
+    markInvalidUtilityCandidate: Function;
+    markInvalidUtilityNode: Function;
+    notClassCache: Set<string>;
+    offsets: {
+        layerPositions: object;
+        offsets: object;
+        reservedVariantBits: any;
+        variantOffsets: Map<string, any>;
+    };
+    postCssNodeCache: Map<object, [Node]>;
+    ruleCache: Set<[object, Node]>;
+    stylesheetCache: Record<string, Set<any>>;
+    tailwindConfig: Config;
+    userConfigPath: string | null;
+    variantMap: Map<string, [[object, Function]]>;
+    variantOptions: Map<string, object>;
+};
+type DeepRequired<T> = {
+    [K in keyof T]: Required<DeepRequired<T[K]>>;
+};
+
+declare function getCacheOptions(options?: CacheOptions | boolean): InternalCacheOptions;
+declare class CacheManager {
+    options: Required<CacheOptions> & {
+        filename: string;
+    };
+    constructor(options?: CacheOptions);
+    mkdir(cacheDirectory: string): string;
+    getOptions(options?: CacheOptions): Required<CacheOptions> & {
+        filename: string;
+    };
+    write(data: Set<string>): string | undefined;
+    read(): Set<string> | undefined;
+}
+
+declare class TailwindcssPatcher {
+    rawOptions: TailwindcssPatcherOptions;
+    cacheOptions: InternalCacheOptions;
+    patchOptions: InternalPatchOptions;
+    patch: () => void;
+    cacheManager: CacheManager;
+    constructor(options?: TailwindcssPatcherOptions);
+    getPkgEntry(basedir?: string): string;
+    setCache(set: Set<string>): string | undefined;
+    getCache(): Set<string> | undefined;
+    /**
+     * @description 在多个 tailwindcss 上下文时，这个方法将被执行多次，所以策略上应该使用 append
+     * 详见 taro weapp-tailwindcss 独立分包
+     * @param basedir
+     * @returns
+     */
+    getClassSet(options?: {
+        basedir?: string;
+        cacheStrategy?: CacheStrategy;
+        removeUniversalSelector?: boolean;
+    }): Set<string>;
+    getContexts(basedir?: string): TailwindcssRuntimeContext[];
+    extract(options: UserConfig['patch']): Promise<string | undefined>;
+}
+
+declare function getTailwindcssEntry(basedir?: string): string;
+declare function getContexts(basedir?: string): TailwindcssRuntimeContext[];
+declare function getClassCaches(basedir?: string): TailwindcssClassCache[];
+declare function getClassCacheSet(basedir?: string, options?: {
+    removeUniversalSelector?: boolean;
+}): Set<string>;
+
+declare function inspectProcessTailwindFeaturesReturnContext(content: string): {
+    code: string;
+    hasPatched: boolean;
+};
+declare function inspectPostcssPlugin(content: string): {
+    code: string;
+    hasPatched: boolean;
+};
+
+declare function getInstalledPkgJsonPath(options?: PatchOptions): string | undefined;
+declare function getPatchOptions(options?: PatchOptions): InternalPatchOptions;
+declare function createPatch(opt: InternalPatchOptions): () => any;
+declare function monkeyPatchForExposingContext(twDir: string, opt: InternalPatchOptions): {
+    processTailwindFeatures?: string | undefined;
+    plugin?: string | undefined;
+} & Record<string, any>;
+declare function internalPatch(pkgJsonPath: string | undefined, options: InternalPatchOptions): any | undefined;
+
+declare function ensureFileContent(filepaths: string | string[]): string | undefined;
+declare function requireResolve(id: string, opts?: SyncOpts): string;
+declare function ensureDir(p: string): Promise<void>;
+
+export { CacheManager, type CacheOptions, type CacheStrategy, type DeepRequired, type InternalCacheOptions, type InternalPatchOptions, type PatchOptions, type TailwindcssClassCache, TailwindcssPatcher, type TailwindcssPatcherOptions, type TailwindcssRuntimeContext, createPatch, ensureDir, ensureFileContent, getCacheOptions, getClassCacheSet, getClassCaches, getContexts, getInstalledPkgJsonPath, getPatchOptions, getTailwindcssEntry, inspectPostcssPlugin, inspectProcessTailwindFeaturesReturnContext, internalPatch, monkeyPatchForExposingContext, requireResolve };

package/dist/index.d.mts

@@ -0,0 +1,149 @@
+import { Rule, Node } from 'postcss';
+import { Config } from 'tailwindcss';
+import { UserConfig } from '@tailwindcss-mangle/config';
+export * from '@tailwindcss-mangle/config';
+import { SyncOpts } from 'resolve';
+
+type CacheStrategy = 'merge' | 'overwrite';
+interface CacheOptions {
+    dir?: string;
+    cwd?: string;
+    file?: string;
+    strategy?: CacheStrategy;
+}
+type InternalCacheOptions = CacheOptions & {
+    enable?: boolean;
+};
+interface PatchOptions {
+    overwrite?: boolean;
+    paths?: string[];
+    basedir?: string;
+    custom?: (dir: string, ctx: Record<string, any>) => void;
+}
+interface InternalPatchOptions {
+    overwrite: boolean;
+    paths?: string[];
+    basedir?: string;
+    custom?: (dir: string, ctx: Record<string, any>) => void;
+    version?: string;
+}
+interface TailwindcssPatcherOptions {
+    cache?: CacheOptions | boolean;
+    patch?: PatchOptions;
+}
+type TailwindcssClassCache = Map<string, ({
+    layer: string;
+    options: Record<string, any>;
+    sort: Record<string, any>;
+} | Rule)[]>;
+type TailwindcssRuntimeContext = {
+    applyClassCache: Map<any, any>;
+    candidateRuleCache: Map<string | string, Set<[
+        {
+            arbitrary: any;
+            index: any;
+            layer: string;
+            options: any[];
+            parallelIndex: any;
+            parentLayer: string;
+            variants: any;
+        },
+        Node
+    ]>>;
+    candidateRuleMap: Map<string | string, [object, Node][]>;
+    changedContent: any[];
+    classCache: TailwindcssClassCache;
+    disposables: any[];
+    getClassList: Function;
+    getClassOrder: Function;
+    getVariants: Function;
+    markInvalidUtilityCandidate: Function;
+    markInvalidUtilityNode: Function;
+    notClassCache: Set<string>;
+    offsets: {
+        layerPositions: object;
+        offsets: object;
+        reservedVariantBits: any;
+        variantOffsets: Map<string, any>;
+    };
+    postCssNodeCache: Map<object, [Node]>;
+    ruleCache: Set<[object, Node]>;
+    stylesheetCache: Record<string, Set<any>>;
+    tailwindConfig: Config;
+    userConfigPath: string | null;
+    variantMap: Map<string, [[object, Function]]>;
+    variantOptions: Map<string, object>;
+};
+type DeepRequired<T> = {
+    [K in keyof T]: Required<DeepRequired<T[K]>>;
+};
+
+declare function getCacheOptions(options?: CacheOptions | boolean): InternalCacheOptions;
+declare class CacheManager {
+    options: Required<CacheOptions> & {
+        filename: string;
+    };
+    constructor(options?: CacheOptions);
+    mkdir(cacheDirectory: string): string;
+    getOptions(options?: CacheOptions): Required<CacheOptions> & {
+        filename: string;
+    };
+    write(data: Set<string>): string | undefined;
+    read(): Set<string> | undefined;
+}
+
+declare class TailwindcssPatcher {
+    rawOptions: TailwindcssPatcherOptions;
+    cacheOptions: InternalCacheOptions;
+    patchOptions: InternalPatchOptions;
+    patch: () => void;
+    cacheManager: CacheManager;
+    constructor(options?: TailwindcssPatcherOptions);
+    getPkgEntry(basedir?: string): string;
+    setCache(set: Set<string>): string | undefined;
+    getCache(): Set<string> | undefined;
+    /**
+     * @description 在多个 tailwindcss 上下文时，这个方法将被执行多次，所以策略上应该使用 append
+     * 详见 taro weapp-tailwindcss 独立分包
+     * @param basedir
+     * @returns
+     */
+    getClassSet(options?: {
+        basedir?: string;
+        cacheStrategy?: CacheStrategy;
+        removeUniversalSelector?: boolean;
+    }): Set<string>;
+    getContexts(basedir?: string): TailwindcssRuntimeContext[];
+    extract(options: UserConfig['patch']): Promise<string | undefined>;
+}
+
+declare function getTailwindcssEntry(basedir?: string): string;
+declare function getContexts(basedir?: string): TailwindcssRuntimeContext[];
+declare function getClassCaches(basedir?: string): TailwindcssClassCache[];
+declare function getClassCacheSet(basedir?: string, options?: {
+    removeUniversalSelector?: boolean;
+}): Set<string>;
+
+declare function inspectProcessTailwindFeaturesReturnContext(content: string): {
+    code: string;
+    hasPatched: boolean;
+};
+declare function inspectPostcssPlugin(content: string): {
+    code: string;
+    hasPatched: boolean;
+};
+
+declare function getInstalledPkgJsonPath(options?: PatchOptions): string | undefined;
+declare function getPatchOptions(options?: PatchOptions): InternalPatchOptions;
+declare function createPatch(opt: InternalPatchOptions): () => any;
+declare function monkeyPatchForExposingContext(twDir: string, opt: InternalPatchOptions): {
+    processTailwindFeatures?: string | undefined;
+    plugin?: string | undefined;
+} & Record<string, any>;
+declare function internalPatch(pkgJsonPath: string | undefined, options: InternalPatchOptions): any | undefined;
+
+declare function ensureFileContent(filepaths: string | string[]): string | undefined;
+declare function requireResolve(id: string, opts?: SyncOpts): string;
+declare function ensureDir(p: string): Promise<void>;
+
+export { CacheManager, type CacheOptions, type CacheStrategy, type DeepRequired, type InternalCacheOptions, type InternalPatchOptions, type PatchOptions, type TailwindcssClassCache, TailwindcssPatcher, type TailwindcssPatcherOptions, type TailwindcssRuntimeContext, createPatch, ensureDir, ensureFileContent, getCacheOptions, getClassCacheSet, getClassCaches, getContexts, getInstalledPkgJsonPath, getPatchOptions, getTailwindcssEntry, inspectPostcssPlugin, inspectProcessTailwindFeaturesReturnContext, internalPatch, monkeyPatchForExposingContext, requireResolve };

package/dist/index.d.ts

@@ -146,4 +146,4 @@ declare function ensureFileContent(filepaths: string | string[]): string | undef
 declare function requireResolve(id: string, opts?: SyncOpts): string;
 declare function ensureDir(p: string): Promise<void>;
 
-export { CacheManager, CacheOptions, CacheStrategy, DeepRequired, InternalCacheOptions, InternalPatchOptions, PatchOptions, TailwindcssClassCache, TailwindcssPatcher, TailwindcssPatcherOptions, TailwindcssRuntimeContext, createPatch, ensureDir, ensureFileContent, getCacheOptions, getClassCacheSet, getClassCaches, getContexts, getInstalledPkgJsonPath, getPatchOptions, getTailwindcssEntry, inspectPostcssPlugin, inspectProcessTailwindFeaturesReturnContext, internalPatch, monkeyPatchForExposingContext, requireResolve };
+export { CacheManager, type CacheOptions, type CacheStrategy, type DeepRequired, type InternalCacheOptions, type InternalPatchOptions, type PatchOptions, type TailwindcssClassCache, TailwindcssPatcher, type TailwindcssPatcherOptions, type TailwindcssRuntimeContext, createPatch, ensureDir, ensureFileContent, getCacheOptions, getClassCacheSet, getClassCaches, getContexts, getInstalledPkgJsonPath, getPatchOptions, getTailwindcssEntry, inspectPostcssPlugin, inspectProcessTailwindFeaturesReturnContext, internalPatch, monkeyPatchForExposingContext, requireResolve };

package/dist/index.mjs

@@ -92,6 +92,12 @@ function log(message, ...optionalParams) {
   return console.log(`[${pkgName}]:` + message, ...optionalParams);
 }
 
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 function getCacheOptions(options) {
   let cache;
   switch (typeof options) {
@@ -116,6 +122,7 @@ function getCacheOptions(options) {
 }
 class CacheManager {
   constructor(options = {}) {
+    __publicField$1(this, "options");
     this.options = this.getOptions(options);
   }
   mkdir(cacheDirectory) {
@@ -456,8 +463,19 @@ async function processTailwindcss(options) {
   });
 }
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 class TailwindcssPatcher {
   constructor(options = {}) {
+    __publicField(this, "rawOptions");
+    __publicField(this, "cacheOptions");
+    __publicField(this, "patchOptions");
+    __publicField(this, "patch");
+    __publicField(this, "cacheManager");
     this.rawOptions = options;
     this.cacheOptions = getCacheOptions(options.cache);
     this.patchOptions = getPatchOptions(options.patch);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tailwindcss-patch",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "patch tailwindcss for exposing context and extract classes",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -36,22 +36,22 @@
     "@types/babel__generator": "^7.6.4",
     "@types/babel__traverse": "^7.20.1",
     "@types/resolve": "^1.20.2",
-    "@types/semver": "^7.5.0",
+    "@types/semver": "^7.5.2",
     "pkg-types": "^1.0.3",
     "tailwindcss": "^3.3.3"
   },
   "dependencies": {
-    "@babel/generator": "^7.22.10",
-    "@babel/parser": "^7.22.10",
-    "@babel/traverse": "^7.22.10",
-    "@babel/types": "^7.22.10",
+    "@babel/generator": "^7.22.15",
+    "@babel/parser": "^7.22.16",
+    "@babel/traverse": "^7.22.19",
+    "@babel/types": "^7.22.19",
     "cac": "^6.7.14",
-    "jiti": "^1.19.1",
+    "jiti": "^1.20.0",
     "lilconfig": "^2.1.0",
-    "postcss": "^8.4.27",
-    "resolve": "^1.22.4",
+    "postcss": "^8.4.29",
+    "resolve": "^1.22.5",
     "semver": "^7.5.4",
-    "@tailwindcss-mangle/config": "^2.1.0"
+    "@tailwindcss-mangle/config": "^2.2.0"
   },
   "homepage": "https://github.com/sonofmagic/tailwindcss-mangle",
   "repository": {
@@ -65,6 +65,7 @@
     "test": "test"
   },
   "scripts": {
+    "dev": "unbuild --sourcemap",
     "build": "unbuild",
     "test": "vitest run --coverage.enabled",
     "test:dev": "vitest",