kibi-cli 2.38.0 → 2.40.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 (222) hide show
  1. package/dist/cli-json-command.d.ts.map +1 -1
  2. package/dist/cli-json-command.js +4 -0
  3. package/dist/cli-register-foundation.js +2 -2
  4. package/dist/cli-register-reporting.d.ts.map +1 -1
  5. package/dist/cli-register-reporting.js +1 -0
  6. package/dist/cli.d.ts.map +1 -1
  7. package/dist/cli.js +3 -0
  8. package/dist/commands/check.d.ts.map +1 -1
  9. package/dist/commands/check.js +33 -9
  10. package/dist/commands/coverage.d.ts +1 -0
  11. package/dist/commands/coverage.d.ts.map +1 -1
  12. package/dist/commands/coverage.js +40 -0
  13. package/dist/commands/doctor.d.ts +5 -0
  14. package/dist/commands/doctor.d.ts.map +1 -1
  15. package/dist/commands/doctor.js +29 -0
  16. package/dist/commands/init.d.ts.map +1 -1
  17. package/dist/commands/init.js +4 -0
  18. package/dist/commands/migrate-plan-record.d.ts +18 -0
  19. package/dist/commands/migrate-plan-record.d.ts.map +1 -0
  20. package/dist/commands/migrate-plan-record.js +112 -0
  21. package/dist/commands/migrate.d.ts +11 -2
  22. package/dist/commands/migrate.d.ts.map +1 -1
  23. package/dist/commands/migrate.js +60 -8
  24. package/dist/commands/prove.d.ts.map +1 -1
  25. package/dist/commands/prove.js +18 -3
  26. package/dist/commands/sync/manifest.d.ts.map +1 -1
  27. package/dist/commands/sync/manifest.js +17 -4
  28. package/dist/commands/sync/persistence.d.ts.map +1 -1
  29. package/dist/commands/sync/persistence.js +6 -0
  30. package/dist/commands/sync.d.ts.map +1 -1
  31. package/dist/commands/sync.js +8 -0
  32. package/dist/commands/telemetry.d.ts.map +1 -1
  33. package/dist/commands/telemetry.js +12 -2
  34. package/dist/extractors/markdown.d.ts +6 -0
  35. package/dist/extractors/markdown.d.ts.map +1 -1
  36. package/dist/extractors/markdown.js +21 -0
  37. package/dist/extractors/symbol-title-match.d.ts +31 -0
  38. package/dist/extractors/symbol-title-match.d.ts.map +1 -0
  39. package/dist/extractors/symbol-title-match.js +133 -0
  40. package/dist/extractors/symbols-coordinator.d.ts.map +1 -1
  41. package/dist/extractors/symbols-coordinator.js +81 -12
  42. package/dist/operations/bootstrap/discovery-evidence.d.ts.map +1 -1
  43. package/dist/operations/bootstrap/discovery-evidence.js +44 -2
  44. package/dist/operations/bootstrap/discovery.d.ts.map +1 -1
  45. package/dist/operations/bootstrap/discovery.js +1 -0
  46. package/dist/operations/bootstrap/guidance-actions.d.ts.map +1 -1
  47. package/dist/operations/bootstrap/guidance-actions.js +12 -1
  48. package/dist/operations/bootstrap/plugin-offers.d.ts +7 -1
  49. package/dist/operations/bootstrap/plugin-offers.d.ts.map +1 -1
  50. package/dist/operations/bootstrap/plugin-offers.js +73 -3
  51. package/dist/operations/modeling/logic-modeling.d.ts.map +1 -1
  52. package/dist/operations/modeling/logic-modeling.js +2 -1
  53. package/dist/operations/modeling/model-requirement.d.ts.map +1 -1
  54. package/dist/operations/modeling/model-requirement.js +2 -1
  55. package/dist/operations/mutation/symbol-refresh.d.ts +2 -0
  56. package/dist/operations/mutation/symbol-refresh.d.ts.map +1 -1
  57. package/dist/operations/mutation/symbol-refresh.js +6 -1
  58. package/dist/operations/mutation/upsert.d.ts.map +1 -1
  59. package/dist/operations/mutation/upsert.js +7 -0
  60. package/dist/operations/planning/compile-intent.d.ts.map +1 -1
  61. package/dist/operations/planning/compile-intent.js +2 -1
  62. package/dist/operations/proof/claim-bindings.d.ts +11 -0
  63. package/dist/operations/proof/claim-bindings.d.ts.map +1 -1
  64. package/dist/operations/proof/claim-bindings.js +144 -1
  65. package/dist/operations/proof/code-certificates.d.ts +10 -3
  66. package/dist/operations/proof/code-certificates.d.ts.map +1 -1
  67. package/dist/operations/proof/code-certificates.js +65 -13
  68. package/dist/operations/proof/code-languages.d.ts +104 -0
  69. package/dist/operations/proof/code-languages.d.ts.map +1 -0
  70. package/dist/operations/proof/code-languages.js +119 -0
  71. package/dist/operations/proof/code-models.d.ts +2 -0
  72. package/dist/operations/proof/code-models.d.ts.map +1 -1
  73. package/dist/operations/proof/code-models.js +11 -5
  74. package/dist/operations/proof/code-runner.d.ts +12 -9
  75. package/dist/operations/proof/code-runner.d.ts.map +1 -1
  76. package/dist/operations/proof/code-runner.js +81 -38
  77. package/dist/operations/proof/code-scope.d.ts +8 -0
  78. package/dist/operations/proof/code-scope.d.ts.map +1 -1
  79. package/dist/operations/proof/code-scope.js +30 -1
  80. package/dist/operations/proof/explain.d.ts +76 -0
  81. package/dist/operations/proof/explain.d.ts.map +1 -1
  82. package/dist/operations/proof/explain.js +228 -0
  83. package/dist/operations/proof/ingest-proof.d.ts +2 -0
  84. package/dist/operations/proof/ingest-proof.d.ts.map +1 -1
  85. package/dist/operations/proof/ingest-proof.js +1 -0
  86. package/dist/operations/proof/java-package-shadow.d.ts +14 -0
  87. package/dist/operations/proof/java-package-shadow.d.ts.map +1 -0
  88. package/dist/operations/proof/java-package-shadow.js +389 -0
  89. package/dist/operations/proof/prolog-evaluator.d.ts +14 -0
  90. package/dist/operations/proof/prolog-evaluator.d.ts.map +1 -0
  91. package/dist/operations/proof/prolog-evaluator.js +247 -0
  92. package/dist/operations/proof/prolog-source-reader.d.ts +20 -0
  93. package/dist/operations/proof/prolog-source-reader.d.ts.map +1 -0
  94. package/dist/operations/proof/prolog-source-reader.js +1123 -0
  95. package/dist/operations/proof/source-code-readers.d.ts +6 -0
  96. package/dist/operations/proof/source-code-readers.d.ts.map +1 -1
  97. package/dist/operations/proof/source-code-readers.js +879 -75
  98. package/dist/operations/semantic-advisor/analyze-prose.d.ts +9 -1
  99. package/dist/operations/semantic-advisor/analyze-prose.d.ts.map +1 -1
  100. package/dist/operations/semantic-advisor/analyze-prose.js +21 -0
  101. package/dist/operations/semantic-advisor/case-preview.d.ts +24 -0
  102. package/dist/operations/semantic-advisor/case-preview.d.ts.map +1 -0
  103. package/dist/operations/semantic-advisor/case-preview.js +216 -0
  104. package/dist/operations/semantic-advisor/shared.d.ts.map +1 -1
  105. package/dist/operations/semantic-advisor/shared.js +3 -0
  106. package/dist/operations/semantic-advisor/types.d.ts +23 -0
  107. package/dist/operations/semantic-advisor/types.d.ts.map +1 -1
  108. package/dist/plugins/approved-source-analyzers.generated.d.ts +15 -34
  109. package/dist/plugins/approved-source-analyzers.generated.d.ts.map +1 -1
  110. package/dist/plugins/approved-source-analyzers.generated.js +15 -34
  111. package/dist/plugins/plugin-install-check.d.ts +21 -0
  112. package/dist/plugins/plugin-install-check.d.ts.map +1 -0
  113. package/dist/plugins/plugin-install-check.js +62 -0
  114. package/dist/plugins/proof-reference-extractors.d.ts +20 -0
  115. package/dist/plugins/proof-reference-extractors.d.ts.map +1 -0
  116. package/dist/plugins/proof-reference-extractors.js +104 -0
  117. package/dist/plugins/reference-language-suggestion.d.ts +51 -0
  118. package/dist/plugins/reference-language-suggestion.d.ts.map +1 -0
  119. package/dist/plugins/reference-language-suggestion.js +277 -0
  120. package/dist/plugins/registry.d.ts.map +1 -1
  121. package/dist/plugins/registry.js +3 -1
  122. package/dist/plugins/source-analysis-service.d.ts.map +1 -1
  123. package/dist/plugins/source-analysis-service.js +4 -0
  124. package/dist/plugins/source-change-analysis.d.ts +26 -1
  125. package/dist/plugins/source-change-analysis.d.ts.map +1 -1
  126. package/dist/plugins/source-change-analysis.js +77 -5
  127. package/dist/plugins/source-classification.d.ts +2 -2
  128. package/dist/plugins/source-classification.d.ts.map +1 -1
  129. package/dist/plugins/source-classification.js +45 -1
  130. package/dist/public/operations/catalog.d.ts +62 -7
  131. package/dist/public/operations/catalog.d.ts.map +1 -1
  132. package/dist/public/operations/check-executor.d.ts.map +1 -1
  133. package/dist/public/operations/check-executor.js +3 -0
  134. package/dist/public/operations/evidence-floor.d.ts +8 -0
  135. package/dist/public/operations/evidence-floor.d.ts.map +1 -1
  136. package/dist/public/operations/evidence-floor.js +19 -1
  137. package/dist/public/operations/repair-plan.d.ts +46 -0
  138. package/dist/public/operations/repair-plan.d.ts.map +1 -1
  139. package/dist/public/operations/repair-plan.js +110 -1
  140. package/dist/public/operations/schema6-check-actions.js +1 -1
  141. package/dist/public/operations/specs/check-rules.generated.d.ts +1 -1
  142. package/dist/public/operations/specs/check-rules.generated.d.ts.map +1 -1
  143. package/dist/public/operations/specs/check-rules.generated.js +3 -1
  144. package/dist/public/operations/specs/check.d.ts +1 -1
  145. package/dist/public/operations/specs/mutation-schemas.d.ts +61 -6
  146. package/dist/public/operations/specs/mutation-schemas.d.ts.map +1 -1
  147. package/dist/public/operations/specs/mutation-schemas.js +30 -0
  148. package/dist/public/operations/specs/reporting.d.ts +8 -0
  149. package/dist/public/operations/specs/reporting.d.ts.map +1 -1
  150. package/dist/public/operations/specs/reporting.js +26 -3
  151. package/dist/public/operations/specs/semantic.d.ts.map +1 -1
  152. package/dist/public/operations/specs/semantic.js +2 -1
  153. package/dist/public/operations/specs/upsert.d.ts +61 -6
  154. package/dist/public/operations/specs/upsert.d.ts.map +1 -1
  155. package/dist/public/operations/symbol-coordinates-check.d.ts +11 -0
  156. package/dist/public/operations/symbol-coordinates-check.d.ts.map +1 -0
  157. package/dist/public/operations/symbol-coordinates-check.js +66 -0
  158. package/dist/public/proof-protocol.d.ts +31 -6
  159. package/dist/public/proof-protocol.d.ts.map +1 -1
  160. package/dist/public/proof-protocol.js +45 -15
  161. package/dist/public/proof-sources.d.ts +4 -2
  162. package/dist/public/proof-sources.d.ts.map +1 -1
  163. package/dist/public/proof-sources.js +43 -4
  164. package/dist/public/schemas/entity.d.ts.map +1 -1
  165. package/dist/public/schemas/entity.js +59 -0
  166. package/dist/public/skills/kibi-commit-review/SKILL.md +6 -2
  167. package/dist/public/skills/kibi-decisions/SKILL.md +7 -2
  168. package/dist/public/skills/kibi-decisions/resources/signoff-views.md +3 -1
  169. package/dist/public/skills/kibi-usage/SKILL.md +14 -3
  170. package/dist/public/skills/kibi-usage/resources/prolog-proofs.md +207 -0
  171. package/dist/public/skills/kibi-usage/resources/proof.md +44 -3
  172. package/dist/schemas/entity.schema.json +126 -6
  173. package/dist/search-answer.d.ts +3 -2
  174. package/dist/search-answer.d.ts.map +1 -1
  175. package/dist/search-answer.js +56 -3
  176. package/dist/traceability/analysis-gate.d.ts +3 -1
  177. package/dist/traceability/analysis-gate.d.ts.map +1 -1
  178. package/dist/traceability/analysis-gate.js +9 -1
  179. package/dist/traceability/impact-knowledge.d.ts.map +1 -1
  180. package/dist/traceability/impact-knowledge.js +2 -0
  181. package/dist/traceability/staged-file-coverage.d.ts.map +1 -1
  182. package/dist/traceability/staged-file-coverage.js +7 -2
  183. package/dist/traceability/symbol-extract.d.ts +17 -0
  184. package/dist/traceability/symbol-extract.d.ts.map +1 -1
  185. package/dist/traceability/symbol-extract.js +69 -15
  186. package/dist/traceability/temp-kb.d.ts.map +1 -1
  187. package/dist/traceability/temp-kb.js +11 -1
  188. package/dist/traceability/validate.d.ts.map +1 -1
  189. package/dist/traceability/validate.js +5 -7
  190. package/dist/types/entities.d.ts +12 -0
  191. package/dist/types/entities.d.ts.map +1 -1
  192. package/dist/usage-telemetry.d.ts +9 -0
  193. package/dist/usage-telemetry.d.ts.map +1 -1
  194. package/dist/usage-telemetry.js +50 -4
  195. package/dist/utils/first-sentence.d.ts +9 -0
  196. package/dist/utils/first-sentence.d.ts.map +1 -0
  197. package/dist/utils/first-sentence.js +52 -0
  198. package/dist/utils/rule-registry.generated.d.ts +11 -0
  199. package/dist/utils/rule-registry.generated.d.ts.map +1 -1
  200. package/dist/utils/rule-registry.generated.js +13 -0
  201. package/package.json +5 -5
  202. package/schema/entities.pl +12 -0
  203. package/src/public/operations/check-executor.ts +8 -0
  204. package/src/public/operations/evidence-floor.ts +29 -1
  205. package/src/public/operations/repair-plan.ts +152 -1
  206. package/src/public/operations/schema6-check-actions.ts +1 -1
  207. package/src/public/operations/specs/check-rules.generated.ts +3 -1
  208. package/src/public/operations/specs/mutation-schemas.ts +34 -0
  209. package/src/public/operations/specs/reporting.ts +38 -3
  210. package/src/public/operations/specs/semantic.ts +2 -1
  211. package/src/public/operations/symbol-coordinates-check.ts +79 -0
  212. package/src/public/proof-protocol-types.d.ts +22 -5
  213. package/src/public/proof-protocol.ts +78 -19
  214. package/src/public/proof-sources.ts +51 -3
  215. package/src/public/schemas/entity.ts +65 -0
  216. package/src/public/skills/kibi-commit-review/SKILL.md +6 -2
  217. package/src/public/skills/kibi-decisions/SKILL.md +7 -2
  218. package/src/public/skills/kibi-decisions/resources/signoff-views.md +3 -1
  219. package/src/public/skills/kibi-usage/SKILL.md +14 -3
  220. package/src/public/skills/kibi-usage/resources/prolog-proofs.md +207 -0
  221. package/src/public/skills/kibi-usage/resources/proof.md +44 -3
  222. package/src/schemas/entity.schema.json +126 -6
@@ -0,0 +1,207 @@
1
+ # SWI-Prolog Code Proofs
2
+
3
+ Kibi reads code models from SWI-Prolog files (`.pl`, `.plt`) with the
4
+ SWI-Prolog it runs on (KIBI_SWIPL, the bundled runtime, then `swipl` on
5
+ PATH). It loads the file a symbol names (a module, or a plain file into
6
+ `user`) and reads a predicate named by its indicator, the symbol's title
7
+ (`operator/2`, `lists:append/3`, `greeting//1`) or `export`.
8
+
9
+ - A domain (`exhaustive`, `domains`, `value_source` with `measure: count`)
10
+ is the distinct solutions of one argument. A one-argument predicate needs
11
+ nothing more; for more arguments set `arg` (1-based) to the one that names
12
+ each member: `domain_source: {symbol_id: SYM-operator, arg: 1}` lists every
13
+ `Name` of `operator(Name, Description)`. A solution that leaves that
14
+ argument unbound refuses the read.
15
+ - A value (`value_source`) is the single number a constant holds:
16
+ `hard_limit_seconds(10).` Zero or several solutions refuse the read.
17
+ - A `rule` predicate is called once per row of its argument domains; success
18
+ is true, failure false, an exception an error row (which rejects).
19
+ - A `state_machine` transition table is a `Name/2` (from, to) or `Name/3`
20
+ (from, event, to) fact table: every solution is an edge. With `domains:
21
+ {state, event}` a `Name/3` next-state predicate is called on every state
22
+ and event. `initial_source` names an `initial/1`-style fact.
23
+ - A `regex` reads an atom or string constant as a `type: string` pattern;
24
+ Kibi decides string facts on it. Patterns for `library(pcre)` are not read.
25
+
26
+ Loading a module runs its directives, the same trust a JavaScript import
27
+ gives. The proof file must name the predicate and load its file
28
+ (`use_module`, `ensure_loaded`, `consult`, a `:- [..]` load list, or
29
+ `library(X)` for a pack's `prolog/X.pl`), or be the plunit `.plt` file
30
+ beside it; otherwise Kibi treats the domain as hand-listed. `arg` on a
31
+ TypeScript, JavaScript or Python export is refused, and so is `field` on a
32
+ Prolog predicate.
33
+
34
+ ## Writing the certificate
35
+
36
+ A Prolog test writes the `kibi.code-certificate.v1` JSON into the directory
37
+ `kibi prove` sets in `KIBI_PROOF_CERTIFICATES`. Copy this module into the
38
+ project's test directory (for example `test/kibi_certificate.pl`) and call it
39
+ from the proof. Read members from the code with `findall/3` over the domain
40
+ predicate; never list them by hand.
41
+
42
+ ```prolog
43
+ :- module(kibi_certificate,
44
+ [ kibi_exhaustive_certificate/5, % +TestId, +SymbolId, +Members, :Check, -Certificate
45
+ kibi_rule_certificate/4, % +TestId, +Domains, +Predicates, -Certificate
46
+ kibi_machine_certificate/5, % +TestId, +SymbolId, +Edges, +Initial, -Certificate
47
+ kibi_pattern_certificate/4, % +TestId, +SymbolId, +Text, -Certificate
48
+ kibi_write_certificate/1 % +Certificate
49
+ ]).
50
+ :- use_module(library(http/json)).
51
+ :- use_module(library(apply)).
52
+ :- use_module(library(lists)).
53
+
54
+ :- meta_predicate
55
+ kibi_exhaustive_certificate(+, +, +, 1, -).
56
+
57
+ % Members as Kibi reads them: atoms and strings as text, numbers as written,
58
+ % other terms quoted.
59
+ kibi_text(Value, Text) :- string(Value), !, Text = Value.
60
+ kibi_text(Value, Text) :- atom(Value), !, atom_string(Value, Text).
61
+ kibi_text(Value, Text) :- number(Value), !, number_string(Value, Text).
62
+ kibi_text(Value, Text) :- format(string(Text), "~q", [Value]).
63
+
64
+ %! kibi_exhaustive_certificate(+TestId, +SymbolId, +Members, :Check, -Certificate)
65
+ %
66
+ % Run Check on every member of the domain and record each outcome. Read
67
+ % Members from the code (findall over the domain predicate), never list
68
+ % them by hand: Kibi re-reads the predicate and rejects a different set.
69
+ kibi_exhaustive_certificate(TestId, SymbolId, Members, Check, Certificate) :-
70
+ maplist(kibi_text, Members, Texts),
71
+ maplist(exhaustive_result(Check), Members, Texts, Results),
72
+ Certificate = _{version: "kibi.code-certificate.v1", kind: "exhaustive",
73
+ test_id: TestId,
74
+ domain: _{symbol_id: SymbolId, members: Texts},
75
+ results: Results}.
76
+
77
+ exhaustive_result(Check, Member, Text, Result) :-
78
+ catch(( call(Check, Member)
79
+ -> Result = _{member: Text, outcome: "passed"}
80
+ ; Result = _{member: Text, outcome: "failed", message: "the check failed"}
81
+ ),
82
+ Error,
83
+ ( message_to_text(Error, Message),
84
+ Result = _{member: Text, outcome: "failed", message: Message} )).
85
+
86
+ %! kibi_rule_certificate(+TestId, +Domains, +Predicates, -Certificate)
87
+ %
88
+ % Domains is a list of domain(Type, SymbolId, Members); Predicates a list
89
+ % of predicate(Name, SymbolId, ArgTypes, Goal), where Goal is called with
90
+ % one argument per type appended and decides the row by success or
91
+ % failure.
92
+ kibi_rule_certificate(TestId, Domains, Predicates, Certificate) :-
93
+ findall(Type-_{symbol_id: SymbolId, members: Texts},
94
+ ( member(domain(Type, SymbolId, Members), Domains), maplist(kibi_text, Members, Texts) ),
95
+ DomainPairs),
96
+ dict_pairs(DomainDict, _, DomainPairs),
97
+ findall(Name-_{symbol_id: SymbolId, arg_types: ArgTypes, rows: Rows},
98
+ ( member(predicate(Name, SymbolId, ArgTypes, Goal), Predicates),
99
+ maplist(domain_members(Domains), ArgTypes, Lists),
100
+ findall(Row, (maplist(member, Tuple, Lists), rule_row(Goal, Tuple, Row)), Rows)
101
+ ),
102
+ PredicatePairs),
103
+ dict_pairs(PredicateDict, _, PredicatePairs),
104
+ Certificate = _{version: "kibi.code-certificate.v1", kind: "rule",
105
+ test_id: TestId, domains: DomainDict, predicates: PredicateDict}.
106
+
107
+ domain_members(Domains, Type, Members) :-
108
+ memberchk(domain(Type, _, Members), Domains).
109
+
110
+ rule_row(Goal, Tuple, Row) :-
111
+ maplist(kibi_text, Tuple, Args),
112
+ Call =.. [call, Goal|Tuple],
113
+ catch(( once(Call) -> Row = _{args: Args, value: true} ; Row = _{args: Args, value: false} ),
114
+ Error,
115
+ ( message_to_text(Error, Message), Row = _{args: Args, error: Message} )).
116
+
117
+ %! kibi_machine_certificate(+TestId, +SymbolId, +Edges, +Initial, -Certificate)
118
+ %
119
+ % Edges is the list of From-To pairs of the transition table (findall over
120
+ % it); Initial is the list of initial states, or [] when the contract names
121
+ % no initial_source.
122
+ kibi_machine_certificate(TestId, SymbolId, Edges, Initial, Certificate) :-
123
+ findall([F, T], (member(From-To, Edges), kibi_text(From, F), kibi_text(To, T)), Pairs0),
124
+ sort(Pairs0, Pairs),
125
+ findall(S, (member([A, B], Pairs), member(S, [A, B])), Ends),
126
+ sort(Ends, States),
127
+ Machine0 = _{symbol_id: SymbolId, states: States, transitions: Pairs},
128
+ ( Initial == []
129
+ -> Machine = Machine0
130
+ ; maplist(kibi_text, Initial, InitialTexts0),
131
+ sort(InitialTexts0, InitialTexts),
132
+ Machine = Machine0.put(initial, InitialTexts)
133
+ ),
134
+ Certificate = _{version: "kibi.code-certificate.v1", kind: "state_machine",
135
+ test_id: TestId, machine: Machine}.
136
+
137
+ %! kibi_pattern_certificate(+TestId, +SymbolId, +Text, -Certificate)
138
+ %
139
+ % The string or atom constant a string claim is about.
140
+ kibi_pattern_certificate(TestId, SymbolId, Value, Certificate) :-
141
+ kibi_text(Value, Text),
142
+ Certificate = _{version: "kibi.code-certificate.v1", kind: "regex", test_id: TestId,
143
+ pattern: _{symbol_id: SymbolId, type: "string", value: Text}}.
144
+
145
+ %! kibi_write_certificate(+Certificate)
146
+ %
147
+ % Leave the certificate where kibi prove reads it (the directory in
148
+ % KIBI_PROOF_CERTIFICATES). Does nothing outside a kibi prove run.
149
+ kibi_write_certificate(Certificate) :-
150
+ ( getenv('KIBI_PROOF_CERTIFICATES', Directory), Directory \== ''
151
+ -> make_directory_path(Directory),
152
+ format(atom(Name), "~w.json", [Certificate.test_id]),
153
+ directory_file_path(Directory, Name, File),
154
+ setup_call_cleanup(open(File, write, Out, [encoding(utf8)]),
155
+ json_write_dict(Out, Certificate, [width(0)]),
156
+ close(Out))
157
+ ; true
158
+ ).
159
+
160
+ message_to_text(Error, Text) :-
161
+ catch(message_to_codes(Error, Text), _, fail), !.
162
+ message_to_text(Error, Text) :- format(string(Text), "~q", [Error]).
163
+
164
+ message_to_codes(Error, Text) :-
165
+ '$messages':translate_message(Error, Lines, []),
166
+ with_output_to(string(Raw), print_message_lines(current_output, '', Lines)),
167
+ split_string(Raw, "", "\n ", [Text]).
168
+ ```
169
+
170
+ A proof that the operators are exactly the claimed set:
171
+
172
+ ```prolog
173
+ :- use_module('../prolog/operators').
174
+ :- use_module(kibi_certificate).
175
+ :- initialization(main, main).
176
+
177
+ main :-
178
+ findall(Name, operator(Name, _), Names0),
179
+ list_to_set(Names0, Names),
180
+ kibi_exhaustive_certificate('TEST-operator-set', 'SYM-operator', Names,
181
+ [Name]>>operator(Name, _), Certificate),
182
+ kibi_write_certificate(Certificate).
183
+ ```
184
+
185
+ Its contract: `kind: exhaustive`, `domain_source: {symbol_id: SYM-operator,
186
+ arg: 1}`, `proves: [CLAIM-...]`. A rule proof passes
187
+ `[domain(status, 'SYM-status', Statuses)]` and
188
+ `[predicate(detected, 'SYM-detected', [status], detected)]`; its contract
189
+ names `predicate_source: {detected: {symbol_id: SYM-detected}}` and
190
+ `domains: {status: {symbol_id: SYM-status}}`.
191
+
192
+ ## Source proofs over Prolog code
193
+
194
+ A `source` proof needs no certificate: Kibi reads the Prolog files itself,
195
+ term by term, and never runs them. Use the `references` reader on `.pl` and
196
+ `.plt` files for what modules load (`extract: imports`, members as written:
197
+ `library(lists)`, `helpers`), call (`calls`, `Name/Arity` or
198
+ `Module:Name/Arity`), read from the environment (`env`, `getenv/2`), pass as
199
+ a first argument (`string_args` with `callee`) and throw (`thrown`: the error
200
+ of `error(type_error(...), _)` is `type_error`). Use the `prolog` reader for
201
+ facts: `{reader: prolog, file: pack.pl, functor: requires/1}` lists a pack's
202
+ requirements, and `arg` picks the argument of a fact with several. A goal or
203
+ closure held in a variable (`call(Goal)`, `maplist(G, L)`), a goal with a
204
+ variable module, a clause asserted from a variable and `:- if(...)` fail the
205
+ read with their place: name the predicate instead. The claim cannot be
206
+ decided for a file the read refuses; never drop a file the claim is about
207
+ from `files`.
@@ -262,11 +262,15 @@ left:
262
262
  each list item, such as the `run` of each workflow step), `glob` (`pattern`, `capture`),
263
263
  `openapi` (`file`, `select: operations|unsecured_operations|...`),
264
264
  `references` (`files`, `extract: env|imports|calls|string_args|thrown|
265
- property`), `schema` (`format: drizzle|prisma|sql`, `select:
265
+ property`; TypeScript, JavaScript, Python and SWI-Prolog files, and Go,
266
+ Java, C# and Rust files through `kibi-plugin-treesitter`), `schema` (`format: drizzle|prisma|sql`, `select:
266
267
  tables|columns|required_columns|nullable_columns|foreign_keys`), `routes`
267
268
  (Hono or Express app export, `path_prefix`, `names_from`, `select:
268
269
  routes|middleware`) or `validator` (zod, valibot or pydantic, `select:
269
- fields|required_fields|optional_fields`). A member Kibi cannot read
270
+ fields|required_fields|optional_fields`) or `prolog` (`file`, `functor:
271
+ requires/1`, `arg`: one argument of each fact, such as a pack's
272
+ requirements in `pack.pl`). Prolog files are read term by term and never
273
+ run; see `resources/prolog-proofs.md`. A member Kibi cannot read
270
274
  statically (a computed env name, a dynamic import, an env object handed
271
275
  to a variable) fails the read with its location, and so does an empty
272
276
  read (a glob matching no file, migrations with no `CREATE TABLE`), so a
@@ -288,6 +292,40 @@ left:
288
292
  The builders need kibi-cli 2.33.0 or newer in the project. The env
289
293
  extractor reads `process.env`, `import.meta.env`, `Bun.env`,
290
294
  `Deno.env.get`, `os.environ` and `os.getenv`, through casts.
295
+ - `references` over Go, Java, C# or Rust needs `kibi-plugin-treesitter` and
296
+ the language's grammar pack (`kibi-lang-go`, `kibi-lang-java`,
297
+ `kibi-lang-csharp`, `kibi-lang-rust`) in `devDependencies`, with the
298
+ plugin activated for proofs:
299
+ `"kibi.reference-extractor.v1": { "mode": "augment" }` in its
300
+ `kibi.plugins` entry (next to `"kibi.symbol-extractor.v2"`). A project
301
+ with no `package.json` creates one that only holds this list. Without it
302
+ the read is refused with what to install, so ask the operator before
303
+ installing; `kibi doctor` names what the project needs. Members are
304
+ written as the code names them (`os.Getenv`, `System.out.println`,
305
+ `Console.WriteLine`, `std::env::var`, Go import paths, `java.util.*`,
306
+ `std::io::Write`); a method on an expression Kibi cannot name is
307
+ `*.name`. Reflection, a name computed at run time, the whole
308
+ environment, C# `dynamic` and `#if`, Rust `#[cfg(...)]` items other than
309
+ `#[cfg(test)]`, and any macro for Rust `calls` and `thrown` fail the
310
+ read with their place: the claim cannot be decided for that file, so
311
+ model a claim the code can show (Rust `calls` over a file with
312
+ `println!` is always refused). Never drop a file the claim is about
313
+ from `files`: the read decides a claim only for the files it covers,
314
+ and a proof is rejected when a symbol the test covers or that
315
+ implements the claim's requirement lies outside them.
316
+ - Reference members match by name segments (`.`, `/`, `::`). `excludes`
317
+ fails on anything that is or may be an excluded item: `java.sql`
318
+ excludes `java.sql.Connection`, `github.com/labstack/echo/v4` excludes
319
+ `.../echo/v4/middleware`, a trailing `*` is a prefix (`java.sql.*`), a
320
+ wildcard import or a shorter name (`File.delete`) may be the item, and
321
+ `*.delete` (a call on a receiver Kibi cannot name) may be
322
+ `java.io.File.delete`, so the claim is refused naming it. `includes` and
323
+ `subset_of` count only members that certainly are an item (the item, a
324
+ member under `X.*`, or `a.b.m` for `*.m`); `eq` compares spellings.
325
+ - For a claim about what the code reads from the environment use
326
+ `extract: env`: `string_args` on a getter (`os.Getenv`, `env::var`,
327
+ `System.getenv`, `getenv/2`, ...) sees only that getter, so Kibi refuses
328
+ it for `eq`, `subset_of` and `excludes`.
291
329
 
292
330
  `arithmetic` and `smt` from `constraint_source` alone prove that the
293
331
  knowledge base's facts entail the claim, not that code follows the facts:
@@ -318,7 +356,10 @@ read for a test that wants to assert on it), fail the test when it records a fai
318
356
  (`failedMembers`, `failedCalls`), and call `writeCodeCertificate`; it writes to the
319
357
  directory `kibi prove` sets in `KIBI_PROOF_CERTIFICATES` and does nothing
320
358
  elsewhere. A Python test writes the same `kibi.code-certificate.v1` JSON
321
- to that directory itself. Wire the KB: the proof file symbol is
359
+ to that directory itself. Kibi also reads SWI-Prolog domains, constants,
360
+ rule predicates, transition tables and string constants (`arg` picks a
361
+ predicate's argument); `resources/prolog-proofs.md` has the rules and a
362
+ certificate module to copy. Wire the KB: the proof file symbol is
322
363
  `executable_for` the test and named in `required_proofs`; the domain symbol
323
364
  (and every symbol a rule, machine or pattern contract names) `implements`
324
365
  the requirement and is `covered_by` the test; the test
@@ -562,6 +562,18 @@
562
562
  "minLength": 1,
563
563
  "description": "Requirement-only. Optional reference to the approval decision record (ticket, ADR or review link) for an exception requirement."
564
564
  },
565
+ "failure_side_waiver": {
566
+ "type": "string",
567
+ "minLength": 1,
568
+ "pattern": "\\S",
569
+ "description": "Requirement-only. Why the requirement has no failure side to test: its claims state a capability or an output shape, so there is no input or attempt for Kibi to refuse. Waives the happy_path_only gap once failure_side_waiver_approved_by is set."
570
+ },
571
+ "failure_side_waiver_approved_by": {
572
+ "type": "string",
573
+ "minLength": 1,
574
+ "pattern": "\\S",
575
+ "description": "Requirement-only. The person who accepted failure_side_waiver. Without it the waiver is reported as awaiting approval and the gap stays open."
576
+ },
565
577
  "rationale": {
566
578
  "type": "string",
567
579
  "minLength": 1,
@@ -684,6 +696,32 @@
684
696
  },
685
697
  "reason": {
686
698
  "type": "string"
699
+ },
700
+ "dimension": {
701
+ "type": "object",
702
+ "required": [
703
+ "quantifier",
704
+ "rewrites"
705
+ ],
706
+ "properties": {
707
+ "quantifier": {
708
+ "type": "string",
709
+ "minLength": 1
710
+ },
711
+ "rewrites": {
712
+ "type": "array",
713
+ "items": {
714
+ "type": "string",
715
+ "enum": [
716
+ "bound",
717
+ "rule",
718
+ "count",
719
+ "set"
720
+ ]
721
+ }
722
+ }
723
+ },
724
+ "additionalProperties": false
687
725
  }
688
726
  },
689
727
  "additionalProperties": false
@@ -795,7 +833,7 @@
795
833
  },
796
834
  "source": {
797
835
  "type": "object",
798
- "description": "source: the project source a source proof reads. A project source Kibi reads by itself. reader json or yaml: {file, path?, select?: keys|values|items}. glob: {pattern, capture?, ignore?} (capture true reads what each * matched). openapi: {file, select?: operations|unsecured_operations|security_schemes|responses}. references: {files, extract: env|imports|calls|string_args|thrown|property, callee?, key?, ignore?}. schema: {format: drizzle|prisma|sql, file (drizzle, prisma) or files (sql migrations), exports?, table?, select?: tables|columns|required_columns|nullable_columns|foreign_keys}. routes: {file, export, framework?: hono|express, path_prefix?, names_from?, select?: routes|middleware}. validator: {file, export, select?: fields|required_fields|optional_fields}. Paths are repository-relative. A member Kibi cannot read statically fails the read with its location.",
836
+ "description": "source: the project source a source proof reads. A project source Kibi reads by itself. reader json or yaml: {file, path?, select?: keys|values|items}. glob: {pattern, capture?, ignore?} (capture true reads what each * matched). openapi: {file, select?: operations|unsecured_operations|security_schemes|responses}. references: {files, extract: env|imports|calls|string_args|thrown|property, callee?, key?, ignore?} over TypeScript, JavaScript, Python and SWI-Prolog files. schema: {format: drizzle|prisma|sql, file (drizzle, prisma) or files (sql migrations), exports?, table?, select?: tables|columns|required_columns|nullable_columns|foreign_keys}. routes: {file, export, framework?: hono|express, path_prefix?, names_from?, select?: routes|middleware}. validator: {file, export, select?: fields|required_fields|optional_fields}. prolog: {file, functor: Name/Arity, arg?} reads one argument of every fact with that functor in a SWI-Prolog file (requires/1 in pack.pl), without running it. Paths are repository-relative. A member Kibi cannot read statically fails the read with its location.",
799
837
  "required": [
800
838
  "reader"
801
839
  ],
@@ -810,7 +848,8 @@
810
848
  "references",
811
849
  "schema",
812
850
  "routes",
813
- "validator"
851
+ "validator",
852
+ "prolog"
814
853
  ]
815
854
  }
816
855
  },
@@ -836,6 +875,11 @@
836
875
  "type": "string",
837
876
  "minLength": 1,
838
877
  "description": "exhaustive: when the export is a list of records, the field of each record that names a domain member (a catalog's name)."
878
+ },
879
+ "arg": {
880
+ "type": "integer",
881
+ "minimum": 1,
882
+ "description": "A SWI-Prolog predicate's argument (1-based) whose solutions Kibi reads, when the predicate takes more than one argument (operator/2 with arg 1 lists each operator's name)."
839
883
  }
840
884
  },
841
885
  "additionalProperties": false
@@ -879,9 +923,14 @@
879
923
  "type": "string",
880
924
  "minLength": 1
881
925
  },
926
+ "arg": {
927
+ "type": "integer",
928
+ "minimum": 1,
929
+ "description": "A SWI-Prolog predicate's argument (1-based) whose solutions Kibi reads, when the predicate takes more than one argument (operator/2 with arg 1 lists each operator's name)."
930
+ },
882
931
  "source": {
883
932
  "type": "object",
884
- "description": "A project source Kibi reads by itself. reader json or yaml: {file, path?, select?: keys|values|items}. glob: {pattern, capture?, ignore?} (capture true reads what each * matched). openapi: {file, select?: operations|unsecured_operations|security_schemes|responses}. references: {files, extract: env|imports|calls|string_args|thrown|property, callee?, key?, ignore?}. schema: {format: drizzle|prisma|sql, file (drizzle, prisma) or files (sql migrations), exports?, table?, select?: tables|columns|required_columns|nullable_columns|foreign_keys}. routes: {file, export, framework?: hono|express, path_prefix?, names_from?, select?: routes|middleware}. validator: {file, export, select?: fields|required_fields|optional_fields}. Paths are repository-relative. A member Kibi cannot read statically fails the read with its location.",
933
+ "description": "A project source Kibi reads by itself. reader json or yaml: {file, path?, select?: keys|values|items}. glob: {pattern, capture?, ignore?} (capture true reads what each * matched). openapi: {file, select?: operations|unsecured_operations|security_schemes|responses}. references: {files, extract: env|imports|calls|string_args|thrown|property, callee?, key?, ignore?} over TypeScript, JavaScript, Python and SWI-Prolog files. schema: {format: drizzle|prisma|sql, file (drizzle, prisma) or files (sql migrations), exports?, table?, select?: tables|columns|required_columns|nullable_columns|foreign_keys}. routes: {file, export, framework?: hono|express, path_prefix?, names_from?, select?: routes|middleware}. validator: {file, export, select?: fields|required_fields|optional_fields}. prolog: {file, functor: Name/Arity, arg?} reads one argument of every fact with that functor in a SWI-Prolog file (requires/1 in pack.pl), without running it. Paths are repository-relative. A member Kibi cannot read statically fails the read with its location.",
885
934
  "required": [
886
935
  "reader"
887
936
  ],
@@ -896,7 +945,8 @@
896
945
  "references",
897
946
  "schema",
898
947
  "routes",
899
- "validator"
948
+ "validator",
949
+ "prolog"
900
950
  ]
901
951
  }
902
952
  },
@@ -965,6 +1015,11 @@
965
1015
  "export": {
966
1016
  "type": "string",
967
1017
  "minLength": 1
1018
+ },
1019
+ "arg": {
1020
+ "type": "integer",
1021
+ "minimum": 1,
1022
+ "description": "A SWI-Prolog predicate's argument (1-based) whose solutions Kibi reads, when the predicate takes more than one argument (operator/2 with arg 1 lists each operator's name)."
968
1023
  }
969
1024
  },
970
1025
  "additionalProperties": false
@@ -977,7 +1032,7 @@
977
1032
  "properties": {
978
1033
  "source": {
979
1034
  "type": "object",
980
- "description": "A project source Kibi reads by itself. reader json or yaml: {file, path?, select?: keys|values|items}. glob: {pattern, capture?, ignore?} (capture true reads what each * matched). openapi: {file, select?: operations|unsecured_operations|security_schemes|responses}. references: {files, extract: env|imports|calls|string_args|thrown|property, callee?, key?, ignore?}. schema: {format: drizzle|prisma|sql, file (drizzle, prisma) or files (sql migrations), exports?, table?, select?: tables|columns|required_columns|nullable_columns|foreign_keys}. routes: {file, export, framework?: hono|express, path_prefix?, names_from?, select?: routes|middleware}. validator: {file, export, select?: fields|required_fields|optional_fields}. Paths are repository-relative. A member Kibi cannot read statically fails the read with its location.",
1035
+ "description": "A project source Kibi reads by itself. reader json or yaml: {file, path?, select?: keys|values|items}. glob: {pattern, capture?, ignore?} (capture true reads what each * matched). openapi: {file, select?: operations|unsecured_operations|security_schemes|responses}. references: {files, extract: env|imports|calls|string_args|thrown|property, callee?, key?, ignore?} over TypeScript, JavaScript, Python and SWI-Prolog files. schema: {format: drizzle|prisma|sql, file (drizzle, prisma) or files (sql migrations), exports?, table?, select?: tables|columns|required_columns|nullable_columns|foreign_keys}. routes: {file, export, framework?: hono|express, path_prefix?, names_from?, select?: routes|middleware}. validator: {file, export, select?: fields|required_fields|optional_fields}. prolog: {file, functor: Name/Arity, arg?} reads one argument of every fact with that functor in a SWI-Prolog file (requires/1 in pack.pl), without running it. Paths are repository-relative. A member Kibi cannot read statically fails the read with its location.",
981
1036
  "required": [
982
1037
  "reader"
983
1038
  ],
@@ -992,7 +1047,8 @@
992
1047
  "references",
993
1048
  "schema",
994
1049
  "routes",
995
- "validator"
1050
+ "validator",
1051
+ "prolog"
996
1052
  ]
997
1053
  }
998
1054
  },
@@ -1017,6 +1073,11 @@
1017
1073
  "export": {
1018
1074
  "type": "string",
1019
1075
  "minLength": 1
1076
+ },
1077
+ "arg": {
1078
+ "type": "integer",
1079
+ "minimum": 1,
1080
+ "description": "A SWI-Prolog predicate's argument (1-based) whose solutions Kibi reads, when the predicate takes more than one argument (operator/2 with arg 1 lists each operator's name)."
1020
1081
  }
1021
1082
  },
1022
1083
  "additionalProperties": false,
@@ -1035,6 +1096,11 @@
1035
1096
  "export": {
1036
1097
  "type": "string",
1037
1098
  "minLength": 1
1099
+ },
1100
+ "arg": {
1101
+ "type": "integer",
1102
+ "minimum": 1,
1103
+ "description": "A SWI-Prolog predicate's argument (1-based) whose solutions Kibi reads, when the predicate takes more than one argument (operator/2 with arg 1 lists each operator's name)."
1038
1104
  }
1039
1105
  },
1040
1106
  "additionalProperties": false,
@@ -1602,6 +1668,30 @@
1602
1668
  "claim_text": {
1603
1669
  "type": "string"
1604
1670
  },
1671
+ "dimension_waiver": {
1672
+ "type": "string",
1673
+ "minLength": 1,
1674
+ "pattern": "\\S",
1675
+ "description": "Fact-only. Why the quantifier word in claim_text (each, every, all, or a cardinality bound) ranges over nothing, so the claim needs no count, set or rule. Waives dimension_unrepresented for the claim once dimension_waiver_approved_by is set."
1676
+ },
1677
+ "dimension_waiver_approved_by": {
1678
+ "type": "string",
1679
+ "minLength": 1,
1680
+ "pattern": "\\S",
1681
+ "description": "Fact-only. The person who accepted dimension_waiver. Without it the waiver is reported as awaiting approval and the gap stays open."
1682
+ },
1683
+ "case_waiver": {
1684
+ "type": "string",
1685
+ "minLength": 1,
1686
+ "pattern": "\\S",
1687
+ "description": "Fact-only. Why the edge cases Kibi derives from this fact (the value past a bound, a value outside a set) are covered some other way or cannot occur. Waives uncovered_case for the fact once case_waiver_approved_by is set."
1688
+ },
1689
+ "case_waiver_approved_by": {
1690
+ "type": "string",
1691
+ "minLength": 1,
1692
+ "pattern": "\\S",
1693
+ "description": "Fact-only. The person who accepted case_waiver. Without it the waiver is reported as awaiting approval and the gap stays open."
1694
+ },
1605
1695
  "predicate_name": {
1606
1696
  "type": "string"
1607
1697
  },
@@ -1839,6 +1929,26 @@
1839
1929
  "claim_text"
1840
1930
  ]
1841
1931
  },
1932
+ {
1933
+ "required": [
1934
+ "dimension_waiver"
1935
+ ]
1936
+ },
1937
+ {
1938
+ "required": [
1939
+ "dimension_waiver_approved_by"
1940
+ ]
1941
+ },
1942
+ {
1943
+ "required": [
1944
+ "case_waiver"
1945
+ ]
1946
+ },
1947
+ {
1948
+ "required": [
1949
+ "case_waiver_approved_by"
1950
+ ]
1951
+ },
1842
1952
  {
1843
1953
  "required": [
1844
1954
  "predicate_name"
@@ -2051,6 +2161,16 @@
2051
2161
  "approval_ref"
2052
2162
  ]
2053
2163
  },
2164
+ {
2165
+ "required": [
2166
+ "failure_side_waiver"
2167
+ ]
2168
+ },
2169
+ {
2170
+ "required": [
2171
+ "failure_side_waiver_approved_by"
2172
+ ]
2173
+ },
2054
2174
  {
2055
2175
  "required": [
2056
2176
  "rationale"