prettier 3.0.0-alpha.9-for-vscode → 3.0.1

package/index.d.ts

@@ -33,7 +33,7 @@ type ArrayElement<T> = T extends Array<infer E> ? E : never;
 
 // A union of the properties of the given object that are arrays.
 type ArrayProperties<T> = {
-  [K in keyof T]: NonNullable<T[K]> extends any[] ? K : never;
+  [K in keyof T]: NonNullable<T[K]> extends readonly any[] ? K : never;
 }[keyof T];
 
 // A union of the properties of the given array T that can be used to index it.
@@ -72,12 +72,12 @@ type CallCallback<T, U> = (path: AstPath<T>, index: number, value: any) => U;
 type EachCallback<T> = (
   path: AstPath<ArrayElement<T>>,
   index: number,
-  value: any
+  value: any,
 ) => void;
 type MapCallback<T, U> = (
   path: AstPath<ArrayElement<T>>,
   index: number,
-  value: any
+  value: any,
 ) => U;
 
 // https://github.com/prettier/prettier/blob/next/src/common/ast-path.js
@@ -136,18 +136,18 @@ export class AstPath<T = any> {
   call<U>(callback: CallCallback<T, U>): U;
   call<U, P1 extends CallProperties<T>>(
     callback: CallCallback<IndexValue<T, P1>, U>,
-    prop1: P1
+    prop1: P1,
   ): U;
   call<U, P1 extends keyof T, P2 extends CallProperties<T[P1]>>(
     callback: CallCallback<IndexValue<IndexValue<T, P1>, P2>, U>,
     prop1: P1,
-    prop2: P2
+    prop2: P2,
   ): U;
   call<
     U,
     P1 extends keyof T,
     P2 extends CallProperties<T[P1]>,
-    P3 extends CallProperties<IndexValue<T[P1], P2>>
+    P3 extends CallProperties<IndexValue<T[P1], P2>>,
   >(
     callback: CallCallback<
       IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>,
@@ -155,14 +155,14 @@ export class AstPath<T = any> {
     >,
     prop1: P1,
     prop2: P2,
-    prop3: P3
+    prop3: P3,
   ): U;
   call<
     U,
     P1 extends keyof T,
     P2 extends CallProperties<T[P1]>,
     P3 extends CallProperties<IndexValue<T[P1], P2>>,
-    P4 extends CallProperties<IndexValue<IndexValue<T[P1], P2>, P3>>
+    P4 extends CallProperties<IndexValue<IndexValue<T[P1], P2>, P3>>,
   >(
     callback: CallCallback<
       IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>,
@@ -171,7 +171,7 @@ export class AstPath<T = any> {
     prop1: P1,
     prop2: P2,
     prop3: P3,
-    prop4: P4
+    prop4: P4,
   ): U;
   call<U, P extends PropertyKey>(
     callback: CallCallback<any, U>,
@@ -185,28 +185,28 @@ export class AstPath<T = any> {
   each(callback: EachCallback<T>): void;
   each<P1 extends IterProperties<T>>(
     callback: EachCallback<IndexValue<T, P1>>,
-    prop1: P1
+    prop1: P1,
   ): void;
   each<P1 extends keyof T, P2 extends IterProperties<T[P1]>>(
     callback: EachCallback<IndexValue<IndexValue<T, P1>, P2>>,
     prop1: P1,
-    prop2: P2
+    prop2: P2,
   ): void;
   each<
     P1 extends keyof T,
     P2 extends IterProperties<T[P1]>,
-    P3 extends IterProperties<IndexValue<T[P1], P2>>
+    P3 extends IterProperties<IndexValue<T[P1], P2>>,
   >(
     callback: EachCallback<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>>,
     prop1: P1,
     prop2: P2,
-    prop3: P3
+    prop3: P3,
   ): void;
   each<
     P1 extends keyof T,
     P2 extends IterProperties<T[P1]>,
     P3 extends IterProperties<IndexValue<T[P1], P2>>,
-    P4 extends IterProperties<IndexValue<IndexValue<T[P1], P2>, P3>>
+    P4 extends IterProperties<IndexValue<IndexValue<T[P1], P2>, P3>>,
   >(
     callback: EachCallback<
       IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>
@@ -214,7 +214,7 @@ export class AstPath<T = any> {
     prop1: P1,
     prop2: P2,
     prop3: P3,
-    prop4: P4
+    prop4: P4,
   ): void;
   each(
     callback: EachCallback<any[]>,
@@ -228,30 +228,30 @@ export class AstPath<T = any> {
   map<U>(callback: MapCallback<T, U>): U[];
   map<U, P1 extends IterProperties<T>>(
     callback: MapCallback<IndexValue<T, P1>, U>,
-    prop1: P1
+    prop1: P1,
   ): U[];
   map<U, P1 extends keyof T, P2 extends IterProperties<T[P1]>>(
     callback: MapCallback<IndexValue<IndexValue<T, P1>, P2>, U>,
     prop1: P1,
-    prop2: P2
+    prop2: P2,
   ): U[];
   map<
     U,
     P1 extends keyof T,
     P2 extends IterProperties<T[P1]>,
-    P3 extends IterProperties<IndexValue<T[P1], P2>>
+    P3 extends IterProperties<IndexValue<T[P1], P2>>,
   >(
     callback: MapCallback<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, U>,
     prop1: P1,
     prop2: P2,
-    prop3: P3
+    prop3: P3,
   ): U[];
   map<
     U,
     P1 extends keyof T,
     P2 extends IterProperties<T[P1]>,
     P3 extends IterProperties<IndexValue<T[P1], P2>>,
-    P4 extends IterProperties<IndexValue<IndexValue<T[P1], P2>, P3>>
+    P4 extends IterProperties<IndexValue<IndexValue<T[P1], P2>, P3>>,
   >(
     callback: MapCallback<
       IndexValue<IndexValue<IndexValue<IndexValue<T, P1>, P2>, P3>, P4>,
@@ -260,7 +260,7 @@ export class AstPath<T = any> {
     prop1: P1,
     prop2: P2,
     prop3: P3,
-    prop4: P4
+    prop4: P4,
   ): U[];
   map<U>(
     callback: MapCallback<any[], U>,
@@ -304,7 +304,7 @@ export type BuiltInParsers = Record<BuiltInParserName, BuiltInParser>;
 
 export type CustomParser = (
   text: string,
-  options: Options
+  options: Options,
 ) => AST | Promise<AST>;
 
 /**
@@ -405,10 +405,6 @@ export interface RequiredOptions extends doc.printer.Options {
    * Provide ability to support new languages to prettier.
    */
   plugins: Array<string | Plugin>;
-  /**
-   * Specify plugin directory paths to search for plugins if not installed in the same `node_modules` where prettier is located.
-   */
-  pluginSearchDirs: string[] | false;
   /**
    * How to handle whitespaces in HTML.
    * @default "css"
@@ -449,9 +445,7 @@ export interface ParserOptions<T = any> extends RequiredOptions {
 
 export interface Plugin<T = any> {
   languages?: SupportLanguage[] | undefined;
-  parsers?:
-    | { [parserName: string]: Parser<T> | (() => Promise<Parser<T>>) }
-    | undefined;
+  parsers?: { [parserName: string]: Parser<T> } | undefined;
   printers?: { [astFormat: string]: Printer<T> } | undefined;
   options?: SupportOptions | undefined;
   defaultOptions?: Partial<RequiredOptions> | undefined;
@@ -473,24 +467,27 @@ export interface Printer<T = any> {
     path: AstPath<T>,
     options: ParserOptions<T>,
     print: (path: AstPath<T>) => Doc,
-    args?: unknown
+    args?: unknown,
   ): Doc;
   embed?:
     | ((
         path: AstPath,
-        options: Options
+        options: Options,
       ) =>
         | ((
             textToDoc: (text: string, options: Options) => Promise<Doc>,
             print: (
-              selector?: string | number | Array<string | number> | AstPath
+              selector?: string | number | Array<string | number> | AstPath,
             ) => Doc,
             path: AstPath,
-            options: Options
+            options: Options,
           ) => Promise<Doc | undefined> | Doc | undefined)
         | Doc
         | null)
     | undefined;
+  preprocess?:
+    | ((ast: T, options: ParserOptions<T>) => T | Promise<T>)
+    | undefined;
   insertPragma?: (text: string) => string;
   /**
    * @returns `null` if you want to remove this node
@@ -523,7 +520,7 @@ export interface Printer<T = any> {
               text: string,
               options: ParserOptions<T>,
               ast: T,
-              isLastComment: boolean
+              isLastComment: boolean,
             ) => boolean)
           | undefined;
         endOfLine?:
@@ -532,7 +529,7 @@ export interface Printer<T = any> {
               text: string,
               options: ParserOptions<T>,
               ast: T,
-              isLastComment: boolean
+              isLastComment: boolean,
             ) => boolean)
           | undefined;
         remaining?:
@@ -541,11 +538,14 @@ export interface Printer<T = any> {
               text: string,
               options: ParserOptions<T>,
               ast: T,
-              isLastComment: boolean
+              isLastComment: boolean,
             ) => boolean)
           | undefined;
       }
     | undefined;
+  getVisitorKeys?:
+    | ((node: T, nonTraversableKeys: Set<string>) => string[])
+    | undefined;
 }
 
 export interface CursorOptions extends Options {
@@ -581,7 +581,7 @@ export function check(source: string, options?: Options): Promise<boolean>;
  */
 export function formatWithCursor(
   source: string,
-  options: CursorOptions
+  options: CursorOptions,
 ): Promise<CursorResult>;
 
 export function formatAST(ast: any, options?: Options): Promise<string>;
@@ -622,7 +622,7 @@ export interface ResolveConfigOptions {
  */
 export function resolveConfig(
   filePath: string,
-  options?: ResolveConfigOptions
+  options?: ResolveConfigOptions,
 ): Promise<Options | null>;
 
 /**
@@ -798,7 +798,7 @@ export interface FileInfoResult {
 
 export function getFileInfo(
   filePath: string,
-  options?: FileInfoOptions
+  options?: FileInfoOptions,
 ): Promise<FileInfoResult>;
 
 /**
@@ -826,7 +826,7 @@ export namespace util {
   function getAlignmentSize(
     text: string,
     tabWidth: number,
-    startIndex?: number | undefined
+    startIndex?: number | undefined,
   ): number;
 
   function getIndentSize(value: string, tabWidth: number): number;
@@ -834,83 +834,83 @@ export namespace util {
   function skipNewline(
     text: string,
     startIndex: number | false,
-    options?: SkipOptions | undefined
+    options?: SkipOptions | undefined,
   ): number | false;
 
   function skipInlineComment(
     text: string,
-    startIndex: number | false
+    startIndex: number | false,
   ): number | false;
 
   function skipTrailingComment(
     text: string,
-    startIndex: number | false
+    startIndex: number | false,
   ): number | false;
 
   function skipTrailingComment(
     text: string,
-    startIndex: number | false
+    startIndex: number | false,
   ): number | false;
 
   function hasNewline(
     text: string,
     startIndex: number,
-    options?: SkipOptions | undefined
+    options?: SkipOptions | undefined,
   ): boolean;
 
   function hasNewlineInRange(
     text: string,
     startIndex: number,
-    endIndex: number
+    endIndex: number,
   ): boolean;
 
   function hasSpaces(
     text: string,
     startIndex: number,
-    options?: SkipOptions | undefined
+    options?: SkipOptions | undefined,
   ): boolean;
 
   function getNextNonSpaceNonCommentCharacter(
     text: string,
-    startIndex: number
+    startIndex: number,
   ): string;
 
   function makeString(
     rawText: string,
     enclosingQuote: Quote,
-    unescapeUnnecessaryEscapes?: boolean | undefined
+    unescapeUnnecessaryEscapes?: boolean | undefined,
   ): string;
 
   function skip(
-    characters: string | RegExp
+    characters: string | RegExp,
   ): (
     text: string,
     startIndex: number | false,
-    options?: SkipOptions
+    options?: SkipOptions,
   ) => number | false;
 
   const skipWhitespace: (
     text: string,
     startIndex: number | false,
-    options?: SkipOptions
+    options?: SkipOptions,
   ) => number | false;
 
   const skipSpaces: (
     text: string,
     startIndex: number | false,
-    options?: SkipOptions
+    options?: SkipOptions,
   ) => number | false;
 
   const skipToLineEnd: (
     text: string,
     startIndex: number | false,
-    options?: SkipOptions
+    options?: SkipOptions,
   ) => number | false;
 
   const skipEverythingButNewLine: (
     text: string,
     startIndex: number | false,
-    options?: SkipOptions
+    options?: SkipOptions,
   ) => number | false;
 
   function addLeadingComment(node: any, comment: any): void;