prettier-plugin-embed 0.3.2 → 0.4.1

package/dist/embedded/sql/options.d.ts

@@ -1,23 +1,60 @@
-import type { SqlBaseOptions as PrettierPluginDepsOptions } from "prettier-plugin-sql";
-import { type AutocompleteStringList, type StringListToInterfaceKey } from "../utils.js";
-/** References
- * - https://github.com/un-ts/prettier/blob/master/packages/sql/src/index.ts
- * "sql" is the default dialect, so we only have "sql" as the default identifier to avoid confusion.
+import type { SqlBaseOptions as PrettierPluginSqlOptions } from "prettier-plugin-sql";
+import type { SqlPluginOptions as PrettierPluginSqlCstRequiredOptions } from "prettier-plugin-sql-cst";
+import { type AutocompleteStringList, type StringListToInterfaceKey, type UnionToIntersection } from "../utils.js";
+/**
+ * References
+ *
+ * - https://github.com/un-ts/prettier/blob/master/packages/sql/src/index.ts "sql" is the default
+ *   dialect, so we only have "sql" as the default identifier to avoid confusion.
  */
 declare const DEFAULT_IDENTIFIERS: readonly ["sql"];
 type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
 type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
-declare const embeddedLanguageIdentifiers: "embeddedSqlIdentifiers";
-export { PrettierPluginDepsOptions };
+declare const SQL_PLUGINS: readonly ["prettier-plugin-sql", "prettier-plugin-sql-cst"];
+type SqlPlugin = (typeof SQL_PLUGINS)[number];
+declare const SQL_CST_PARSERS: readonly ["sqlite", "bigquery", "mysql", "mariadb", "postgresql"];
+type SqlCstParser = (typeof SQL_CST_PARSERS)[number];
+declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedSqlIdentifiers";
+declare const EMBEDDED_LANGUAGE_PLUGIN: "embeddedSqlPlugin";
+declare const EMBEDDED_LANGUAGE_PARSER: "embeddedSqlParser";
+type PrettierPluginSqlCstOptions = Partial<PrettierPluginSqlCstRequiredOptions>;
+export interface PrettierPluginDepsOptions extends UnionToIntersection<PrettierPluginSqlOptions>, PrettierPluginSqlCstOptions {
+}
 export declare const options: {
-    embeddedSqlIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: "sql"[];
-        }[];
+    readonly embeddedSqlIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["sql"];
+        }];
+        readonly description: "Specify embedded SQL language identifiers. This requires \"prettier-plugin-sql\" or \"prettier-plugin-sql-cst\".";
+    };
+    readonly embeddedSqlPlugin: {
+        category: string;
+        type: "choice";
+        default: "prettier-plugin-sql";
+        description: string;
+        choices: ({
+            value: "prettier-plugin-sql";
+            description: string;
+        } | {
+            value: "prettier-plugin-sql-cst";
+            description: string;
+        })[];
+    };
+    readonly embeddedSqlParser: {
+        category: string;
+        type: "choice";
+        default: "sqlite";
         description: string;
+        choices: ({
+            value: "sqlite";
+            description: string;
+        } | {
+            value: "bigquery";
+            description: string;
+        })[];
     };
 };
 type Options = typeof options;
@@ -27,10 +64,13 @@ declare module "../types.js" {
     interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
     }
     interface PrettierPluginEmbedOptions {
-        [embeddedLanguageIdentifiers]?: Identifiers;
+        [EMBEDDED_LANGUAGE_IDENTIFIERS]?: Identifiers;
+        [EMBEDDED_LANGUAGE_PLUGIN]?: SqlPlugin;
+        [EMBEDDED_LANGUAGE_PARSER]?: SqlCstParser;
     }
 }
 declare module "prettier" {
     interface Options extends PrettierPluginDepsOptions {
     }
 }
+export {};

package/dist/embedded/toml/embedder.d.ts

@@ -0,0 +1,12 @@
+import type { Options } from "prettier";
+import type { Embedder } from "../../types.js";
+import { language } from "./language.js";
+export declare const embedder: Embedder<Options>;
+/**
+ * Register the embedder to the EmbeddedEmbedders
+ */
+declare module "../types.js" {
+    interface EmbeddedEmbedders {
+        [language]: typeof embedder;
+    }
+}

package/dist/embedded/toml/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./embedder.js";
+export * from "./language.js";
+export * from "./options.js";

package/dist/embedded/toml/language.d.ts

@@ -0,0 +1,9 @@
+export declare const language = "embeddedToml";
+/**
+ * Register the language to the EmbeddedLanguagesHolder
+ */
+declare module "../types.js" {
+    interface EmbeddedLanguagesHolder {
+        [language]: void;
+    }
+}

package/dist/embedded/toml/options.d.ts

@@ -0,0 +1,39 @@
+import type { PrettierTaploOptions } from "prettier-plugin-toml";
+import { type AutocompleteStringList, type StringListToInterfaceKey } from "../utils.js";
+/**
+ * References:
+ *
+ * - https://github.com/github-linguist/linguist/blob/7ca3799b8b5f1acde1dd7a8dfb7ae849d3dfb4cd/lib/linguist/languages.yml#L6890
+ */
+declare const DEFAULT_IDENTIFIERS: readonly ["toml"];
+type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
+type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
+declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedTomlIdentifiers";
+export interface PrettierPluginDepsOptions extends PrettierTaploOptions {
+}
+export declare const options: {
+    readonly embeddedTomlIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["toml"];
+        }];
+        readonly description: "Specify embedded TOML language identifiers. This requires \"prettier-plugin-toml\".";
+    };
+};
+type Options = typeof options;
+declare module "../types.js" {
+    interface EmbeddedOptions extends Options {
+    }
+    interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
+    }
+    interface PrettierPluginEmbedOptions {
+        [EMBEDDED_LANGUAGE_IDENTIFIERS]?: Identifiers;
+    }
+}
+declare module "prettier" {
+    interface Options extends PrettierPluginDepsOptions {
+    }
+}
+export {};

package/dist/embedded/ts/embedder.d.ts

@@ -1,9 +1,12 @@
 import type { Options } from "prettier";
 import type { Embedder } from "../../types.js";
-import { embeddedLanguage } from "./embedded-language.js";
+import { language } from "./language.js";
 export declare const embedder: Embedder<Options>;
+/**
+ * Register the embedder to the EmbeddedEmbedders
+ */
 declare module "../types.js" {
     interface EmbeddedEmbedders {
-        [embeddedLanguage]: typeof embedder;
+        [language]: typeof embedder;
     }
 }

package/dist/embedded/ts/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./embedded-language.js";
 export * from "./embedder.js";
+export * from "./language.js";
 export * from "./options.js";

package/dist/embedded/ts/language.d.ts

@@ -0,0 +1,9 @@
+export declare const language = "embeddedTs";
+/**
+ * Register the language to the EmbeddedLanguagesHolder
+ */
+declare module "../types.js" {
+    interface EmbeddedLanguagesHolder {
+        [language]: void;
+    }
+}

package/dist/embedded/ts/options.d.ts

@@ -1,33 +1,38 @@
 import { type AutocompleteStringList, type StringListToInterfaceKey } from "../utils.js";
-/** References:
+/**
+ * References:
+ *
  * - https://github.com/microsoft/vscode/blob/de0121cf0e05d1673903551b6dbb2871556bfae9/extensions/typescript-basics/package.json#L24
  * - https://github.com/github-linguist/linguist/blob/7ca3799b8b5f1acde1dd7a8dfb7ae849d3dfb4cd/lib/linguist/languages.yml#L7158
  */
 declare const DEFAULT_IDENTIFIERS: readonly ["ts", "tsx", "cts", "mts", "typescript"];
 type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
 type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
-declare const DEFAULT_TS_PARSERS: readonly ["typescript", "babel-ts"];
-type TsParser = (typeof DEFAULT_TS_PARSERS)[number];
+declare const TS_PARSERS: readonly ["typescript", "babel-ts"];
+type TsParser = (typeof TS_PARSERS)[number];
 declare const EMBEDDED_LANGUAGE_PARSER: "embeddedTsParser";
 declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedTsIdentifiers";
 export interface PrettierPluginDepsOptions {
 }
 export declare const options: {
-    embeddedTsIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("ts" | "tsx" | "cts" | "mts" | "typescript")[];
-        }[];
-        description: string;
+    readonly embeddedTsIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["ts", "tsx", "cts", "mts", "typescript"];
+        }];
+        readonly description: "Specify embedded TS language parsers.";
     };
-    embeddedTsParser: {
-        category: "Global";
-        type: "string";
-        array: false;
-        default: string;
+    readonly embeddedTsParser: {
+        category: string;
+        type: "choice";
+        default: "typescript";
         description: string;
+        choices: {
+            value: "typescript" | "babel-ts";
+            description: string;
+        }[];
     };
 };
 type Options = typeof options;

package/dist/embedded/utils.d.ts

@@ -8,7 +8,7 @@ export declare function printTemplateExpression(path: AstPath<Expression & {
 export declare function printTemplateExpressions(path: AstPath<TemplateLiteral>, print: InternalPrintFun): builders.Doc[][];
 export declare function simpleRehydrateDoc(doc: Doc, placeholderRegex: RegExp, expressionDocs: Doc[]): builders.Doc[] | builders.DocCommand;
 export declare function throwIfPluginIsNotFound(pluginName: string, options: Options, identifier: string): void;
-export declare function insertEmbeddedLanguage(embeddedLanguages: string[], embeddedLanguage: string, firstEmbeddedLanguage: string): void;
+export declare function insertLanguage(languages: string[], language: string, firstLanguage: string): void;
 export declare const randomUUID: () => string;
 export declare function preparePlaceholder(leading?: string, trailing?: string): {
     createPlaceholder: (index: number) => string;
@@ -16,9 +16,11 @@ export declare function preparePlaceholder(leading?: string, trailing?: string):
 };
 export declare function escapeRegExp(text: string): string;
 export declare function makeIdentifiersOptionName<T extends string>(language: T): `${T}Identifiers`;
+export declare function makePluginOptionName<T extends string>(language: T): `${T}Plugin`;
 export declare function makeParserOptionName<T extends string>(language: T): `${T}Parser`;
 export type AutocompleteStringList<T extends readonly string[]> = (T[number][] & string[]) | string[];
 export type StringListToInterfaceKey<T extends readonly string[]> = {
     [key in T[number]]: void;
 };
 export type Satisfies<U, T extends U> = T;
+export type UnionToIntersection<U> = (U extends unknown ? (x: U) => void : never) extends (x: infer I) => void ? I : never;

package/dist/embedded/xml/embedder.d.ts

@@ -1,9 +1,12 @@
 import type { Options } from "prettier";
 import type { Embedder } from "../../types.js";
-import { embeddedLanguage } from "./embedded-language.js";
+import { language } from "./language.js";
 export declare const embedder: Embedder<Options>;
+/**
+ * Register the embedder to the EmbeddedEmbedders
+ */
 declare module "../types.js" {
     interface EmbeddedEmbedders {
-        [embeddedLanguage]: typeof embedder;
+        [language]: typeof embedder;
     }
 }

package/dist/embedded/xml/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./embedded-language.js";
 export * from "./embedder.js";
+export * from "./language.js";
 export * from "./options.js";
 export * from "./parser.js";

package/dist/embedded/xml/language.d.ts

@@ -0,0 +1,9 @@
+export declare const language = "embeddedXml";
+/**
+ * Register the language to the EmbeddedLanguagesHolder
+ */
+declare module "../types.js" {
+    interface EmbeddedLanguagesHolder {
+        [language]: void;
+    }
+}

package/dist/embedded/xml/options.d.ts

@@ -1,12 +1,14 @@
 import { type AutocompleteStringList, type StringListToInterfaceKey } from "../utils.js";
-/** References:
+/**
+ * References:
+ *
  * - https://github.com/microsoft/vscode/blob/de0121cf0e05d1673903551b6dbb2871556bfae9/extensions/xml/package.json#L15
  * - https://github.com/github-linguist/linguist/blob/7ca3799b8b5f1acde1dd7a8dfb7ae849d3dfb4cd/lib/linguist/languages.yml#L7712
  */
-declare const DEFAULT_IDENTIFIERS: readonly ["xml", "xsd", "ascx", "atom", "axml", "axaml", "bpmn", "cpt", "csl", "csproj", "dita", "ditamap", "dtd", "ent", "mod", "dtml", "fsproj", "fxml", "iml", "isml", "jmx", "launch", "menu", "nuspec", "opml", "owl", "proj", "props", "pt", "publishsettings", "pubxml", "rbxlx", "rbxmx", "rdf", "rng", "rss", "shproj", "storyboard", "svg", "targets", "tld", "tmx", "vbproj", "vcxproj", "wsdl", "wxi", "wxl", "wxs", "xaml", "xbl", "xib", "xlf", "xliff", "xpdl", "xul", "xoml"];
+declare const DEFAULT_IDENTIFIERS: readonly ["xml", "opml", "rss", "svg"];
 type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
 type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
-declare const embeddedLanguageIdentifiers: "embeddedXmlIdentifiers";
+declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedXmlIdentifiers";
 export interface PrettierPluginDepsOptions {
     xmlSelfClosingSpace?: boolean;
     xmlWhitespaceSensitivity?: "strict" | "preserve" | "ignore";
@@ -14,24 +16,26 @@ export interface PrettierPluginDepsOptions {
     xmlQuoteAttributes?: "preserve" | "single" | "double";
 }
 export declare const options: {
-    embeddedXmlIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("xml" | "xsd" | "ascx" | "atom" | "axml" | "axaml" | "bpmn" | "cpt" | "csl" | "csproj" | "dita" | "ditamap" | "dtd" | "ent" | "mod" | "dtml" | "fsproj" | "fxml" | "iml" | "isml" | "jmx" | "launch" | "menu" | "nuspec" | "opml" | "owl" | "proj" | "props" | "pt" | "publishsettings" | "pubxml" | "rbxlx" | "rbxmx" | "rdf" | "rng" | "rss" | "shproj" | "storyboard" | "svg" | "targets" | "tld" | "tmx" | "vbproj" | "vcxproj" | "wsdl" | "wxi" | "wxl" | "wxs" | "xaml" | "xbl" | "xib" | "xlf" | "xliff" | "xpdl" | "xul" | "xoml")[];
-        }[];
-        description: string;
+    readonly embeddedXmlIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["xml", "opml", "rss", "svg"];
+        }];
+        readonly description: "Specify embedded XML language identifiers. This requires \"@prettier/plugin-xml\".";
     };
-    /** @internal */
-    __embeddedXmlFragmentRecoverIndex: {
-        category: "Global";
-        type: "int";
-        array: true;
-        default: {
-            value: never[];
-        }[];
-        description: string;
+    /**
+     * @internal
+     */
+    readonly __embeddedXmlFragmentRecoverIndex: {
+        readonly category: "Embed";
+        readonly type: "int";
+        readonly array: true;
+        readonly default: [{
+            readonly value: [];
+        }];
+        readonly description: "This option is read only and used as a workaround to support xml fragments";
     };
 };
 type Options = typeof options;
@@ -41,7 +45,7 @@ declare module "../types.js" {
     interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
     }
     interface PrettierPluginEmbedOptions {
-        [embeddedLanguageIdentifiers]?: Identifiers;
+        [EMBEDDED_LANGUAGE_IDENTIFIERS]?: Identifiers;
     }
 }
 declare module "prettier" {

package/dist/embedded/xml/parser.d.ts

@@ -1,9 +1,9 @@
 import type { CstNode } from "chevrotain";
 import type { Parser } from "prettier";
-import { embeddedLanguage } from "./embedded-language.js";
+import { language } from "./language.js";
 export declare const parser: Parser<CstNode>;
 declare module "../types.js" {
     interface EmbeddedParsers {
-        [embeddedLanguage]: Parser;
+        [language]: Parser;
     }
 }

package/dist/embedded/yaml/embedder.d.ts

@@ -0,0 +1,12 @@
+import type { Options } from "prettier";
+import type { Embedder } from "../../types.js";
+import { language } from "./language.js";
+export declare const embedder: Embedder<Options>;
+/**
+ * Register the embedder to the EmbeddedEmbedders
+ */
+declare module "../types.js" {
+    interface EmbeddedEmbedders {
+        [language]: typeof embedder;
+    }
+}

package/dist/embedded/yaml/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./embedder.js";
+export * from "./language.js";
+export * from "./options.js";

package/dist/embedded/yaml/language.d.ts

@@ -0,0 +1,9 @@
+export declare const language = "embeddedYaml";
+/**
+ * Register the language to the EmbeddedLanguagesHolder
+ */
+declare module "../types.js" {
+    interface EmbeddedLanguagesHolder {
+        [language]: void;
+    }
+}

package/dist/embedded/yaml/options.d.ts

@@ -0,0 +1,38 @@
+import { type AutocompleteStringList, type StringListToInterfaceKey } from "../utils.js";
+/**
+ * References:
+ *
+ * - https://github.com/github-linguist/linguist/blob/7ca3799b8b5f1acde1dd7a8dfb7ae849d3dfb4cd/lib/linguist/languages.yml#L7940
+ */
+declare const DEFAULT_IDENTIFIERS: readonly ["yaml", "yml"];
+type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
+type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
+declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedYamlIdentifiers";
+export interface PrettierPluginDepsOptions {
+}
+export declare const options: {
+    readonly embeddedYamlIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["yaml", "yml"];
+        }];
+        readonly description: "Specify embedded YAML language identifiers.";
+    };
+};
+type Options = typeof options;
+declare module "../types.js" {
+    interface EmbeddedOptions extends Options {
+    }
+    interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
+    }
+    interface PrettierPluginEmbedOptions {
+        [EMBEDDED_LANGUAGE_IDENTIFIERS]?: Identifiers;
+    }
+}
+declare module "prettier" {
+    interface Options extends PrettierPluginDepsOptions {
+    }
+}
+export {};