@upstatement/twix 0.1.4 → 0.1.5

package/README.md

@@ -59,12 +59,12 @@ Create a `.twixrc.json` or `twix.config.json` file in your project root:
 **Block tags** (have a body and `{% end* %}` tag):
 
 - Standard Twig: `if`, `for`, `block`, `set`, `apply`, `autoescape`, `embed`, `filter`, `macro`, `sandbox`, `verbatim`, `with`
-- Craft CMS: `switch`, `cache`, `js`, `css`, `nav`, `paginate`, `tag`
+- Craft CMS: `switch`, `cache`, `js`, `css`, `nav`, `tag`
 
 **Inline tags** (self-closing):
 
 - Standard Twig: `extends`, `include`, `use`, `import`, `from`, `do`, `flush`, `deprecated`
-- Craft CMS: `exit`, `header`, `redirect`, `requireLogin`, `requireAdmin`, `requireGuest`, `requirePermission`
+- Craft CMS: `exit`, `header`, `paginate`, `redirect`, `requireLogin`, `requireAdmin`, `requireGuest`, `requirePermission`
 
 **Intermediate tags** (appear within blocks):
 
@@ -83,9 +83,20 @@ Create a `.twixrc.json` or `twix.config.json` file in your project root:
 ### Twig Formatting
 
 - Block tags are indented with their content
-- Expressions (`{{ }}`) preserve their content
 - Whitespace control modifiers (`{%- -%}`, `{{- -}}`) are preserved
-- Comments (`{# #}`) are preserved
+- Comments (`{# #}`) are preserved exactly as-is (content inside comments is not formatted)
+
+### Expression Formatting
+
+Twix parses and formats Twig expressions inside `{{ }}` and `{% %}` tags:
+
+- Spaces around binary operators (`a + b`), after commas, inside hashes (`{ key: value }`)
+- No spaces around pipes (`value|filter|another`)
+- Strings normalized to double quotes (except when containing unescaped double quotes)
+- Long method chains break with `.` at the start of each line
+- Long function/method calls break arguments onto separate lines with trailing commas
+- Hashes and arrays break onto multiple lines when they exceed `printWidth`
+- Expressions inside string interpolation (`#{...}`) are formatted
 
 ### Twig Inside HTML Attributes
 
@@ -124,10 +135,10 @@ Skip formatting for specific sections using ignore directives:
 
 ### Not Supported
 
-- **Twig expressions are not parsed** - Content inside `{{ }}` and `{% %}` is preserved as-is, not reformatted
 - **No HTML entity handling** - Entities like ` ` are passed through unchanged
 - **No CSS/JS formatting** - Content inside `<style>` and `<script>` tags is not formatted
 - **Windows line endings** - Output uses Unix line endings (`\n`)
+- **Complex Twig edge cases** - Some advanced Twig syntax may fall back to preserving original formatting
 
 ## Editor Integration
 

package/bin/twix.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+
+const { execFileSync } = require("child_process");
+const path = require("path");
+const os = require("os");
+
+const platform = os.platform();
+const arch = os.arch();
+
+const PLATFORMS = {
+  "darwin-arm64": "@upstatement/twix-darwin-arm64",
+  "darwin-x64": "@upstatement/twix-darwin-x64",
+  "linux-arm64": "@upstatement/twix-linux-arm64",
+  "linux-x64": "@upstatement/twix-linux-x64",
+};
+
+const platformKey = `${platform}-${arch}`;
+const packageName = PLATFORMS[platformKey];
+
+if (!packageName) {
+  console.error(`Unsupported platform: ${platform}-${arch}`);
+  console.error(
+    `twix currently supports: darwin-arm64, darwin-x64, linux-arm64, linux-x64`,
+  );
+  process.exit(1);
+}
+
+let binaryPath;
+try {
+  // Use require.resolve to find the binary in node_modules
+  // This works correctly with npm, pnpm, yarn, and monorepos
+  const packagePath = require.resolve(`${packageName}/package.json`);
+  binaryPath = path.join(path.dirname(packagePath), "bin", "twix");
+} catch (e) {
+  console.error(
+    `Could not find the twix binary for your platform (${platformKey}).`,
+  );
+  console.error(`The package ${packageName} does not appear to be installed.`);
+  console.error("");
+  console.error("This can happen if:");
+  console.error("  1. Your platform is not supported");
+  console.error(
+    "  2. Optional dependencies were not installed (try: npm install --include=optional)",
+  );
+  console.error(
+    "  3. You're using a package manager that doesn't install optional dependencies by default",
+  );
+  process.exit(1);
+}
+
+try {
+  execFileSync(binaryPath, process.argv.slice(2), { stdio: "inherit" });
+} catch (e) {
+  if (e.status !== undefined) {
+    process.exit(e.status);
+  }
+  // If we get here, it's an actual error (not just a non-zero exit code)
+  console.error(`Failed to execute twix: ${e.message}`);
+  process.exit(1);
+}

package/package.json

@@ -1,17 +1,24 @@
 {
   "name": "@upstatement/twix",
-  "version": "0.1.4",
-  "description": "A formatter for Twig templates with HTML",
+  "version": "0.1.5",
+  "description": "An opinionated formatter for Twig templating engine",
+  "bin": {
+    "twix": "bin/twix.js"
+  },
+  "files": [
+    "bin/",
+    "README.md"
+  ],
+  "optionalDependencies": {
+    "@upstatement/twix-darwin-arm64": "0.1.5",
+    "@upstatement/twix-darwin-x64": "0.1.5",
+    "@upstatement/twix-linux-arm64": "0.1.5",
+    "@upstatement/twix-linux-x64": "0.1.5"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Upstatement/twix.git"
   },
-  "optionalDependencies": {
-    "@upstatement/twix-darwin-arm64": "0.1.4",
-    "@upstatement/twix-darwin-x64": "0.1.4",
-    "@upstatement/twix-linux-arm64": "0.1.4",
-    "@upstatement/twix-linux-x64": "0.1.4"
-  },
   "keywords": [
     "twig",
     "formatter",
@@ -21,7 +28,8 @@
   ],
   "author": "Upstatement",
   "license": "MIT",
-  "bin": {
-    "twix": "bin/twix"
-  }
+  "bugs": {
+    "url": "https://github.com/Upstatement/twix/issues"
+  },
+  "homepage": "https://github.com/Upstatement/twix#readme"
 }

package/bin/twix

@@ -1,23 +0,0 @@
-#!/bin/sh
-# Resolve the real path of this script (following symlinks)
-# This is needed because npm creates a symlink in node_modules/.bin/
-SCRIPT="$0"
-while [ -h "$SCRIPT" ]; do
-  SCRIPTDIR="$(cd -P "$(dirname "$SCRIPT")" && pwd)"
-  SCRIPT="$(readlink "$SCRIPT")"
-  case "$SCRIPT" in
-    /*) ;;
-    *) SCRIPT="$SCRIPTDIR/$SCRIPT" ;;
-  esac
-done
-SCRIPTDIR="$(cd -P "$(dirname "$SCRIPT")" && pwd)"
-
-# SCRIPTDIR is now the real bin/ directory inside @upstatement/twix
-# Go up two levels to @upstatement/, then into the platform package
-case "$(uname -s)-$(uname -m)" in
-  Darwin-arm64) exec "$SCRIPTDIR/../../twix-darwin-arm64/bin/twix" "$@" ;;
-  Darwin-x86_64) exec "$SCRIPTDIR/../../twix-darwin-x64/bin/twix" "$@" ;;
-  Linux-aarch64) exec "$SCRIPTDIR/../../twix-linux-arm64/bin/twix" "$@" ;;
-  Linux-x86_64) exec "$SCRIPTDIR/../../twix-linux-x64/bin/twix" "$@" ;;
-  *) echo "Unsupported platform: $(uname -s)-$(uname -m)" >&2; exit 1 ;;
-esac