@runtimestudio/tailwind-sort-php 0.2.0 → 0.2.1

package/README.md

@@ -20,17 +20,17 @@ values, using a real PHP-aware lexer, and leaves everything else byte-identical.
 
 ## Requirements
 
-- **Bun**, or **Node ≥ 22.18** (native TypeScript type-stripping) — both run the CLI and the programmatic API.
+- **Node ≥ 22.18**, or **Bun** — both run the CLI and the programmatic API.
 - `prettier` ≥ 3 and `prettier-plugin-tailwindcss` ≥ 0.8 (peer dependencies).
 
 ## Install
 
 ```sh
-# Bun
-bun add -D @runtimestudio/tailwind-sort-php prettier prettier-plugin-tailwindcss
-
 # npm
 npm install -D @runtimestudio/tailwind-sort-php prettier prettier-plugin-tailwindcss
+
+# Bun
+bun add -D @runtimestudio/tailwind-sort-php prettier prettier-plugin-tailwindcss
 ```
 
 pnpm and yarn work the same (`pnpm add -D …` / `yarn add -D …`).
@@ -38,7 +38,9 @@ pnpm and yarn work the same (`pnpm add -D …` / `yarn add -D …`).
 ## Setup
 
 Point Prettier at your Tailwind v4 entry stylesheet so both `prettier-plugin-tailwindcss` and this tool share one
-vocabulary. In `prettier.config.mjs`:
+vocabulary. Any config format Prettier supports works (`.prettierrc`, `prettier.config.js`, a `package.json`
+`"prettier"` key, …) — the tool reads the resolved config, exactly like the plugin does. For example, in
+`prettier.config.mjs`:
 
 ```js
 export default {
@@ -52,23 +54,23 @@ this in place, the CLI needs no flags.
 
 ## Usage
 
-Run with `bunx` (Bun) or `npx` (Node ≥ 22.18):
+Run with `npx` (Node ≥ 22.18) or `bunx` (Bun):
 
 ```sh
 # sort every .php file under the cwd (stylesheet read from your Prettier config)
-bunx tailwind-sort-php
+npx tailwind-sort-php
 
 # specific globs
-bunx tailwind-sort-php "template-parts/**/*.php" "*.php"
+npx tailwind-sort-php "template-parts/**/*.php" "*.php"
 
 # CI / pre-commit — write nothing, exit 1 if anything is unsorted
-bunx tailwind-sort-php --check
+npx tailwind-sort-php --check
 
 # explicit stylesheet (overrides the Prettier config)
-bunx tailwind-sort-php --stylesheet ./resources/css/main.css
+npx tailwind-sort-php --stylesheet ./resources/css/main.css
 
 # one-time: install the pre-commit hook (see "Pre-commit gate" below)
-bunx tailwind-sort-php init
+npx tailwind-sort-php init
 ```
 
 ### Options
@@ -198,8 +200,8 @@ const out = transform(source, sortFn);
 ## Development
 
 ```sh
-bun test                       # or: node --test "test/*.test.ts"
-bun run build                  # compile src → dist (tsc); the published artifact
+bun test      # or: node --test "test/*.test.ts"
+bun run build # compile src → dist (tsc); the published artifact
 ```
 
 54 tests: 41 core tests that are dependency-free (the sorter is injected, so they run against a mock `SortFn`), 5

package/dist/cli.d.ts

@@ -12,7 +12,7 @@
  *   --check Don't write; exit 1 if any file needs sorting
  *   --no-short-tags Don't treat bare `<?` as a PHP open tag
  *
- * Defaults to all `.php` files under `cwd` (`"**" + "/*.php"`) when no globs are given.
+ * Defaults to all `.php` files under `cwd` when no globs are given.
  * Skips `node_modules`, `vendor`, `dist` and `.git`. The `init` subcommand installs the pre-commit hook; see `init.ts`.
  */
 export {};

package/dist/cli.js

@@ -12,7 +12,7 @@
  *   --check Don't write; exit 1 if any file needs sorting
  *   --no-short-tags Don't treat bare `<?` as a PHP open tag
  *
- * Defaults to all `.php` files under `cwd` (`"**" + "/*.php"`) when no globs are given.
+ * Defaults to all `.php` files under `cwd` when no globs are given.
  * Skips `node_modules`, `vendor`, `dist` and `.git`. The `init` subcommand installs the pre-commit hook; see `init.ts`.
  */
 import { readFile, writeFile } from 'node:fs/promises';
@@ -60,7 +60,6 @@ function parseArgs(argv) {
  * @param globs Glob patterns relative to `cwd`.
  */
 async function* scanFiles(globs) {
-    // Use `Bun.Glob` when available, fall back to `node:fs` glob (Node 22+).
     if (typeof globalThis.Bun !== 'undefined') {
         const { Glob } = await import('bun');
         for (const pattern of globs) {

package/dist/html.d.ts

@@ -8,7 +8,7 @@
  *   - islands inside a quoted attribute value read as opaque atoms
  *
  * Skips HTML comments, doctype/CDATA, and the raw-text content of `script`/`style`/`textarea`/`title` elements —
- * their `script`/`style` content may contain strings like `class="..."` that must not be touched.
+ * their content may contain strings like `class="..."` that must not be touched.
  *
  * @see islands.ts - first pass; produces the islands consumed here.
  */

package/dist/html.js

@@ -8,7 +8,7 @@
  *   - islands inside a quoted attribute value read as opaque atoms
  *
  * Skips HTML comments, doctype/CDATA, and the raw-text content of `script`/`style`/`textarea`/`title` elements —
- * their `script`/`style` content may contain strings like `class="..."` that must not be touched.
+ * their content may contain strings like `class="..."` that must not be touched.
  *
  * @see islands.ts - first pass; produces the islands consumed here.
  */

package/dist/init.js

@@ -13,9 +13,8 @@ const HOOK_PATH = `${HOOKS_DIR}/pre-commit`;
  * Check-and-fail hook (default): names the unsorted files and blocks the commit; never writes.
  */
 const HOOK_CHECK = `#!/bin/sh
-# Block commits with unsorted Tailwind classes in staged PHP files.
-# Installed by \`tailwind-sort-php init\`. Note: checks working-tree file
-# contents, so partial staging (git add -p) can mis-report; see README.
+# Block commits with unsorted Tailwind classes in staged PHP files. Installed by \`tailwind-sort-php init\`.
+# Note: checks working-tree file contents, so partial staging (\`git add -p\`) can mis-report; see README.
 sorter=./node_modules/.bin/tailwind-sort-php
 [ -x "$sorter" ] || exit 0
 git diff --cached --name-only --diff-filter=ACMR -- '*.php' | grep -q . || exit 0
@@ -31,10 +30,9 @@ exit 1
  * Auto-fix hook (--fix): sorts the staged files in place, then blocks the commit for review.
  */
 const HOOK_FIX = `#!/bin/sh
-# Sort Tailwind classes in staged PHP files, then abort the commit so the
-# changes can be reviewed and re-staged. Rewrites working-tree files.
-# Installed by \`tailwind-sort-php init --fix\`. Note: with partial staging
-# (git add -p), re-staging can pull in unrelated unstaged hunks; see README.
+# Sort Tailwind classes in staged PHP files, then abort the commit so the changes can be reviewed and re-staged.
+# Rewrites working-tree files. Installed by \`tailwind-sort-php init --fix\`.
+# Note: with partial staging (\`git add -p\`), re-staging can pull in unrelated unstaged hunks; see README.
 sorter=./node_modules/.bin/tailwind-sort-php
 [ -x "$sorter" ] || exit 0
 git diff --cached --name-only --diff-filter=ACMR -- '*.php' | grep -q . || exit 0

package/dist/islands.js

@@ -73,7 +73,7 @@ function scanPhpBody(src, i) {
             continue;
         }
         // Double-quoted string.
-        // Limitation: nested double quotes in complex `{$a["k"]}` interpolation can desync the lexer (documented).
+        // Limitation: nested double quotes in complex `{$a["k"]}` interpolation can desync the lexer; see README.
         if (c === '"') {
             i = scanQuoted(src, i + 1, '"');
             continue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runtimestudio/tailwind-sort-php",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Tailwind CSS Class Sorter for PHP",
   "keywords": [
     "class-sorting",

package/src/cli.ts

@@ -12,7 +12,7 @@
  *   --check Don't write; exit 1 if any file needs sorting
  *   --no-short-tags Don't treat bare `<?` as a PHP open tag
  *
- * Defaults to all `.php` files under `cwd` (`"**" + "/*.php"`) when no globs are given.
+ * Defaults to all `.php` files under `cwd` when no globs are given.
  * Skips `node_modules`, `vendor`, `dist` and `.git`. The `init` subcommand installs the pre-commit hook; see `init.ts`.
  */
 
@@ -65,7 +65,6 @@ function parseArgs(argv: string[]): Cli {
  * @param globs Glob patterns relative to `cwd`.
  */
 async function* scanFiles(globs: string[]): AsyncGenerator<string> {
-  // Use `Bun.Glob` when available, fall back to `node:fs` glob (Node 22+).
   if (typeof (globalThis as any).Bun !== 'undefined') {
     const { Glob } = await import('bun');
     for (const pattern of globs) {

package/src/html.ts

@@ -8,7 +8,7 @@
  *   - islands inside a quoted attribute value read as opaque atoms
  *
  * Skips HTML comments, doctype/CDATA, and the raw-text content of `script`/`style`/`textarea`/`title` elements —
- * their `script`/`style` content may contain strings like `class="..."` that must not be touched.
+ * their content may contain strings like `class="..."` that must not be touched.
  *
  * @see islands.ts - first pass; produces the islands consumed here.
  */

package/src/init.ts

@@ -16,9 +16,8 @@ const HOOK_PATH = `${HOOKS_DIR}/pre-commit`;
  * Check-and-fail hook (default): names the unsorted files and blocks the commit; never writes.
  */
 const HOOK_CHECK = `#!/bin/sh
-# Block commits with unsorted Tailwind classes in staged PHP files.
-# Installed by \`tailwind-sort-php init\`. Note: checks working-tree file
-# contents, so partial staging (git add -p) can mis-report; see README.
+# Block commits with unsorted Tailwind classes in staged PHP files. Installed by \`tailwind-sort-php init\`.
+# Note: checks working-tree file contents, so partial staging (\`git add -p\`) can mis-report; see README.
 sorter=./node_modules/.bin/tailwind-sort-php
 [ -x "$sorter" ] || exit 0
 git diff --cached --name-only --diff-filter=ACMR -- '*.php' | grep -q . || exit 0
@@ -35,10 +34,9 @@ exit 1
  * Auto-fix hook (--fix): sorts the staged files in place, then blocks the commit for review.
  */
 const HOOK_FIX = `#!/bin/sh
-# Sort Tailwind classes in staged PHP files, then abort the commit so the
-# changes can be reviewed and re-staged. Rewrites working-tree files.
-# Installed by \`tailwind-sort-php init --fix\`. Note: with partial staging
-# (git add -p), re-staging can pull in unrelated unstaged hunks; see README.
+# Sort Tailwind classes in staged PHP files, then abort the commit so the changes can be reviewed and re-staged.
+# Rewrites working-tree files. Installed by \`tailwind-sort-php init --fix\`.
+# Note: with partial staging (\`git add -p\`), re-staging can pull in unrelated unstaged hunks; see README.
 sorter=./node_modules/.bin/tailwind-sort-php
 [ -x "$sorter" ] || exit 0
 git diff --cached --name-only --diff-filter=ACMR -- '*.php' | grep -q . || exit 0

package/src/islands.ts

@@ -104,7 +104,7 @@ function scanPhpBody(src: string, i: number): number {
     }
 
     // Double-quoted string.
-    // Limitation: nested double quotes in complex `{$a["k"]}` interpolation can desync the lexer (documented).
+    // Limitation: nested double quotes in complex `{$a["k"]}` interpolation can desync the lexer; see README.
     if (c === '"') {
       i = scanQuoted(src, i + 1, '"');
       continue;