docattest 0.0.0-stage → 0.1.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.
Files changed (139) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +147 -2
  3. package/dist/agents/claude.json +30 -0
  4. package/dist/agents/cursor.json +19 -0
  5. package/dist/agents/gemini.json +27 -0
  6. package/dist/agents/index.json +3 -0
  7. package/dist/api/adapter.d.ts +231 -0
  8. package/dist/api/adapter.js +2 -0
  9. package/dist/api/attestation.d.ts +76 -0
  10. package/dist/api/attestation.js +2 -0
  11. package/dist/api/audit.d.ts +56 -0
  12. package/dist/api/audit.js +2 -0
  13. package/dist/api/config.d.ts +44 -0
  14. package/dist/api/config.js +2 -0
  15. package/dist/api/constants.d.ts +35 -0
  16. package/dist/api/constants.js +56 -0
  17. package/dist/api/errors.d.ts +15 -0
  18. package/dist/api/errors.js +22 -0
  19. package/dist/api/impact.d.ts +49 -0
  20. package/dist/api/impact.js +2 -0
  21. package/dist/api/project.d.ts +64 -0
  22. package/dist/api/project.js +2 -0
  23. package/dist/api/report.d.ts +107 -0
  24. package/dist/api/report.js +2 -0
  25. package/dist/client/answers.d.ts +17 -0
  26. package/dist/client/answers.js +23 -0
  27. package/dist/client/core.d.ts +18 -0
  28. package/dist/client/core.js +58 -0
  29. package/dist/client/place.d.ts +14 -0
  30. package/dist/client/place.js +37 -0
  31. package/dist/client/project.d.ts +3 -0
  32. package/dist/client/project.js +98 -0
  33. package/dist/client/workspace.d.ts +12 -0
  34. package/dist/client/workspace.js +72 -0
  35. package/dist/compare-strings.d.ts +2 -0
  36. package/dist/compare-strings.js +5 -0
  37. package/dist/core-binary/locate.js +113 -0
  38. package/dist/core-binary/package.js +70 -0
  39. package/dist/core.json +4 -0
  40. package/dist/files/disk.d.ts +4 -0
  41. package/dist/files/disk.js +67 -0
  42. package/dist/files/glob.d.ts +10 -0
  43. package/dist/files/glob.js +21 -0
  44. package/dist/files/ignored.d.ts +14 -0
  45. package/dist/files/ignored.js +14 -0
  46. package/dist/files/memory.d.ts +5 -0
  47. package/dist/files/memory.js +26 -0
  48. package/dist/files/source.d.ts +22 -0
  49. package/dist/files/source.js +17 -0
  50. package/dist/index.d.ts +10 -0
  51. package/dist/index.js +6 -0
  52. package/dist/json.d.ts +16 -0
  53. package/dist/json.js +43 -0
  54. package/dist/language/cache.js +18 -0
  55. package/dist/language/citations/listing.js +64 -0
  56. package/dist/language/citations/match.js +14 -0
  57. package/dist/language/citations/tests-in-file.js +101 -0
  58. package/dist/language/compiler.js +73 -0
  59. package/dist/language/description.js +24 -0
  60. package/dist/language/impact/affected.js +50 -0
  61. package/dist/language/impact/fingerprint.js +123 -0
  62. package/dist/language/impact/graph.js +72 -0
  63. package/dist/language/impact/lookup.js +100 -0
  64. package/dist/language/impact/program.js +87 -0
  65. package/dist/language/impact/renames.js +57 -0
  66. package/dist/language/impact/revision.js +62 -0
  67. package/dist/language/impact/units.js +80 -0
  68. package/dist/language/index.js +10 -0
  69. package/dist/language/inventory/observables.js +56 -0
  70. package/dist/language/inventory/plan.js +72 -0
  71. package/dist/language/inventory/probe.js +150 -0
  72. package/dist/language/languages.js +43 -0
  73. package/dist/language/node/dependency.js +34 -0
  74. package/dist/language/node/exports-map.js +92 -0
  75. package/dist/language/program/exports.js +29 -0
  76. package/dist/language/program/file-names.js +13 -0
  77. package/dist/language/program/globals.js +38 -0
  78. package/dist/language/program/host.js +91 -0
  79. package/dist/language/program/options.js +48 -0
  80. package/dist/language/program/program.js +41 -0
  81. package/dist/language/run/attempt.js +100 -0
  82. package/dist/language/run/facts.js +109 -0
  83. package/dist/language/run/host.js +73 -0
  84. package/dist/language/run/jobs.js +37 -0
  85. package/dist/language/run/pool.js +75 -0
  86. package/dist/language/run/protocol.js +37 -0
  87. package/dist/language/run/result.js +18 -0
  88. package/dist/language/run/runner.js +115 -0
  89. package/dist/language/run/sourcemap.js +43 -0
  90. package/dist/language/run/spawn.js +40 -0
  91. package/dist/language/run/transpile.js +50 -0
  92. package/dist/language/session.js +42 -0
  93. package/dist/language/surfaces/packages.js +71 -0
  94. package/dist/language/surfaces/resolve.js +48 -0
  95. package/dist/language/surfaces/specs.js +32 -0
  96. package/dist/language/surfaces/stale.js +23 -0
  97. package/dist/language/symbols.js +95 -0
  98. package/dist/language/syntax/doc-comments.js +90 -0
  99. package/dist/language/syntax/doc-prose.js +23 -0
  100. package/dist/language/syntax/expression.js +52 -0
  101. package/dist/language/syntax/imports.js +83 -0
  102. package/dist/language/syntax/lexical.js +41 -0
  103. package/dist/language/syntax/parse.js +11 -0
  104. package/dist/language/syntax/prose.js +11 -0
  105. package/dist/language/syntax/setup-module.js +88 -0
  106. package/dist/language/ts.cjs +9 -0
  107. package/dist/language/worker/cases.js +73 -0
  108. package/dist/language/worker/compile.js +15 -0
  109. package/dist/language/worker/console.js +10 -0
  110. package/dist/language/worker/context.js +16 -0
  111. package/dist/language/worker/describe.js +107 -0
  112. package/dist/language/worker/example.js +27 -0
  113. package/dist/language/worker/facts.js +69 -0
  114. package/dist/language/worker/host-client.js +55 -0
  115. package/dist/language/worker/main.js +71 -0
  116. package/dist/language/worker/network.js +35 -0
  117. package/dist/language/worker/observe.js +39 -0
  118. package/dist/language/worker/registry.js +78 -0
  119. package/dist/language/worker/setup-facts.js +50 -0
  120. package/dist/language/worker/strays.js +37 -0
  121. package/dist/launcher/main.js +38 -0
  122. package/dist/platforms.json +40 -0
  123. package/dist/protocol/context.js +48 -0
  124. package/dist/protocol/main.js +22 -0
  125. package/dist/protocol/methods.js +178 -0
  126. package/dist/protocol/output.js +40 -0
  127. package/dist/protocol/overlay.js +31 -0
  128. package/dist/protocol/serve.js +24 -0
  129. package/dist/protocol/server.js +108 -0
  130. package/dist/protocol/wire.js +117 -0
  131. package/dist/schema/agent.json +162 -0
  132. package/dist/schema/attestations.json +307 -0
  133. package/dist/schema/kit.json +190 -0
  134. package/dist/schema/language.json +162 -0
  135. package/dist/schema/messages.json +68 -0
  136. package/dist/schema/methods.json +412 -0
  137. package/dist/schema/project.json +113 -0
  138. package/dist/schema/results.json +249 -0
  139. package/package.json +73 -4
@@ -0,0 +1,113 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "title": "docattest adapter protocol, version 1: the project as open describes it, its surfaces, snapshots and manifests",
4
+ "description": "Every value the protocol carries. Optional fields are omitted, never null, unless a type says null. Paths are relative to the project root, with / separators.",
5
+ "$defs": {
6
+ "ConfiguredSurface": {
7
+ "type": "object",
8
+ "properties": {
9
+ "name": {
10
+ "type": "string"
11
+ },
12
+ "entry": {
13
+ "$ref": "#/$defs/SurfaceEntry"
14
+ }
15
+ },
16
+ "required": ["name", "entry"],
17
+ "additionalProperties": false
18
+ },
19
+ "SurfaceEntry": {
20
+ "description": "A surface as the config wrote it. What it means is the adapter's to say.",
21
+ "anyOf": [
22
+ {
23
+ "description": "A string.",
24
+ "type": "string",
25
+ "minLength": 1
26
+ },
27
+ {
28
+ "type": "object",
29
+ "properties": {
30
+ "import": {
31
+ "type": "string"
32
+ },
33
+ "path": {
34
+ "type": "string"
35
+ }
36
+ },
37
+ "required": ["import", "path"],
38
+ "additionalProperties": false
39
+ }
40
+ ]
41
+ },
42
+ "SurfaceResolution": {
43
+ "type": "object",
44
+ "description": "Where a surface resolved. Printed by the report, and passed on as it is in --json.",
45
+ "properties": {
46
+ "import": {
47
+ "description": "What examples and facts import.",
48
+ "type": "string"
49
+ },
50
+ "entry": {
51
+ "description": "The file it is read from, relative to the project root when inside it.",
52
+ "type": "string"
53
+ },
54
+ "package": {
55
+ "type": "object",
56
+ "properties": {
57
+ "name": {
58
+ "type": "string"
59
+ },
60
+ "version": {
61
+ "type": "string"
62
+ },
63
+ "display": {
64
+ "description": "The package and its version as the language writes them ('name@1.2.0', 'name 1.2.0'); the text report prints it.",
65
+ "type": "string"
66
+ }
67
+ },
68
+ "required": ["name", "display"],
69
+ "additionalProperties": false
70
+ }
71
+ },
72
+ "required": ["import", "entry"],
73
+ "additionalProperties": false
74
+ },
75
+ "SurfaceDescription": {
76
+ "type": "object",
77
+ "properties": {
78
+ "resolution": {
79
+ "$ref": "#/$defs/SurfaceResolution"
80
+ },
81
+ "warnings": {
82
+ "type": "array",
83
+ "items": {
84
+ "type": "string"
85
+ }
86
+ }
87
+ },
88
+ "required": ["warnings"],
89
+ "additionalProperties": false
90
+ },
91
+ "Snapshots": {
92
+ "description": "The snapshots of the project: the directory they are read from, and their data by name.",
93
+ "type": "object",
94
+ "properties": {
95
+ "dir": {
96
+ "type": "string"
97
+ },
98
+ "data": {
99
+ "type": "object"
100
+ }
101
+ },
102
+ "required": ["data"],
103
+ "additionalProperties": false
104
+ },
105
+ "Manifests": {
106
+ "description": "The manifests fact expressions name in manifest(\"<path>\"): the data of each that could be read, by the path as the expression writes it. Each is an object.",
107
+ "type": "object",
108
+ "additionalProperties": {
109
+ "type": "object"
110
+ }
111
+ }
112
+ }
113
+ }
@@ -0,0 +1,249 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "title": "docattest adapter protocol, version 1: what running, evaluating and reading a project answers",
4
+ "description": "Every value the protocol carries. Optional fields are omitted, never null, unless a type says null. Paths are relative to the project root, with / separators.",
5
+ "$defs": {
6
+ "Result": {
7
+ "type": "object",
8
+ "description": "The verdict on one example, or on one row of a cases table.",
9
+ "properties": {
10
+ "page": {
11
+ "type": "string"
12
+ },
13
+ "line": {
14
+ "type": "integer",
15
+ "minimum": 1
16
+ },
17
+ "kind": {
18
+ "enum": ["example", "fact", "cases", "snapshot", "test"]
19
+ },
20
+ "status": {
21
+ "enum": ["pass", "fail", "error", "skipped"]
22
+ },
23
+ "symbols": {
24
+ "description": "The core fills this in; an adapter may leave it empty or out.",
25
+ "type": "array",
26
+ "items": {
27
+ "type": "string"
28
+ }
29
+ },
30
+ "expected": {
31
+ "type": "string"
32
+ },
33
+ "actual": {
34
+ "type": "string"
35
+ },
36
+ "message": {
37
+ "type": "string"
38
+ }
39
+ },
40
+ "required": ["page", "line", "kind", "status", "message"],
41
+ "additionalProperties": false
42
+ },
43
+ "Diagnostic": {
44
+ "type": "object",
45
+ "description": "A reason an example does not compile.",
46
+ "properties": {
47
+ "id": {
48
+ "description": "The example's id.",
49
+ "type": "string"
50
+ },
51
+ "message": {
52
+ "type": "string"
53
+ },
54
+ "line": {
55
+ "description": "Line within the block; 1 when omitted.",
56
+ "type": "integer",
57
+ "minimum": 1
58
+ }
59
+ },
60
+ "required": ["id", "message"],
61
+ "additionalProperties": false
62
+ },
63
+ "Evaluation": {
64
+ "description": "The outcome of evaluating one fact expression.",
65
+ "anyOf": [
66
+ {
67
+ "type": "object",
68
+ "properties": {
69
+ "ok": {
70
+ "const": true
71
+ },
72
+ "value": {
73
+ "$ref": "#/$defs/Observation"
74
+ }
75
+ },
76
+ "required": ["ok", "value"],
77
+ "additionalProperties": false
78
+ },
79
+ {
80
+ "type": "object",
81
+ "properties": {
82
+ "ok": {
83
+ "const": false
84
+ },
85
+ "message": {
86
+ "type": "string"
87
+ }
88
+ },
89
+ "required": ["ok", "message"],
90
+ "additionalProperties": false
91
+ }
92
+ ]
93
+ },
94
+ "Observation": {
95
+ "type": "object",
96
+ "description": "A value as the runtime observed it: everything a comparison needs, as plain data.",
97
+ "properties": {
98
+ "text": {
99
+ "description": "The value as the language itself displays it to a reader: String(value) in JavaScript, str(value) in Python. A scalar on a page is compared with it, character for character.",
100
+ "type": "string"
101
+ },
102
+ "items": {
103
+ "description": "Each item displayed the same way, when the value is a list, a set or another iterable that is not text.",
104
+ "type": "array",
105
+ "items": {
106
+ "type": "string"
107
+ }
108
+ },
109
+ "description": {
110
+ "description": "A few words for messages, such as 'an object' or 'number 3'. Never parsed.",
111
+ "type": "string"
112
+ },
113
+ "kind": {
114
+ "description": "text when the value is a string of the language. Omitted otherwise.",
115
+ "enum": ["text"]
116
+ }
117
+ },
118
+ "required": ["text", "description"],
119
+ "additionalProperties": false
120
+ },
121
+ "Observable": {
122
+ "type": "object",
123
+ "description": "A value a surface offers, with the fact expression that reads it.",
124
+ "properties": {
125
+ "surface": {
126
+ "type": "string"
127
+ },
128
+ "expression": {
129
+ "description": "A fact expression that evaluates to value.",
130
+ "type": "string"
131
+ },
132
+ "path": {
133
+ "description": "Names on the way to the value.",
134
+ "type": "array",
135
+ "items": {
136
+ "type": "string"
137
+ }
138
+ },
139
+ "value": {
140
+ "$ref": "#/$defs/Observation"
141
+ }
142
+ },
143
+ "required": ["surface", "expression", "value"],
144
+ "additionalProperties": false
145
+ },
146
+ "SymbolRef": {
147
+ "type": "object",
148
+ "description": "A surface symbol an attestation exercises.",
149
+ "properties": {
150
+ "name": {
151
+ "type": "string"
152
+ },
153
+ "surface": {
154
+ "description": "Omitted when no surface exports the name.",
155
+ "type": "string"
156
+ }
157
+ },
158
+ "required": ["name"],
159
+ "additionalProperties": false
160
+ },
161
+ "TestListing": {
162
+ "description": "What a test file declares, or why it cannot be read.",
163
+ "anyOf": [
164
+ {
165
+ "type": "object",
166
+ "properties": {
167
+ "ok": {
168
+ "const": true
169
+ },
170
+ "tests": {
171
+ "type": "array",
172
+ "items": {
173
+ "$ref": "#/$defs/DeclaredTest"
174
+ }
175
+ },
176
+ "suites": {
177
+ "type": "array",
178
+ "items": {
179
+ "$ref": "#/$defs/DeclaredSuite"
180
+ }
181
+ }
182
+ },
183
+ "required": ["ok", "tests", "suites"],
184
+ "additionalProperties": false
185
+ },
186
+ {
187
+ "type": "object",
188
+ "properties": {
189
+ "ok": {
190
+ "const": false
191
+ },
192
+ "message": {
193
+ "type": "string"
194
+ }
195
+ },
196
+ "required": ["ok", "message"],
197
+ "additionalProperties": false
198
+ }
199
+ ]
200
+ },
201
+ "DeclaredTest": {
202
+ "type": "object",
203
+ "description": "A test a test file declares.",
204
+ "properties": {
205
+ "title": {
206
+ "type": "string"
207
+ },
208
+ "describes": {
209
+ "description": "Titles that enclose it, outermost first; null where one cannot be cited (it is not a literal).",
210
+ "type": "array",
211
+ "items": {
212
+ "type": ["string", "null"]
213
+ }
214
+ },
215
+ "line": {
216
+ "type": "integer",
217
+ "minimum": 1
218
+ }
219
+ },
220
+ "required": ["title", "describes", "line"],
221
+ "additionalProperties": false
222
+ },
223
+ "DeclaredSuite": {
224
+ "type": "object",
225
+ "description": "Something a test file declares that may be cited by mistake for a test.",
226
+ "properties": {
227
+ "title": {
228
+ "type": "string"
229
+ },
230
+ "describes": {
231
+ "type": "array",
232
+ "items": {
233
+ "type": ["string", "null"]
234
+ }
235
+ },
236
+ "line": {
237
+ "type": "integer",
238
+ "minimum": 1
239
+ },
240
+ "kind": {
241
+ "description": "What it is, in the language's words and with its article ('a describe block', 'a class'): the core says '\"x\" in <file> is <kind>, not a test'.",
242
+ "type": "string"
243
+ }
244
+ },
245
+ "required": ["title", "describes", "line", "kind"],
246
+ "additionalProperties": false
247
+ }
248
+ }
249
+ }
package/package.json CHANGED
@@ -1,6 +1,75 @@
1
1
  {
2
2
  "name": "docattest",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.1.0",
4
+ "description": "Documentation that CI can fail: pages carry their own proof, and code links back to the pages that describe it.",
5
+ "keywords": [
6
+ "documentation",
7
+ "docs",
8
+ "doctest",
9
+ "markdown",
10
+ "typescript",
11
+ "testing",
12
+ "ci",
13
+ "drift"
14
+ ],
15
+ "license": "MIT",
16
+ "author": "Matthew Hammond",
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "git+https://github.com/docattest/docattest.git",
20
+ "directory": "adapters/typescript"
21
+ },
22
+ "homepage": "https://github.com/docattest/docattest#readme",
23
+ "bugs": "https://github.com/docattest/docattest/issues",
24
+ "type": "module",
25
+ "exports": {
26
+ ".": {
27
+ "types": "./dist/index.d.ts",
28
+ "default": "./dist/index.js"
29
+ },
30
+ "./package.json": "./package.json"
31
+ },
32
+ "types": "./dist/index.d.ts",
33
+ "bin": {
34
+ "docattest": "./dist/launcher/main.js",
35
+ "docattest-adapter-typescript": "./dist/protocol/main.js"
36
+ },
37
+ "files": [
38
+ "dist",
39
+ "!dist/**/*.map",
40
+ "!dist/{core-binary,language,launcher,protocol}/**/*.d.{ts,cts}",
41
+ "README.md",
42
+ "LICENSE"
43
+ ],
44
+ "engines": {
45
+ "node": ">=22.12"
46
+ },
47
+ "scripts": {
48
+ "clean": "node --eval \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
49
+ "build": "npm run clean && tsc -p tsconfig.build.json && node ../../protocol/sync.ts dist && npm run chmod",
50
+ "chmod": "node --eval \"for (const f of ['dist/protocol/main.js', 'dist/launcher/main.js']) require('node:fs').chmodSync(f, 0o755)\"",
51
+ "typecheck": "tsc -p tsconfig.json && tsc -p test/tsconfig.json",
52
+ "test": "node ../../scripts/with-core.ts vitest run",
53
+ "prepublishOnly": "cd ../.. && node scripts/version.ts check && node scripts/release/check-published.ts && npm run typecheck && npm run lint && npm run format:check && npm run build && npm run build:core && npm test && npm run test:docs"
54
+ },
55
+ "optionalDependencies": {
56
+ "@docattest/core-darwin-arm64": "0.1.0",
57
+ "@docattest/core-darwin-x64": "0.1.0",
58
+ "@docattest/core-linux-arm64": "0.1.0",
59
+ "@docattest/core-linux-x64": "0.1.0",
60
+ "@docattest/core-windows-x64": "0.1.0"
61
+ },
62
+ "peerDependencies": {
63
+ "typescript": ">=5.4 <7"
64
+ },
65
+ "dependencies": {
66
+ "picomatch": "^4.0.7",
67
+ "yaml": "^2.9.1"
68
+ },
69
+ "devDependencies": {
70
+ "@types/node": "^22.20.5",
71
+ "@types/picomatch": "^4.0.3",
72
+ "typescript": "~5.9.3",
73
+ "vitest": "^3.2.4"
74
+ }
75
+ }