fact-kit-facts 0.1.0 → 0.2.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/dist/go/index.json +423 -0
- package/dist/index.json +2302 -182
- package/dist/py/index.json +423 -0
- package/dist/rs/index.json +423 -0
- package/dist/swift/index.json +421 -0
- package/package.json +15 -3
|
@@ -0,0 +1,423 @@
|
|
|
1
|
+
{
|
|
2
|
+
"indexFormat": "1.1",
|
|
3
|
+
"package": "fact-kit-facts",
|
|
4
|
+
"entry": "go",
|
|
5
|
+
"component": "@component/go",
|
|
6
|
+
"describes": {},
|
|
7
|
+
"facts": [
|
|
8
|
+
{
|
|
9
|
+
"id": "fact-kit-go.package",
|
|
10
|
+
"tool": "fact-kit-go",
|
|
11
|
+
"topics": [
|
|
12
|
+
"install"
|
|
13
|
+
],
|
|
14
|
+
"title": {
|
|
15
|
+
"en": "Where the Go reader is published"
|
|
16
|
+
},
|
|
17
|
+
"description": {
|
|
18
|
+
"en": "The registry, the package name, the name code imports, the tag prefix and the toolchain."
|
|
19
|
+
},
|
|
20
|
+
"content": {
|
|
21
|
+
"value": {
|
|
22
|
+
"registry": "go module proxy",
|
|
23
|
+
"name": "github.com/carlos-space/fact-kit/go",
|
|
24
|
+
"import": "factkit",
|
|
25
|
+
"tagPrefix": "go/v",
|
|
26
|
+
"requires": "go>=1.26"
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
"variants": [
|
|
30
|
+
{
|
|
31
|
+
"since": "next",
|
|
32
|
+
"pending": "readers",
|
|
33
|
+
"content": {
|
|
34
|
+
"value": {
|
|
35
|
+
"registry": "go module proxy",
|
|
36
|
+
"name": "github.com/carlos-space/fact-kit/go",
|
|
37
|
+
"import": "factkit",
|
|
38
|
+
"tagPrefix": "go/v",
|
|
39
|
+
"requires": "go>=1.26"
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
],
|
|
44
|
+
"source": {
|
|
45
|
+
"kind": "published"
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"id": "fact-kit-go.read-facts",
|
|
50
|
+
"tool": "fact-kit-go",
|
|
51
|
+
"topics": [
|
|
52
|
+
"read"
|
|
53
|
+
],
|
|
54
|
+
"title": {
|
|
55
|
+
"en": "ReadFacts parameters and return value"
|
|
56
|
+
},
|
|
57
|
+
"description": {
|
|
58
|
+
"en": "Each parameter and member names the one of the JS `readFacts` it stands for. `options.onRead` and the check of `describes` against an installed component are JS only."
|
|
59
|
+
},
|
|
60
|
+
"content": {
|
|
61
|
+
"value": {
|
|
62
|
+
"name": "ReadFacts",
|
|
63
|
+
"signature": "ReadFacts(spec string, opts ReadFactsOptions) (*FactReader, error)",
|
|
64
|
+
"parameters": [
|
|
65
|
+
{
|
|
66
|
+
"name": "spec",
|
|
67
|
+
"js": "spec",
|
|
68
|
+
"type": "string",
|
|
69
|
+
"required": true
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "opts.Root",
|
|
73
|
+
"js": "options.root",
|
|
74
|
+
"type": "string",
|
|
75
|
+
"required": false,
|
|
76
|
+
"default": "the current working directory"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "opts.Version",
|
|
80
|
+
"js": "options.version",
|
|
81
|
+
"type": "*string",
|
|
82
|
+
"required": false,
|
|
83
|
+
"default": "nil"
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"name": "opts.Include",
|
|
87
|
+
"js": "options.include",
|
|
88
|
+
"type": "[]string",
|
|
89
|
+
"required": false,
|
|
90
|
+
"default": "nil"
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"name": "opts.Platform",
|
|
94
|
+
"js": "options.platform",
|
|
95
|
+
"type": "string",
|
|
96
|
+
"required": false,
|
|
97
|
+
"default": "\"\""
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": "opts.OS",
|
|
101
|
+
"js": "options.os",
|
|
102
|
+
"type": "string",
|
|
103
|
+
"required": false,
|
|
104
|
+
"default": "\"\""
|
|
105
|
+
}
|
|
106
|
+
],
|
|
107
|
+
"returns": {
|
|
108
|
+
"type": "*FactReader",
|
|
109
|
+
"members": [
|
|
110
|
+
{
|
|
111
|
+
"name": "Package",
|
|
112
|
+
"js": "package"
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"name": "Version",
|
|
116
|
+
"js": "version"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"name": "Entry",
|
|
120
|
+
"js": "entry"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"name": "Describes",
|
|
124
|
+
"js": "describes"
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"name": "Facts",
|
|
128
|
+
"js": "facts"
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"name": "Has",
|
|
132
|
+
"js": "has"
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"name": "Get",
|
|
136
|
+
"js": "get"
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "Value",
|
|
140
|
+
"js": "value"
|
|
141
|
+
}
|
|
142
|
+
]
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
},
|
|
146
|
+
"variants": [
|
|
147
|
+
{
|
|
148
|
+
"since": "next",
|
|
149
|
+
"pending": "readers",
|
|
150
|
+
"content": {
|
|
151
|
+
"value": {
|
|
152
|
+
"name": "ReadFacts",
|
|
153
|
+
"signature": "ReadFacts(spec string, opts ReadFactsOptions) (*FactReader, error)",
|
|
154
|
+
"parameters": [
|
|
155
|
+
{
|
|
156
|
+
"name": "spec",
|
|
157
|
+
"js": "spec",
|
|
158
|
+
"type": "string",
|
|
159
|
+
"required": true
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
"name": "opts.Root",
|
|
163
|
+
"js": "options.root",
|
|
164
|
+
"type": "string",
|
|
165
|
+
"required": false,
|
|
166
|
+
"default": "the current working directory"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"name": "opts.Version",
|
|
170
|
+
"js": "options.version",
|
|
171
|
+
"type": "*string",
|
|
172
|
+
"required": false,
|
|
173
|
+
"default": "nil"
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"name": "opts.Include",
|
|
177
|
+
"js": "options.include",
|
|
178
|
+
"type": "[]string",
|
|
179
|
+
"required": false,
|
|
180
|
+
"default": "nil"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"name": "opts.Platform",
|
|
184
|
+
"js": "options.platform",
|
|
185
|
+
"type": "string",
|
|
186
|
+
"required": false,
|
|
187
|
+
"default": "\"\""
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"name": "opts.OS",
|
|
191
|
+
"js": "options.os",
|
|
192
|
+
"type": "string",
|
|
193
|
+
"required": false,
|
|
194
|
+
"default": "\"\""
|
|
195
|
+
}
|
|
196
|
+
],
|
|
197
|
+
"returns": {
|
|
198
|
+
"type": "*FactReader",
|
|
199
|
+
"members": [
|
|
200
|
+
{
|
|
201
|
+
"name": "Package",
|
|
202
|
+
"js": "package"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "Version",
|
|
206
|
+
"js": "version"
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"name": "Entry",
|
|
210
|
+
"js": "entry"
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"name": "Describes",
|
|
214
|
+
"js": "describes"
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"name": "Facts",
|
|
218
|
+
"js": "facts"
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"name": "Has",
|
|
222
|
+
"js": "has"
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"name": "Get",
|
|
226
|
+
"js": "get"
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"name": "Value",
|
|
230
|
+
"js": "value"
|
|
231
|
+
}
|
|
232
|
+
]
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
],
|
|
238
|
+
"source": {
|
|
239
|
+
"kind": "published"
|
|
240
|
+
}
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"id": "fact-kit-go.select-facts",
|
|
244
|
+
"tool": "fact-kit-go",
|
|
245
|
+
"topics": [
|
|
246
|
+
"read",
|
|
247
|
+
"select"
|
|
248
|
+
],
|
|
249
|
+
"title": {
|
|
250
|
+
"en": "SelectFacts parameters"
|
|
251
|
+
},
|
|
252
|
+
"description": {
|
|
253
|
+
"en": "Chooses the rows of a parsed index for one reader, with the rules of `conformance/`."
|
|
254
|
+
},
|
|
255
|
+
"content": {
|
|
256
|
+
"value": {
|
|
257
|
+
"name": "SelectFacts",
|
|
258
|
+
"signature": "SelectFacts(index []byte, opts SelectOptions) ([]SelectedFact, error)",
|
|
259
|
+
"parameters": [
|
|
260
|
+
{
|
|
261
|
+
"name": "index",
|
|
262
|
+
"js": "index",
|
|
263
|
+
"type": "[]byte",
|
|
264
|
+
"required": true
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"name": "opts.Version",
|
|
268
|
+
"js": "options.version",
|
|
269
|
+
"type": "*string",
|
|
270
|
+
"required": false,
|
|
271
|
+
"default": "nil"
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"name": "opts.Include",
|
|
275
|
+
"js": "options.include",
|
|
276
|
+
"type": "[]string",
|
|
277
|
+
"required": false,
|
|
278
|
+
"default": "nil"
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"name": "opts.Platform",
|
|
282
|
+
"js": "options.platform",
|
|
283
|
+
"type": "string",
|
|
284
|
+
"required": false,
|
|
285
|
+
"default": "\"\""
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"name": "opts.OS",
|
|
289
|
+
"js": "options.os",
|
|
290
|
+
"type": "string",
|
|
291
|
+
"required": false,
|
|
292
|
+
"default": "\"\""
|
|
293
|
+
}
|
|
294
|
+
],
|
|
295
|
+
"returns": "([]SelectedFact, error)"
|
|
296
|
+
}
|
|
297
|
+
},
|
|
298
|
+
"variants": [
|
|
299
|
+
{
|
|
300
|
+
"since": "next",
|
|
301
|
+
"pending": "readers",
|
|
302
|
+
"content": {
|
|
303
|
+
"value": {
|
|
304
|
+
"name": "SelectFacts",
|
|
305
|
+
"signature": "SelectFacts(index []byte, opts SelectOptions) ([]SelectedFact, error)",
|
|
306
|
+
"parameters": [
|
|
307
|
+
{
|
|
308
|
+
"name": "index",
|
|
309
|
+
"js": "index",
|
|
310
|
+
"type": "[]byte",
|
|
311
|
+
"required": true
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
"name": "opts.Version",
|
|
315
|
+
"js": "options.version",
|
|
316
|
+
"type": "*string",
|
|
317
|
+
"required": false,
|
|
318
|
+
"default": "nil"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"name": "opts.Include",
|
|
322
|
+
"js": "options.include",
|
|
323
|
+
"type": "[]string",
|
|
324
|
+
"required": false,
|
|
325
|
+
"default": "nil"
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"name": "opts.Platform",
|
|
329
|
+
"js": "options.platform",
|
|
330
|
+
"type": "string",
|
|
331
|
+
"required": false,
|
|
332
|
+
"default": "\"\""
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"name": "opts.OS",
|
|
336
|
+
"js": "options.os",
|
|
337
|
+
"type": "string",
|
|
338
|
+
"required": false,
|
|
339
|
+
"default": "\"\""
|
|
340
|
+
}
|
|
341
|
+
],
|
|
342
|
+
"returns": "([]SelectedFact, error)"
|
|
343
|
+
}
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
],
|
|
347
|
+
"source": {
|
|
348
|
+
"kind": "published"
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"id": "fact-kit-go.read-errors",
|
|
353
|
+
"tool": "fact-kit-go",
|
|
354
|
+
"topics": [
|
|
355
|
+
"read",
|
|
356
|
+
"errors"
|
|
357
|
+
],
|
|
358
|
+
"title": {
|
|
359
|
+
"en": "Error codes of the Go reader"
|
|
360
|
+
},
|
|
361
|
+
"description": {
|
|
362
|
+
"en": "The stable code of each error. The message is for people and can change."
|
|
363
|
+
},
|
|
364
|
+
"content": {
|
|
365
|
+
"value": {
|
|
366
|
+
"type": "*FactReadError",
|
|
367
|
+
"code": "errors.As(err, &e); e.Code",
|
|
368
|
+
"codes": [
|
|
369
|
+
{
|
|
370
|
+
"code": "not-an-index",
|
|
371
|
+
"variant": "CodeNotAnIndex"
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"code": "unsupported-index-format",
|
|
375
|
+
"variant": "CodeUnsupportedIndexFormat"
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"code": "not-found",
|
|
379
|
+
"variant": "CodeNotFound"
|
|
380
|
+
},
|
|
381
|
+
{
|
|
382
|
+
"code": "invalid-version",
|
|
383
|
+
"variant": "CodeInvalidVersion"
|
|
384
|
+
}
|
|
385
|
+
]
|
|
386
|
+
}
|
|
387
|
+
},
|
|
388
|
+
"variants": [
|
|
389
|
+
{
|
|
390
|
+
"since": "next",
|
|
391
|
+
"pending": "readers",
|
|
392
|
+
"content": {
|
|
393
|
+
"value": {
|
|
394
|
+
"type": "*FactReadError",
|
|
395
|
+
"code": "errors.As(err, &e); e.Code",
|
|
396
|
+
"codes": [
|
|
397
|
+
{
|
|
398
|
+
"code": "not-an-index",
|
|
399
|
+
"variant": "CodeNotAnIndex"
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"code": "unsupported-index-format",
|
|
403
|
+
"variant": "CodeUnsupportedIndexFormat"
|
|
404
|
+
},
|
|
405
|
+
{
|
|
406
|
+
"code": "not-found",
|
|
407
|
+
"variant": "CodeNotFound"
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"code": "invalid-version",
|
|
411
|
+
"variant": "CodeInvalidVersion"
|
|
412
|
+
}
|
|
413
|
+
]
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
],
|
|
418
|
+
"source": {
|
|
419
|
+
"kind": "published"
|
|
420
|
+
}
|
|
421
|
+
}
|
|
422
|
+
]
|
|
423
|
+
}
|