From b47da0de38420ba2337601bc2127928259dcf315 Mon Sep 17 00:00:00 2001 From: Armano Date: Tue, 14 Jan 2020 20:30:38 +0100 Subject: [PATCH] docs(typescript-estree): clarify filePath resolution in docs (#1458) --- packages/typescript-estree/README.md | 4 ++-- packages/typescript-estree/src/parser-options.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/typescript-estree/README.md b/packages/typescript-estree/README.md index 1d9a38d0fb3..54706cf47f9 100644 --- a/packages/typescript-estree/README.md +++ b/packages/typescript-estree/README.md @@ -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; @@ -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; diff --git a/packages/typescript-estree/src/parser-options.ts b/packages/typescript-estree/src/parser-options.ts index 1cd8b4d5475..2317a683abf 100644 --- a/packages/typescript-estree/src/parser-options.ts +++ b/packages/typescript-estree/src/parser-options.ts @@ -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;