@owenlamont/ryl 0.4.1 → 0.4.3

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,96 @@
-console.log('Initializing ryl...');
+#!/usr/bin/env node
+
+const path = require('path');
+const { spawnSync } = require('child_process');
+
+const pkg = require('../package.json');
+const platforms = require('../npm-platforms.json');
+const binName = process.platform === 'win32' ? 'ryl.exe' : 'ryl';
+const localBinPath = path.join(__dirname, binName);
+
+async function run() {
+  if (process.env.RYL_BINARY_PATH) {
+    execute(process.env.RYL_BINARY_PATH);
+    return;
+  }
+
+  if (exists(localBinPath)) {
+    execute(localBinPath);
+    return;
+  }
+
+  const platformPackage = resolvePlatformPackage();
+  const platformPackageJson = resolveInstalledPackageJson(platformPackage.packageName);
+  if (!platformPackageJson) {
+    console.error(
+      [
+        `No installed npm platform package matches ${process.platform}/${process.arch}.`,
+        `Expected optional dependency: ${platformPackage.packageName}`,
+        'This package requires npm optionalDependencies; installs done with',
+        '--omit=optional or npm_config_optional=false are not supported.',
+        `Reinstall ${pkg.name} with optional dependencies enabled.`
+      ].join('\n')
+    );
+    process.exit(1);
+  }
+
+  const packageRoot = path.dirname(platformPackageJson);
+  const binaryPath = path.join(packageRoot, 'bin', platformPackage.binaryName);
+  if (!exists(binaryPath)) {
+    console.error(
+      `Installed package ${platformPackage.packageName} is missing binary ${platformPackage.binaryName}.`
+    );
+    process.exit(1);
+  }
+
+  execute(binaryPath);
+}
+
+function exists(candidatePath) {
+  try {
+    require('fs').accessSync(candidatePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function resolvePlatformPackage() {
+  for (const platform of platforms.platforms) {
+    if (platform.os.includes(process.platform) && platform.cpu.includes(process.arch)) {
+      return platform;
+    }
+  }
+
+  console.error(`Unsupported platform/architecture: ${process.platform}/${process.arch}`);
+  process.exit(1);
+}
+
+function resolveInstalledPackageJson(packageName) {
+  try {
+    return require.resolve(`${packageName}/package.json`);
+  } catch {
+    return null;
+  }
+}
+
+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/npm-platforms.json

@@ -0,0 +1,124 @@
+{
+  "binaryName": "ryl",
+  "metaPackageName": "@owenlamont/ryl",
+  "packageScope": "@owenlamont",
+  "platforms": [
+    {
+      "archiveName": "ryl-aarch64-apple-darwin.tar.gz",
+      "binaryName": "ryl",
+      "cpu": [
+        "arm64"
+      ],
+      "folderName": "ryl-darwin-arm64",
+      "os": [
+        "darwin"
+      ],
+      "packageName": "@owenlamont/ryl-darwin-arm64",
+      "target": "aarch64-apple-darwin"
+    },
+    {
+      "archiveName": "ryl-x86_64-unknown-linux-musl.tar.gz",
+      "binaryName": "ryl",
+      "cpu": [
+        "x64"
+      ],
+      "folderName": "ryl-linux-x64-musl",
+      "os": [
+        "linux"
+      ],
+      "packageName": "@owenlamont/ryl-linux-x64-musl",
+      "target": "x86_64-unknown-linux-musl"
+    },
+    {
+      "archiveName": "ryl-aarch64-unknown-linux-musl.tar.gz",
+      "binaryName": "ryl",
+      "cpu": [
+        "arm64"
+      ],
+      "folderName": "ryl-linux-arm64-musl",
+      "os": [
+        "linux"
+      ],
+      "packageName": "@owenlamont/ryl-linux-arm64-musl",
+      "target": "aarch64-unknown-linux-musl"
+    },
+    {
+      "archiveName": "ryl-armv7-unknown-linux-gnueabihf.tar.gz",
+      "binaryName": "ryl",
+      "cpu": [
+        "arm"
+      ],
+      "folderName": "ryl-linux-armv7-gnu",
+      "os": [
+        "linux"
+      ],
+      "packageName": "@owenlamont/ryl-linux-armv7-gnu",
+      "target": "armv7-unknown-linux-gnueabihf"
+    },
+    {
+      "archiveName": "ryl-i686-unknown-linux-gnu.tar.gz",
+      "binaryName": "ryl",
+      "cpu": [
+        "ia32"
+      ],
+      "folderName": "ryl-linux-ia32-gnu",
+      "os": [
+        "linux"
+      ],
+      "packageName": "@owenlamont/ryl-linux-ia32-gnu",
+      "target": "i686-unknown-linux-gnu"
+    },
+    {
+      "archiveName": "ryl-powerpc64le-unknown-linux-gnu.tar.gz",
+      "binaryName": "ryl",
+      "cpu": [
+        "ppc64"
+      ],
+      "folderName": "ryl-linux-ppc64le-gnu",
+      "os": [
+        "linux"
+      ],
+      "packageName": "@owenlamont/ryl-linux-ppc64le-gnu",
+      "target": "powerpc64le-unknown-linux-gnu"
+    },
+    {
+      "archiveName": "ryl-s390x-unknown-linux-gnu.tar.gz",
+      "binaryName": "ryl",
+      "cpu": [
+        "s390x"
+      ],
+      "folderName": "ryl-linux-s390x-gnu",
+      "os": [
+        "linux"
+      ],
+      "packageName": "@owenlamont/ryl-linux-s390x-gnu",
+      "target": "s390x-unknown-linux-gnu"
+    },
+    {
+      "archiveName": "ryl-x86_64-pc-windows-msvc.zip",
+      "binaryName": "ryl.exe",
+      "cpu": [
+        "x64"
+      ],
+      "folderName": "ryl-win32-x64-msvc",
+      "os": [
+        "win32"
+      ],
+      "packageName": "@owenlamont/ryl-win32-x64-msvc",
+      "target": "x86_64-pc-windows-msvc"
+    },
+    {
+      "archiveName": "ryl-aarch64-pc-windows-msvc.zip",
+      "binaryName": "ryl.exe",
+      "cpu": [
+        "arm64"
+      ],
+      "folderName": "ryl-win32-arm64-msvc",
+      "os": [
+        "win32"
+      ],
+      "packageName": "@owenlamont/ryl-win32-arm64-msvc",
+      "target": "aarch64-pc-windows-msvc"
+    }
+  ]
+}

package/package.json

@@ -1,28 +1,62 @@
 {
-  "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/",
+    "npm-platforms.json",
+    "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.3",
+  "optionalDependencies": {
+    "@owenlamont/ryl-darwin-arm64": "0.4.3",
+    "@owenlamont/ryl-linux-x64-musl": "0.4.3",
+    "@owenlamont/ryl-linux-arm64-musl": "0.4.3",
+    "@owenlamont/ryl-linux-armv7-gnu": "0.4.3",
+    "@owenlamont/ryl-linux-ia32-gnu": "0.4.3",
+    "@owenlamont/ryl-linux-ppc64le-gnu": "0.4.3",
+    "@owenlamont/ryl-linux-s390x-gnu": "0.4.3",
+    "@owenlamont/ryl-win32-x64-msvc": "0.4.3",
+    "@owenlamont/ryl-win32-arm64-msvc": "0.4.3"
   }
 }

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