@owenlamont/ryl 0.4.1 → 0.4.2

package/README.md

@@ -13,7 +13,11 @@ Compatibility note:
 ## Quick Start
 
 ```bash
+# Using uv (Python)
 uvx ryl .
+
+# Using npx (Node.js)
+npx @owenlamont/ryl .
 ```
 
 For `prek` / `pre-commit` integration, see
@@ -27,6 +31,12 @@ For `prek` / `pre-commit` integration, see
 uv tool install ryl
 ```
 
+### NPM
+
+```bash
+npm install -g @owenlamont/ryl
+```
+
 ### pip
 
 ```bash
@@ -228,3 +238,6 @@ developer automation, especially:
 - [saphyr](https://github.com/saphyr-rs/saphyr) - ryl is built on saphyr and saphyr's
   developers were very patient in showing some of the nuance and complexity of parsing
   YAML which I was embarrassingly ignorant of when start ryl.
+- [esbuild](https://github.com/evanw/esbuild) and
+  [biome](https://github.com/biomejs/biome) - for providing the "binary wrapper"
+  blueprint for distributing high-performance native tools via NPM.

package/bin/ryl.js

@@ -1 +1,195 @@
-console.log('Initializing ryl...');
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const https = require('https');
+const os = require('os');
+const { spawnSync } = require('child_process');
+
+const pkg = require('../package.json');
+const version = pkg.version;
+const binName = process.platform === 'win32' ? 'ryl.exe' : 'ryl';
+
+// Support user-writable cache directory to avoid EACCES in global installs
+function getCacheDir() {
+  if (process.platform === 'win32') {
+    return process.env.LOCALAPPDATA || path.join(os.homedir(), 'AppData', 'Local');
+  }
+  if (process.platform === 'darwin') {
+    return path.join(os.homedir(), 'Library', 'Caches');
+  }
+  return process.env.XDG_CACHE_HOME || path.join(os.homedir(), '.cache');
+}
+
+const rylCacheDir = path.join(getCacheDir(), 'ryl', version);
+const cacheBinPath = path.join(rylCacheDir, binName);
+const localBinPath = path.join(__dirname, binName);
+
+const PLATFORMS = {
+  darwin: {
+    arm64: 'aarch64-apple-darwin'
+  },
+  linux: {
+    x64: 'x86_64-unknown-linux-musl',
+    arm64: 'aarch64-unknown-linux-musl',
+    arm: 'armv7-unknown-linux-gnueabihf',
+    ia32: 'i686-unknown-linux-gnu',
+    ppc64: 'powerpc64le-unknown-linux-gnu',
+    s390x: 's390x-unknown-linux-gnu'
+  },
+  win32: {
+    x64: 'x86_64-pc-windows-msvc',
+    arm64: 'aarch64-pc-windows-msvc'
+  }
+};
+
+function getBinaryName() {
+  const platform = PLATFORMS[process.platform];
+  if (!platform) return null;
+  const target = platform[process.arch];
+  if (!target) return null;
+
+  if (process.platform === 'win32') {
+    return `ryl-${target}.zip`;
+  }
+  return `ryl-${target}.tar.gz`;
+}
+
+function download(url, dest) {
+  return new Promise((resolve, reject) => {
+    const file = fs.createWriteStream(dest);
+    https.get(url, (response) => {
+      if (response.statusCode === 302 || response.statusCode === 301) {
+        file.close(() => {
+          fs.unlink(dest, () => {
+            download(response.headers.location, dest).then(resolve).catch(reject);
+          });
+        });
+        return;
+      }
+      if (response.statusCode !== 200) {
+        file.close(() => {
+          fs.unlink(dest, () => {
+            reject(new Error(`Failed to download binary: ${response.statusCode}`));
+          });
+        });
+        return;
+      }
+      response.pipe(file);
+      file.on('finish', () => {
+        file.close();
+        resolve();
+      });
+    }).on('error', (err) => {
+      file.close(() => {
+        fs.unlink(dest, () => reject(err));
+      });
+    });
+  });
+}
+
+async function run() {
+  // 0. Try Environment Variable Override
+  if (process.env.RYL_BINARY_PATH) {
+    execute(process.env.RYL_BINARY_PATH);
+    return;
+  }
+
+  // 1. Try Local Bin (for dev/local installs)
+  if (fs.existsSync(localBinPath)) {
+    execute(localBinPath);
+    return;
+  }
+
+  // 2. Try Cache Bin
+  if (fs.existsSync(cacheBinPath)) {
+    execute(cacheBinPath);
+    return;
+  }
+
+  // 3. Install and Execute
+  await install();
+  execute(cacheBinPath);
+}
+
+async function install() {
+  const binaryAsset = getBinaryName();
+  if (!binaryAsset) {
+    console.error(`Unsupported platform/architecture: ${process.platform}/${process.arch}`);
+    process.exit(1);
+  }
+
+  // Ensure cache directory exists
+  try {
+    fs.mkdirSync(rylCacheDir, { recursive: true });
+  } catch (err) {
+    console.error(`Error creating cache directory ${rylCacheDir}: ${err.message}`);
+    process.exit(1);
+  }
+
+  const url = `https://github.com/owenlamont/ryl/releases/download/v${version}/${binaryAsset}`;
+  const archivePath = path.join(rylCacheDir, `${binaryAsset}.tmp`);
+  const extractDir = path.join(rylCacheDir, `extract-${Date.now()}`);
+
+  console.log(`Downloading ryl v${version} for ${process.platform}/${process.arch}...`);
+  console.log(`Installing to: ${cacheBinPath}`);
+
+  try {
+    await download(url, archivePath);
+    fs.mkdirSync(extractDir, { recursive: true });
+
+    if (process.platform === 'win32') {
+      spawnSync('powershell.exe', ['-Command', `Expand-Archive -Path "${archivePath}" -DestinationPath "${extractDir}" -Force`], { stdio: 'inherit' });
+    } else {
+      spawnSync('tar', ['-xzf', archivePath, '-C', extractDir], { stdio: 'inherit' });
+    }
+
+    const extractedBinPath = path.join(extractDir, binName);
+    if (!fs.existsSync(extractedBinPath)) {
+      throw new Error(`Binary not found in archive: ${binName}`);
+    }
+
+    // Atomic move
+    fs.renameSync(extractedBinPath, cacheBinPath);
+
+    // Cleanup
+    fs.unlinkSync(archivePath);
+    fs.rmSync(extractDir, { recursive: true, force: true });
+
+    if (process.platform !== 'win32') {
+      fs.chmodSync(cacheBinPath, 0o755);
+    }
+    console.log('Successfully installed ryl!');
+  } catch (err) {
+    console.error(`Error installing ryl binary: ${err.message}`);
+    // Cleanup on failure
+    if (fs.existsSync(archivePath)) fs.unlinkSync(archivePath);
+    if (fs.existsSync(extractDir)) fs.rmSync(extractDir, { recursive: true, force: true });
+
+    if (process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy) {
+      console.error('Note: You are using a proxy; please ensure your environment is configured correctly for Node.js https.get().');
+    }
+    process.exit(1);
+  }
+}
+
+function execute(binPath) {
+  const result = spawnSync(binPath, process.argv.slice(2), {
+    stdio: 'inherit',
+    windowsHide: true
+  });
+
+  if (result.error) {
+    console.error(`Error executing binary at ${binPath}: ${result.error.message}`);
+    process.exit(1);
+  }
+
+  if (result.status === null) {
+    console.error('Binary execution failed (no exit status)');
+    process.exit(1);
+  }
+
+  process.exit(result.status);
+}
+
+run();

package/package.json

@@ -1,28 +1,50 @@
 {
-  "name": "@owenlamont/ryl",
-  "version": "0.4.1",
-  "description": "Fast YAML linter inspired by yamllint",
-  "main": "index.js",
+  "author": "Owen Lamont",
   "bin": {
     "ryl": "bin/ryl.js"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/owenlamont/ryl.git"
+  "bugs": {
+    "url": "https://github.com/owenlamont/ryl/issues"
+  },
+  "cpu": [
+    "x64",
+    "arm64",
+    "arm",
+    "ia32",
+    "ppc64",
+    "s390x"
+  ],
+  "description": "Fast YAML linter inspired by yamllint",
+  "engines": {
+    "node": ">=18.0.0"
   },
+  "files": [
+    "bin/",
+    "README.md",
+    "LICENSE"
+  ],
+  "homepage": "https://github.com/owenlamont/ryl#readme",
   "keywords": [
     "yaml",
     "lint",
     "cli",
     "rust"
   ],
-  "author": "Owen Lamont",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/owenlamont/ryl/issues"
-  },
-  "homepage": "https://github.com/owenlamont/ryl#readme",
+  "name": "@owenlamont/ryl",
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/owenlamont/ryl.git"
+  },
+  "sideEffects": false,
+  "type": "commonjs",
+  "version": "0.4.2"
 }

package/.github/CODEOWNERS

@@ -1 +0,0 @@
-* @owenlamont

package/.github/dependabot.yml

@@ -1,13 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "friday"
-    groups:
-      actions-dependencies:
-        patterns:
-          - "*"
-    cooldown:
-      default-days: 7

package/.github/workflows/ci.yml

@@ -1,107 +0,0 @@
-name: CI
-on:
-  pull_request:
-jobs:
-  checks:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pull-requests: write
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78
-
-      - name: Install prek
-        run: uv tool install prek --force
-
-      - name: Install yamllint
-        run: |
-          uv tool install yamllint --force
-          yamllint --version
-
-      - uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4
-
-      - name: Install Rust components
-        run: rustup component add rustfmt clippy llvm-tools-preview
-
-      - name: Install cargo-nextest
-        uses: taiki-e/install-action@6cc14f7f2f4b3129aff07a8b071d2d4f2733465d
-        with:
-          tool: cargo-nextest
-
-      - name: Install cargo-llvm-cov
-        uses: taiki-e/install-action@6cc14f7f2f4b3129aff07a8b071d2d4f2733465d
-        with:
-          tool: cargo-llvm-cov
-
-      - name: Run prek hooks (lint and static checks)
-        env:
-          SKIP: no-commit-to-branch,nextest
-        run: prek run --all-files
-
-      - name: Run tests with coverage (nextest + cargo-llvm-cov)
-        run: |
-          set -euo pipefail
-          echo '### Test Coverage (nextest + cargo-llvm-cov)' > coverage.md
-          echo '```text' >> coverage.md
-          cargo llvm-cov nextest --summary-only | tee -a coverage.md
-          echo '```' >> coverage.md
-          # Produce LCOV for detailed per-line/branch analysis
-          cargo llvm-cov nextest --lcov --output-path lcov.info
-          echo '' >> coverage.md
-          echo '#### Missed Lines (per file)' >> coverage.md
-          awk -F: '
-            /^SF:/ {f=$2}
-            /^DA:/ {split($2,a,","); if (a[2]==0) lines[f]=lines[f] a[1] ","}
-            END {
-              for (f in lines) {
-                gsub(/,$/, "", lines[f]);
-                printf("- %s: %s\n", f, lines[f]);
-              }
-            }
-          ' lcov.info | sort >> coverage.md || true
-          echo '' >> coverage.md
-          if grep -q '^BRDA:' lcov.info; then
-            echo '#### Missed Branches (per file)' >> coverage.md
-            awk -F: '
-              /^SF:/ {f=$2}
-              /^BRDA:/ {
-                split($2,a,",");
-                # a[4] is taken count; treat 0 or - as missed
-                if (a[4]=="-" || a[4]==0) {
-                  branches[f]=branches[f] sprintf("%s(b%s)", a[1], a[3]) ",";
-                }
-              }
-              END {
-                for (f in branches) {
-                  gsub(/,$/, "", branches[f]);
-                  printf("- %s: %s\n", f, branches[f]);
-                }
-              }
-            ' lcov.info | sort >> coverage.md || true
-          fi
-
-      - name: Upload coverage artifacts
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f
-        with:
-          name: coverage
-          path: |
-            coverage.md
-            lcov.info
-
-      - name: Comment coverage summary on PR
-        if: github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork
-        uses: marocchino/sticky-pull-request-comment@70d2764d1a7d5d9560b100cbea0077fc8f633987
-        with:
-          header: ryl-coverage
-          path: coverage.md
-
-      - name: Enforce coverage thresholds
-        run: |
-          # Enforce zero missed lines and regions
-          cargo llvm-cov nextest --summary-only \
-            --fail-uncovered-lines 0 \
-            --fail-uncovered-regions 0