@scalequality/check 0.1.0

package/README.md

@@ -0,0 +1,47 @@
+# @scalequality/check
+
+Continuous code-maturity gate for CI. On every build it asks ScaleQuality to
+re-measure your repo and **fails the pipeline when maturity drops below your line**,
+so quality regressions are caught before they merge.
+
+```bash
+npx @scalequality/check --token "$SQ_TOKEN" --project <projectId>
+```
+
+Get your token and project id from ScaleQuality: open a connected repo's diagnosis
+and **Turn on continuous measurement**. Store the token as a CI secret named
+`SQ_TOKEN`.
+
+## Options
+
+| Flag | Env | Default | Meaning |
+|------|-----|---------|---------|
+| `--token` | `SQ_TOKEN` | — | Your SQ token (required) |
+| `--project` | `SQ_PROJECT` | — | ScaleQuality project id (required) |
+| `--host` | `SQ_HOST` | `https://app.scalequality.io` | API host |
+| `--timeout` | — | `600` | Max seconds to wait for the measurement |
+| `--json` | — | off | Print the raw result as JSON |
+
+Exit codes: `0` passed (or track-only), `1` below the cutoff, `2` error.
+
+## CI examples
+
+GitHub Actions (a step in your job):
+
+```yaml
+- run: npx @scalequality/check --token "$SQ_TOKEN" --project <projectId>
+  env:
+    SQ_TOKEN: ${{ secrets.SQ_TOKEN }}
+```
+
+GitLab CI:
+
+```yaml
+scalequality:
+  image: node:20
+  script:
+    - npx @scalequality/check --token "$SQ_TOKEN" --project <projectId>
+```
+
+Any other CI: run the same `npx @scalequality/check` command, with `SQ_TOKEN`
+exposed as a secret/variable.

package/bin/check.mjs

@@ -0,0 +1,90 @@
+#!/usr/bin/env node
+// ScaleQuality continuous check. Reports the project to ScaleQuality (re-measures
+// the repo) and exits non-zero when maturity is below the configured cutoff, so a
+// CI step can fail the build. Pure Node 18+ (global fetch), no dependencies.
+
+const args = process.argv.slice(2)
+const flag = (name) => {
+  const i = args.indexOf(name)
+  return i >= 0 ? args[i + 1] : undefined
+}
+const has = (name) => args.includes(name)
+
+if (has("--help") || has("-h")) {
+  console.log(`scalequality check — continuous code-maturity gate for CI
+
+Usage:
+  npx @scalequality/check --token <SQ_TOKEN> --project <projectId> [options]
+
+Options:
+  --token <t>      SQ token (or env SQ_TOKEN)
+  --project <id>   ScaleQuality project id (or env SQ_PROJECT)
+  --host <url>     API host (default https://app.scalequality.io, or env SQ_HOST)
+  --timeout <s>    Max seconds to wait for the measurement (default 600)
+  --json           Print the raw result as JSON
+  -h, --help       Show this help
+
+Exit codes: 0 passed (or track-only), 1 below the cutoff, 2 error.`)
+  process.exit(0)
+}
+
+const token = flag("--token") || process.env.SQ_TOKEN
+const project = flag("--project") || process.env.SQ_PROJECT
+const host = (flag("--host") || process.env.SQ_HOST || "https://app.scalequality.io").replace(/\/+$/, "")
+const jsonOut = has("--json")
+const timeoutMs = Math.max(30, Number(flag("--timeout") || 600)) * 1000
+
+const base = `${host}/api/insights/continuous`
+const log = (m) => { if (!jsonOut) console.log(m) }
+const fail = (m) => { console.error(`ScaleQuality: ${m}`); process.exit(2) }
+const sleep = (ms) => new Promise((r) => setTimeout(r, ms))
+
+if (!token || !project) {
+  fail("--token and --project are required (or env SQ_TOKEN / SQ_PROJECT). See --help.")
+}
+
+async function main() {
+  const auth = { Authorization: `Bearer ${token}` }
+  const r = await fetch(`${base}/report`, {
+    method: "POST",
+    headers: { ...auth, "Content-Type": "application/json" },
+    body: JSON.stringify({ project }),
+  }).catch((e) => fail(`could not reach ${host} (${e.message})`))
+  if (!r.ok) {
+    const body = await r.text().catch(() => "")
+    if (r.status === 401) fail("invalid token.")
+    if (r.status === 402) fail("continuous measurement needs an active subscription.")
+    if (r.status === 409) fail("continuous is not enabled for this project. Turn it on in ScaleQuality.")
+    fail(`report failed (${r.status}) ${body}`)
+  }
+  const { runId } = await r.json()
+  if (!runId) fail("no run id returned.")
+  log(`ScaleQuality: measuring ${project} …`)
+
+  const deadline = Date.now() + timeoutMs
+  let last
+  while (Date.now() < deadline) {
+    await sleep(5000)
+    const sr = await fetch(`${base}/report/${runId}`, { headers: auth }).catch((e) => fail(`status check failed (${e.message})`))
+    if (!sr.ok) { const b = await sr.text().catch(() => ""); fail(`status failed (${sr.status}) ${b}`) }
+    last = await sr.json()
+    if (last.status === "COMPLETED" || last.status === "FAILED") break
+    if (!jsonOut) process.stdout.write(".")
+  }
+  if (!jsonOut) process.stdout.write("\n")
+
+  if (!last || (last.status !== "COMPLETED" && last.status !== "FAILED")) fail("timed out waiting for the measurement.")
+  if (last.status === "FAILED") fail(`measurement failed: ${last.failureReason || "unknown"}`)
+
+  if (jsonOut) {
+    console.log(JSON.stringify(last))
+  } else {
+    const cut = last.cutoff != null ? ` (cutoff ${last.cutoff})` : " (track only)"
+    log(`ScaleQuality: maturity ${last.maturity ?? "—"}${cut}`)
+    if (last.passed === false) console.error("ScaleQuality: below the line — failing the build.")
+    else log("ScaleQuality: passed.")
+  }
+  process.exit(last.passed === false ? 1 : 0)
+}
+
+main().catch((e) => fail(e?.message || String(e)))

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@scalequality/check",
+  "version": "0.1.0",
+  "description": "ScaleQuality continuous code-maturity check for CI. Re-measures your repo on every build and fails the pipeline below your maturity line.",
+  "type": "module",
+  "bin": {
+    "check": "bin/check.mjs",
+    "scalequality-check": "bin/check.mjs"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "bin",
+    "README.md"
+  ],
+  "keywords": [
+    "scalequality",
+    "code-quality",
+    "code-maturity",
+    "ci",
+    "continuous-measurement",
+    "ai-code"
+  ],
+  "license": "MIT",
+  "homepage": "https://scalequality.io",
+  "publishConfig": {
+    "access": "public"
+  }
+}