dslinter 0.0.10 → 0.0.12

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## v0.0.12
+
+[compare changes](https://github.com/jrmybtlr/DSLinter/compare/v0.0.11...v0.0.12)
+
+### 🚀 Enhancements
+
+- Enhance GitHub release asset handling and logging ([4a62b9f](https://github.com/jrmybtlr/DSLinter/commit/4a62b9f))
+
+### ❤️ Contributors
+
+- Jeremy Butler <jeremy.butler@laravel.com>
+
+## v0.0.11
+
+[compare changes](https://github.com/jrmybtlr/DSLinter/compare/v0.0.10...v0.0.11)
+
+### 🩹 Fixes
+
+- Update repository references from DSLint to DSLinter ([2dbae8d](https://github.com/jrmybtlr/DSLinter/commit/2dbae8d))
+
+### ❤️ Contributors
+
+- Jeremy Butler <jeremy.butler@laravel.com>
+
 ## v0.0.10
 
 [compare changes](https://github.com/jrmybtlr/DSLint/compare/v0.0.9...v0.0.10)

package/README.md

@@ -25,7 +25,7 @@ The **`dslinter` binary** runs the **`dslint`** scanner with the same flags as t
 
 On **`npm install dslinter`**, a **`postinstall`** script tries to download a **prebuilt `dslint`** for your OS/arch from this repo’s **GitHub Releases**, using the **same tag as the npm version** (for example npm `dslinter@0.0.6` → release **`v0.0.6`** and assets like `dslint-x86_64-unknown-linux-gnu`). The binary is stored under `node_modules/dslinter/vendor/` and `dslinter` / `npx dslinter` prefer it over `PATH`.
 
-**Release workflow:** push git tag `v*` (after bumping the npm version) so [.github/workflows/release-dslint-binaries.yml](https://github.com/jrmybtlr/DSLint/blob/main/.github/workflows/release-dslint-binaries.yml) uploads the platform binaries, **then** publish `dslinter` to npm (or publish after the workflow finishes so installs resolve the assets).
+**Release workflow:** push git tag `v*` (after bumping the npm version) so [.github/workflows/release-dslint-binaries.yml](https://github.com/jrmybtlr/DSLinter/blob/main/.github/workflows/release-dslint-binaries.yml) uploads the platform binaries, **then** publish `dslinter` to npm (or publish after the workflow finishes so installs resolve the assets).
 
 Environment variables:
 
@@ -33,7 +33,9 @@ Environment variables:
 |----------|---------|
 | `DSLINT_SKIP_DOWNLOAD=1` | Skip postinstall download (air-gapped / you only use `PATH`). |
 | `DSLINT_RELEASE_TAG` | Override release tag (default `v` + `dslinter` version from `package.json`). |
-| `DSLINT_GITHUB_REPO` | Override `owner/repo` for downloads (default `jrmybtlr/DSLint`). |
+| `DSLINT_GITHUB_REPO` | Override `owner/repo` for downloads (default from `package.json` → `jrmybtlr/DSLinter`). |
+| `DSLINT_VERBOSE=1` | Log which GitHub releases/assets were tried when downloading. |
+| `GITHUB_TOKEN` / `GH_TOKEN` | Optional token for private repos or higher API rate limits. |
 
 ### How this differs from `oxlint`
 
@@ -45,7 +47,7 @@ Environment variables:
 
 The crates.io crate **`dslint`** (v0.0.x) is a **different project** (design-file linting). It is **not** this design-system scanner. Installing it will break `npx dslinter` if it ends up on your `PATH`.
 
-Use **`cargo install --git https://github.com/jrmybtlr/DSLint dslinter --locked`** or set **`DSLINT_BIN`** to a local `target/release/dslinter` build.
+Use **`cargo install --git https://github.com/jrmybtlr/DSLinter dslinter --locked`** or set **`DSLINT_BIN`** to a local `target/release/dslinter` build.
 
 ### If there is no matching release asset yet
 
@@ -59,7 +61,7 @@ npx dslinter /path/to/repo --json -o dslint-report.json
 |--------------|-------------------------|
 | **npm + GitHub Releases** | Default: download when release `vX.Y.Z` includes your platform asset. |
 | **GitHub Releases** | Manual download of `dslinter-*` from the release; run directly or set `DSLINT_BIN`. |
-| **From source** | `cargo install --git https://github.com/jrmybtlr/DSLint dslinter --locked` (not `cargo install dslint`). |
+| **From source** | `cargo install --git https://github.com/jrmybtlr/DSLinter dslinter --locked` (not `cargo install dslint`). |
 
 Typical usage:
 

package/bin/dslinter.mjs

@@ -43,7 +43,7 @@ async function resolveCommand() {
 
   const vendored = vendorBinaryPath(packageRoot);
   if (!existsSync(vendored)) {
-    await ensureDslintBinary(packageRoot, { quiet: true });
+    await ensureDslintBinary(packageRoot, { quiet: false });
   }
   if (existsSync(vendored)) {
     return vendored;

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "dslinter",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "DSLinter dashboard UI: playground shell, token wall, and governance panels (consumes dslint-report.json).",
   "license": "Apache-2.0",
   "type": "module",
   "repository": {
     "type": "git",
-    "url": "https://github.com/jrmybtlr/DSLint.git",
+    "url": "https://github.com/jrmybtlr/DSLinter.git",
     "directory": "packages/dashboard"
   },
   "bugs": {
-    "url": "https://github.com/jrmybtlr/DSLint/issues"
+    "url": "https://github.com/jrmybtlr/DSLinter/issues"
   },
-  "homepage": "https://github.com/jrmybtlr/DSLint#readme",
+  "homepage": "https://github.com/jrmybtlr/DSLinter#readme",
   "keywords": [
     "dslinter",
     "design-system",

package/scripts/ensure-dslint.mjs

@@ -7,7 +7,12 @@ import { chmod, mkdir, stat } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import {
-  releaseAssetBaseName,
+  fetchReleasesForVersion,
+  pickReleaseAsset,
+} from "./github-release.mjs";
+import {
+  githubRepoFromPackage,
+  releaseAssetCandidateNames,
   vendorBinaryPath,
 } from "./resolve-dslint-binary.mjs";
 
@@ -30,18 +35,10 @@ function readPackageVersion(packageRoot) {
   return pkg.version;
 }
 
-function releaseTag(version) {
-  const o = process.env.DSLINT_RELEASE_TAG?.trim();
-  if (o) return o.startsWith("v") ? o : `v${o}`;
-  return `v${version}`;
-}
-
-function releaseRepo() {
-  return process.env.DSLINT_GITHUB_REPO?.trim() || "jrmybtlr/DSLint";
-}
-
-function assetUrl(tag, asset) {
-  return `https://github.com/${releaseRepo()}/releases/download/${tag}/${asset}`;
+function releaseRepo(packageRoot) {
+  const override = process.env.DSLINT_GITHUB_REPO?.trim();
+  if (override) return override;
+  return githubRepoFromPackage(packageRoot);
 }
 
 /**
@@ -52,6 +49,7 @@ function assetUrl(tag, asset) {
 export async function ensureDslintBinary(packageRoot = defaultPackageRoot, opts = {}) {
   const { quiet = false } = opts;
   const log = quiet ? () => {} : console.warn.bind(console);
+  const verbose = process.env.DSLINT_VERBOSE === "1";
 
   if (process.env.DSLINT_SKIP_DOWNLOAD === "1") {
     return pathExists(vendorBinaryPath(packageRoot));
@@ -60,8 +58,8 @@ export async function ensureDslintBinary(packageRoot = defaultPackageRoot, opts
   const dest = vendorBinaryPath(packageRoot);
   if (await pathExists(dest)) return true;
 
-  const asset = releaseAssetBaseName();
-  if (!asset) {
+  const candidates = releaseAssetCandidateNames();
+  if (candidates.length === 0) {
     log(
       `[dslinter] No prebuilt scanner for ${process.platform}-${process.arch}.`,
     );
@@ -69,22 +67,55 @@ export async function ensureDslintBinary(packageRoot = defaultPackageRoot, opts
   }
 
   const version = readPackageVersion(packageRoot);
-  const tagsToTry = [releaseTag(version)];
-  if (process.env.DSLINT_USE_LATEST_RELEASE !== "0") {
-    tagsToTry.push("latest");
-  }
-
+  const repo = releaseRepo(packageRoot);
   const vendorDir = join(packageRoot, "vendor");
   await mkdir(vendorDir, { recursive: true });
   const tmp = `${dest}.part`;
 
-  for (const tag of tagsToTry) {
-    const url = assetUrl(tag, asset);
+  let releases;
+  try {
+    releases = await fetchReleasesForVersion(repo, version);
+  } catch (err) {
+    log(
+      `[dslinter] Could not query GitHub releases for ${repo}: ${err instanceof Error ? err.message : err}`,
+    );
+    if (process.env.GITHUB_TOKEN || process.env.GH_TOKEN) {
+      log("  (token was set but request still failed — check repo access)");
+    } else {
+      log(
+        "  For private repos, set GITHUB_TOKEN or GH_TOKEN with read access to releases.",
+      );
+    }
+    return false;
+  }
+
+  if (releases.length === 0) {
+    log(
+      `[dslinter] No GitHub release found on ${repo} for v${version}.\n` +
+        `  Publish tag v${version} with workflow release-dslint-binaries.yml (assets: ${candidates.join(" or ")}).`,
+    );
+    return false;
+  }
+
+  for (const release of releases) {
+    const asset = pickReleaseAsset(release, candidates);
+    if (!asset) {
+      if (verbose) {
+        log(
+          `[dslinter] Release ${release.tag_name} has no asset in ${candidates.join(", ")} (has: ${release.assets.map((a) => a.name).join(", ") || "none"})`,
+        );
+      }
+      continue;
+    }
+
+    if (verbose) {
+      log(`[dslinter] Downloading ${asset.name} from ${release.tag_name}…`);
+    }
+
     try {
-      const res = await fetch(url, { redirect: "follow" });
-      if (res.status === 404) continue;
+      const res = await fetch(asset.browser_download_url, { redirect: "follow" });
       if (!res.ok) {
-        log(`[dslinter] Download failed (${res.status}): ${url}`);
+        log(`[dslinter] Download failed (${res.status}): ${asset.browser_download_url}`);
         continue;
       }
 
@@ -99,15 +130,15 @@ export async function ensureDslintBinary(packageRoot = defaultPackageRoot, opts
       if (process.platform !== "win32") {
         await chmod(dest, 0o755);
       }
-      if (tag === "latest" && !quiet) {
+      if (release.tag_name !== `v${version}` && !quiet) {
         log(
-          `[dslinter] Installed scanner from latest GitHub release (no asset for npm v${version}).`,
+          `[dslinter] Installed scanner from release ${release.tag_name} (npm v${version}).`,
         );
       }
       return true;
     } catch (err) {
       log(
-        `[dslinter] Could not download: ${err instanceof Error ? err.message : err}`,
+        `[dslinter] Could not download ${asset.name}: ${err instanceof Error ? err.message : err}`,
       );
       try {
         unlinkSync(tmp);
@@ -118,8 +149,8 @@ export async function ensureDslintBinary(packageRoot = defaultPackageRoot, opts
   }
 
   log(
-    `[dslinter] No GitHub release with asset "${asset}" (tried ${tagsToTry.join(", ")}).\n` +
-      `  Publish tag ${releaseTag(version)} with workflow release-dslint-binaries.yml, or set DSLINT_BIN to a local build.`,
+    `[dslinter] Found releases on ${repo} but none include ${candidates.join(" or ")} for this platform.\n` +
+      `  Upload platform binaries via .github/workflows/release-dslint-binaries.yml, or set DSLINT_BIN.`,
   );
   return false;
 }
@@ -129,6 +160,6 @@ const isMain =
   fileURLToPath(import.meta.url) === process.argv[1];
 
 if (isMain) {
-  const ok = await ensureDslintBinary();
-  process.exit(ok ? 0 : 0);
+  await ensureDslintBinary();
+  process.exit(0);
 }

package/scripts/github-release.mjs

@@ -0,0 +1,109 @@
+/**
+ * Resolve GitHub release assets via the REST API (works with exact names + legacy names).
+ */
+
+const API = "https://api.github.com";
+
+function apiHeaders() {
+  const headers = {
+    Accept: "application/vnd.github+json",
+    "User-Agent": "dslinter-npm",
+    "X-GitHub-Api-Version": "2022-11-28",
+  };
+  const token =
+    process.env.GITHUB_TOKEN?.trim() || process.env.GH_TOKEN?.trim();
+  if (token) headers.Authorization = `Bearer ${token}`;
+  return headers;
+}
+
+/**
+ * @param {string} repo `owner/name`
+ * @param {string} path
+ */
+async function githubGet(repo, path) {
+  const res = await fetch(`${API}/repos/${repo}${path}`, {
+    headers: apiHeaders(),
+    redirect: "follow",
+  });
+  if (res.status === 404) return null;
+  if (!res.ok) {
+    const body = await res.text().catch(() => "");
+    throw new Error(`GitHub API ${res.status} for ${path}: ${body.slice(0, 200)}`);
+  }
+  return res.json();
+}
+
+/**
+ * @param {string} repo
+ * @param {string} tag e.g. `v0.0.11` or `latest`
+ */
+export async function fetchRelease(repo, tag) {
+  if (tag === "latest") {
+    return githubGet(repo, "/releases/latest");
+  }
+  const byTag = await githubGet(repo, `/releases/tags/${encodeURIComponent(tag)}`);
+  if (byTag) return byTag;
+  // Some releases use tag without `v` prefix.
+  if (tag.startsWith("v")) {
+    return githubGet(repo, `/releases/tags/${encodeURIComponent(tag.slice(1))}`);
+  }
+  return null;
+}
+
+/**
+ * @param {string} repo
+ * @param {string} npmVersion e.g. `0.0.11`
+ */
+export async function fetchReleasesForVersion(repo, npmVersion) {
+  const out = [];
+  const seen = new Set();
+
+  const push = (release) => {
+    if (!release?.assets?.length) return;
+    const key = release.id ?? release.tag_name;
+    if (seen.has(key)) return;
+    seen.add(key);
+    out.push(release);
+  };
+
+  push(await fetchRelease(repo, `v${npmVersion}`));
+  push(await fetchRelease(repo, npmVersion));
+  push(await fetchRelease(repo, "latest"));
+
+  if (out.length > 0) return out;
+
+  const list = await githubGet(repo, "/releases?per_page=30");
+  if (!Array.isArray(list)) return out;
+
+  for (const release of list) {
+    const tag = String(release.tag_name ?? "");
+    if (tag === `v${npmVersion}` || tag === npmVersion) {
+      push(release);
+    }
+  }
+  if (out.length > 0) return out;
+
+  // Newest release that has any scanner-looking asset.
+  for (const release of list) {
+    const names = release.assets?.map((a) => a.name) ?? [];
+    if (names.some((n) => n.startsWith("dslinter-") || n.startsWith("dslint-"))) {
+      push(release);
+      break;
+    }
+  }
+
+  return out;
+}
+
+/**
+ * @param {string[]} candidateNames
+ * @param {{ assets: { name: string; browser_download_url: string }[] }} release
+ * @returns {{ name: string; browser_download_url: string } | null}
+ */
+export function pickReleaseAsset(release, candidateNames) {
+  for (const name of candidateNames) {
+    const asset = release.assets.find((a) => a.name === name);
+    if (asset?.browser_download_url) return asset;
+  }
+  return null;
+}

package/scripts/print-missing-scanner.mjs

@@ -16,10 +16,12 @@ To run the design-system scanner:
 
   1. Re-run after a GitHub release exists for v${version} (prebuilt download), or
   2. Build from this repo and point at it:
-       cargo install --git https://github.com/jrmybtlr/DSLint dslinter --locked
+       cargo install --git https://github.com/jrmybtlr/DSLinter dslinter --locked
        export DSLINT_BIN="$(command -v dslinter)"
        npx dslinter ...
   3. Or set DSLINT_BIN to your local target/release/dslinter
 
-Releases: https://github.com/jrmybtlr/DSLint/releases
+Releases: https://github.com/jrmybtlr/DSLinter/releases
+
+Tip: re-run with DSLINT_VERBOSE=1 to see which GitHub releases/assets were tried.
 `);

package/scripts/resolve-dslint-binary.mjs

@@ -1,8 +1,38 @@
+import { readFileSync } from "node:fs";
 import { join } from "node:path";
 
 /** CLI binary name (avoids collision with unrelated `dslint` on crates.io). */
 export const CLI_BINARY_NAME = "dslinter";
 
+/** Fallback when package.json has no parseable `repository` field. */
+export const DEFAULT_GITHUB_REPO = "jrmybtlr/DSLinter";
+
+/**
+ * @param {string | { type?: string; url?: string } | undefined} repository
+ * @returns {string | null} `owner/repo`
+ */
+export function parseGitHubRepo(repository) {
+  if (!repository) return null;
+  const url = typeof repository === "string" ? repository : repository.url;
+  if (!url) return null;
+  const m = String(url).match(/github\.com[/:]([^/]+)\/([^/.]+?)(?:\.git)?\/?$/i);
+  return m ? `${m[1]}/${m[2]}` : null;
+}
+
+/**
+ * @param {string} packageRoot
+ */
+export function githubRepoFromPackage(packageRoot) {
+  try {
+    const pkg = JSON.parse(
+      readFileSync(join(packageRoot, "package.json"), "utf8"),
+    );
+    return parseGitHubRepo(pkg.repository) ?? DEFAULT_GITHUB_REPO;
+  } catch {
+    return DEFAULT_GITHUB_REPO;
+  }
+}
+
 /**
  * Maps the current OS/arch to the GitHub release asset basename (must match CI upload names).
  * @param {NodeJS.Process} [proc]
@@ -28,6 +58,14 @@ export function releaseAssetBaseName(proc = process) {
   return null;
 }
 
+/** Primary GitHub asset name plus legacy `dslint-*` names from older releases. */
+export function releaseAssetCandidateNames(proc = process) {
+  const primary = releaseAssetBaseName(proc);
+  if (!primary) return [];
+  const legacy = primary.replace(/^dslinter/, "dslint");
+  return legacy === primary ? [primary] : [primary, legacy];
+}
+
 /**
  * @param {string} packageRoot — directory containing package.json
  * @param {NodeJS.Process} [proc]

package/src/resolve-dslint-binary.test.ts

@@ -1,8 +1,14 @@
 import { join } from "node:path";
 import { describe, expect, it } from "vitest";
+import {
+  pickReleaseAsset,
+} from "../scripts/github-release.mjs";
 import {
   CLI_BINARY_NAME,
+  DEFAULT_GITHUB_REPO,
+  parseGitHubRepo,
   releaseAssetBaseName,
+  releaseAssetCandidateNames,
   vendorBinaryPath,
 } from "../scripts/resolve-dslint-binary.mjs";
 
@@ -10,6 +16,52 @@ function proc(platform: string, arch: string): NodeJS.Process {
   return { platform, arch } as NodeJS.Process;
 }
 
+describe("parseGitHubRepo", () => {
+  it("parses https repository url", () => {
+    expect(
+      parseGitHubRepo("https://github.com/jrmybtlr/DSLinter.git"),
+    ).toBe("jrmybtlr/DSLinter");
+  });
+
+  it("parses repository object", () => {
+    expect(
+      parseGitHubRepo({
+        type: "git",
+        url: "git+https://github.com/jrmybtlr/DSLinter.git",
+      }),
+    ).toBe("jrmybtlr/DSLinter");
+  });
+
+  it("defaults constant points at DSLinter", () => {
+    expect(DEFAULT_GITHUB_REPO).toBe("jrmybtlr/DSLinter");
+  });
+});
+
+describe("releaseAssetCandidateNames", () => {
+  it("includes legacy dslint asset name", () => {
+    expect(releaseAssetCandidateNames(proc("darwin", "arm64"))).toEqual([
+      "dslinter-aarch64-apple-darwin",
+      "dslint-aarch64-apple-darwin",
+    ]);
+  });
+});
+
+describe("pickReleaseAsset", () => {
+  it("prefers primary name then legacy", () => {
+    const release = {
+      assets: [
+        {
+          name: "dslint-aarch64-apple-darwin",
+          browser_download_url: "https://example.com/legacy",
+        },
+      ],
+    };
+    expect(
+      pickReleaseAsset(release, releaseAssetCandidateNames(proc("darwin", "arm64"))),
+    ).toMatchObject({ name: "dslint-aarch64-apple-darwin" });
+  });
+});
+
 describe("releaseAssetBaseName", () => {
   it("maps darwin arm64", () => {
     expect(releaseAssetBaseName(proc("darwin", "arm64"))).toBe(