@x-ror/ruby-templates 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 x_ror
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,15 @@
-# Temporary Holding Version
+# ruby-templates
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+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.
+
+```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 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.
+
+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/bin/ruby-templates.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+// Runs the `ruby-templates` binary from the package built for this platform (`<name>-<platform>-<arch>`), which npm
+// installs through optionalDependencies.
+import { spawnSync } from "child_process";
+import fs from "fs";
+import path from "path";
+import { createRequire } from "module";
+
+const require = createRequire(import.meta.url);
+const { name, optionalDependencies } = JSON.parse(
+  fs.readFileSync(path.join(import.meta.dirname, "..", "package.json"), "utf8"),
+);
+const exe =
+  process.platform === "win32" ? "ruby-templates.exe" : "ruby-templates";
+
+function binary() {
+  if (process.env.RUBY_TEMPLATES_BINARY)
+    return process.env.RUBY_TEMPLATES_BINARY;
+  const platformPackage = `${name}-${process.platform}-${process.arch}`;
+  try {
+    const manifest = require.resolve(`${platformPackage}/package.json`);
+    return path.join(path.dirname(manifest), "bin", exe);
+  } catch {
+    const why =
+      platformPackage in optionalDependencies
+        ? `${platformPackage} is not installed; reinstall without --omit=optional`
+        : `no prebuilt binary is published for ${process.platform}-${process.arch}`;
+    console.error(`ruby-templates: ${why}, or set RUBY_TEMPLATES_BINARY.`);
+    process.exit(2);
+  }
+}
+
+const { status, signal, error } = spawnSync(binary(), process.argv.slice(2), {
+  stdio: "inherit",
+});
+if (error) {
+  console.error(`ruby-templates: ${error.message}`);
+  process.exit(2);
+}
+if (signal) process.kill(process.pid, signal);
+process.exit(status ?? 2);

package/package.json

@@ -1,6 +1,32 @@
 {
   "name": "@x-ror/ruby-templates",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Whitespace-only formatter and checks for ERB, Haml and Slim templates",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/x-ror/vscode-ruby-templates.git"
+  },
+  "keywords": [
+    "erb",
+    "haml",
+    "slim",
+    "rails",
+    "formatter"
+  ],
+  "type": "module",
+  "bin": {
+    "ruby-templates": "bin/ruby-templates.js"
+  },
+  "files": [
+    "bin"
+  ],
+  "engines": {
+    "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"
+  }
+}