@bushizhanghan/dsh-publish-gate 0.8.2 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.9.0
+
+- `checkChangelog()`: `changelog-missing-version` (warn), `changelog-no-versions` (warn), `no-changelog` (info).
+  The changelog is the only place a user can learn what a version changed; a bump without an entry is silent
+  drift, because npm publishes it anyway and the release notes stay one version behind. Headings accept
+  `## 1.2.3`, `### [v1.2.3]` and `# v1.2.3`.
+- An `engines-missing` rule was written and then deleted: `no-engines` already existed. Two rules for one
+  condition would have reported the same gap twice.
 ## 0.8.2
 
 - `publish_gate_verify` now returns `pending: true` when the wait runs out with the version still invisible.

package/README.md

@@ -72,7 +72,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 写的测试数和真实数不一致），以及市场条目的 `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`（只是提醒），以及市场条目的 `market-*` 全系列。
 
 ### 产物层：npm 到底会发出什么
 
@@ -216,7 +216,7 @@ dsh plugin --profile desktop add @bushizhanghan/dsh-publish-gate
 ## 开发
 
 ```sh
-node --test                      # 93 个引擎单测
+node --test                      # 97 个引擎单测
 node test/integration.test.mjs   # 27 条集成断言（9 个真实插件作 fixture）
 ```
 

package/lib/engine.js

@@ -556,6 +556,56 @@ export function checkDocs(dir) {
   return out
 }
 
+/**
+ * The changelog is the only place a user can learn what a version changed, and
+ * a version bump without an entry is invisible drift: `npm publish` says
+ * nothing, and the release notes stay one version behind forever.
+ */
+export function checkChangelog(dir) {
+  const out = []
+  const json = readPkgJson(dir)
+  if (!json?.version) return out
+  const file = ['CHANGELOG.md', 'CHANGELOG', 'HISTORY.md'].find((name) => existsSync(join(dir, name)))
+  if (!file) {
+    out.push(
+      F(
+        'no-changelog',
+        'info',
+        'no CHANGELOG.md',
+        'Every published version is permanent, so users need a place to read what changed. This is a nudge, not a defect.',
+        'Add CHANGELOG.md with one `## <version>` heading per release, and put it in `files`.',
+      ),
+    )
+    return out
+  }
+  const text = safeText(join(dir, file)) || ''
+  const headings = [...text.matchAll(/^#{1,3}\s*\[?v?(\d+\.\d+\.\d+)/gm)].map((m) => m[1])
+  if (!headings.length) {
+    out.push(
+      F(
+        'changelog-no-versions',
+        'warn',
+        `${file} has no version headings`,
+        'A changelog without `## 1.2.3` headings cannot be matched to a release, so a reader cannot tell which entry belongs to the version they installed.',
+        'Give every release a `## <version>` heading.',
+      ),
+    )
+    return out
+  }
+  if (!headings.includes(json.version)) {
+    out.push(
+      F(
+        'changelog-missing-version',
+        'warn',
+        `${file} has no entry for ${json.version} (newest heading is ${headings[0]})`,
+        'The version you are about to publish has no changelog entry. npm publishes it anyway, and the notes now describe an older release.',
+        `Add a \`## ${json.version}\` section at the top of ${file}.`,
+      ),
+    )
+  }
+  return out
+}
+
 // =====================================================================
 // npm / GitHub / market state
 // =====================================================================
@@ -2172,6 +2222,7 @@ export function runStaticChecks(dir) {
     ...checkBuildFreshness(dir),
     ...checkDependencies(dir),
     ...checkDocs(dir),
+    ...checkChangelog(dir),
     ...checkTests(dir),
     ...checkNpmState(dir),
     ...checkGitState(dir),
@@ -2200,6 +2251,7 @@ const RULE_ORDER = [
   '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',
   'readme-tool-undocumented', 'readme-test-count',
   'no-tests', 'no-test-files', 'no-test-script', 'no-engines', 'bad-repo-url', 'no-gitignore',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bushizhanghan/dsh-publish-gate",
-  "version": "0.8.2",
+  "version": "0.9.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",