sourcey 3.5.10 → 3.6.1
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/README.md +24 -97
- package/dist/adapters/index.d.ts +12 -0
- package/dist/adapters/index.d.ts.map +1 -0
- package/dist/adapters/index.js +130 -0
- package/dist/adapters/mkdocs.d.ts +5 -0
- package/dist/adapters/mkdocs.d.ts.map +1 -0
- package/dist/adapters/mkdocs.js +367 -0
- package/dist/adapters/shared.d.ts +12 -0
- package/dist/adapters/shared.d.ts.map +1 -0
- package/dist/adapters/shared.js +134 -0
- package/dist/adapters/types.d.ts +74 -0
- package/dist/adapters/types.d.ts.map +1 -0
- package/dist/adapters/types.js +1 -0
- package/dist/cli.js +28 -34
- package/dist/client/search.js +213 -82
- package/dist/client/tabs.js +23 -0
- package/dist/components/layout/Head.js +17 -4
- package/dist/components/layout/TableOfContents.d.ts.map +1 -1
- package/dist/components/layout/TableOfContents.js +4 -2
- package/dist/components/openapi/Introduction.d.ts.map +1 -1
- package/dist/components/openapi/Introduction.js +16 -1
- package/dist/components/openapi/Security.d.ts.map +1 -1
- package/dist/components/openapi/Security.js +18 -2
- package/dist/config.d.ts +101 -0
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +95 -143
- package/dist/core/api-rendering.d.ts +47 -0
- package/dist/core/api-rendering.d.ts.map +1 -0
- package/dist/core/api-rendering.js +76 -0
- package/dist/core/doxygen-loader.d.ts.map +1 -1
- package/dist/core/doxygen-loader.js +36 -17
- package/dist/core/godoc-loader.d.ts.map +1 -1
- package/dist/core/godoc-loader.js +17 -6
- package/dist/core/markdown-loader.d.ts +14 -0
- package/dist/core/markdown-loader.d.ts.map +1 -1
- package/dist/core/markdown-loader.js +70 -26
- package/dist/core/mcp-normalizer.d.ts.map +1 -1
- package/dist/core/mcp-normalizer.js +48 -34
- package/dist/core/navigation.d.ts.map +1 -1
- package/dist/core/navigation.js +8 -7
- package/dist/core/parser.d.ts.map +1 -1
- package/dist/core/parser.js +75 -4
- package/dist/core/rustdoc-introspector.d.ts +29 -0
- package/dist/core/rustdoc-introspector.d.ts.map +1 -0
- package/dist/core/rustdoc-introspector.js +236 -0
- package/dist/core/rustdoc-loader.d.ts +25 -0
- package/dist/core/rustdoc-loader.d.ts.map +1 -0
- package/dist/core/rustdoc-loader.js +469 -0
- package/dist/core/rustdoc-render.d.ts +76 -0
- package/dist/core/rustdoc-render.d.ts.map +1 -0
- package/dist/core/rustdoc-render.js +785 -0
- package/dist/core/rustdoc-types.d.ts +314 -0
- package/dist/core/rustdoc-types.d.ts.map +1 -0
- package/dist/core/rustdoc-types.js +18 -0
- package/dist/core/search-indexer.d.ts +10 -0
- package/dist/core/search-indexer.d.ts.map +1 -1
- package/dist/core/search-indexer.js +6 -1
- package/dist/core/sourcey-rustdoc/Cargo.lock +705 -0
- package/dist/core/sourcey-rustdoc/Cargo.toml +38 -0
- package/dist/core/sourcey-rustdoc/README.md +59 -0
- package/dist/core/sourcey-rustdoc/src/diagnostics.rs +42 -0
- package/dist/core/sourcey-rustdoc/src/doctest.rs +268 -0
- package/dist/core/sourcey-rustdoc/src/extract.rs +492 -0
- package/dist/core/sourcey-rustdoc/src/lib.rs +58 -0
- package/dist/core/sourcey-rustdoc/src/links.rs +126 -0
- package/dist/core/sourcey-rustdoc/src/main.rs +256 -0
- package/dist/core/sourcey-rustdoc/src/signature.rs +415 -0
- package/dist/core/sourcey-rustdoc/src/spec.rs +390 -0
- package/dist/core/sourcey-rustdoc/tests/format_version.rs +45 -0
- package/dist/dev-server.d.ts.map +1 -1
- package/dist/dev-server.js +109 -33
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +26 -14
- package/dist/init.d.ts.map +1 -1
- package/dist/init.js +21 -16
- package/dist/renderer/changelog-feed.d.ts.map +1 -1
- package/dist/renderer/changelog-feed.js +27 -19
- package/dist/renderer/html-builder.d.ts.map +1 -1
- package/dist/renderer/html-builder.js +4 -3
- package/dist/renderer/llms.js +57 -2
- package/dist/site-assembly.d.ts +5 -0
- package/dist/site-assembly.d.ts.map +1 -1
- package/dist/site-assembly.js +161 -25
- package/dist/themes/default/sourcey.css +300 -0
- package/dist/utils/code-samples.d.ts +1 -0
- package/dist/utils/code-samples.d.ts.map +1 -1
- package/dist/utils/code-samples.js +30 -22
- package/dist/utils/html.d.ts +10 -0
- package/dist/utils/html.d.ts.map +1 -0
- package/dist/utils/html.js +152 -0
- package/dist/utils/http.d.ts +0 -2
- package/dist/utils/http.d.ts.map +1 -1
- package/dist/utils/http.js +19 -34
- package/dist/utils/markdown.d.ts.map +1 -1
- package/dist/utils/markdown.js +115 -39
- package/dist/vite-plugin.d.ts +2 -0
- package/dist/vite-plugin.d.ts.map +1 -1
- package/dist/vite-plugin.js +71 -1
- package/package.json +11 -5
|
@@ -0,0 +1,314 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TypeScript mirror of the v1 RustdocSpec snapshot schema emitted by the
|
|
3
|
+
* bundled `sourcey-rustdoc` helper crate. Keep in lock-step with
|
|
4
|
+
* `oss/rust/sourcey-rustdoc/src/spec.rs`.
|
|
5
|
+
*/
|
|
6
|
+
export declare const SPEC_VERSION: 1;
|
|
7
|
+
export type ItemId = string;
|
|
8
|
+
export type RustdocMode = "auto" | "live" | "snapshot";
|
|
9
|
+
export type DiagnosticSeverity = "error" | "warning" | "info";
|
|
10
|
+
export interface RustdocSpec {
|
|
11
|
+
version: number;
|
|
12
|
+
sourcey_rustdoc_version: string;
|
|
13
|
+
rustdoc_format_version: number;
|
|
14
|
+
rust_toolchain: string;
|
|
15
|
+
generated_at: string;
|
|
16
|
+
crates: CrateSpec[];
|
|
17
|
+
/** Snapshot-level diagnostics (e.g. format_version mismatch). */
|
|
18
|
+
diagnostics?: RustdocDiagnostic[];
|
|
19
|
+
}
|
|
20
|
+
export interface CrateSpec {
|
|
21
|
+
name: string;
|
|
22
|
+
version: string | null;
|
|
23
|
+
root_module_id: ItemId;
|
|
24
|
+
modules: ModuleSpec[];
|
|
25
|
+
items: Record<ItemId, Item>;
|
|
26
|
+
external_crates: ExternalCrateRef[];
|
|
27
|
+
diagnostics: RustdocDiagnostic[];
|
|
28
|
+
}
|
|
29
|
+
export interface ModuleSpec {
|
|
30
|
+
id: ItemId;
|
|
31
|
+
path: string[];
|
|
32
|
+
docs_markdown: string | null;
|
|
33
|
+
doc_aliases: string[];
|
|
34
|
+
item_ids: ItemId[];
|
|
35
|
+
sub_module_paths: string[][];
|
|
36
|
+
source: SourceLocation | null;
|
|
37
|
+
}
|
|
38
|
+
export interface SourceLocation {
|
|
39
|
+
file: string;
|
|
40
|
+
line_start: number;
|
|
41
|
+
line_end: number;
|
|
42
|
+
}
|
|
43
|
+
export type Visibility = {
|
|
44
|
+
kind: "public";
|
|
45
|
+
} | {
|
|
46
|
+
kind: "crate";
|
|
47
|
+
} | {
|
|
48
|
+
kind: "restricted";
|
|
49
|
+
path: string;
|
|
50
|
+
} | {
|
|
51
|
+
kind: "default";
|
|
52
|
+
};
|
|
53
|
+
export interface Deprecation {
|
|
54
|
+
since: string | null;
|
|
55
|
+
note: string | null;
|
|
56
|
+
}
|
|
57
|
+
export type StabilityLevel = "stable" | "unstable";
|
|
58
|
+
export interface Stability {
|
|
59
|
+
level: StabilityLevel;
|
|
60
|
+
since: string | null;
|
|
61
|
+
feature: string | null;
|
|
62
|
+
issue: number | null;
|
|
63
|
+
}
|
|
64
|
+
export interface Item {
|
|
65
|
+
id: ItemId;
|
|
66
|
+
name: string | null;
|
|
67
|
+
path: string[];
|
|
68
|
+
visibility: Visibility;
|
|
69
|
+
source: SourceLocation | null;
|
|
70
|
+
docs_markdown: string | null;
|
|
71
|
+
doc_aliases: string[];
|
|
72
|
+
deprecation: Deprecation | null;
|
|
73
|
+
stability: Stability | null;
|
|
74
|
+
feature_gates: string[];
|
|
75
|
+
attrs_structured: string[];
|
|
76
|
+
/** Intra-doc link table: link label → resolved target. From rustdoc's `Item.links`. */
|
|
77
|
+
links: Record<string, LinkTarget>;
|
|
78
|
+
inner: ItemInner;
|
|
79
|
+
doctests: Doctest[];
|
|
80
|
+
}
|
|
81
|
+
export type ItemInner = ({
|
|
82
|
+
kind: "function";
|
|
83
|
+
} & FunctionItem) | ({
|
|
84
|
+
kind: "struct";
|
|
85
|
+
} & StructItem) | ({
|
|
86
|
+
kind: "enum";
|
|
87
|
+
} & EnumItem) | ({
|
|
88
|
+
kind: "variant";
|
|
89
|
+
} & VariantItem) | ({
|
|
90
|
+
kind: "union";
|
|
91
|
+
} & UnionItem) | ({
|
|
92
|
+
kind: "trait";
|
|
93
|
+
} & TraitItem) | ({
|
|
94
|
+
kind: "trait_alias";
|
|
95
|
+
} & TraitAliasItem) | ({
|
|
96
|
+
kind: "impl";
|
|
97
|
+
} & ImplItem) | ({
|
|
98
|
+
kind: "type_alias";
|
|
99
|
+
} & TypeAliasItem) | ({
|
|
100
|
+
kind: "constant";
|
|
101
|
+
} & ConstantItem) | ({
|
|
102
|
+
kind: "static";
|
|
103
|
+
} & StaticItem) | ({
|
|
104
|
+
kind: "macro";
|
|
105
|
+
} & MacroItem) | ({
|
|
106
|
+
kind: "proc_macro";
|
|
107
|
+
} & ProcMacroItem) | ({
|
|
108
|
+
kind: "assoc_type";
|
|
109
|
+
} & AssocTypeItem) | ({
|
|
110
|
+
kind: "assoc_const";
|
|
111
|
+
} & AssocConstItem) | ({
|
|
112
|
+
kind: "use";
|
|
113
|
+
} & UseItem) | ({
|
|
114
|
+
kind: "struct_field";
|
|
115
|
+
} & StructFieldItem) | {
|
|
116
|
+
kind: "module";
|
|
117
|
+
} | {
|
|
118
|
+
kind: "primitive";
|
|
119
|
+
} | {
|
|
120
|
+
kind: "extern_type";
|
|
121
|
+
};
|
|
122
|
+
export interface FunctionItem {
|
|
123
|
+
signature: Signature;
|
|
124
|
+
generics: Generics;
|
|
125
|
+
is_const: boolean;
|
|
126
|
+
is_async: boolean;
|
|
127
|
+
is_unsafe: boolean;
|
|
128
|
+
has_body: boolean;
|
|
129
|
+
}
|
|
130
|
+
export type StructKindKind = "plain" | "tuple" | "unit";
|
|
131
|
+
export interface StructItem {
|
|
132
|
+
struct_kind: StructKindKind;
|
|
133
|
+
generics: Generics;
|
|
134
|
+
fields: ItemId[];
|
|
135
|
+
has_stripped_fields: boolean;
|
|
136
|
+
impls: ItemId[];
|
|
137
|
+
}
|
|
138
|
+
export interface EnumItem {
|
|
139
|
+
generics: Generics;
|
|
140
|
+
variants: ItemId[];
|
|
141
|
+
has_stripped_variants: boolean;
|
|
142
|
+
impls: ItemId[];
|
|
143
|
+
}
|
|
144
|
+
export type VariantKindKind = "plain" | "tuple" | "struct";
|
|
145
|
+
export interface VariantItem {
|
|
146
|
+
variant_kind: VariantKindKind;
|
|
147
|
+
discriminant: string | null;
|
|
148
|
+
}
|
|
149
|
+
export interface UnionItem {
|
|
150
|
+
generics: Generics;
|
|
151
|
+
fields: ItemId[];
|
|
152
|
+
has_stripped_fields: boolean;
|
|
153
|
+
impls: ItemId[];
|
|
154
|
+
}
|
|
155
|
+
export interface TraitItem {
|
|
156
|
+
is_auto: boolean;
|
|
157
|
+
is_unsafe: boolean;
|
|
158
|
+
is_dyn_compatible: boolean;
|
|
159
|
+
generics: Generics;
|
|
160
|
+
bounds: string[];
|
|
161
|
+
items: ItemId[];
|
|
162
|
+
implementations: ItemId[];
|
|
163
|
+
}
|
|
164
|
+
export interface TraitAliasItem {
|
|
165
|
+
generics: Generics;
|
|
166
|
+
bounds: string[];
|
|
167
|
+
}
|
|
168
|
+
export interface ImplItem {
|
|
169
|
+
generics: Generics;
|
|
170
|
+
trait_path: TypePath | null;
|
|
171
|
+
for_type: TypePath;
|
|
172
|
+
items: ItemId[];
|
|
173
|
+
is_negative: boolean;
|
|
174
|
+
is_synthetic: boolean;
|
|
175
|
+
is_blanket: boolean;
|
|
176
|
+
provided_trait_methods: string[];
|
|
177
|
+
}
|
|
178
|
+
export interface TypeAliasItem {
|
|
179
|
+
aliased_type: TypePath;
|
|
180
|
+
generics: Generics;
|
|
181
|
+
}
|
|
182
|
+
export interface ConstantItem {
|
|
183
|
+
type_display: string;
|
|
184
|
+
expr: string;
|
|
185
|
+
value: string | null;
|
|
186
|
+
is_literal: boolean;
|
|
187
|
+
}
|
|
188
|
+
export interface StaticItem {
|
|
189
|
+
type_display: string;
|
|
190
|
+
expr: string;
|
|
191
|
+
is_mutable: boolean;
|
|
192
|
+
is_unsafe: boolean;
|
|
193
|
+
}
|
|
194
|
+
export interface MacroItem {
|
|
195
|
+
source: string;
|
|
196
|
+
}
|
|
197
|
+
export type ProcMacroKindKind = "bang" | "attr" | "derive";
|
|
198
|
+
export interface ProcMacroItem {
|
|
199
|
+
macro_kind: ProcMacroKindKind;
|
|
200
|
+
helpers: string[];
|
|
201
|
+
}
|
|
202
|
+
export interface AssocTypeItem {
|
|
203
|
+
generics: Generics;
|
|
204
|
+
bounds: string[];
|
|
205
|
+
default_display: string | null;
|
|
206
|
+
}
|
|
207
|
+
export interface AssocConstItem {
|
|
208
|
+
type_display: string;
|
|
209
|
+
default_display: string | null;
|
|
210
|
+
}
|
|
211
|
+
export interface UseItem {
|
|
212
|
+
source: string;
|
|
213
|
+
name: string;
|
|
214
|
+
target_id: ItemId | null;
|
|
215
|
+
is_glob: boolean;
|
|
216
|
+
}
|
|
217
|
+
export interface StructFieldItem {
|
|
218
|
+
type_display: string;
|
|
219
|
+
}
|
|
220
|
+
export interface Signature {
|
|
221
|
+
display: string;
|
|
222
|
+
tokens: SigToken[];
|
|
223
|
+
inputs: SigInput[];
|
|
224
|
+
output_display: string | null;
|
|
225
|
+
is_c_variadic: boolean;
|
|
226
|
+
}
|
|
227
|
+
export interface SigInput {
|
|
228
|
+
name: string;
|
|
229
|
+
type_display: string;
|
|
230
|
+
}
|
|
231
|
+
export type SigToken = {
|
|
232
|
+
kind: "keyword";
|
|
233
|
+
text: string;
|
|
234
|
+
} | {
|
|
235
|
+
kind: "punct";
|
|
236
|
+
text: string;
|
|
237
|
+
} | {
|
|
238
|
+
kind: "generic";
|
|
239
|
+
text: string;
|
|
240
|
+
} | {
|
|
241
|
+
kind: "lifetime";
|
|
242
|
+
text: string;
|
|
243
|
+
} | {
|
|
244
|
+
kind: "type";
|
|
245
|
+
text: string;
|
|
246
|
+
target: TypePath | null;
|
|
247
|
+
} | {
|
|
248
|
+
kind: "whitespace";
|
|
249
|
+
} | {
|
|
250
|
+
kind: "newline";
|
|
251
|
+
};
|
|
252
|
+
export interface TypePath {
|
|
253
|
+
crate_id: number;
|
|
254
|
+
path: string[];
|
|
255
|
+
display: string;
|
|
256
|
+
external: boolean;
|
|
257
|
+
html_root_url: string | null;
|
|
258
|
+
}
|
|
259
|
+
export interface Generics {
|
|
260
|
+
params: GenericParam[];
|
|
261
|
+
where_predicates: string[];
|
|
262
|
+
}
|
|
263
|
+
export type GenericParamKind = "lifetime" | "type" | "const";
|
|
264
|
+
export interface GenericParam {
|
|
265
|
+
name: string;
|
|
266
|
+
kind: GenericParamKind;
|
|
267
|
+
default_display: string | null;
|
|
268
|
+
bounds: string[];
|
|
269
|
+
}
|
|
270
|
+
export type LinkTarget = {
|
|
271
|
+
kind: "internal";
|
|
272
|
+
id: ItemId;
|
|
273
|
+
} | {
|
|
274
|
+
kind: "external";
|
|
275
|
+
crate_name: string;
|
|
276
|
+
path: string[];
|
|
277
|
+
html_root_url: string | null;
|
|
278
|
+
};
|
|
279
|
+
export interface Doctest {
|
|
280
|
+
lang: string;
|
|
281
|
+
fence_attributes: string[];
|
|
282
|
+
display_code: string;
|
|
283
|
+
executable_code: string;
|
|
284
|
+
implicit_main_wrap: boolean;
|
|
285
|
+
source: SourceLocation | null;
|
|
286
|
+
ordinal: number;
|
|
287
|
+
}
|
|
288
|
+
export interface ExternalCrateRef {
|
|
289
|
+
crate_id: number;
|
|
290
|
+
name: string;
|
|
291
|
+
html_root_url: string | null;
|
|
292
|
+
}
|
|
293
|
+
export interface RustdocDiagnostic {
|
|
294
|
+
severity: DiagnosticSeverity;
|
|
295
|
+
code: string;
|
|
296
|
+
message: string;
|
|
297
|
+
crate_name?: string | null;
|
|
298
|
+
file?: string | null;
|
|
299
|
+
line?: number | null;
|
|
300
|
+
}
|
|
301
|
+
export declare const RUSTDOC_DIAGNOSTIC_CODES: {
|
|
302
|
+
readonly FORMAT_VERSION_MISMATCH: "RUSTDOC_FORMAT_VERSION_MISMATCH";
|
|
303
|
+
readonly INTRA_DOC_LINK_UNRESOLVED: "RUSTDOC_INTRA_DOC_LINK_UNRESOLVED";
|
|
304
|
+
readonly MISSING_HTML_ROOT_URL: "RUSTDOC_MISSING_HTML_ROOT_URL";
|
|
305
|
+
readonly AUTO_FELL_BACK_TO_SNAPSHOT: "RUSTDOC_AUTO_FELL_BACK_TO_SNAPSHOT";
|
|
306
|
+
readonly NO_VIABLE_MODE: "RUSTDOC_NO_VIABLE_MODE";
|
|
307
|
+
readonly HELPER_MISSING: "RUSTDOC_HELPER_MISSING";
|
|
308
|
+
readonly HELPER_FAILED: "RUSTDOC_HELPER_FAILED";
|
|
309
|
+
readonly INVALID_SNAPSHOT_SCHEMA: "RUSTDOC_INVALID_SNAPSHOT_SCHEMA";
|
|
310
|
+
readonly NIGHTLY_NOT_FOUND: "RUST_NIGHTLY_NOT_FOUND";
|
|
311
|
+
readonly RUSTUP_NOT_FOUND: "RUSTUP_NOT_FOUND";
|
|
312
|
+
};
|
|
313
|
+
export type RustdocDiagnosticCode = (typeof RUSTDOC_DIAGNOSTIC_CODES)[keyof typeof RUSTDOC_DIAGNOSTIC_CODES];
|
|
314
|
+
//# sourceMappingURL=rustdoc-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rustdoc-types.d.ts","sourceRoot":"","sources":["../../src/core/rustdoc-types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,eAAO,MAAM,YAAY,EAAG,CAAU,CAAC;AAEvC,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;AAEvD,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;AAE9D,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,uBAAuB,EAAE,MAAM,CAAC;IAChC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,iEAAiE;IACjE,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5B,eAAe,EAAE,gBAAgB,EAAE,CAAC;IACpC,WAAW,EAAE,iBAAiB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,gBAAgB,EAAE,MAAM,EAAE,EAAE,CAAC;IAC7B,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEnD,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,cAAc,CAAC;IACtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAC9B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,uFAAuF;IACvF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClC,KAAK,EAAE,SAAS,CAAC;IACjB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,MAAM,MAAM,SAAS,GACjB,CAAC;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GAAG,YAAY,CAAC,GACrC,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,UAAU,CAAC,GACjC,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,QAAQ,CAAC,GAC7B,CAAC;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG,WAAW,CAAC,GACnC,CAAC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,CAAC,GAC/B,CAAC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,CAAC,GAC/B,CAAC;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GAAG,cAAc,CAAC,GAC1C,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,QAAQ,CAAC,GAC7B,CAAC;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GAAG,aAAa,CAAC,GACxC,CAAC;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GAAG,YAAY,CAAC,GACrC,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAAG,UAAU,CAAC,GACjC,CAAC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,CAAC,GAC/B,CAAC;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GAAG,aAAa,CAAC,GACxC,CAAC;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GAAG,aAAa,CAAC,GACxC,CAAC;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GAAG,cAAc,CAAC,GAC1C,CAAC;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,GAC3B,CAAC;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,GAAG,eAAe,CAAC,GAC5C;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,CAAC;AAE5B,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;AAExD,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,cAAc,CAAC;IAC5B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE3D,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,eAAe,CAAC;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC5B,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,sBAAsB,EAAE,MAAM,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,QAAQ,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE3D,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,aAAa,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,QAAQ,GAChB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACjC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACjC;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,GACtB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;AAE7D,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC;IACvB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAE3F,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,eAAO,MAAM,wBAAwB;;;;;;;;;;;CAW3B,CAAC;AAEX,MAAM,MAAM,qBAAqB,GAC/B,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,OAAO,wBAAwB,CAAC,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TypeScript mirror of the v1 RustdocSpec snapshot schema emitted by the
|
|
3
|
+
* bundled `sourcey-rustdoc` helper crate. Keep in lock-step with
|
|
4
|
+
* `oss/rust/sourcey-rustdoc/src/spec.rs`.
|
|
5
|
+
*/
|
|
6
|
+
export const SPEC_VERSION = 1;
|
|
7
|
+
export const RUSTDOC_DIAGNOSTIC_CODES = {
|
|
8
|
+
FORMAT_VERSION_MISMATCH: "RUSTDOC_FORMAT_VERSION_MISMATCH",
|
|
9
|
+
INTRA_DOC_LINK_UNRESOLVED: "RUSTDOC_INTRA_DOC_LINK_UNRESOLVED",
|
|
10
|
+
MISSING_HTML_ROOT_URL: "RUSTDOC_MISSING_HTML_ROOT_URL",
|
|
11
|
+
AUTO_FELL_BACK_TO_SNAPSHOT: "RUSTDOC_AUTO_FELL_BACK_TO_SNAPSHOT",
|
|
12
|
+
NO_VIABLE_MODE: "RUSTDOC_NO_VIABLE_MODE",
|
|
13
|
+
HELPER_MISSING: "RUSTDOC_HELPER_MISSING",
|
|
14
|
+
HELPER_FAILED: "RUSTDOC_HELPER_FAILED",
|
|
15
|
+
INVALID_SNAPSHOT_SCHEMA: "RUSTDOC_INVALID_SNAPSHOT_SCHEMA",
|
|
16
|
+
NIGHTLY_NOT_FOUND: "RUST_NIGHTLY_NOT_FOUND",
|
|
17
|
+
RUSTUP_NOT_FOUND: "RUSTUP_NOT_FOUND",
|
|
18
|
+
};
|
|
@@ -19,6 +19,16 @@ export interface SearchEntry {
|
|
|
19
19
|
category: string;
|
|
20
20
|
/** Featured in default search results */
|
|
21
21
|
featured?: boolean;
|
|
22
|
+
/** Source adapter symbol kind, e.g. C++ function, enumvalue, typedef */
|
|
23
|
+
symbolKind?: string;
|
|
24
|
+
/** Owning symbol, e.g. icy::Application */
|
|
25
|
+
owner?: string;
|
|
26
|
+
/** Owning symbol kind, e.g. class, struct, enum */
|
|
27
|
+
ownerKind?: string;
|
|
28
|
+
/** Namespace for source languages that expose one */
|
|
29
|
+
namespace?: string;
|
|
30
|
+
/** Fully qualified symbol name */
|
|
31
|
+
qualifiedName?: string;
|
|
22
32
|
}
|
|
23
33
|
/**
|
|
24
34
|
* Build a search index from specs and markdown pages.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search-indexer.d.ts","sourceRoot":"","sources":["../../src/core/search-indexer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AASjD,MAAM,WAAW,WAAW;IAC1B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"search-indexer.d.ts","sourceRoot":"","sources":["../../src/core/search-indexer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AASjD,MAAM,WAAW,WAAW;IAC1B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,wEAAwE;IACxE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,EAClC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,EAC9B,UAAU,EAAE,cAAc,EAC1B,SAAS,SAAM,EACf,aAAa,GAAE,MAAM,EAAO,EAC5B,UAAU,GAAE,UAAkB,GAC7B,MAAM,CAiGR"}
|
|
@@ -62,7 +62,7 @@ export function buildSearchIndex(specs, pages, navigation, assetBase = "/", feat
|
|
|
62
62
|
for (const heading of page.headings) {
|
|
63
63
|
entries.push({
|
|
64
64
|
title: heading.text,
|
|
65
|
-
content: `${page.title}
|
|
65
|
+
content: `${page.title} - ${heading.text}`,
|
|
66
66
|
url: `${href}#${heading.id}`,
|
|
67
67
|
tab: tabLabel,
|
|
68
68
|
category: "Sections",
|
|
@@ -75,6 +75,11 @@ export function buildSearchIndex(specs, pages, navigation, assetBase = "/", feat
|
|
|
75
75
|
url: entry.anchor ? `${href}#${entry.anchor}` : href,
|
|
76
76
|
tab: tabLabel,
|
|
77
77
|
category: entry.category,
|
|
78
|
+
...(entry.symbolKind && { symbolKind: entry.symbolKind }),
|
|
79
|
+
...(entry.owner && { owner: entry.owner }),
|
|
80
|
+
...(entry.ownerKind && { ownerKind: entry.ownerKind }),
|
|
81
|
+
...(entry.namespace && { namespace: entry.namespace }),
|
|
82
|
+
...(entry.qualifiedName && { qualifiedName: entry.qualifiedName }),
|
|
78
83
|
});
|
|
79
84
|
}
|
|
80
85
|
}
|