dslinter 0.0.16 → 0.0.27

package/src/components/Section.tsx

@@ -1,3 +1,5 @@
+import type { ReactNode } from "react";
+
 export function Section({
   id,
   children,
@@ -6,10 +8,10 @@ export function Section({
   actions,
 }: {
   id: string;
-  children: React.ReactNode;
+  children: ReactNode;
   title: string;
   description: string;
-  actions?: React.ReactNode;
+  actions?: ReactNode;
 }) {
   return (
     <section id={id} className="scroll-mt-20">

package/src/components/playgroundUsageHighlight.ts

@@ -6,15 +6,6 @@ import { createJavaScriptRegexEngine } from "shiki/engine/javascript";
 const THEME = "github-dark";
 const LANG = "tsx";
 
-/** When true, run Twoslash (CDN ATA + hover) before highlighting. */
-export function usageSnippetNeedsTwoslash(source: string): boolean {
-  return (
-    /\^\?/.test(source) ||
-    /\/\/\s*@(?:errors|error|log|warn|filename|noErrors)/m.test(source) ||
-    /\/\/\s*---cut---/.test(source)
-  );
-}
-
 let highlighterPromise: Promise<HighlighterCore> | null = null;
 
 function getHighlighter(): Promise<HighlighterCore> {
@@ -32,22 +23,12 @@ function assertNotAborted(signal: AbortSignal | undefined): void {
   if (signal?.aborted) throw new DOMException("Aborted", "AbortError");
 }
 
-/**
- * Renders usage source to Shiki HTML. Twoslash runs only when {@link usageSnippetNeedsTwoslash} is true
- * (loaded in a separate async chunk so the default bundle stays smaller).
- */
+/** Renders usage source to Shiki HTML. */
 export async function renderPlaygroundUsageHtml(
   source: string,
   signal?: AbortSignal,
 ): Promise<string> {
   const highlighter = await getHighlighter();
   assertNotAborted(signal);
-
-  if (!usageSnippetNeedsTwoslash(source)) {
-    return highlighter.codeToHtml(source, { lang: LANG, theme: THEME });
-  }
-
-  const { renderUsageWithTwoslash } = await import("./playgroundUsageTwoslash");
-  assertNotAborted(signal);
-  return renderUsageWithTwoslash(highlighter, source, signal);
+  return highlighter.codeToHtml(source, { lang: LANG, theme: THEME });
 }

package/scripts/ensure-dslint.mjs

@@ -1,187 +0,0 @@
-/**
- * Best-effort download of the prebuilt `dslinter` CLI for this platform.
- */
-import { readFileSync, renameSync, unlinkSync, writeFileSync } from "node:fs";
-import { chmod, mkdir, stat } from "node:fs/promises";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-import {
-  fetchReleasesForVersion,
-  githubAuthToken,
-  pickReleaseAsset,
-  tryDirectAssetDownload,
-} from "./github-release.mjs";
-import {
-  githubRepoFromPackage,
-  releaseAssetCandidateNames,
-  vendorBinaryPath,
-} from "./resolve-dslint-binary.mjs";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const defaultPackageRoot = join(__dirname, "..");
-
-async function pathExists(p) {
-  try {
-    await stat(p);
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-function readPackageVersion(packageRoot) {
-  const pkg = JSON.parse(
-    readFileSync(join(packageRoot, "package.json"), "utf8"),
-  );
-  return pkg.version;
-}
-
-function releaseRepo(packageRoot) {
-  const override = process.env.DSLINT_GITHUB_REPO?.trim();
-  if (override) return override;
-  return githubRepoFromPackage(packageRoot);
-}
-
-/**
- * @param {string} dest
- * @param {{ buf: Buffer }} payload
- */
-async function writeVendorBinary(dest, { buf }) {
-  const tmp = `${dest}.part`;
-  writeFileSync(tmp, buf);
-  try {
-    if (await pathExists(dest)) unlinkSync(dest);
-  } catch {
-    /* ignore */
-  }
-  renameSync(tmp, dest);
-  if (process.platform !== "win32") {
-    await chmod(dest, 0o755);
-  }
-}
-
-/**
- * @param {string} packageRoot
- * @param {{ quiet?: boolean }} [opts]
- */
-export async function ensureDslintBinary(packageRoot = defaultPackageRoot, opts = {}) {
-  const { quiet = false } = opts;
-  const log = quiet ? () => {} : console.warn.bind(console);
-
-  if (process.env.DSLINT_SKIP_DOWNLOAD === "1") {
-    return pathExists(vendorBinaryPath(packageRoot));
-  }
-
-  const dest = vendorBinaryPath(packageRoot);
-  if (await pathExists(dest)) return true;
-
-  const candidates = releaseAssetCandidateNames();
-  if (candidates.length === 0) {
-    log(
-      `[dslinter] No prebuilt scanner for ${process.platform}-${process.arch}.`,
-    );
-    return false;
-  }
-
-  const version = readPackageVersion(packageRoot);
-  const repo = releaseRepo(packageRoot);
-  await mkdir(join(packageRoot, "vendor"), { recursive: true });
-
-  const direct = await tryDirectAssetDownload(repo, version, candidates, log);
-  if (direct) {
-    await writeVendorBinary(dest, direct);
-    if (direct.tag !== `v${version}` && !quiet) {
-      log(
-        `[dslinter] Installed ${direct.name} from release ${direct.tag} (npm v${version}).`,
-      );
-    }
-    return true;
-  }
-
-  let apiDenied = false;
-  let tagExistsWithoutBinaries = null;
-  try {
-    const {
-      releases,
-      apiDenied: denied,
-      apiError,
-      tagExistsWithoutBinaries: emptyTag,
-    } = await fetchReleasesForVersion(repo, version);
-    apiDenied = denied;
-    tagExistsWithoutBinaries = emptyTag ?? null;
-
-    if (apiError) {
-      log(
-        `[dslinter] GitHub API error: ${apiError.message}`,
-      );
-    }
-
-    for (const release of releases) {
-      const asset = pickReleaseAsset(release, candidates);
-      if (!asset) continue;
-
-      const headers = {};
-      const token = githubAuthToken();
-      if (token) headers.Authorization = `Bearer ${token}`;
-
-      const res = await fetch(asset.browser_download_url, {
-        headers,
-        redirect: "follow",
-      });
-      if (!res.ok) continue;
-
-      const buf = Buffer.from(await res.arrayBuffer());
-      await writeVendorBinary(dest, { buf });
-      if (release.tag_name !== `v${version}` && !quiet) {
-        log(
-          `[dslinter] Installed ${asset.name} from release ${release.tag_name} (npm v${version}).`,
-        );
-      }
-      return true;
-    }
-  } catch (err) {
-    log(
-      `[dslinter] GitHub API: ${err instanceof Error ? err.message : err}`,
-    );
-  }
-
-  const tag = `v${version}`;
-  const releasePage = `https://github.com/${repo}/releases/tag/${tag}`;
-
-  if (tagExistsWithoutBinaries) {
-    log(
-      `[dslinter] GitHub release ${tagExistsWithoutBinaries} exists but has no scanner binaries attached.\n` +
-        `  Run the "Release dslinter binaries" workflow on ${repo} (Actions → workflow_dispatch, tag ${tagExistsWithoutBinaries}),\n` +
-        `  or push a new tag so CI uploads assets like ${candidates[0]}.\n` +
-        `  ${releasePage}`,
-    );
-    return false;
-  }
-
-  if (apiDenied || !githubAuthToken()) {
-    log(
-      `[dslinter] Cannot reach ${repo} releases without authentication (GitHub returned 404).\n` +
-        `  If you can open ${releasePage} in a browser, the repo is likely private.\n` +
-        `  Create a fine-grained or classic token with repo read access, then:\n` +
-        `    export GITHUB_TOKEN=ghp_...\n` +
-        `    npx dslinter\n` +
-        `  Or install from source: cargo install --git https://github.com/${repo} dslinter --locked`,
-    );
-    return false;
-  }
-
-  log(
-    `[dslinter] No release with asset ${candidates.join(" or ")} on ${repo} for ${tag}.\n` +
-      `  Create ${releasePage} and run release-dslint-binaries.yml, or set DSLINT_BIN.`,
-  );
-  return false;
-}
-
-const isMain =
-  process.argv[1] &&
-  fileURLToPath(import.meta.url) === process.argv[1];
-
-if (isMain) {
-  await ensureDslintBinary();
-  process.exit(0);
-}

package/scripts/github-release.mjs

@@ -1,219 +0,0 @@
-/**
- * Resolve and download GitHub release assets (API + direct URLs; supports private repos with a token).
- */
-
-const API = "https://api.github.com";
-
-export function githubAuthToken() {
-  return (
-    process.env.GITHUB_TOKEN?.trim() || process.env.GH_TOKEN?.trim() || null
-  );
-}
-
-export function downloadAuthHeaders() {
-  const token = githubAuthToken();
-  return token ? { Authorization: `Bearer ${token}` } : {};
-}
-
-function apiHeaders() {
-  return {
-    Accept: "application/vnd.github+json",
-    "User-Agent": "dslinter-npm",
-    "X-GitHub-Api-Version": "2022-11-28",
-    ...downloadAuthHeaders(),
-  };
-}
-
-/**
- * @param {string} repo `owner/name`
- * @param {string} tag `v0.0.12` or `latest`
- * @param {string} assetName
- */
-export function directAssetUrl(repo, tag, assetName) {
-  const file = encodeURIComponent(assetName);
-  if (tag === "latest") {
-    return `https://github.com/${repo}/releases/latest/download/${file}`;
-  }
-  return `https://github.com/${repo}/releases/download/${encodeURIComponent(tag)}/${file}`;
-}
-
-/**
- * @param {string} npmVersion
- */
-export function releaseTagsToTry(npmVersion) {
-  const override = process.env.DSLINT_RELEASE_TAG?.trim();
-  if (override) {
-    return [override.startsWith("v") ? override : `v${override}`];
-  }
-  return [`v${npmVersion}`, npmVersion, "latest"];
-}
-
-/**
- * @param {string} repo
- * @param {string} path
- * @returns {Promise<{ data: unknown } | { notFound: true } | { error: Error }>}
- */
-async function githubGet(repo, path) {
-  const res = await fetch(`${API}/repos/${repo}${path}`, {
-    headers: apiHeaders(),
-    redirect: "follow",
-  });
-  if (res.status === 404) return { notFound: true };
-  if (!res.ok) {
-    const body = await res.text().catch(() => "");
-    return {
-      error: new Error(`GitHub API ${res.status} for ${path}: ${body.slice(0, 200)}`),
-    };
-  }
-  return { data: await res.json() };
-}
-
-/**
- * @param {string} repo
- * @param {string} tag e.g. `v0.0.12` or `latest`
- */
-export async function fetchRelease(repo, tag) {
-  const path =
-    tag === "latest" ? "/releases/latest" : `/releases/tags/${encodeURIComponent(tag)}`;
-  let result = await githubGet(repo, path);
-  if (result.notFound && tag.startsWith("v")) {
-    result = await githubGet(
-      repo,
-      `/releases/tags/${encodeURIComponent(tag.slice(1))}`,
-    );
-  }
-  if ("data" in result) return result.data;
-  return null;
-}
-
-/**
- * @param {string} repo
- * @param {string} npmVersion
- */
-/** @param {unknown} release */
-function hasScannerAssets(release) {
-  const names = release?.assets?.map((a) => a.name) ?? [];
-  return names.some((n) => n.startsWith("dslinter-") || n.startsWith("dslint-"));
-}
-
-export async function fetchReleasesForVersion(repo, npmVersion) {
-  const out = [];
-  const seen = new Set();
-  /** @type {string | null} */
-  let tagExistsWithoutBinaries = null;
-
-  const consider = (release) => {
-    if (!release?.tag_name) return;
-    const tag = String(release.tag_name);
-    const matches =
-      tag === `v${npmVersion}` || tag === npmVersion;
-    if (matches && !hasScannerAssets(release)) {
-      tagExistsWithoutBinaries = tag;
-    }
-  };
-
-  const push = (release) => {
-    if (!hasScannerAssets(release)) return;
-    const key = release.id ?? release.tag_name;
-    if (seen.has(key)) return;
-    seen.add(key);
-    out.push(release);
-  };
-
-  const vRelease = await fetchRelease(repo, `v${npmVersion}`);
-  consider(vRelease);
-  push(vRelease);
-
-  const bareRelease = await fetchRelease(repo, npmVersion);
-  consider(bareRelease);
-  push(bareRelease);
-
-  const latestRelease = await fetchRelease(repo, "latest");
-  push(latestRelease);
-
-  if (out.length > 0) {
-    return { releases: out, apiDenied: false, tagExistsWithoutBinaries };
-  }
-
-  const listResult = await githubGet(repo, "/releases?per_page=30");
-  if ("error" in listResult) {
-    return { releases: out, apiDenied: false, apiError: listResult.error };
-  }
-  if (listResult.notFound) {
-    return { releases: out, apiDenied: !githubAuthToken() };
-  }
-
-  const list = listResult.data;
-  if (!Array.isArray(list)) return { releases: out, apiDenied: false };
-
-  for (const release of list) {
-    const tag = String(release.tag_name ?? "");
-    if (tag === `v${npmVersion}` || tag === npmVersion) {
-      push(release);
-    }
-  }
-  if (out.length > 0) {
-    return { releases: out, apiDenied: false, tagExistsWithoutBinaries };
-  }
-
-  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 { releases: out, apiDenied: false, tagExistsWithoutBinaries };
-}
-
-/**
- * @param {string[]} candidateNames
- * @param {{ assets: { name: string; browser_download_url: string }[] }} release
- */
-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;
-}
-
-/**
- * Download via public/private release URLs (no API metadata required).
- * @param {(msg: string) => void} log
- */
-export async function tryDirectAssetDownload(repo, npmVersion, candidateNames, log) {
-  const verbose = process.env.DSLINT_VERBOSE === "1";
-  const headers = downloadAuthHeaders();
-  const tags = releaseTagsToTry(npmVersion);
-
-  for (const tag of tags) {
-    for (const name of candidateNames) {
-      const url = directAssetUrl(repo, tag, name);
-      if (verbose) log(`[dslinter] GET ${url}`);
-      try {
-        const res = await fetch(url, { headers, redirect: "follow" });
-        if (res.status === 404) continue;
-        if (!res.ok) {
-          if (verbose) log(`[dslinter] ${res.status} ${url}`);
-          continue;
-        }
-        const contentType = res.headers.get("content-type") ?? "";
-        if (contentType.includes("text/html")) continue;
-
-        const buf = Buffer.from(await res.arrayBuffer());
-        if (buf.length < 512) continue;
-
-        return { buf, tag, name, url };
-      } catch (err) {
-        if (verbose) {
-          log(
-            `[dslinter] ${url}: ${err instanceof Error ? err.message : err}`,
-          );
-        }
-      }
-    }
-  }
-  return null;
-}

package/scripts/print-missing-scanner.mjs

@@ -1,32 +0,0 @@
-import { readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-import { githubRepoFromPackage } from "./resolve-dslint-binary.mjs";
-
-const packageRoot = join(dirname(fileURLToPath(import.meta.url)), "..");
-const version = JSON.parse(
-  readFileSync(join(packageRoot, "package.json"), "utf8"),
-).version;
-const repo = githubRepoFromPackage(packageRoot);
-
-process.stderr.write(`dslinter: scanner binary not available.
-
-Do NOT run:  cargo install dslint
-  That installs a different package on crates.io (design-file linter).
-
-Install the design-system scanner from this repo instead:
-
-  cargo install --git https://github.com/${repo} dslinter --locked
-  export DSLINT_BIN="$(command -v dslinter)"
-  npx dslinter ...
-
-If releases exist at https://github.com/${repo}/releases/tag/v${version} but
-download failed, the repo may be private — set a GitHub token then retry:
-
-  export GITHUB_TOKEN=ghp_...   # needs read access to ${repo}
-  npx dslinter
-
-Or point at a local build:  DSLINT_BIN=/path/to/dslinter
-
-Tip: DSLINT_VERBOSE=1 shows each download URL tried.
-`);

package/scripts/resolve-dslint-binary.mjs

@@ -1,80 +0,0 @@
-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]
- * @returns {string | null}
- */
-export function releaseAssetBaseName(proc = process) {
-  const { platform, arch } = proc;
-  if (platform === "darwin" && arch === "arm64") {
-    return "dslinter-aarch64-apple-darwin";
-  }
-  if (platform === "darwin" && arch === "x64") {
-    return "dslinter-x86_64-apple-darwin";
-  }
-  if (platform === "linux" && arch === "x64") {
-    return "dslinter-x86_64-unknown-linux-gnu";
-  }
-  if (platform === "linux" && arch === "arm64") {
-    return "dslinter-aarch64-unknown-linux-gnu";
-  }
-  if (platform === "win32" && arch === "x64") {
-    return "dslinter-x86_64-pc-windows-msvc.exe";
-  }
-  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]
- */
-export function vendorBinaryPath(packageRoot, proc = process) {
-  const name =
-    proc.platform === "win32" ? `${CLI_BINARY_NAME}.exe` : CLI_BINARY_NAME;
-  return join(packageRoot, "vendor", name);
-}
-
-/** Our scanner prints this in `dslinter --version` help output (clap about line). */
-export const SCANNER_VERSION_MARKER = "design system linting";

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

@@ -1,127 +0,0 @@
-import { join } from "node:path";
-import { describe, expect, it } from "vitest";
-import {
-  directAssetUrl,
-  pickReleaseAsset,
-  releaseTagsToTry,
-} from "../scripts/github-release.mjs";
-import {
-  CLI_BINARY_NAME,
-  DEFAULT_GITHUB_REPO,
-  parseGitHubRepo,
-  releaseAssetBaseName,
-  releaseAssetCandidateNames,
-  vendorBinaryPath,
-} from "../scripts/resolve-dslint-binary.mjs";
-
-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("directAssetUrl", () => {
-  it("uses releases/latest/download for latest tag", () => {
-    expect(
-      directAssetUrl("jrmybtlr/DSLinter", "latest", "dslinter-aarch64-apple-darwin"),
-    ).toBe(
-      "https://github.com/jrmybtlr/DSLinter/releases/latest/download/dslinter-aarch64-apple-darwin",
-    );
-  });
-
-  it("uses releases/download for version tags", () => {
-    expect(
-      directAssetUrl("jrmybtlr/DSLinter", "v0.0.12", "dslinter-aarch64-apple-darwin"),
-    ).toBe(
-      "https://github.com/jrmybtlr/DSLinter/releases/download/v0.0.12/dslinter-aarch64-apple-darwin",
-    );
-  });
-});
-
-describe("releaseTagsToTry", () => {
-  it("tries v-prefixed tag first", () => {
-    expect(releaseTagsToTry("0.0.12")).toEqual(["v0.0.12", "0.0.12", "latest"]);
-  });
-});
-
-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(
-      "dslinter-aarch64-apple-darwin",
-    );
-  });
-
-  it("maps linux x64", () => {
-    expect(releaseAssetBaseName(proc("linux", "x64"))).toBe(
-      "dslinter-x86_64-unknown-linux-gnu",
-    );
-  });
-
-  it("maps win32 x64", () => {
-    expect(releaseAssetBaseName(proc("win32", "x64"))).toBe(
-      "dslinter-x86_64-pc-windows-msvc.exe",
-    );
-  });
-
-  it("returns null for unknown", () => {
-    expect(releaseAssetBaseName(proc("freebsd", "x64"))).toBeNull();
-  });
-});
-
-describe("vendorBinaryPath", () => {
-  it("uses dslinter.exe on Windows", () => {
-    expect(vendorBinaryPath(join("/", "pkg"), proc("win32", "x64"))).toBe(
-      join("/", "pkg", "vendor", `${CLI_BINARY_NAME}.exe`),
-    );
-  });
-
-  it("uses dslinter on Unix", () => {
-    expect(vendorBinaryPath(join("/", "pkg"), proc("linux", "x64"))).toBe(
-      join("/", "pkg", "vendor", CLI_BINARY_NAME),
-    );
-  });
-});