Skip to content

docs(typescript-estree): clarify filePath resolution in docs #1458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 14, 2020
Merged

docs(typescript-estree): clarify filePath resolution in docs #1458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/typescript-estree/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ interface ParseOptions {
errorOnUnknownASTType?: boolean;

/**
* The absolute path to the file being parsed.
* Absolute (or relative to `cwd`) path to the file being parsed.
*/
filePath?: string;

Expand Down Expand Up @@ -159,7 +159,7 @@ interface ParseAndGenerateServicesOptions extends ParseOptions {
extraFileExtensions?: string[];

/**
* The absolute path to the file being parsed.
* Absolute (or relative to `tsconfigRootDir`) path to the file being parsed.
* When `project` is provided, this is required, as it is used to fetch the file from the TypeScript compiler's cache.
*/
filePath?: string;
Expand Down
2 changes: 1 addition & 1 deletion packages/typescript-estree/src/parser-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export interface TSESTreeOptions {
extraFileExtensions?: string[];

/**
* The absolute path to the file being parsed.
* Absolute (or relative to `tsconfigRootDir`) path to the file being parsed.
* When `project` is provided, this is required, as it is used to fetch the file from the TypeScript compiler's cache.
*/
filePath?: string;
Expand Down