dorian 2.6.8 → 3.0.0

data/vendor/prettier/index.d.ts

@@ -296,6 +296,7 @@ export type BuiltInParserName =
   | "markdown"
   | "mdx"
   | "meriyah"
+  | "mjml"
   | "scss"
   | "typescript"
   | "vue"
@@ -303,7 +304,7 @@ export type BuiltInParserName =
 export type BuiltInParsers = Record<BuiltInParserName, BuiltInParser>;
 
 /**
- * For use in `.prettierrc.js`, `.prettierrc.cjs`, `prettierrc.mjs`, `prettier.config.js`, `prettier.config.cjs`, `prettier.config.mjs`
+ * For use in `.prettierrc.js`, `.prettierrc.ts`, `.prettierrc.cjs`, `.prettierrc.cts`, `prettierrc.mjs`, `prettierrc.mts`, `prettier.config.js`, `prettier.config.ts`, `prettier.config.cjs`, `prettier.config.cts`, `prettier.config.mjs`, `prettier.config.mts`
  */
 export interface Config extends Options {
   overrides?: Array<{
@@ -341,6 +342,11 @@ export interface RequiredOptions extends doc.printer.Options {
    * @default true
    */
   bracketSpacing: boolean;
+  /**
+   * How to wrap object literals.
+   * @default "preserve"
+   */
+  objectWrap: "preserve" | "collapse";
   /**
    * Put the `>` of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being
    * alone on the next line (does not apply to self closing elements).
@@ -379,6 +385,11 @@ export interface RequiredOptions extends doc.printer.Options {
    * @default false
    */
   insertPragma: boolean;
+  /**
+   * Prettier can allow individual files to opt out of formatting if they contain a special comment, called a pragma, at the top of the file.
+   * @default false
+   */
+  checkIgnorePragma: boolean;
   /**
    * By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer.
    * In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out.
@@ -393,7 +404,7 @@ export interface RequiredOptions extends doc.printer.Options {
   /**
    * Provide ability to support new languages to prettier.
    */
-  plugins: Array<string | Plugin>;
+  plugins: Array<string | URL | Plugin>;
   /**
    * How to handle whitespaces in HTML.
    * @default "css"
@@ -424,6 +435,11 @@ export interface RequiredOptions extends doc.printer.Options {
    * @default false
    */
   singleAttributePerLine: boolean;
+  /**
+   * Where to print operators when binary expressions wrap lines.
+   * @default "end"
+   */
+  experimentalOperatorPosition: "start" | "end";
   /**
    * Use curious ternaries, with the question mark after the condition, instead
    * of on the same line as the consequent.
@@ -460,10 +476,11 @@ export interface Parser<T = any> {
   parse: (text: string, options: ParserOptions<T>) => T | Promise<T>;
   astFormat: string;
   hasPragma?: ((text: string) => boolean) | undefined;
+  hasIgnorePragma?: ((text: string) => boolean) | undefined;
   locStart: (node: T) => number;
   locEnd: (node: T) => number;
   preprocess?:
-    | ((text: string, options: ParserOptions<T>) => string)
+    | ((text: string, options: ParserOptions<T>) => string | Promise<string>)
     | undefined;
 }
 
@@ -474,6 +491,12 @@ export interface Printer<T = any> {
     print: (path: AstPath<T>) => Doc,
     args?: unknown,
   ): Doc;
+  printPrettierIgnored?(
+    path: AstPath<T>,
+    options: ParserOptions<T>,
+    print: (path: AstPath<T>) => Doc,
+    args?: unknown,
+  ): Doc;
   embed?:
     | ((
         path: AstPath,
@@ -503,7 +526,7 @@ export interface Printer<T = any> {
     | ((original: any, cloned: any, parent: any) => any)
     | undefined;
   hasPrettierIgnore?: ((path: AstPath<T>) => boolean) | undefined;
-  canAttachComment?: ((node: T) => boolean) | undefined;
+  canAttachComment?: ((node: T, ancestors: T[]) => boolean) | undefined;
   isBlockComment?: ((node: T) => boolean) | undefined;
   willPrintOwnComments?: ((path: AstPath<T>) => boolean) | undefined;
   printComment?:
@@ -568,7 +591,7 @@ export interface CursorResult {
 }
 
 /**
- * `format` is used to format text using Prettier. [Options](https://prettier.io/docs/en/options.html) may be provided to override the defaults.
+ * `format` is used to format text using Prettier. [Options](https://prettier.io/docs/options) may be provided to override the defaults.
  */
 export function format(source: string, options?: Options): Promise<string>;
 
@@ -597,7 +620,7 @@ export interface ResolveConfigOptions {
   /**
    * Pass directly the path of the config file if you don't wish to search for it.
    */
-  config?: string | undefined;
+  config?: string | URL | undefined;
   /**
    * If set to `true` and an `.editorconfig` file is in your project,
    * Prettier will parse it and convert its properties to the corresponding prettier configuration.
@@ -617,7 +640,7 @@ export interface ResolveConfigOptions {
  *
  * A promise is returned which will resolve to:
  *
- *  - An options object, providing a [config file](https://prettier.io/docs/en/configuration.html) was found.
+ *  - An options object, providing a [config file](https://prettier.io/docs/configuration) was found.
  *  - `null`, if no file was found.
  *
  * The promise will be rejected if there was an error parsing the configuration file.
@@ -650,7 +673,6 @@ export function clearConfigCache(): Promise<void>;
 
 export interface SupportLanguage {
   name: string;
-  since?: string | undefined;
   parsers: BuiltInParserName[] | string[];
   group?: string | undefined;
   tmScope?: string | undefined;
@@ -663,6 +685,7 @@ export interface SupportLanguage {
   linguistLanguageId?: number | undefined;
   vscodeLanguageIds?: string[] | undefined;
   interpreters?: string[] | undefined;
+  isSupported?: ((options: { filepath: string }) => boolean) | undefined;
 }
 
 export interface SupportOptionRange {
@@ -743,18 +766,17 @@ export interface BooleanSupportOption extends BaseSupportOption<"boolean"> {
   oppositeDescription?: string | undefined;
 }
 
-export interface BooleanArraySupportOption
-  extends BaseSupportOption<"boolean"> {
+export interface BooleanArraySupportOption extends BaseSupportOption<"boolean"> {
   default?: Array<{ value: boolean[] }> | undefined;
   array: true;
 }
 
-export interface ChoiceSupportOption<Value = any>
-  extends BaseSupportOption<"choice"> {
+export interface ChoiceSupportOption<
+  Value = any,
+> extends BaseSupportOption<"choice"> {
   default?: Value | Array<{ value: Value }> | undefined;
   description: string;
   choices: Array<{
-    since?: string | undefined;
     value: Value;
     description: string;
   }>;
@@ -791,7 +813,7 @@ export interface SupportInfo {
 export interface FileInfoOptions {
   ignorePath?: string | URL | (string | URL)[] | undefined;
   withNodeModules?: boolean | undefined;
-  plugins?: Array<string | Plugin> | undefined;
+  plugins?: Array<string | URL | Plugin> | undefined;
   resolveConfig?: boolean | undefined;
 }
 
@@ -806,7 +828,7 @@ export function getFileInfo(
 ): Promise<FileInfoResult>;
 
 export interface SupportInfoOptions {
-  plugins?: Array<string | Plugin> | undefined;
+  plugins?: Array<string | URL | Plugin> | undefined;
   showDeprecated?: boolean | undefined;
 }
 
@@ -822,7 +844,7 @@ export function getSupportInfo(
  */
 export const version: string;
 
-// https://github.com/prettier/prettier/blob/next/src/utils/public.js
+// https://github.com/prettier/prettier/blob/main/src/utilities/public.js
 export namespace util {
   interface SkipOptions {
     backwards?: boolean | undefined;
@@ -938,4 +960,9 @@ export namespace util {
   function addDanglingComment(node: any, comment: any, marker: any): void;
 
   function addTrailingComment(node: any, comment: any): void;
+
+  function getPreferredQuote(
+    text: string,
+    preferredQuoteOrPreferSingleQuote: Quote | boolean,
+  ): Quote;
 }