Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

Commit 7797872

Browse files
author
Christopher Quadflieg
committed
chore: add jsdoc
1 parent daa42b2 commit 7797872

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

src/parser-options.d.ts

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,22 @@ export interface ParserOptions extends Partial<Record<string, unknown>> {
118118
};
119119
jsxPragma?: string;
120120
jsxFragmentName?: string | null;
121+
/**
122+
* @see [lib](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionslib)
123+
*/
121124
lib?: Lib[];
122125
comment?: boolean;
123126
debugLevel?: DebugLevel;
124127
errorOnTypeScriptSyntacticAndSemanticIssues?: boolean;
125128
errorOnUnknownASTType?: boolean;
129+
/**
130+
* This option allows you to provide one or more additional file extensions which should be considered in the TypeScript Program compilation.
131+
*
132+
* The default extensions are `.ts`, `.tsx`, `.js`, and `.jsx`. Add extensions starting with `.`, followed by the file extension.
133+
* E.g. for a `.vue` file use `"extraFileExtensions: [".vue"]`.
134+
*
135+
* @see [extraFileExtensions](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionsextrafileextensions)
136+
*/
126137
extraFileExtensions?: string[];
127138
filePath?: string;
128139
loc?: boolean;
@@ -133,11 +144,29 @@ export interface ParserOptions extends Partial<Record<string, unknown>> {
133144
* @see [Specifying Parser](https://eslint.org/docs/user-guide/configuring/plugins#specifying-parser)
134145
*/
135146
parser?: Parser;
147+
/**
148+
* @see [project](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionsproject)
149+
*/
136150
project?: string | string[];
151+
/**
152+
* @see [projectFolderIgnoreList](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionsprojectfolderignorelist)
153+
*/
137154
projectFolderIgnoreList?: Array<string | RegExp>;
138155
range?: boolean;
139156
tokens?: boolean;
157+
/**
158+
* This option allows you to provide the root directory for relative tsconfig paths specified in the `project` option above.
159+
*
160+
* @see [tsconfigRootDir](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionstsconfigrootdir)
161+
*/
140162
tsconfigRootDir?: string;
141163
useJSXTextNode?: boolean;
164+
/**
165+
* This option allows you to toggle the warning that the parser will give you if you use a version of TypeScript which is not explicitly supported.
166+
*
167+
* @default true
168+
*
169+
* @see [warnOnUnsupportedTypeScriptVersion](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionswarnonunsupportedtypescriptversion)
170+
*/
142171
warnOnUnsupportedTypeScriptVersion?: boolean;
143172
}

0 commit comments

Comments
 (0)