-
-
Notifications
You must be signed in to change notification settings - Fork 84
/
options.ts
106 lines (99 loc) · 2.56 KB
/
options.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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
import type { CacheOptions } from './util/cache';
export interface LinterOptions extends BaseOptions, CacheOptions {
/**
* Display verbose information
*/
verbose?: boolean;
/**
* Show extensive output.
*/
debug?: boolean;
/**
* a globs to exclude files from being checked.
*/
exclude?: string[] | string;
/**
* Only report the words, no line numbers or file names.
*/
wordsOnly?: boolean;
/**
* unique errors per file only.
*/
unique?: boolean;
/**
* root directory, defaults to `cwd`
*/
root?: string;
/**
* Determine if files / directories starting with `.` should be part
* of the glob search.
* @default false
*/
dot?: boolean;
/**
* Show part of a line where an issue is found.
* if true, it will show the default number of characters on either side.
* if a number, it will shat number of characters on either side.
*/
showContext?: boolean | number;
/**
* Show suggestions for spelling errors.
*/
showSuggestions?: boolean;
/**
* Enable filtering out files matching globs found in `.gitignore` files.
*/
gitignore?: boolean;
/**
* Stop searching for a `.gitignore`s when a root is reached.
*/
gitignoreRoot?: string | string[];
/**
* List of files that contains the paths to files to be spell checked.
* The files in the lists will be filtered against the glob patterns.
* - an entry of `stdin` means to read the file list from **`stdin`**
*/
fileLists?: string[] | undefined;
/**
* Files must be found and processed otherwise it is considered an error.
*/
mustFindFiles?: boolean;
}
export interface TraceOptions extends BaseOptions {
allowCompoundWords?: boolean;
ignoreCase?: boolean;
}
export interface BaseOptions {
/**
* Path to configuration file.
*/
config?: string;
/**
* Programming Language ID.
*/
languageId?: string;
/**
* Locale to use.
*/
locale?: string;
/**
* @deprecated
*/
local?: string;
}
export interface LinterCliOptions extends Omit<LinterOptions, 'fileLists'> {
legacy?: boolean;
summary: boolean;
issues: boolean;
silent: boolean;
mustFindFiles: boolean;
progress?: boolean;
/**
* issues are shown with a relative path to the root or `cwd`
*/
relative?: boolean;
/**
* List of file paths to files that contains a list of files to be spell checked.
*/
fileList?: string[];
}