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

typescript-eslint · Jan 14, 2020 · b47da0d · b47da0d
1 parent 982c8bc
commit b47da0d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git 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
@@ -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;