@runroom/code-quality 1.1.5 → 1.1.7

package/README.md

@@ -0,0 +1,39 @@
+# @runroom/code-quality
+
+This package is a thin launcher for an incremental quality gate for TypeScript/JavaScript, PHP, Python, and web templates. It runs the pinned Docker image `ghcr.io/runroom/code-quality`, and its findings use reduction-only baselines.
+
+## Requirements
+
+- Docker must be running.
+- Node 18 or newer is required for `npx`.
+
+## Usage
+
+```sh
+npx @runroom/code-quality init                          # scaffold configuration and baselines
+npx @runroom/code-quality check                         # run all configured checks
+npx @runroom/code-quality check complexity duplication  # run selected checks
+npx @runroom/code-quality report                        # generate advisory reports
+npx @runroom/code-quality doctor                        # verify tools and grammar assets
+npx @runroom/code-quality versions                      # list pinned tool versions
+```
+
+## How it works
+
+Launcher X.Y.Z always runs image `ghcr.io/runroom/code-quality:vX.Y.Z`. The equivalent direct command is:
+
+```sh
+docker run --rm -v "$PWD:/work" ghcr.io/runroom/code-quality:vX.Y.Z <args>
+```
+
+`CODE_QUALITY_IMAGE` overrides the image and is validated as an image reference. Set it only to an image you trust because the current directory is mounted read-write into the container.
+
+`CI`, `GITHUB_ACTIONS`, `NO_COLOR`, and `FORCE_COLOR` are forwarded to the container. `--color` and `--no-color` override everything; otherwise a non-empty `NO_COLOR` disables color, then `FORCE_COLOR` (any value but `0`) forces it, then color is on in GitHub Actions or when stdout is a TTY.
+
+## Documentation
+
+See the [repository documentation](https://github.com/Runroom/code-quality#readme) for `.code-quality.yml` configuration, checks, baselines, and the reusable GitHub Actions workflow.
+
+## License
+
+MIT

package/dist/cli.js

@@ -38,9 +38,12 @@ function buildDockerArgs(ctx) {
   if (ctx.platform === "linux" && ctx.uid !== void 0 && ctx.gid !== void 0) {
     args.push("--user", `${ctx.uid}:${ctx.gid}`);
   }
-  for (const name of ["CI", "GITHUB_ACTIONS"]) {
+  for (const name of ["CI", "GITHUB_ACTIONS", "NO_COLOR", "FORCE_COLOR"]) {
     if (ctx.env[name] !== void 0) args.push("-e", name);
   }
+  if (ctx.isTTY && !ctx.env.NO_COLOR && ctx.env.FORCE_COLOR === void 0) {
+    args.push("-e", "FORCE_COLOR=1");
+  }
   args.push(ctx.image, ...ctx.argv);
   return args;
 }
@@ -71,7 +74,8 @@ try {
     platform: process.platform,
     ...process.getuid ? { uid: process.getuid() } : {},
     ...process.getgid ? { gid: process.getgid() } : {},
-    image
+    image,
+    isTTY: process.stdout.isTTY === true
   });
   const result = spawnSync("docker", args, { stdio: "inherit" });
   const outcome = resolveOutcome(result, image);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runroom/code-quality",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "Runroom incremental quality gate — runs the pinned ghcr.io/runroom/code-quality image",
   "type": "module",
   "scripts": {
@@ -24,5 +24,9 @@
     "url": "git+https://github.com/Runroom/code-quality.git",
     "directory": "launcher"
   },
+  "homepage": "https://github.com/Runroom/code-quality#readme",
+  "bugs": {
+    "url": "https://github.com/Runroom/code-quality/issues"
+  },
   "license": "MIT"
 }