tailwindcss-patch 2.0.0-alpha.0 → 2.0.0

package/README.md

@@ -7,9 +7,11 @@ get tailwindcss context at runtime ! extract all class to json file!
   - [Usage](#usage)
   - [Cli](#cli)
     - [Init Config File](#init-config-file)
-    - [extract all class into a json](#extract-all-class-into-a-json)
+    - [Extract all class into a json](#extract-all-class-into-a-json)
     - [Nodejs](#nodejs)
   - [Migration form v1 to v2](#migration-form-v1-to-v2)
+    - [2. cli command change](#2-cli-command-change)
+    - [1. default remove `*` in json array result](#1-default-remove--in-json-array-result)
   - [Notice](#notice)
 
 ## Setup
@@ -51,7 +53,7 @@ tw-patch init
 
 Then there will be a ts file called `tailwindcss-patch.config.ts` exist in your `cwd`.
 
-### extract all class into a json
+### Extract all class into a json
 
 ```sh
 tw-patch extract
@@ -70,11 +72,13 @@ const twPatcher = new TailwindcssPatcher(/* options */)
 // get all contexts at runtime
 twPatcher.getContexts()
 // get all class generated by tailwindcss utilities
-twPatcher.getClassCacheSet()
+twPatcher.getClassSet()
 ```
 
 ## Migration form v1 to v2
 
+### 2. cli command change
+
 ```diff
 {
 - "tw-patch"
@@ -82,6 +86,16 @@ twPatcher.getClassCacheSet()
 }
 ```
 
+### 1. default remove `*` in json array result
+
+```diff
+[
+- "*",
+  "text-[99px]",
+  "text-[100px]"
+]
+```
+
 ## Notice
 
 `getContexts`,`getClassCacheSet` should be invoked after `postcss-loader`'s activation.

package/bin/tw-patch.js

@@ -1,7 +1,7 @@
-#!/usr/bin/env node
-const fs = require('node:fs')
-const path = require('node:path')
-const cliPath = path.resolve(__dirname, '../dist/cli.cjs')
-if (fs.existsSync(cliPath)) {
-  require(cliPath)
-}
+#!/usr/bin/env node
+const fs = require('node:fs')
+const path = require('node:path')
+const cliPath = path.resolve(__dirname, '../dist/cli.cjs')
+if (fs.existsSync(cliPath)) {
+  require(cliPath)
+}

package/dist/cli.cjs

@@ -105,13 +105,10 @@ cli.command("init").action(async () => {
 });
 cli.command("extract").action(async () => {
   const { config } = await index.getConfig();
-  if (config?.output?.filename) {
+  if (config) {
     const twPatcher = new index.TailwindcssPatcher();
-    await twPatcher.extract({
-      filename: config.output.filename,
-      configDir: config.postcss?.configDir,
-      loose: config.postcss?.loose
-    });
+    const p = await twPatcher.extract(config);
+    console.log("\u2728 tailwindcss-patch extract success! file path:\n" + p);
   }
 });
 cli.help();

package/dist/cli.mjs

@@ -97,13 +97,10 @@ cli.command("init").action(async () => {
 });
 cli.command("extract").action(async () => {
   const { config } = await getConfig();
-  if (config?.output?.filename) {
+  if (config) {
     const twPatcher = new TailwindcssPatcher();
-    await twPatcher.extract({
-      filename: config.output.filename,
-      configDir: config.postcss?.configDir,
-      loose: config.postcss?.loose
-    });
+    const p = await twPatcher.extract(config);
+    console.log("\u2728 tailwindcss-patch extract success! file path:\n" + p);
   }
 });
 cli.help();

package/dist/index.cjs

@@ -86,12 +86,15 @@ function getClassCaches(basedir) {
   const contexts = getContexts(basedir);
   return contexts.map((x) => x.classCache);
 }
-function getClassCacheSet(basedir) {
+function getClassCacheSet(basedir, options) {
   const classCaches = getClassCaches(basedir);
   const classSet = /* @__PURE__ */ new Set();
   for (const classCacheMap of classCaches) {
     const keys = classCacheMap.keys();
     for (const key of keys) {
+      if (options?.removeUniversalSelector && key.toString() === "*") {
+        continue;
+      }
       classSet.add(key.toString());
     }
   }
@@ -362,6 +365,18 @@ const defu = createDefu();
 const defaultOptions = {
   overwrite: true
 };
+function getDefaultUserConfig() {
+  return {
+    output: {
+      filename: ".tw-patch/tw-class-list.json",
+      removeUniversalSelector: true,
+      loose: true
+    },
+    postcss: {
+      configDir: process.cwd()
+    }
+  };
+}
 
 function getInstalledPkgJsonPath(options = {}) {
   try {
@@ -470,11 +485,11 @@ class TailwindcssPatcher {
    * @param basedir
    * @returns
    */
-  getClassSet(options = {
-    cacheStrategy: this.cacheOptions.strategy ?? "merge"
-  }) {
-    const { basedir, cacheStrategy } = options;
-    const set = getClassCacheSet(basedir);
+  getClassSet(options) {
+    const { basedir, cacheStrategy = this.cacheOptions.strategy ?? "merge", removeUniversalSelector = true } = options ?? {};
+    const set = getClassCacheSet(basedir, {
+      removeUniversalSelector
+    });
     if (cacheStrategy === "overwrite") {
       set.size > 0 && this.setCache(set);
     } else if (cacheStrategy === "merge") {
@@ -492,13 +507,19 @@ class TailwindcssPatcher {
     return getContexts(basedir);
   }
   async extract(options) {
-    const { configDir, filename, loose } = options;
-    await getCss(configDir);
-    const set = this.getClassSet();
-    await ensureDir(path.dirname(filename));
-    const classList = [...set];
-    await fs__default$1.writeFile(filename, JSON.stringify(classList, null, loose ? 2 : void 0), "utf8");
-    return classList;
+    const { output, postcss } = options;
+    if (output && postcss) {
+      const { removeUniversalSelector, filename, loose } = output;
+      const { configDir } = postcss;
+      await getCss(configDir);
+      const set = this.getClassSet({
+        removeUniversalSelector
+      });
+      await ensureDir(path.dirname(filename));
+      const classList = [...set];
+      await fs__default$1.writeFile(filename, JSON.stringify(classList, null, loose ? 2 : void 0), "utf8");
+      return filename;
+    }
   }
 }
 
@@ -506,13 +527,7 @@ function getConfig() {
   return c12.loadConfig({
     name: "tailwindcss-patch",
     defaults: {
-      output: {
-        filename: ".tw-patch/tw-class-list.json"
-      },
-      postcss: {
-        configDir: process.cwd(),
-        loose: true
-      }
+      ...getDefaultUserConfig()
     }
   });
 }

package/dist/index.d.ts

@@ -76,13 +76,20 @@ type TailwindcssRuntimeContext = {
 interface UserConfig {
     output?: {
         filename?: string;
+        loose?: boolean;
+        /**
+         * @description remove * in output json
+         */
+        removeUniversalSelector?: boolean;
     };
     postcss?: {
         configDir?: string;
-        loose?: boolean;
     };
     tailwindcss?: {};
 }
+type DeepRequired<T> = {
+    [K in keyof T]: Required<DeepRequired<T[K]>>;
+};
 
 declare function getCacheOptions(options?: CacheOptions | boolean): InternalCacheOptions;
 declare class CacheManager {
@@ -117,19 +124,18 @@ declare class TailwindcssPatcher {
     getClassSet(options?: {
         basedir?: string;
         cacheStrategy?: CacheStrategy;
+        removeUniversalSelector?: boolean;
     }): Set<string>;
     getContexts(basedir?: string): TailwindcssRuntimeContext[];
-    extract(options: {
-        configDir: string;
-        filename: string;
-        loose: boolean;
-    }): Promise<string[]>;
+    extract(options: DeepRequired<UserConfig>): 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): Set<string>;
+declare function getClassCacheSet(basedir?: string, options?: {
+    removeUniversalSelector?: boolean;
+}): Set<string>;
 
 declare function inspectProcessTailwindFeaturesReturnContext(content: string): {
     code: string;
@@ -149,11 +155,11 @@ declare function monkeyPatchForExposingContext(twDir: string, opt: InternalPatch
 } & Record<string, any>;
 declare function internalPatch(pkgJsonPath: string | undefined, options: InternalPatchOptions): any | undefined;
 
-declare function getConfig(): Promise<c12.ResolvedConfig<UserConfig, c12.ConfigLayerMeta>>;
+declare function getConfig(): Promise<c12.ResolvedConfig<DeepRequired<UserConfig>, c12.ConfigLayerMeta>>;
 declare const defineConfig: c12.DefineConfig<UserConfig, c12.ConfigLayerMeta>;
 
 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, CacheOptions, CacheStrategy, InternalCacheOptions, InternalPatchOptions, PatchOptions, TailwindcssClassCache, TailwindcssPatcher, TailwindcssPatcherOptions, TailwindcssRuntimeContext, UserConfig, createPatch, defineConfig, ensureDir, ensureFileContent, getCacheOptions, getClassCacheSet, getClassCaches, getConfig, getContexts, getInstalledPkgJsonPath, getPatchOptions, getTailwindcssEntry, inspectPostcssPlugin, inspectProcessTailwindFeaturesReturnContext, internalPatch, monkeyPatchForExposingContext, requireResolve };
+export { CacheManager, CacheOptions, CacheStrategy, DeepRequired, InternalCacheOptions, InternalPatchOptions, PatchOptions, TailwindcssClassCache, TailwindcssPatcher, TailwindcssPatcherOptions, TailwindcssRuntimeContext, UserConfig, createPatch, defineConfig, ensureDir, ensureFileContent, getCacheOptions, getClassCacheSet, getClassCaches, getConfig, getContexts, getInstalledPkgJsonPath, getPatchOptions, getTailwindcssEntry, inspectPostcssPlugin, inspectProcessTailwindFeaturesReturnContext, internalPatch, monkeyPatchForExposingContext, requireResolve };

package/dist/index.mjs

@@ -69,12 +69,15 @@ function getClassCaches(basedir) {
   const contexts = getContexts(basedir);
   return contexts.map((x) => x.classCache);
 }
-function getClassCacheSet(basedir) {
+function getClassCacheSet(basedir, options) {
   const classCaches = getClassCaches(basedir);
   const classSet = /* @__PURE__ */ new Set();
   for (const classCacheMap of classCaches) {
     const keys = classCacheMap.keys();
     for (const key of keys) {
+      if (options?.removeUniversalSelector && key.toString() === "*") {
+        continue;
+      }
       classSet.add(key.toString());
     }
   }
@@ -345,6 +348,18 @@ const defu = createDefu();
 const defaultOptions = {
   overwrite: true
 };
+function getDefaultUserConfig() {
+  return {
+    output: {
+      filename: ".tw-patch/tw-class-list.json",
+      removeUniversalSelector: true,
+      loose: true
+    },
+    postcss: {
+      configDir: process.cwd()
+    }
+  };
+}
 
 function getInstalledPkgJsonPath(options = {}) {
   try {
@@ -453,11 +468,11 @@ class TailwindcssPatcher {
    * @param basedir
    * @returns
    */
-  getClassSet(options = {
-    cacheStrategy: this.cacheOptions.strategy ?? "merge"
-  }) {
-    const { basedir, cacheStrategy } = options;
-    const set = getClassCacheSet(basedir);
+  getClassSet(options) {
+    const { basedir, cacheStrategy = this.cacheOptions.strategy ?? "merge", removeUniversalSelector = true } = options ?? {};
+    const set = getClassCacheSet(basedir, {
+      removeUniversalSelector
+    });
     if (cacheStrategy === "overwrite") {
       set.size > 0 && this.setCache(set);
     } else if (cacheStrategy === "merge") {
@@ -475,13 +490,19 @@ class TailwindcssPatcher {
     return getContexts(basedir);
   }
   async extract(options) {
-    const { configDir, filename, loose } = options;
-    await getCss(configDir);
-    const set = this.getClassSet();
-    await ensureDir(dirname(filename));
-    const classList = [...set];
-    await fs$1.writeFile(filename, JSON.stringify(classList, null, loose ? 2 : void 0), "utf8");
-    return classList;
+    const { output, postcss } = options;
+    if (output && postcss) {
+      const { removeUniversalSelector, filename, loose } = output;
+      const { configDir } = postcss;
+      await getCss(configDir);
+      const set = this.getClassSet({
+        removeUniversalSelector
+      });
+      await ensureDir(dirname(filename));
+      const classList = [...set];
+      await fs$1.writeFile(filename, JSON.stringify(classList, null, loose ? 2 : void 0), "utf8");
+      return filename;
+    }
   }
 }
 
@@ -489,13 +510,7 @@ function getConfig() {
   return loadConfig({
     name: "tailwindcss-patch",
     defaults: {
-      output: {
-        filename: ".tw-patch/tw-class-list.json"
-      },
-      postcss: {
-        configDir: process.cwd(),
-        loose: true
-      }
+      ...getDefaultUserConfig()
     }
   });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tailwindcss-patch",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0",
   "description": "patch tailwindcss for exposing context",
   "exports": {
     ".": {
@@ -75,6 +75,6 @@
     "build": "unbuild",
     "test": "vitest run --coverage.enabled",
     "test:dev": "vitest",
-    "cli": "node bin/tw-patch.js"
+    "cli": "node bin/tw-patch.js install"
   }
 }