@lzear/repo-lint 4.0.3 → 4.1.1

package/README.md

@@ -0,0 +1,82 @@
+# @lzear/repo-lint
+
+[![npm](https://img.shields.io/npm/v/@lzear/repo-lint)](https://www.npmjs.com/package/@lzear/repo-lint)
+[![license](https://img.shields.io/npm/l/@lzear/repo-lint)](../../LICENSE)
+
+Checks lzear repos against forge standards. Used internally by `forge check`.
+
+## Install
+
+```sh
+npm install -D @lzear/repo-lint
+# or
+yarn add -D @lzear/repo-lint
+```
+
+Requires Node ≥ 20.
+
+## CLI
+
+```sh
+npx repo-lint          # check current directory
+```
+
+Most users should use `forge check` via [`@lzear/forge`](https://www.npmjs.com/package/@lzear/forge) instead.
+
+## Programmatic API
+
+```ts
+import { checkLocal, checkRepo, CHECKS } from '@lzear/repo-lint'
+
+// Check the current working directory
+const report = await checkLocal()
+console.log(report.results)
+// [
+//   { pass: true,  desc: 'README.md exists' },
+//   { pass: false, desc: 'publint (all published packages)', detail: '...' },
+//   ...
+// ]
+
+// Check a remote GitHub repo (clones via gh CLI)
+const remote = await checkRepo('lzear/votes', { skipRemote: false })
+```
+
+### `checkLocal(options?)`
+
+| Option        | Type      | Default | Description                       |
+|---------------|-----------|---------|-----------------------------------|
+| `skipRemote`  | `boolean` | `false` | Skip GitHub secret checks         |
+
+Returns `Promise<RepoReport>`.
+
+### `RepoReport`
+
+```ts
+interface RepoReport {
+  repo: string
+  results: { pass: boolean; desc: string; detail?: string }[]
+}
+```
+
+## Checks performed
+
+| Check                          | Description                                           |
+|--------------------------------|-------------------------------------------------------|
+| `readme-exists`                | `README.md` exists                                    |
+| `readme-npm-badge`             | README has an npm badge                               |
+| `readme-codacy-grade-badge`    | README has Codacy grade badge                         |
+| `readme-codacy-coverage-badge` | README has Codacy coverage badge                      |
+| `codacy-config`                | `.codacy.yml` exists                                  |
+| `license`                      | `LICENSE` exists                                      |
+| `ci-workflow`                  | `.github/workflows/ci.yml` exists                     |
+| `renovate`                     | `renovate.json` exists                                |
+| `pkg-publint`                  | All published packages pass `publint`                 |
+| `pkg-attw`                     | All published packages pass `attw` (ESM-only profile) |
+| `pkg-knip`                     | No unused exports or dependencies (`knip`)            |
+| `deps-fresh`                   | All dependencies up to date (`ncu`)                   |
+| `secret-npm-token`             | GitHub secret `NPM_TOKEN` is set                      |
+| `secret-codacy-token`          | GitHub secret `CODACY_PROJECT_TOKEN` is set           |
+
+## Part of forge
+
+This package is part of [forge](https://github.com/lzear/forge) — shared dev tooling for lzear repos.

package/dist/bin.js

@@ -13,7 +13,7 @@ import path2 from "path";
 
 // src/checks.ts
 import { spawnSync } from "child_process";
-import { existsSync, readFileSync, readdirSync } from "fs";
+import { existsSync, readdirSync, readFileSync } from "fs";
 import path from "path";
 import { fileURLToPath } from "url";
 import { run as ncuRun } from "npm-check-updates";
@@ -81,6 +81,12 @@ var eachPublishedPkg = async (dir, fn) => {
   }
   return fn(dir);
 };
+var hasPublishedPkg = (dir) => {
+  const pkg = readPkg(dir);
+  if (!pkg) return false;
+  if (pkg.private !== true) return true;
+  return getWorkspaceDirs(dir).some((d) => hasPublishedPkg(d));
+};
 var readmeIncludes = (dir, needle) => {
   const f = path.join(dir, "README.md");
   return existsSync(f) && readFileSync(f, "utf8").includes(needle);
@@ -96,42 +102,42 @@ var LOCAL_CHECKS = [
     id: "readme-codacy-grade-badge",
     desc: "README has Codacy grade badge",
     type: "local",
+    publishedOnly: true,
     check: (dir) => readmeIncludes(dir, "project/badge/Grade/")
   },
   {
     id: "readme-codacy-coverage-badge",
     desc: "README has Codacy coverage badge",
     type: "local",
+    publishedOnly: true,
     check: (dir) => readmeIncludes(dir, "project/badge/Coverage/")
   },
   {
     id: "readme-npm-badge",
     desc: "README has npm badge",
     type: "local",
+    publishedOnly: true,
     check: (dir) => readmeIncludes(dir, "shields.io/npm/v/")
   },
-  {
-    id: "editorconfig",
-    desc: ".editorconfig exists",
-    type: "local",
-    check: (dir) => existsSync(path.join(dir, ".editorconfig"))
-  },
   {
     id: "codacy-config",
     desc: ".codacy.yml exists",
     type: "local",
+    publishedOnly: true,
     check: (dir) => existsSync(path.join(dir, ".codacy.yml"))
   },
   {
     id: "license",
     desc: "LICENSE exists",
     type: "local",
+    publishedOnly: true,
     check: (dir) => existsSync(path.join(dir, "LICENSE"))
   },
   {
     id: "ci-workflow",
     desc: "CI workflow exists",
     type: "local",
+    publishedOnly: true,
     check: (dir) => existsSync(path.join(dir, ".github/workflows/ci.yml"))
   },
   {
@@ -144,6 +150,7 @@ var LOCAL_CHECKS = [
     id: "pkg-publint",
     desc: "publint (all published packages)",
     type: "local",
+    publishedOnly: true,
     check: (dir) => eachPublishedPkg(dir, async (pkgDir) => {
       const { messages } = await publint({ pkgDir });
       const failures = messages.filter(
@@ -247,6 +254,7 @@ var REMOTE_CHECKS = [
     id: "secret-npm-token",
     desc: "Secret NPM_TOKEN set",
     type: "remote",
+    publishedOnly: true,
     check: (repo) => {
       const secrets = listSecrets(repo);
       return secrets?.includes("NPM_TOKEN") ?? false;
@@ -256,6 +264,7 @@ var REMOTE_CHECKS = [
     id: "secret-codacy-token",
     desc: "Secret CODACY_PROJECT_TOKEN set",
     type: "remote",
+    publishedOnly: true,
     check: (repo) => {
       const secrets = listSecrets(repo);
       return secrets?.includes("CODACY_PROJECT_TOKEN") ?? false;
@@ -279,13 +288,14 @@ var checkLocal = async (options = {}) => {
       return dir;
     }
   })();
+  const published = hasPublishedPkg(dir);
   const localResults = await Promise.all(
-    LOCAL_CHECKS.map(async (c) => {
+    LOCAL_CHECKS.filter((c) => !c.publishedOnly || published).map(async (c) => {
       const raw = await c.check(dir);
       return typeof raw === "boolean" ? { id: c.id, desc: c.desc, pass: raw } : { id: c.id, desc: c.desc, ...raw };
     })
   );
-  const remoteResults = skipRemote ? [] : REMOTE_CHECKS.map((c) => ({
+  const remoteResults = skipRemote ? [] : REMOTE_CHECKS.filter((c) => !c.publishedOnly || published).map((c) => ({
     id: c.id,
     desc: c.desc,
     pass: c.check(repo)

package/dist/index.d.ts

@@ -7,12 +7,14 @@ interface LocalCheck {
     id: string;
     desc: string;
     type: 'local';
+    publishedOnly?: boolean;
     check: (dir: string) => CheckResult$1;
 }
 interface RemoteCheck {
     id: string;
     desc: string;
     type: 'remote';
+    publishedOnly?: boolean;
     check: (repo: string) => boolean;
 }
 type Check = LocalCheck | RemoteCheck;

package/dist/index.js

@@ -6,7 +6,7 @@ import path2 from "path";
 
 // src/checks.ts
 import { spawnSync } from "child_process";
-import { existsSync, readFileSync, readdirSync } from "fs";
+import { existsSync, readdirSync, readFileSync } from "fs";
 import path from "path";
 import { fileURLToPath } from "url";
 import { run as ncuRun } from "npm-check-updates";
@@ -74,6 +74,12 @@ var eachPublishedPkg = async (dir, fn) => {
   }
   return fn(dir);
 };
+var hasPublishedPkg = (dir) => {
+  const pkg = readPkg(dir);
+  if (!pkg) return false;
+  if (pkg.private !== true) return true;
+  return getWorkspaceDirs(dir).some((d) => hasPublishedPkg(d));
+};
 var readmeIncludes = (dir, needle) => {
   const f = path.join(dir, "README.md");
   return existsSync(f) && readFileSync(f, "utf8").includes(needle);
@@ -89,42 +95,42 @@ var LOCAL_CHECKS = [
     id: "readme-codacy-grade-badge",
     desc: "README has Codacy grade badge",
     type: "local",
+    publishedOnly: true,
     check: (dir) => readmeIncludes(dir, "project/badge/Grade/")
   },
   {
     id: "readme-codacy-coverage-badge",
     desc: "README has Codacy coverage badge",
     type: "local",
+    publishedOnly: true,
     check: (dir) => readmeIncludes(dir, "project/badge/Coverage/")
   },
   {
     id: "readme-npm-badge",
     desc: "README has npm badge",
     type: "local",
+    publishedOnly: true,
     check: (dir) => readmeIncludes(dir, "shields.io/npm/v/")
   },
-  {
-    id: "editorconfig",
-    desc: ".editorconfig exists",
-    type: "local",
-    check: (dir) => existsSync(path.join(dir, ".editorconfig"))
-  },
   {
     id: "codacy-config",
     desc: ".codacy.yml exists",
     type: "local",
+    publishedOnly: true,
     check: (dir) => existsSync(path.join(dir, ".codacy.yml"))
   },
   {
     id: "license",
     desc: "LICENSE exists",
     type: "local",
+    publishedOnly: true,
     check: (dir) => existsSync(path.join(dir, "LICENSE"))
   },
   {
     id: "ci-workflow",
     desc: "CI workflow exists",
     type: "local",
+    publishedOnly: true,
     check: (dir) => existsSync(path.join(dir, ".github/workflows/ci.yml"))
   },
   {
@@ -137,6 +143,7 @@ var LOCAL_CHECKS = [
     id: "pkg-publint",
     desc: "publint (all published packages)",
     type: "local",
+    publishedOnly: true,
     check: (dir) => eachPublishedPkg(dir, async (pkgDir) => {
       const { messages } = await publint({ pkgDir });
       const failures = messages.filter(
@@ -240,6 +247,7 @@ var REMOTE_CHECKS = [
     id: "secret-npm-token",
     desc: "Secret NPM_TOKEN set",
     type: "remote",
+    publishedOnly: true,
     check: (repo) => {
       const secrets = listSecrets(repo);
       return secrets?.includes("NPM_TOKEN") ?? false;
@@ -249,6 +257,7 @@ var REMOTE_CHECKS = [
     id: "secret-codacy-token",
     desc: "Secret CODACY_PROJECT_TOKEN set",
     type: "remote",
+    publishedOnly: true,
     check: (repo) => {
       const secrets = listSecrets(repo);
       return secrets?.includes("CODACY_PROJECT_TOKEN") ?? false;
@@ -272,13 +281,14 @@ var checkLocal = async (options = {}) => {
       return dir;
     }
   })();
+  const published = hasPublishedPkg(dir);
   const localResults = await Promise.all(
-    LOCAL_CHECKS.map(async (c) => {
+    LOCAL_CHECKS.filter((c) => !c.publishedOnly || published).map(async (c) => {
       const raw = await c.check(dir);
       return typeof raw === "boolean" ? { id: c.id, desc: c.desc, pass: raw } : { id: c.id, desc: c.desc, ...raw };
     })
   );
-  const remoteResults = skipRemote ? [] : REMOTE_CHECKS.map((c) => ({
+  const remoteResults = skipRemote ? [] : REMOTE_CHECKS.filter((c) => !c.publishedOnly || published).map((c) => ({
     id: c.id,
     desc: c.desc,
     pass: c.check(repo)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lzear/repo-lint",
-  "version": "4.0.3",
+  "version": "4.1.1",
   "description": "Checks lzear repos against forge standards",
   "repository": {
     "type": "git",
@@ -35,7 +35,7 @@
     "publint": "^0.3"
   },
   "devDependencies": {
-    "@lzear/configs": "4.0.3",
+    "@lzear/configs": "workspace:*",
     "@types/node": "^25",
     "@vitest/coverage-v8": "^4",
     "tsup": "^8",
@@ -48,4 +48,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}