@runtimestudio/tailwind-sort-php 0.2.1 → 0.4.0

package/src/transform.ts

@@ -19,6 +19,7 @@
 
 import { findIslands, type Island, type IslandOptions } from './islands.ts';
 import { maskIslands, findClassAttributes, type HtmlScanOptions } from './html.ts';
+import { findSortablePhpStrings } from './php-strings.ts';
 
 /**
  * Sorting strategy injected by the caller. Receives the class tokens of a single static run;
@@ -27,9 +28,14 @@ import { maskIslands, findClassAttributes, type HtmlScanOptions } from './html.t
 export type SortFn = (classes: string[]) => string[];
 
 /**
- * Combined options for both lexer passes.
+ * Combined options for all lexer passes.
  */
-export interface TransformOptions extends IslandOptions, HtmlScanOptions {}
+export interface TransformOptions extends IslandOptions, HtmlScanOptions {
+    /**
+     * Sort classes in PHP string-literal values too. Off by default; see `php-strings.ts` for eligibility.
+     */
+    sortPhpStrings?: boolean;
+}
 
 /**
  * Rewrite all class attribute values in the template source with sorted classes.
@@ -45,90 +51,129 @@ export interface TransformOptions extends IslandOptions, HtmlScanOptions {}
  * // '<div class="mt-4 z-10 <?= $x ?> a b">'
  */
 export function transform(src: string, sortFn: SortFn, opts: TransformOptions = {}): string {
-  const islands = findIslands(src, opts);
-  const masked = maskIslands(src, islands);
-  const attrs = findClassAttributes(masked, opts);
-
-  // Apply replacements back-to-front so offsets stay valid.
-  let out = src;
-  for (let a = attrs.length - 1; a >= 0; a--) {
-    const { valueStart, valueEnd } = attrs[a];
-    const original = src.slice(valueStart, valueEnd);
-    const inner = islands.filter((isl) => isl.start >= valueStart && isl.end <= valueEnd);
-    const rewritten = rewriteValue(original, valueStart, inner, sortFn);
-    if (rewritten !== original) {
-      out = out.slice(0, valueStart) + rewritten + out.slice(valueEnd);
+    const islands = findIslands(src, opts);
+    const masked = maskIslands(src, islands);
+    const attrs = findClassAttributes(masked, opts);
+
+    // Computed before the attribute pass: an edit inside a class-attribute island must be folded into that
+    // attribute's rewrite, or the enclosing rewrite would overwrite it and a second pass would be needed.
+    const phpEdits: Edit[] = [];
+    if (opts.sortPhpStrings) {
+        for (const { start, end } of findSortablePhpStrings(src, islands)) {
+            const original = src.slice(start, end);
+            const tokens = original.split(/\s+/).filter(Boolean);
+            if (tokens.length < 2) continue; // nothing to reorder; leave byte-identical
+            const text = sortFn(tokens).join(' ');
+            if (text !== original) phpEdits.push({ start, end, text });
+        }
+    }
+
+    // Collect every edit as a {start, end, text} range, then apply them back-to-front so offsets stay valid.
+    const edits: Edit[] = [];
+    const absorbed = new Set<Edit>();
+
+    for (const { valueStart, valueEnd } of attrs) {
+        const original = src.slice(valueStart, valueEnd);
+        const inner = islands.filter((isl) => isl.start >= valueStart && isl.end <= valueEnd);
+        const innerEdits = phpEdits.filter((e) => e.start >= valueStart && e.end <= valueEnd);
+        const rewritten = rewriteValue(original, valueStart, inner, sortFn, innerEdits);
+        if (rewritten !== original) edits.push({ start: valueStart, end: valueEnd, text: rewritten });
+        for (const e of innerEdits) absorbed.add(e);
     }
-  }
-  return out;
+
+    for (const e of phpEdits) if (!absorbed.has(e)) edits.push(e);
+
+    edits.sort((a, b) => b.start - a.start);
+    let out = src;
+    for (const e of edits) out = out.slice(0, e.start) + e.text + out.slice(e.end);
+    return out;
+}
+
+interface Edit {
+    start: number;
+    end: number;
+    text: string;
 }
 
 interface Part {
-  type: 'static' | 'island';
-  text: string;
+    type: 'static' | 'island';
+    text: string;
 }
 
-function rewriteValue(value: string, base: number, islands: Island[], sortFn: SortFn): string {
-  // Build alternating static/island parts.
-  const parts: Part[] = [];
-  let pos = 0;
-  for (const isl of islands) {
-    const s = isl.start - base;
-    const e = isl.end - base;
-    parts.push({ type: 'static', text: value.slice(pos, s) });
-    parts.push({ type: 'island', text: value.slice(s, e) });
-    pos = e;
-  }
-  parts.push({ type: 'static', text: value.slice(pos) });
-
-  let out = '';
-  for (let p = 0; p < parts.length; p++) {
-    const part = parts[p];
-    if (part.type === 'island') {
-      out += part.text;
-      continue;
+/**
+ * Apply the edits that fall entirely within `[offset, offset + text.length)` to `text`.
+ * Edits arrive in document order and never overlap, so a back-to-front pass keeps offsets valid.
+ */
+function spliceEdits(text: string, offset: number, edits: Edit[]): string {
+    for (let k = edits.length - 1; k >= 0; k--) {
+        const e = edits[k];
+        if (e.start < offset || e.end > offset + text.length) continue;
+        text = text.slice(0, e.start - offset) + e.text + text.slice(e.end - offset);
     }
+    return text;
+}
 
-    const prevIsIsland = p > 0;
-    const nextIsIsland = p < parts.length - 1;
-    const t = part.text;
-
-    const hasLeadingWs = /^\s/.test(t);
-    const hasTrailingWs = /\s$/.test(t);
-    const tokens = t.split(/\s+/).filter(Boolean);
-
-    // Whitespace-only run between islands → preserve a single space.
-    if (tokens.length === 0) {
-      if (t.length > 0 && prevIsIsland && nextIsIsland) out += ' ';
-      continue;
+function rewriteValue(value: string, base: number, islands: Island[], sortFn: SortFn, phpEdits: Edit[]): string {
+    // Build alternating static/island parts; island text carries any PHP-string edits it contains.
+    const parts: Part[] = [];
+    let pos = 0;
+    for (const isl of islands) {
+        const s = isl.start - base;
+        const e = isl.end - base;
+        parts.push({ type: 'static', text: value.slice(pos, s) });
+        parts.push({ type: 'island', text: spliceEdits(value.slice(s, e), isl.start, phpEdits) });
+        pos = e;
     }
-
-    const pinStart = prevIsIsland && !hasLeadingWs;
-    const pinEnd = nextIsIsland && !hasTrailingWs;
-
-    let head: string[] = [];
-    let tail: string[] = [];
-    let middle: string[];
-
-    if (pinStart && pinEnd && tokens.length === 1) {
-      // Single fragment glued to islands on both sides.
-      middle = [];
-      head = [tokens[0]];
-    } else {
-      const from = pinStart ? 1 : 0;
-      const to = pinEnd ? tokens.length - 1 : tokens.length;
-      if (pinStart) head = [tokens[0]];
-      if (pinEnd) tail = [tokens[tokens.length - 1]];
-      middle = tokens.slice(from, to);
+    parts.push({ type: 'static', text: value.slice(pos) });
+
+    let out = '';
+    for (let p = 0; p < parts.length; p++) {
+        const part = parts[p];
+        if (part.type === 'island') {
+            out += part.text;
+            continue;
+        }
+
+        const prevIsIsland = p > 0;
+        const nextIsIsland = p < parts.length - 1;
+        const t = part.text;
+
+        const hasLeadingWs = /^\s/.test(t);
+        const hasTrailingWs = /\s$/.test(t);
+        const tokens = t.split(/\s+/).filter(Boolean);
+
+        // Whitespace-only run between islands → preserve a single space.
+        if (tokens.length === 0) {
+            if (t.length > 0 && prevIsIsland && nextIsIsland) out += ' ';
+            continue;
+        }
+
+        const pinStart = prevIsIsland && !hasLeadingWs;
+        const pinEnd = nextIsIsland && !hasTrailingWs;
+
+        let head: string[] = [];
+        let tail: string[] = [];
+        let middle: string[];
+
+        if (pinStart && pinEnd && tokens.length === 1) {
+            // Single fragment glued to islands on both sides.
+            middle = [];
+            head = [tokens[0]];
+        } else {
+            const from = pinStart ? 1 : 0;
+            const to = pinEnd ? tokens.length - 1 : tokens.length;
+            if (pinStart) head = [tokens[0]];
+            if (pinEnd) tail = [tokens[tokens.length - 1]];
+            middle = tokens.slice(from, to);
+        }
+
+        const sorted = middle.length > 1 ? sortFn(middle) : middle;
+        const joined = [...head, ...sorted, ...tail].join(' ');
+
+        const prefix = prevIsIsland && hasLeadingWs ? ' ' : '';
+        const suffix = nextIsIsland && hasTrailingWs ? ' ' : '';
+        out += prefix + joined + suffix;
     }
 
-    const sorted = middle.length > 1 ? sortFn(middle) : middle;
-    const joined = [...head, ...sorted, ...tail].join(' ');
-
-    const prefix = prevIsIsland && hasLeadingWs ? ' ' : '';
-    const suffix = nextIsIsland && hasTrailingWs ? ' ' : '';
-    out += prefix + joined + suffix;
-  }
-
-  return out;
+    return out;
 }