tailwindcss-patch 1.2.7 → 2.0.0

package/README.md

@@ -1,6 +1,18 @@
 # tailwindcss-patch
 
-get tailwindcss context at runtime!
+get tailwindcss context at runtime ! extract all class to json 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)
+  - [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
 
@@ -13,7 +25,7 @@ get tailwindcss context at runtime!
 2. Patch tailwindcss
 
 ```sh
-npx tw-patch
+npx tw-patch install
 ```
 
 3. Add `prepare` script (keeps patch persisted after npm install)
@@ -24,19 +36,64 @@ npx tw-patch
 {
   /* ... */
   "scripts": {
-    "prepare": "tw-patch"
+    "prepare": "tw-patch install"
   }
 }
 ```
 
 ## Usage
 
+## Cli
+
+### Init Config File
+
+```sh
+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
+
+```sh
+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-patch.config.ts`
+
+### Nodejs
+
 ```js
-import { getContexts, getClassCacheSet } from 'tailwindcss-patch'
+import { TailwindcssPatcher } from 'tailwindcss-patch'
+
+const twPatcher = new TailwindcssPatcher(/* options */)
 // get all contexts at runtime
-getContexts()
+twPatcher.getContexts()
 // get all class generated by tailwindcss utilities
-getClassCacheSet()
+twPatcher.getClassSet()
+```
+
+## Migration form v1 to v2
+
+### 2. cli command change
+
+```diff
+{
+- "tw-patch"
++ "tw-patch install"
+}
+```
+
+### 1. default remove `*` in json array result
+
+```diff
+[
+- "*",
+  "text-[99px]",
+  "text-[100px]"
+]
 ```
 
 ## Notice

package/bin/tw-patch.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
-const fs = require('fs')
-const path = require('path')
-const cliPath = path.resolve(__dirname, '../dist/cli.js')
+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

@@ -0,0 +1,115 @@
+'use strict';
+
+const index = require('./index.cjs');
+const path = require('node:path');
+require('node:fs');
+const fs = require('node:fs/promises');
+require('resolve');
+require('@babel/types');
+require('@babel/generator');
+require('@babel/traverse');
+require('@babel/parser');
+const cac = require('cac');
+require('semver');
+require('postcss');
+require('postcss-load-config');
+require('c12');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const path__default = /*#__PURE__*/_interopDefaultCompat(path);
+const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+const cac__default = /*#__PURE__*/_interopDefaultCompat(cac);
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+const dedent = createDedent({});
+function createDedent(options) {
+  dedent.withOptions = newOptions => createDedent(_objectSpread(_objectSpread({}, options), newOptions));
+  return dedent;
+  function dedent(strings, ...values) {
+    const raw = typeof strings === "string" ? [strings] : strings.raw;
+    const {
+      escapeSpecialCharacters = Array.isArray(strings)
+    } = options;
+
+    // first, perform interpolation
+    let result = "";
+    for (let i = 0; i < raw.length; i++) {
+      let next = raw[i];
+      if (escapeSpecialCharacters) {
+        // handle escaped newlines, backticks, and interpolation characters
+        next = next.replace(/\\\n[ \t]*/g, "").replace(/\\`/g, "`").replace(/\\\$/g, "$").replace(/\\{/g, "{");
+      }
+      result += next;
+      if (i < values.length) {
+        // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
+        result += values[i];
+      }
+    }
+
+    // now strip indentation
+    const lines = result.split("\n");
+    let mindent = null;
+    for (const l of lines) {
+      const m = l.match(/^(\s+)\S+/);
+      if (m) {
+        const indent = m[1].length;
+        if (!mindent) {
+          // this is the first indented line
+          mindent = indent;
+        } else {
+          mindent = Math.min(mindent, indent);
+        }
+      }
+    }
+    if (mindent !== null) {
+      const m = mindent; // appease TypeScript
+      result = lines
+      // https://github.com/typescript-eslint/typescript-eslint/issues/7140
+      // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with
+      .map(l => l[0] === " " || l[0] === "\t" ? l.slice(m) : l).join("\n");
+    }
+    return result
+    // dedent eats leading and trailing whitespace too
+    .trim()
+    // handle escaped newlines at the end to ensure they don't get stripped too
+    .replace(/\\n/g, "\n");
+  }
+}
+
+function init() {
+  const cwd = process.cwd();
+  return fs__default.writeFile(
+    path__default.resolve(cwd, "tailwindcss-patch.config.ts"),
+    dedent`
+      import { defineConfig } from 'tailwindcss-patch'
+
+      export default defineConfig({})
+    `,
+    "utf8"
+  );
+}
+const cli = cac__default();
+cli.command("install", "patch install").action(() => {
+  const opt = index.getPatchOptions();
+  const patch = index.createPatch(opt);
+  patch();
+});
+cli.command("init").action(async () => {
+  await init();
+  console.log("\u2728 tailwindcss-patch config initialized!");
+});
+cli.command("extract").action(async () => {
+  const { config } = await index.getConfig();
+  if (config) {
+    const twPatcher = new index.TailwindcssPatcher();
+    const p = await twPatcher.extract(config);
+    console.log("\u2728 tailwindcss-patch extract success! file path:\n" + p);
+  }
+});
+cli.help();
+cli.parse();

package/dist/cli.d.ts

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

package/dist/cli.mjs

@@ -0,0 +1,107 @@
+import { getPatchOptions, getConfig, TailwindcssPatcher, createPatch } from './index.mjs';
+import path from 'node:path';
+import 'node:fs';
+import fs from 'node:fs/promises';
+import 'resolve';
+import '@babel/types';
+import '@babel/generator';
+import '@babel/traverse';
+import '@babel/parser';
+import cac from 'cac';
+import 'semver';
+import 'postcss';
+import 'postcss-load-config';
+import 'c12';
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+const dedent = createDedent({});
+function createDedent(options) {
+  dedent.withOptions = newOptions => createDedent(_objectSpread(_objectSpread({}, options), newOptions));
+  return dedent;
+  function dedent(strings, ...values) {
+    const raw = typeof strings === "string" ? [strings] : strings.raw;
+    const {
+      escapeSpecialCharacters = Array.isArray(strings)
+    } = options;
+
+    // first, perform interpolation
+    let result = "";
+    for (let i = 0; i < raw.length; i++) {
+      let next = raw[i];
+      if (escapeSpecialCharacters) {
+        // handle escaped newlines, backticks, and interpolation characters
+        next = next.replace(/\\\n[ \t]*/g, "").replace(/\\`/g, "`").replace(/\\\$/g, "$").replace(/\\{/g, "{");
+      }
+      result += next;
+      if (i < values.length) {
+        // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
+        result += values[i];
+      }
+    }
+
+    // now strip indentation
+    const lines = result.split("\n");
+    let mindent = null;
+    for (const l of lines) {
+      const m = l.match(/^(\s+)\S+/);
+      if (m) {
+        const indent = m[1].length;
+        if (!mindent) {
+          // this is the first indented line
+          mindent = indent;
+        } else {
+          mindent = Math.min(mindent, indent);
+        }
+      }
+    }
+    if (mindent !== null) {
+      const m = mindent; // appease TypeScript
+      result = lines
+      // https://github.com/typescript-eslint/typescript-eslint/issues/7140
+      // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with
+      .map(l => l[0] === " " || l[0] === "\t" ? l.slice(m) : l).join("\n");
+    }
+    return result
+    // dedent eats leading and trailing whitespace too
+    .trim()
+    // handle escaped newlines at the end to ensure they don't get stripped too
+    .replace(/\\n/g, "\n");
+  }
+}
+
+function init() {
+  const cwd = process.cwd();
+  return fs.writeFile(
+    path.resolve(cwd, "tailwindcss-patch.config.ts"),
+    dedent`
+      import { defineConfig } from 'tailwindcss-patch'
+
+      export default defineConfig({})
+    `,
+    "utf8"
+  );
+}
+const cli = cac();
+cli.command("install", "patch install").action(() => {
+  const opt = getPatchOptions();
+  const patch = createPatch(opt);
+  patch();
+});
+cli.command("init").action(async () => {
+  await init();
+  console.log("\u2728 tailwindcss-patch config initialized!");
+});
+cli.command("extract").action(async () => {
+  const { config } = await getConfig();
+  if (config) {
+    const twPatcher = new TailwindcssPatcher();
+    const p = await twPatcher.extract(config);
+    console.log("\u2728 tailwindcss-patch extract success! file path:\n" + p);
+  }
+});
+cli.help();
+cli.parse();