@bushizhanghan/dsh-publish-gate 0.15.0 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 0.17.0
+
+- `changelog-not-shipped` (warn): a CHANGELOG.md that exists on disk but is not in the tarball. npm
+  force-includes README and LICENSE and nothing else, so the file you keep updating never reaches the
+  registry page. Hit it the first time I added a changelog and had to add it to `files` by hand.
+- `git-tag-unverified` (info): origin could not be read, so the tag was not checked. Previously this
+  fell back to the local tag list and claimed a missing tag — six of my nine plugins were flagged on a
+  day GitHub was unreachable, and all six were tagged. The local list proves nothing when the commit
+  was pushed through the API and local HEAD is not the shipped commit.
+- First end-to-end run of the gate with the test layer over all nine plugins in this workspace: every
+  suite passed, and the tag rule was the only false positive.
+
+- `changelog-not-shipped` (warn): a CHANGELOG.md that exists on disk but is not in the tarball. npm
+  force-includes README and LICENSE and nothing else, so the file you keep updating never reaches the
+  registry page. Hit it the first time I added a changelog and had to add it to `files` by hand.
+- First end-to-end run of the gate with the test layer over all nine plugins in this workspace.
+
+## 0.16.0
+
+- `market-release-behind` (warn): the newest GitHub release is older (or newer) than package.json. A
+  catalogue entry may install `releases/latest/download/<asset>`, so a lagging release serves code the
+  description no longer describes — a reviewer blocked a submission for exactly that.
+- `straySeverities` + `internal-bad-severity`: a finding whose severity is not error/warn/info is counted
+  by nothing and reported nowhere, so the rule looks like it never fires. `publish_gate` now turns any such
+  finding into a loud error instead of dropping it.
+- The source scan added in 0.15.0 caught the same mistake again while building this version: a string
+  replace aimed at RULE_ORDER matched an earlier `F(...)` call and wrote the new rule name into a severity
+  slot. Fixed, and the fix now goes through the RULE_ORDER slice instead of a global replace.
+
 ## 0.15.0
 
 - Three rules shipped with a *rule name* in their severity slot: `market-repo-too-new`,

package/README.md

@@ -8,6 +8,10 @@
 
 门禁分三层：**清单层**看 package.json / patch / 入口源码，**产物层**真的跑一遍 `npm pack --dry-run` 看 npm 到底会发出什么，**运行时层**在独立子进程里 `import()` 入口并 `apply(ctx)` 一遍，看它到底注册了什么。
 
+### 自检：看不见的 finding
+
+`severity` 不是 `error`/`warn`/`info` 的 finding 会被所有计数器忽略，等于规则从没触发过。`publish_gate` 现在会把这类 finding 提升成一条 `internal-bad-severity` 的 error，测试里还有一条源码扫描盯着 `F(...)` 的第二个参数。这条网加上当天就抓到了我自己的同一个错误。
+
 ### 测试层：门禁真的会跑一遍你的测试
 
 `tests-fail` / `tests-timeout` / `tests-not-run` 三条规则会以 `node --test` 在插件目录里真跑一次（不经过 `npm test`，因为脚本内容由作者决定、可能 shell 出去）。子进程会去掉继承来的 `NODE_TEST_CONTEXT`——否则当门禁本身跑在 `node --test` 里时，子进程进入 test-child 模式、一个摘要都不打印，看起来像"没有测试"。
@@ -76,7 +80,7 @@ dsh plugin --profile desktop add @bushizhanghan/dsh-publish-gate
 | `readme-wrong-package` | README 的安装命令写的是**另一个包名**（从别的插件抄过来没改）。照着装的人装到别的插件上，而且不会报错——那个包真的存在 |
 
 ### 值得在发布前知道的（warn / info）
-`npm-scope-mismatch`（登录的账号不是包 scope 的所有者，PUT 会 403，而错误里既不说 token 也不说 scope——我为一个 403 花了一小时）、`unscoped-name`（granular token 的 403）、`repo-missing`、`patch-name-unresolvable`（junction 放错层级）、`inject-unused-service`（`inject` 里写了个拼错的服务名，cordis 一直等它，插件静默不激活）、`no-publish-config-access`（scoped 包没写 `publishConfig.access`，只是提醒，因为命令里本来就带 `--access public`）、`publish-config-registry`（`publishConfig.registry` 指到内网 registry，版本发到别人装不到的地方）、`no-readme` / `readme-no-install` / `readme-no-profile`、`license-mismatch`、`no-tests` / `no-test-files` / `no-test-script`、`no-engines`、`bad-repo-url`、`no-git` / `no-gitignore`、`readme-tool-undocumented`（README 没提这个工具）/ `readme-test-count`（README 写的测试数和真实数不一致）、`changelog-missing-version`（要发的这个版本号在 CHANGELOG 里没有对应标题，npm 照样发，发布说明就永远落后一版）、`changelog-no-versions`（CHANGELOG 里没有版本标题，读者对不上自己装的那版）、`no-changelog`（只是提醒），以及市场条目的 `market-*` 全系列。
+`npm-scope-mismatch`（登录的账号不是包 scope 的所有者，PUT 会 403，而错误里既不说 token 也不说 scope——我为一个 403 花了一小时）、`unscoped-name`（granular token 的 403）、`repo-missing`、`patch-name-unresolvable`（junction 放错层级）、`inject-unused-service`（`inject` 里写了个拼错的服务名，cordis 一直等它，插件静默不激活）、`no-publish-config-access`（scoped 包没写 `publishConfig.access`，只是提醒，因为命令里本来就带 `--access public`）、`publish-config-registry`（`publishConfig.registry` 指到内网 registry，版本发到别人装不到的地方）、`no-readme` / `readme-no-install` / `readme-no-profile`、`license-mismatch`、`no-tests` / `no-test-files` / `no-test-script`、`no-engines`、`bad-repo-url`、`no-git` / `no-gitignore`、`readme-tool-undocumented`（README 没提这个工具）/ `readme-test-count`（README 写的测试数和真实数不一致）、`changelog-missing-version`（要发的这个版本号在 CHANGELOG 里没有对应标题，npm 照样发，发布说明就永远落后一版）、`changelog-no-versions`（CHANGELOG 里没有版本标题，读者对不上自己装的那版）、`no-changelog`（只是提醒）、`changelog-not-shipped`（CHANGELOG 在本地但没进 tarball——npm 只强制带 README 和 LICENSE，你一直更新的那份文件在 registry 页面上看不见），以及市场条目的 `market-*` 全系列。
 
 ### 产物层：npm 到底会发出什么
 
@@ -143,6 +147,7 @@ dsh plugin --profile desktop add @bushizhanghan/dsh-publish-gate
 | 规则 | 抓什么 |
 |---|---|
 | `market-duplicate-entry` | 这个仓库**已经在目录里**。再提一个 PR 就是同一仓库的第二条条目，reviewer 会拒。版本升级根本不需要 PR——目录条目只存 `url` |
+| `market-release-behind` | warn | 最新 GitHub release 比 package.json 旧（或新） | 目录里写着 1.2.7、release 资产还是 1.2.6 时，市场条目装的是旧代码，而描述是新版写的——维护者正是以「描述与 tarball 不符」驳回过一次提交 |
 | `market-npm-name-collision` | 另一个条目也在发同一个 npm 包，安装路径会互相盖 |
 | `market-repo-too-new` | 仓库创建不满 24 小时。门禁会报 `0.0 days old` 然后**自己重跑**，PR 不会丢，但在那之前什么都不会合 |
 | `market-fork-of-listed` | 这个仓库是某个**已经在目录里**的仓库的 fork。两条条目装的代码抢同一批 id，两个都装就有一个被静默盖掉——而且 reviewer 会把"没写"当成"隐瞒 fork" |
@@ -187,7 +192,8 @@ dsh plugin --profile desktop add @bushizhanghan/dsh-publish-gate
 |---|---|
 | `git-uncommitted` | 会进 tarball 的文件有未提交改动。发出去的字节不在任何 commit 里，以后复现不出来、也没法 bisect |
 | `git-tag-missing` | HEAD 上没有 `v<version>` tag。发完之后这些字节的唯一记录就是 registry，GitHub release、changelog、市场条目都没法指向一个从没打过 tag 的 commit |
-| `git-tag-elsewhere` | tag 存在但不在 HEAD 上：tag 和 tarball 是两份不同的字节，从那个 tag 构建出来的东西不是你刚发的东西 |
+| `git-tag-elsewhere` | tag 存在但不在 HEAD 上：tag 和 tarball 是两份不同的字节，从那个 tag 构建出来的东西不是你刚发的东西 |
+| `git-tag-unverified` | 读不到 `origin`（断网、私有仓库、没配 remote）。这是 **info**，不是 warn：提交是用 GitHub API 推的时候本地 HEAD 不是发出去的那个 commit，本地 tag 列表证明不了任何事。断网那天我有六个插件被误报「没有 tag」，六个都打了 |
 
 都是 warn：本地试发、私有包、发完再补 tag 都合理。但「发完之后指不出是哪份代码」这件事，事后补不回来。
 
@@ -227,7 +233,7 @@ dsh plugin --profile desktop add @bushizhanghan/dsh-publish-gate
 ## 开发
 
 ```sh
-node --test                      # 113 个引擎单测
+node --test                      # 117 个引擎单测
 node test/integration.test.mjs   # 27 条集成断言（9 个真实插件作 fixture）
 ```
 

package/lib/engine.js

@@ -27,7 +27,17 @@ const safeText = (p) => {
   return b === null ? null : b.toString('utf8')
 }
 
-export const F = (rule, severity, title, detail, fix) => ({ rule, severity, title, detail, fix })
+export const F = (rule, severity, title, detail, fix) => ({ rule, severity, title, detail, fix })
+
+/**
+ * A finding whose severity is not error/warn/info is invisible: the counters
+ * only count those three, so the rule silently never reports. Three of them
+ * shipped that way before this existed. The source scan in the test suite
+ * catches the literal forms; this catches whatever a future refactor builds.
+ */
+export const SEVERITIES = new Set(['error', 'warn', 'info'])
+export const straySeverities = (findings) =>
+  [...new Set((findings || []).filter((f) => !SEVERITIES.has(f?.severity)).map((f) => String(f?.rule || '<no rule>')))]
 
 /** package.json without the BOM trap. Null when it is missing or unparseable. */
 export function readPkgJson(dir) {
@@ -857,7 +867,8 @@ export async function checkMarketReadiness(dir, opts = {}) {
     return out
   }
   const json = readPkgJson(dir)
-  const pkgName = typeof json?.name === 'string' ? json.name : null
+  const pkgName = typeof json?.name === 'string' ? json.name : null
+  const pkgVersion = typeof json?.version === 'string' ? json.version : null
 
   let entries = Array.isArray(opts.entries) ? opts.entries : null
   try {
@@ -972,6 +983,37 @@ export async function checkMarketReadiness(dir, opts = {}) {
         ),
       )
     }
+  }
+  // A catalogue entry can point at a GitHub release asset instead of npm. When
+  // the newest release is older than this directory, the entry serves code the
+  // description no longer matches — a reviewer blocked a submission for exactly
+  // that (the entry said 1.2.7, the asset was still 1.2.6).
+  let releaseInfo = opts.releaseInfo ?? null
+  if (releaseInfo === null) {
+    try {
+      const res = await fetch(`https://api.github.com/repos/${slug}/releases/latest`, {
+        signal: AbortSignal.timeout(timeoutMs),
+        headers: { 'user-agent': 'dsh-publish-gate', accept: 'application/vnd.github+json' },
+      })
+      if (res.ok) releaseInfo = await res.json()
+    } catch {
+      // no network, no releases, or a rate limit — the rule stays quiet
+    }
+  }
+  const releaseTag = typeof releaseInfo?.tag_name === 'string' ? releaseInfo.tag_name.replace(/^v/, '') : null
+  if (releaseTag && pkgVersion && releaseTag !== pkgVersion) {
+    const older = compareVersions(releaseTag, pkgVersion) < 0
+    out.push(
+      F(
+        'market-release-behind',
+        'warn',
+        `the newest GitHub release is ${releaseTag}, this directory says ${pkgVersion}`,
+        older
+          ? 'An entry that installs releases/latest/download/<asset> serves the older code while the description is written for the newer version — a reviewer reads that as a false claim.'
+          : `The release is ahead of package.json, so what the release ships is not what this directory builds.`,
+        `Cut a ${pkgVersion} release (asset name unchanged) or point the entry at npm.`,
+      ),
+    )
   }
   return out
 }
@@ -1171,6 +1213,22 @@ export async function checkPack(dir, opts = {}) {
         'Add "lib" to files.',
       ),
     )
+  }
+  // npm does not force-include a changelog the way it does README and LICENSE,
+  // so a CHANGELOG.md that is not listed in `files` never reaches the registry
+  // page — the file exists, the author updates it, and nobody installing the
+  // package can see it. I hit this the first time I added one.
+  const changelogOnDisk = ['CHANGELOG.md', 'CHANGELOG', 'HISTORY.md'].find((f) => existsSync(join(dir, f)))
+  if (changelogOnDisk && !paths.includes(changelogOnDisk)) {
+    out.push(
+      F(
+        'changelog-not-shipped',
+        'warn',
+        `${changelogOnDisk} is not in the tarball`,
+        'npm force-includes README and LICENSE but not the changelog, so the file you keep updating is invisible on the package page.',
+        `Add "${changelogOnDisk}" to files.`,
+      ),
+    )
   }
   if (json?.dsh?.bundle?.patch && !paths.includes(String(json.dsh.bundle.patch).replace(/^\.\//, ''))) {
     out.push(
@@ -2399,6 +2457,29 @@ export async function checkTraceability(dir, opts = {}) {
     return out
   }
 
+  // No answer from the remote. Two very different situations hide here: a repo
+  // with no `origin` at all, where the local tag is the only truth and a missing
+  // one is real; and a repo whose `origin` simply could not be reached, where
+  // local HEAD is not the shipped commit (the API pusher builds its own commit)
+  // and the tag usually exists. A check that cannot see the truth must not claim
+  // a defect — this reported six false positives on a day GitHub was down.
+  const remotes = opts.remotes === undefined ? await gitOut(dir, ['remote']) : opts.remotes
+  const hasOrigin = typeof remotes === 'string' && remotes.split('\n').map((r) => r.trim()).includes('origin')
+  if (hasOrigin) {
+    if (!localHasIt) {
+      out.push(
+        F(
+          'git-tag-unverified',
+          'info',
+          `could not check whether v${version} is tagged on the remote`,
+          'origin could not be read, and with an API-pushed commit the local HEAD is not the commit that shipped, so the local tag list proves nothing either way.',
+          'Re-run when the network is back — the tag may well exist.',
+        ),
+      )
+    }
+    return out
+  }
+
   if (typeof atHead === 'string' && !localHasIt) {
     const exists = opts.tagExists === undefined ? await gitOut(dir, ['rev-parse', '--verify', '--quiet', `refs/tags/v${version}`]) : opts.tagExists ? 'sha' : null
     out.push(
@@ -2481,9 +2562,9 @@ const RULE_ORDER = [
   'no-license', 'license-mismatch', 'version-taken', 'version-behind-latest', 'npm-not-logged-in', 'npm-scope-mismatch', 'npm-whoami-unavailable', 'registry-unreachable', 'publish-not-served',
   'publish-served-mismatch', 'publish-served', 'market-empty', 'market-no-url', 'market-url-not-github',
   'market-no-name', 'market-name-shape', 'market-no-category', 'market-bad-category', 'market-no-desc', 'market-no-en', 'market-no-zh', 'unscoped-name', 'no-git', 'no-readme', 'readme-no-install', 'readme-no-profile', 'readme-wrong-package',
-  'market-no-repo', 'market-unavailable', 'market-duplicate-entry', 'market-npm-name-collision', 'market-repo-too-new',
-  'no-changelog', 'changelog-no-versions', 'changelog-missing-version',
-  'git-uncommitted', 'git-tag-missing', 'git-tag-elsewhere',
+  'market-no-repo', 'market-unavailable', 'market-duplicate-entry', 'market-npm-name-collision', 'market-repo-too-new', 'market-release-behind',
+  'no-changelog', 'changelog-no-versions', 'changelog-missing-version', 'changelog-not-shipped',
+  'git-uncommitted', 'git-tag-missing', 'git-tag-unverified', 'git-tag-elsewhere',
   'readme-tool-undocumented', 'readme-test-count',
   'no-tests', 'no-test-files', 'no-test-script', 'no-engines', 'bad-repo-url', 'no-gitignore',
 ]

package/lib/index.js

@@ -29,7 +29,8 @@ import {
   latestPublished,
   renderReport,
   runArtifactChecks,
-  checkTestRun,
+  checkTestRun,
+  straySeverities,
   runStaticChecks,
 } from './engine.js'
 
@@ -116,6 +117,18 @@ export function apply(ctx, config = {}) {
         const tests = args.skipTests ? null : await checkTestRun(dir, { timeoutMs: cfg.testTimeoutMs })
         if (tests) findings.push(...tests)
         if (!args.skipNetwork) findings.push(...(await networkGate(dir)))
+        // A finding with an unexpected severity is invisible to the counters
+        // below, so the rule silently never reports. Make that loud instead.
+        const stray = straySeverities(findings)
+        if (stray.length > 0) {
+          findings.push({
+            rule: 'internal-bad-severity',
+            severity: 'error',
+            title: `these rules built a finding with an unknown severity: ${stray.join(", ")}`,
+            detail: 'The gate counted them as nothing, so they never appeared in a report. This is a bug in publish-gate, not in the plugin being gated.',
+            fix: 'Report it: the severity slot of F(...) took something other than error/warn/info.',
+          })
+        }
         const counts = {
           error: findings.filter((f) => f.severity === 'error').length,
           warn: findings.filter((f) => f.severity === 'warn').length,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bushizhanghan/dsh-publish-gate",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Pre-publish gate for DSH plugins: manifest, dependencies, artifact, runtime, browser half, traceability and market readiness — plus an input fuzzer that drives every declared parameter with the wrong type. 发布前的七层门禁 + 入参模糊测试。",
   "type": "module",
   "main": "lib/index.js",