UNPKG

2.27 kBTypeScriptView Raw
1import type { Options } from './ecmarkup';
2import type { ExportedBiblio } from './Biblio';
3import Clause from './Clause';
4import { CancellationToken } from 'prex';
5import type { JSDOM } from 'jsdom';
6export type Warning = {
7 type: 'global';
8 ruleId: string;
9 message: string;
10} | {
11 type: 'node';
12 node: Text | Element;
13 ruleId: string;
14 message: string;
15} | {
16 type: 'attr';
17 node: Element;
18 attr: string;
19 ruleId: string;
20 message: string;
21} | {
22 type: 'attr-value';
23 node: Element;
24 attr: string;
25 ruleId: string;
26 message: string;
27} | {
28 type: 'contents';
29 node: Text | Element;
30 ruleId: string;
31 message: string;
32 nodeRelativeLine: number;
33 nodeRelativeColumn: number;
34} | {
35 type: 'raw';
36 ruleId: string;
37 message: string;
38 line: number;
39 column: number;
40 file?: string;
41 source?: string;
42};
43export type WorklistItem = {
44 aoid: string | null;
45 effects: string[];
46};
47export declare function maybeAddClauseToEffectWorklist(effectName: string, clause: Clause, worklist: WorklistItem[]): void;
48export default class Spec {
49 spec: this;
50 opts: Options;
51 rootPath: string;
52 rootDir: string;
53 namespace: string;
54 generatedFiles: Map<string | null, string | Buffer>;
55 readonly log: (msg: string) => void;
56 readonly warn: (err: Warning) => void | undefined;
57 private _fetch;
58 constructor(rootPath: string, fetch: (file: string, token: CancellationToken) => PromiseLike<string>, dom: JSDOM, opts: Options | undefined, sourceText: string, token?: CancellationToken);
59 private labelClauses;
60 private toHTML;
61 private buildReferenceGraph;
62 private readSectionId;
63 private propagateEffects;
64 private propagateEffect;
65 private annotateExternalLinks;
66 private buildMultipage;
67 private buildAssets;
68 private addStyle;
69 private buildSpecWrapper;
70 private buildShortcutsHelp;
71 private processMetadata;
72 private loadBiblios;
73 private loadImports;
74 exportBiblio(): ExportedBiblio | null;
75 private highlightCode;
76 private buildBoilerplate;
77 private buildCopyrightBoilerplate;
78 private generateSDOMap;
79 private getProductions;
80 private setReplacementAlgorithmOffsets;
81 private _updateBySelector;
82}