v11y-check 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.readyup/kits/default.js +83 -0
- package/.readyup/manifest.json +16 -0
- package/README.md +29 -4
- package/package.json +11 -3
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/** @noformat — @generated. Do not edit. Compiled by rdy. */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
export const __readyupVersion = "0.23.0";
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
// .readyup/kits/default.ts
|
|
7
|
+
import { existsSync } from "node:fs";
|
|
8
|
+
import { join } from "node:path";
|
|
9
|
+
import { defineRdyKit } from "readyup";
|
|
10
|
+
import { fileExists, fileMatchesHash, hasDevDependency, hasMinDevDependencyVersion } from "readyup/check-utils";
|
|
11
|
+
var AUDIT_WORKFLOW_HASH = "cdcab39d794ed7ec5ea45e8f3c887eb5d15edb63eab65e515714556933d9b03f";
|
|
12
|
+
var default_default = defineRdyKit({
|
|
13
|
+
checklists: [
|
|
14
|
+
{
|
|
15
|
+
name: "v11y-check",
|
|
16
|
+
checks: [
|
|
17
|
+
// -- Setup ---------------------------------------------------------------
|
|
18
|
+
{
|
|
19
|
+
name: "v11y-check in devDependencies",
|
|
20
|
+
severity: "error",
|
|
21
|
+
check: () => hasDevDependency("v11y-check"),
|
|
22
|
+
fix: "pnpm add --save-dev v11y-check",
|
|
23
|
+
checks: [
|
|
24
|
+
{
|
|
25
|
+
get name() {
|
|
26
|
+
return `v11y-check >= ${getMinVersion()}`;
|
|
27
|
+
},
|
|
28
|
+
severity: "error",
|
|
29
|
+
check: () => hasMinDevDependencyVersion("v11y-check", getMinVersion(), {
|
|
30
|
+
exempt: (range) => range.startsWith("workspace:")
|
|
31
|
+
}),
|
|
32
|
+
get fix() {
|
|
33
|
+
return `pnpm add --save-dev v11y-check@^${getMinVersion()}`;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
},
|
|
38
|
+
// -- Audit-ci config migration -------------------------------------------
|
|
39
|
+
{
|
|
40
|
+
name: "audit-ci configs are under .config/audit-ci/",
|
|
41
|
+
severity: "warn",
|
|
42
|
+
skip: skipLegacyAuditCiCheck,
|
|
43
|
+
check: noLegacyAuditCiDirectory,
|
|
44
|
+
fix: "Move audit-ci configs from .audit-ci/ to .config/audit-ci/ and update references"
|
|
45
|
+
},
|
|
46
|
+
// -- Audit workflow ------------------------------------------------------
|
|
47
|
+
{
|
|
48
|
+
name: "audit.yaml workflow exists",
|
|
49
|
+
severity: "warn",
|
|
50
|
+
check: () => fileExists(".github/workflows/audit.yaml"),
|
|
51
|
+
fix: "Add .github/workflows/audit.yaml using the audit workflow template",
|
|
52
|
+
checks: [
|
|
53
|
+
{
|
|
54
|
+
name: "audit.yaml matches template",
|
|
55
|
+
severity: "warn",
|
|
56
|
+
check: () => fileMatchesHash(".github/workflows/audit.yaml", AUDIT_WORKFLOW_HASH),
|
|
57
|
+
fix: "Replace .github/workflows/audit.yaml with the current template at williamthorsen/node-monorepo-tools:.github/workflows/audit.yaml"
|
|
58
|
+
}
|
|
59
|
+
]
|
|
60
|
+
}
|
|
61
|
+
]
|
|
62
|
+
}
|
|
63
|
+
]
|
|
64
|
+
});
|
|
65
|
+
function getMinVersion() {
|
|
66
|
+
const picked = { "version": "0.14.0" };
|
|
67
|
+
if (typeof picked.version !== "string") {
|
|
68
|
+
throw new TypeError("v11y-check/package.json: 'version' must be a string");
|
|
69
|
+
}
|
|
70
|
+
return picked.version;
|
|
71
|
+
}
|
|
72
|
+
function noLegacyAuditCiDirectory() {
|
|
73
|
+
return !existsSync(join(process.cwd(), ".audit-ci"));
|
|
74
|
+
}
|
|
75
|
+
function skipLegacyAuditCiCheck() {
|
|
76
|
+
return !existsSync(join(process.cwd(), ".audit-ci")) ? "no legacy .audit-ci/ directory" : false;
|
|
77
|
+
}
|
|
78
|
+
export {
|
|
79
|
+
AUDIT_WORKFLOW_HASH,
|
|
80
|
+
default_default as default,
|
|
81
|
+
noLegacyAuditCiDirectory,
|
|
82
|
+
skipLegacyAuditCiCheck
|
|
83
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"kits": [
|
|
4
|
+
{
|
|
5
|
+
"checklists": [
|
|
6
|
+
"v11y-check"
|
|
7
|
+
],
|
|
8
|
+
"name": "default",
|
|
9
|
+
"path": "kits/default.js",
|
|
10
|
+
"readyupVersion": "0.23.0",
|
|
11
|
+
"source": "kits/default.ts",
|
|
12
|
+
"sourceHash": "7bf5eedb",
|
|
13
|
+
"targetHash": "269e3ada"
|
|
14
|
+
}
|
|
15
|
+
]
|
|
16
|
+
}
|
package/README.md
CHANGED
|
@@ -3,15 +3,15 @@
|
|
|
3
3
|
Wraps [audit-ci](https://github.com/IBM/audit-ci) with a richer config model, typed JSON source of truth, and a sync workflow that automates allowlist management.
|
|
4
4
|
|
|
5
5
|
<!-- section:release-notes -->
|
|
6
|
-
## Release notes — v0.
|
|
6
|
+
## Release notes — v0.14.0 (2026-08-04)
|
|
7
7
|
|
|
8
8
|
### 🎉 Features
|
|
9
9
|
|
|
10
|
-
-
|
|
10
|
+
- Publish each package's readyup kit from the package that owns it (#590)
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
ReadyUp checks for `@williamthorsen/nmr`, `@williamthorsen/release-kit`, and `v11y-check` are now run directly against these packages, guaranteeing a version-appropriate check, instead of against their host repo. The package must be installed as a direct dependency in the calling repo.
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
The syntax is `rdy run --from npm:<package>`. `rdy run --packages` runs the kits contained in any packages listed in `.config/readyup.config.ts`. Requires `readyup` 0.23 or later.
|
|
15
15
|
<!-- /section:release-notes -->
|
|
16
16
|
|
|
17
17
|
## Installation
|
|
@@ -135,6 +135,31 @@ Other options:
|
|
|
135
135
|
|
|
136
136
|
The scaffolded workflow triggers on pull requests to `main`/`next`, on a daily schedule, and on manual `workflow_dispatch`. Commit the file into your repository so the caller runs in CI. If the reusable workflow's caller-side requirements change (for example, the tag bumps), re-run `v11y init --force` to refresh the file.
|
|
137
137
|
|
|
138
|
+
## Readiness checks
|
|
139
|
+
|
|
140
|
+
v11y-check publishes a [readyup](https://www.npmjs.com/package/readyup) kit that checks a consuming repo against the release it has installed: that v11y-check is a devDependency at or above the current version, that audit-ci configs sit under `.config/audit-ci/`, and that `.github/workflows/audit.yaml` matches the template this package scaffolds. The kit ships inside the package, so it checks against the version you installed rather than whatever a repository ref happens to point at.
|
|
141
|
+
|
|
142
|
+
Add `readyup` as a devDependency, then name v11y-check in its config:
|
|
143
|
+
|
|
144
|
+
```ts
|
|
145
|
+
// .config/readyup.config.ts
|
|
146
|
+
import { defineRdyConfig } from 'readyup';
|
|
147
|
+
|
|
148
|
+
export default defineRdyConfig({
|
|
149
|
+
packages: ['v11y-check'],
|
|
150
|
+
});
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
rdy run --packages # every kit each listed package publishes
|
|
155
|
+
rdy run --from npm:v11y-check # v11y-check's kit alone, without the config entry
|
|
156
|
+
rdy list --from npm:v11y-check # what v11y-check publishes
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
`--packages` is the form that survives v11y-check publishing further kits. Every form needs `readyup` 0.23 or later, and `v11y-check` as a _direct_ devDependency: a strict pnpm layout links nothing else into the project, so a transitive copy is unreachable.
|
|
160
|
+
|
|
161
|
+
The kit is no longer reachable through `rdy run --from github:williamthorsen/node-monorepo-tools`. Repos still using that form should switch to one of the invocations above.
|
|
162
|
+
|
|
138
163
|
## Migration from v0.3
|
|
139
164
|
|
|
140
165
|
v0.4 introduces breaking changes to the config schema:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "v11y-check",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.14.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Wrap audit-ci with a richer config model, typed JSON source of truth, and sync workflow",
|
|
6
6
|
"keywords": [
|
|
@@ -33,6 +33,8 @@
|
|
|
33
33
|
"v11y-check": "bin/v11y.js"
|
|
34
34
|
},
|
|
35
35
|
"files": [
|
|
36
|
+
".readyup/kits/*.js",
|
|
37
|
+
".readyup/manifest.json",
|
|
36
38
|
"bin",
|
|
37
39
|
"dist",
|
|
38
40
|
"templates"
|
|
@@ -40,10 +42,16 @@
|
|
|
40
42
|
"dependencies": {
|
|
41
43
|
"audit-ci": "7.1.0",
|
|
42
44
|
"zod": "4.4.3",
|
|
43
|
-
"@williamthorsen/nmr-core": "0.
|
|
45
|
+
"@williamthorsen/nmr-core": "0.9.0"
|
|
46
|
+
},
|
|
47
|
+
"devDependencies": {
|
|
48
|
+
"readyup": "0.23.0"
|
|
44
49
|
},
|
|
45
50
|
"engines": {
|
|
46
51
|
"node": ">=24"
|
|
47
52
|
},
|
|
48
|
-
"scripts": {
|
|
53
|
+
"scripts": {
|
|
54
|
+
"build:post": "rdy compile",
|
|
55
|
+
"build:pre": "rdy verify"
|
|
56
|
+
}
|
|
49
57
|
}
|