@runtimestudio/tailwind-sort-php 0.2.0 → 0.3.0

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
@@ -53,9 +51,9 @@ exit 1
 `;
 
 interface InitCli {
-  fix: boolean;
-  force: boolean;
-  dryRun: boolean;
+    fix: boolean;
+    force: boolean;
+    dryRun: boolean;
 }
 
 /**
@@ -65,17 +63,17 @@ interface InitCli {
  * @returns Parsed flags with defaults applied.
  */
 function parseArgs(argv: string[]): InitCli {
-  const cli: InitCli = { fix: false, force: false, dryRun: false };
-  for (const a of argv) {
-    if (a === '--fix') cli.fix = true;
-    else if (a === '--force') cli.force = true;
-    else if (a === '--dry-run') cli.dryRun = true;
-    else {
-      console.error(`Unknown init option: ${a}`);
-      process.exit(2);
+    const cli: InitCli = { fix: false, force: false, dryRun: false };
+    for (const a of argv) {
+        if (a === '--fix') cli.fix = true;
+        else if (a === '--force') cli.force = true;
+        else if (a === '--dry-run') cli.dryRun = true;
+        else {
+            console.error(`Unknown init option: ${a}`);
+            process.exit(2);
+        }
     }
-  }
-  return cli;
+    return cli;
 }
 
 /**
@@ -85,11 +83,11 @@ function parseArgs(argv: string[]): InitCli {
  * @returns Trimmed stdout, or `null` when git exits non-zero (unset config, not a repo, …).
  */
 function git(args: string[]): string | null {
-  try {
-    return execFileSync('git', args, { encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }).trim();
-  } catch {
-    return null;
-  }
+    try {
+        return execFileSync('git', args, { encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }).trim();
+    } catch {
+        return null;
+    }
 }
 
 /**
@@ -98,8 +96,8 @@ function git(args: string[]): string | null {
  * @param message Error text explaining why init refused to proceed.
  */
 function fail(message: string): never {
-  console.error(message);
-  process.exit(1);
+    console.error(message);
+    process.exit(1);
 }
 
 /**
@@ -108,81 +106,89 @@ function fail(message: string): never {
  * @param argv Arguments after the `init` subcommand name.
  */
 export async function runInit(argv: string[]): Promise<void> {
-  const cli = parseArgs(argv);
-  const hookBody = cli.fix ? HOOK_FIX : HOOK_CHECK;
-  const variant = cli.fix ? 'fix' : 'check';
+    const cli = parseArgs(argv);
+    const hookBody = cli.fix ? HOOK_FIX : HOOK_CHECK;
+    const variant = cli.fix ? 'fix' : 'check';
 
-  // Anchor everything at the repository root: a relative `core.hooksPath` resolves there,
-  // and the hook's `./node_modules/...` path assumes hooks run from it (they do, for pre-commit).
-  const top = git(['rev-parse', '--show-toplevel']);
-  if (top === null) fail('Not a git repository (or a bare one) — run init from inside a working tree.');
-  const gitDir = git(['rev-parse', '--absolute-git-dir'])!;
-  const hookAbs = join(top, HOOK_PATH);
+    // Anchor everything at the repository root: a relative `core.hooksPath` resolves there,
+    // and the hook's `./node_modules/...` path assumes hooks run from it (they do, for pre-commit).
+    const top = git(['rev-parse', '--show-toplevel']);
+    if (top === null) fail('Not a git repository (or a bare one) — run init from inside a working tree.');
+    const gitDir = git(['rev-parse', '--absolute-git-dir'])!;
+    const hookAbs = join(top, HOOK_PATH);
 
-  // Decide whether `core.hooksPath` needs to change. Repointing it makes git ignore `.git/hooks` entirely,
-  // so refuse to silently disable hooks that already live there.
-  const hooksPath = git(['config', '--get', 'core.hooksPath']);
-  let setConfig = false;
-  if (hooksPath === null) {
-    const live = (await readdir(join(gitDir, 'hooks')).catch(() => [])).filter((f) => !f.endsWith('.sample'));
-    if (live.length > 0 && !cli.force) {
-      fail(
-        `Found existing hook(s) in .git/hooks: ${live.join(', ')}.\n` +
-          `Setting core.hooksPath would disable them. Move them into ${HOOKS_DIR}/ first, ` +
-          'or re-run with --force to proceed anyway.',
-      );
-    }
-    setConfig = true;
-  } else if (hooksPath !== HOOKS_DIR) {
-    if (!cli.force) {
-      fail(
-        `core.hooksPath is already set to "${hooksPath}" — add the hook there yourself, or re-run ` +
-          `with --force to repoint it to ${HOOKS_DIR}. Hook body:\n\n${hookBody}`,
-      );
+    // Decide whether `core.hooksPath` needs to change. Repointing it makes git ignore `.git/hooks` entirely,
+    // so refuse to silently disable hooks that already live there.
+    const hooksPath = git(['config', '--get', 'core.hooksPath']);
+    let setConfig = false;
+    if (hooksPath === null) {
+        const live = (await readdir(join(gitDir, 'hooks')).catch(() => [])).filter((f) => !f.endsWith('.sample'));
+        if (live.length > 0 && !cli.force) {
+            fail(
+                `Found existing hook(s) in .git/hooks: ${live.join(', ')}.\n` +
+                    `Setting core.hooksPath would disable them. Move them into ${HOOKS_DIR}/ first, ` +
+                    'or re-run with --force to proceed anyway.',
+            );
+        }
+        setConfig = true;
+    } else if (hooksPath !== HOOKS_DIR) {
+        if (!cli.force) {
+            fail(
+                `core.hooksPath is already set to "${hooksPath}" — add the hook there yourself, or re-run ` +
+                    `with --force to repoint it to ${HOOKS_DIR}. Hook body:\n\n${hookBody}`,
+            );
+        }
+        setConfig = true;
     }
-    setConfig = true;
-  }
 
-  // Decide whether the hook file needs writing; overwriting a differing hook needs --force.
-  const current = await readFile(hookAbs, 'utf8').catch(() => null);
-  let writeHook = current === null;
-  let repairMode = false;
-  if (current !== null && current !== hookBody) {
-    if (!cli.force) {
-      const installed =
-        current === HOOK_CHECK ? 'the check variant' : current === HOOK_FIX ? 'the --fix variant' : 'a custom hook';
-      fail(`${HOOK_PATH} already exists and differs (${installed} is installed). Re-run with --force to overwrite.`);
+    // Decide whether the hook file needs writing; overwriting a differing hook needs --force.
+    const current = await readFile(hookAbs, 'utf8').catch(() => null);
+    let writeHook = current === null;
+    let repairMode = false;
+    if (current !== null && current !== hookBody) {
+        if (!cli.force) {
+            const installed =
+                current === HOOK_CHECK
+                    ? 'the check variant'
+                    : current === HOOK_FIX
+                      ? 'the --fix variant'
+                      : 'a custom hook';
+            fail(
+                `${HOOK_PATH} already exists and differs (${installed} is installed). Re-run with --force to overwrite.`,
+            );
+        }
+        writeHook = true;
+    }
+    if (current === hookBody) {
+        // Content is already right; still repair a missing executable bit, or git silently skips the hook.
+        repairMode = ((await stat(hookAbs)).mode & 0o111) === 0;
     }
-    writeHook = true;
-  }
-  if (current === hookBody) {
-    // Content is already right; still repair a missing executable bit, or git silently skips the hook.
-    repairMode = ((await stat(hookAbs)).mode & 0o111) === 0;
-  }
 
-  const done: string[] = [];
-  if (writeHook) {
-    if (!cli.dryRun) {
-      await mkdir(join(top, HOOKS_DIR), { recursive: true });
-      await writeFile(hookAbs, hookBody);
-      await chmod(hookAbs, 0o755);
+    const done: string[] = [];
+    if (writeHook) {
+        if (!cli.dryRun) {
+            await mkdir(join(top, HOOKS_DIR), { recursive: true });
+            await writeFile(hookAbs, hookBody);
+            await chmod(hookAbs, 0o755);
+        }
+        done.push(
+            cli.dryRun
+                ? `would install ${HOOK_PATH} (${variant} variant)`
+                : `installed ${HOOK_PATH} (${variant} variant)`,
+        );
+    }
+    if (repairMode) {
+        if (!cli.dryRun) await chmod(hookAbs, 0o755);
+        done.push(cli.dryRun ? `would make ${HOOK_PATH} executable` : `made ${HOOK_PATH} executable`);
+    }
+    if (setConfig) {
+        if (!cli.dryRun) git(['config', 'core.hooksPath', HOOKS_DIR]);
+        done.push(cli.dryRun ? `would set core.hooksPath = ${HOOKS_DIR}` : `set core.hooksPath = ${HOOKS_DIR}`);
     }
-    done.push(
-      cli.dryRun ? `would install ${HOOK_PATH} (${variant} variant)` : `installed ${HOOK_PATH} (${variant} variant)`,
-    );
-  }
-  if (repairMode) {
-    if (!cli.dryRun) await chmod(hookAbs, 0o755);
-    done.push(cli.dryRun ? `would make ${HOOK_PATH} executable` : `made ${HOOK_PATH} executable`);
-  }
-  if (setConfig) {
-    if (!cli.dryRun) git(['config', 'core.hooksPath', HOOKS_DIR]);
-    done.push(cli.dryRun ? `would set core.hooksPath = ${HOOKS_DIR}` : `set core.hooksPath = ${HOOKS_DIR}`);
-  }
 
-  if (done.length === 0) {
-    console.log(`Nothing to do — ${HOOK_PATH} (${variant} variant) is already installed.`);
-    return;
-  }
-  for (const line of done) console.log(line);
+    if (done.length === 0) {
+        console.log(`Nothing to do — ${HOOK_PATH} (${variant} variant) is already installed.`);
+        return;
+    }
+    for (const line of done) console.log(line);
 }

package/src/islands.ts

@@ -14,25 +14,25 @@
  * A contiguous region of PHP code within a mixed template source.
  */
 export interface Island {
-  /**
-   * Inclusive start offset of `<?`.
-   */
-  start: number;
-  /**
-   * Exclusive end offset (just past `?>`, or EOF).
-   */
-  end: number;
+    /**
+     * Inclusive start offset of `<?`.
+     */
+    start: number;
+    /**
+     * Exclusive end offset (just past `?>`, or EOF).
+     */
+    end: number;
 }
 
 /**
  * Options controlling PHP open-tag recognition.
  */
 export interface IslandOptions {
-  /**
-   * Treat bare `<?` as a PHP open tag (short_open_tag).
-   * Default true, with a guard so `<?xml` is never treated as PHP.
-   */
-  shortOpenTags?: boolean;
+    /**
+     * Treat bare `<?` as a PHP open tag (short_open_tag).
+     * Default true, with a guard so `<?xml` is never treated as PHP.
+     */
+    shortOpenTags?: boolean;
 }
 
 const isIdentStart = (c: string) => /[A-Za-z_\u0080-\uffff]/.test(c);
@@ -53,35 +53,35 @@ const isIdent = (c: string) => /[A-Za-z0-9_\u0080-\uffff]/.test(c);
  * // [{ start: 3, end: 12 }]
  */
 export function findIslands(src: string, opts: IslandOptions = {}): Island[] {
-  const shortTags = opts.shortOpenTags !== false;
-  const islands: Island[] = [];
-  const len = src.length;
-  let i = 0;
-
-  while (i < len) {
-    const open = src.indexOf('<?', i);
-    if (open === -1) break;
-
-    // Classify the open tag.
-    const after = src.slice(open + 2, open + 6).toLowerCase();
-    let bodyStart: number;
-    if (after.startsWith('php') && (open + 5 >= len || !isIdent(src[open + 5]))) {
-      bodyStart = open + 5;
-    } else if (src[open + 2] === '=') {
-      bodyStart = open + 3;
-    } else if (shortTags && !after.startsWith('xml')) {
-      bodyStart = open + 2;
-    } else {
-      i = open + 2; // not a PHP tag (e.g. `<?xml`) — keep scanning
-      continue;
+    const shortTags = opts.shortOpenTags !== false;
+    const islands: Island[] = [];
+    const len = src.length;
+    let i = 0;
+
+    while (i < len) {
+        const open = src.indexOf('<?', i);
+        if (open === -1) break;
+
+        // Classify the open tag.
+        const after = src.slice(open + 2, open + 6).toLowerCase();
+        let bodyStart: number;
+        if (after.startsWith('php') && (open + 5 >= len || !isIdent(src[open + 5]))) {
+            bodyStart = open + 5;
+        } else if (src[open + 2] === '=') {
+            bodyStart = open + 3;
+        } else if (shortTags && !after.startsWith('xml')) {
+            bodyStart = open + 2;
+        } else {
+            i = open + 2; // not a PHP tag (e.g. `<?xml`) — keep scanning
+            continue;
+        }
+
+        const end = scanPhpBody(src, bodyStart);
+        islands.push({ start: open, end });
+        i = end;
     }
 
-    const end = scanPhpBody(src, bodyStart);
-    islands.push({ start: open, end });
-    i = end;
-  }
-
-  return islands;
+    return islands;
 }
 
 /**
@@ -89,68 +89,68 @@ export function findIslands(src: string, opts: IslandOptions = {}): Island[] {
  * or `src.length` if the file ends in PHP mode.
  */
 function scanPhpBody(src: string, i: number): number {
-  const len = src.length;
-
-  while (i < len) {
-    const c = src[i];
-
-    // Possible close tag.
-    if (c === '?' && src[i + 1] === '>') return i + 2;
-
-    // Single-quoted string.
-    if (c === "'") {
-      i = scanQuoted(src, i + 1, "'");
-      continue;
-    }
-
-    // Double-quoted string.
-    // Limitation: nested double quotes in complex `{$a["k"]}` interpolation can desync the lexer (documented).
-    if (c === '"') {
-      i = scanQuoted(src, i + 1, '"');
-      continue;
-    }
-
-    // Backtick (shell exec) string — same escaping rules.
-    if (c === '`') {
-      i = scanQuoted(src, i + 1, '`');
-      continue;
-    }
-
-    // Comments.
-    if (c === '/' && src[i + 1] === '/') {
-      i = scanLineComment(src, i + 2);
-      if (src.startsWith('?>', i)) return i + 2;
-      continue;
-    }
-    if (c === '#') {
-      // PHP 8 attribute `#[...]` is not a comment.
-      if (src[i + 1] === '[') {
-        i += 2;
-        continue;
-      }
-      i = scanLineComment(src, i + 1);
-      if (src.startsWith('?>', i)) return i + 2;
-      continue;
-    }
-    if (c === '/' && src[i + 1] === '*') {
-      const close = src.indexOf('*/', i + 2);
-      i = close === -1 ? len : close + 2;
-      continue;
+    const len = src.length;
+
+    while (i < len) {
+        const c = src[i];
+
+        // Possible close tag.
+        if (c === '?' && src[i + 1] === '>') return i + 2;
+
+        // Single-quoted string.
+        if (c === "'") {
+            i = scanQuoted(src, i + 1, "'");
+            continue;
+        }
+
+        // Double-quoted string.
+        // Limitation: nested double quotes in complex `{$a["k"]}` interpolation can desync the lexer; see README.
+        if (c === '"') {
+            i = scanQuoted(src, i + 1, '"');
+            continue;
+        }
+
+        // Backtick (shell exec) string — same escaping rules.
+        if (c === '`') {
+            i = scanQuoted(src, i + 1, '`');
+            continue;
+        }
+
+        // Comments.
+        if (c === '/' && src[i + 1] === '/') {
+            i = scanLineComment(src, i + 2);
+            if (src.startsWith('?>', i)) return i + 2;
+            continue;
+        }
+        if (c === '#') {
+            // PHP 8 attribute `#[...]` is not a comment.
+            if (src[i + 1] === '[') {
+                i += 2;
+                continue;
+            }
+            i = scanLineComment(src, i + 1);
+            if (src.startsWith('?>', i)) return i + 2;
+            continue;
+        }
+        if (c === '/' && src[i + 1] === '*') {
+            const close = src.indexOf('*/', i + 2);
+            i = close === -1 ? len : close + 2;
+            continue;
+        }
+
+        // Heredoc / nowdoc.
+        if (c === '<' && src[i + 1] === '<' && src[i + 2] === '<') {
+            const here = scanHeredoc(src, i + 3);
+            if (here !== -1) {
+                i = here;
+                continue;
+            }
+        }
+
+        i++;
     }
 
-    // Heredoc / nowdoc.
-    if (c === '<' && src[i + 1] === '<' && src[i + 2] === '<') {
-      const here = scanHeredoc(src, i + 3);
-      if (here !== -1) {
-        i = here;
-        continue;
-      }
-    }
-
-    i++;
-  }
-
-  return len; // file ends while still in PHP mode
+    return len; // file ends while still in PHP mode
 }
 
 /**
@@ -158,17 +158,17 @@ function scanPhpBody(src: string, i: number): number {
  * Returns offset just past the closing quote (or EOF).
  */
 function scanQuoted(src: string, i: number, quote: string): number {
-  const len = src.length;
-  while (i < len) {
-    const c = src[i];
-    if (c === '\\') {
-      i += 2;
-      continue;
+    const len = src.length;
+    while (i < len) {
+        const c = src[i];
+        if (c === '\\') {
+            i += 2;
+            continue;
+        }
+        if (c === quote) return i + 1;
+        i++;
     }
-    if (c === quote) return i + 1;
-    i++;
-  }
-  return len;
+    return len;
 }
 
 /**
@@ -177,13 +177,13 @@ function scanQuoted(src: string, i: number, quote: string): number {
  * (left for the caller, since `?>` closes both the comment and the island).
  */
 function scanLineComment(src: string, i: number): number {
-  const len = src.length;
-  while (i < len) {
-    if (src[i] === '\n') return i + 1;
-    if (src[i] === '?' && src[i + 1] === '>') return i;
-    i++;
-  }
-  return len;
+    const len = src.length;
+    while (i < len) {
+        if (src[i] === '\n') return i + 1;
+        if (src[i] === '?' && src[i + 1] === '>') return i;
+        i++;
+    }
+    return len;
 }
 
 /**
@@ -191,46 +191,46 @@ function scanLineComment(src: string, i: number): number {
  * Returns the offset past the closing identifier line, or -1 if `<<<` isn't followed by a valid heredoc identifier.
  */
 function scanHeredoc(src: string, i: number): number {
-  const len = src.length;
-  // Optional whitespace (PHP allows spaces/tabs after `<<<`).
-  while (i < len && (src[i] === ' ' || src[i] === '\t')) i++;
-
-  // Optional quote around the identifier.
-  let quote = '';
-  if (src[i] === "'" || src[i] === '"') {
-    quote = src[i];
-    i++;
-  }
+    const len = src.length;
+    // Optional whitespace (PHP allows spaces/tabs after `<<<`).
+    while (i < len && (src[i] === ' ' || src[i] === '\t')) i++;
+
+    // Optional quote around the identifier.
+    let quote = '';
+    if (src[i] === "'" || src[i] === '"') {
+        quote = src[i];
+        i++;
+    }
 
-  if (i >= len || !isIdentStart(src[i])) return -1;
-  const idStart = i;
-  while (i < len && isIdent(src[i])) i++;
-  const id = src.slice(idStart, i);
+    if (i >= len || !isIdentStart(src[i])) return -1;
+    const idStart = i;
+    while (i < len && isIdent(src[i])) i++;
+    const id = src.slice(idStart, i);
 
-  if (quote) {
-    if (src[i] !== quote) return -1;
+    if (quote) {
+        if (src[i] !== quote) return -1;
+        i++;
+    }
+
+    // After the identifier, the line must end immediately — PHP disallows trailing whitespace,
+    // but we tolerate `\r` so `\r\n` endings still work.
+    while (i < len && src[i] === '\r') i++;
+    if (src[i] !== '\n') return -1;
     i++;
-  }
-
-  // After the identifier, the line must end immediately — PHP disallows trailing whitespace,
-  // but we tolerate `\r` so `\r\n` endings still work.
-  while (i < len && src[i] === '\r') i++;
-  if (src[i] !== '\n') return -1;
-  i++;
-
-  // Find a line that starts with optional indentation,
-  // then the identifier followed by a non-identifier character
-  // (PHP 7.3 flexible syntax).
-  while (i < len) {
-    let j = i;
-    while (j < len && (src[j] === ' ' || src[j] === '\t')) j++;
-    if (src.startsWith(id, j)) {
-      const k = j + id.length;
-      if (k >= len || !isIdent(src[k])) return k;
+
+    // Find a line that starts with optional indentation,
+    // then the identifier followed by a non-identifier character
+    // (PHP 7.3 flexible syntax).
+    while (i < len) {
+        let j = i;
+        while (j < len && (src[j] === ' ' || src[j] === '\t')) j++;
+        if (src.startsWith(id, j)) {
+            const k = j + id.length;
+            if (k >= len || !isIdent(src[k])) return k;
+        }
+        const nl = src.indexOf('\n', i);
+        if (nl === -1) return len;
+        i = nl + 1;
     }
-    const nl = src.indexOf('\n', i);
-    if (nl === -1) return len;
-    i = nl + 1;
-  }
-  return len;
+    return len;
 }