forked from palantir/tslint
/
exclusions.ts
81 lines (67 loc) · 2.77 KB
/
exclusions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/**
* @license
* Copyright 2013 Palantir Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DESCRIPTOR_OVERLOADS, DocType } from "../completedDocsRule";
import { BlockExclusion, IBlockExclusionDescriptor } from "./blockExclusion";
import { ClassExclusion, IClassExclusionDescriptor } from "./classExclusion";
import { Exclusion } from "./exclusion";
import { IInputExclusionDescriptors, InputExclusionDescriptor } from "./exclusionDescriptors";
import { ITagExclusionDescriptor, TagExclusion } from "./tagExclusion";
export type ExclusionsMap = Map<DocType, DocTypeExclusions>;
export interface DocTypeExclusions {
overloadsSeparateDocs?: boolean;
requirements: Array<Exclusion<any>>;
}
export const constructExclusionsMap = (
ruleArguments: IInputExclusionDescriptors[],
): ExclusionsMap => {
const exclusions: ExclusionsMap = new Map();
for (const ruleArgument of ruleArguments) {
addRequirements(exclusions, ruleArgument);
}
return exclusions;
};
const addRequirements = (exclusionsMap: ExclusionsMap, descriptors: IInputExclusionDescriptors) => {
if (typeof descriptors === "string") {
exclusionsMap.set(descriptors, createRequirementsForDocType(descriptors, {}));
return;
}
for (const docType of Object.keys(descriptors)) {
exclusionsMap.set(
docType as DocType,
createRequirementsForDocType(docType as DocType, descriptors[docType]),
);
}
};
const createRequirementsForDocType = (docType: DocType, descriptor: InputExclusionDescriptor) => {
const requirements = [];
let overloadsSeparateDocs = false;
if (typeof descriptor === "object" && DESCRIPTOR_OVERLOADS in descriptor) {
overloadsSeparateDocs = !!(descriptor as any)[DESCRIPTOR_OVERLOADS];
}
if (docType === "methods" || docType === "properties") {
requirements.push(new ClassExclusion(descriptor as IClassExclusionDescriptor));
} else {
requirements.push(new BlockExclusion(descriptor as IBlockExclusionDescriptor));
}
if ((descriptor as ITagExclusionDescriptor).tags !== undefined) {
requirements.push(new TagExclusion(descriptor as ITagExclusionDescriptor));
}
return {
overloadsSeparateDocs,
requirements,
};
};