@x-ror/ruby-templates 0.2.0 → 0.3.0

package/README.md

@@ -1,15 +1,22 @@
 # ruby-templates
 
-A whitespace-only formatter and the structure checks for ERB, Haml and Slim templates, from the [Ruby Templates](https://github.com/x-ror/vscode-ruby-templates) VS Code extension's language server.
+Checks and a safe formatter for Rails views in **ERB, Haml and Slim**, for CI, pre-commit hooks and editors. It is the command line of the [Ruby Templates](https://marketplace.visualstudio.com/items?itemName=x-ror.ruby-templates) VS Code extension, so the editor and CI report the same errors and format the same way.
+
+- **No Ruby needed.** A single prebuilt binary (written in Rust): no gems, no Bundler, fast on large `app/views`.
+- **Errors the real engines would raise**: Ruby syntax inside ERB, Haml and Slim (checked with Prism), unclosed `<%` and blocks, mismatched HTML tags, missing `alt`, Haml and Slim indentation and nesting errors, unresolved `render` partials and strict locals mismatches, with Erubi's, Rails', Haml's and Slim's own messages.
+- **Formatting that changes only whitespace**: indentation, trailing whitespace, blank lines, the final newline. It never rewraps lines or touches Ruby, checks that the template still compiles the same, and leaves a file unchanged (saying why on stderr) when in doubt.
 
 ```sh
 npm install --save-dev @x-ror/ruby-templates
-npx ruby-templates check app/views
-npx ruby-templates format --check app/views
-npx ruby-templates format --write app/views
+
+npx ruby-templates check app/views            # errors and warnings; exit 1 if any
+npx ruby-templates format --check app/views   # list files that would change; exit 1 if any
+npx ruby-templates format --write app/views   # format them in place
 npx ruby-templates format --stdin-filepath app/views/users/show.html.erb < show.html.erb
 ```
 
-The formatter changes only indentation, trailing whitespace, blank lines, the final newline and line endings, and leaves a file it is in doubt about unchanged, saying why on stderr. The only setting is the indentation width, from `.editorconfig` (`indent_size`, default 2); see [the settings](https://github.com/x-ror/vscode-ruby-templates/blob/main/docs/FORMATTER_CONFIG.md). Exit codes: 0 ok, 1 diagnostics or files that would change, 2 usage or I/O error.
+Exit codes: 0 ok, 1 diagnostics or files that would change, 2 usage or I/O error.
+
+The only formatter setting is the indentation width, from `.editorconfig` (`indent_size`, default 2), plus `--align-comments` for ERB comments; see [the settings](https://github.com/x-ror/vscode-ruby-templates/blob/main/docs/FORMATTER_CONFIG.md) and [the full reference](https://github.com/x-ror/vscode-ruby-templates/blob/main/docs/FEATURES.md#built-in-formatter).
 
 The binary comes from a per-platform package (Linux x64/arm64, Windows x64) installed as an optional dependency; `RUBY_TEMPLATES_BINARY` points the wrapper at another build.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@x-ror/ruby-templates",
-  "version": "0.2.0",
-  "description": "Whitespace-only formatter and checks for ERB, Haml and Slim templates",
+  "version": "0.3.0",
+  "description": "Checks and a safe, whitespace-only formatter for ERB, Haml and Slim templates, for CI and editors",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -12,8 +12,15 @@
     "haml",
     "slim",
     "rails",
-    "formatter"
+    "formatter",
+    "linter",
+    "ci",
+    "views"
   ],
+  "homepage": "https://github.com/x-ror/vscode-ruby-templates#readme",
+  "bugs": {
+    "url": "https://github.com/x-ror/vscode-ruby-templates/issues"
+  },
   "type": "module",
   "bin": {
     "ruby-templates": "bin/ruby-templates.js"
@@ -25,8 +32,8 @@
     "node": ">=20.11"
   },
   "optionalDependencies": {
-    "@x-ror/ruby-templates-linux-x64": "0.2.0",
-    "@x-ror/ruby-templates-linux-arm64": "0.2.0",
-    "@x-ror/ruby-templates-win32-x64": "0.2.0"
+    "@x-ror/ruby-templates-linux-x64": "0.3.0",
+    "@x-ror/ruby-templates-linux-arm64": "0.3.0",
+    "@x-ror/ruby-templates-win32-x64": "0.3.0"
   }
 }