prettier-plugin-embed 0.5.1 → 0.7.0

package/dist/options.d.ts

@@ -85,6 +85,24 @@ export declare const options: {
         }];
         readonly description: "Tags that prevent their subsequent template literals from being identified as embedded languages and thus from being formatted.";
     };
+    readonly embeddedAstroComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["astro"];
+        }];
+        readonly description: "Block comments that identify embedded Astro in template literals. Requires the `prettier-plugin-astro` plugin.";
+    };
+    readonly embeddedAstroTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["astro"];
+        }];
+        readonly description: "Tags that identify embedded Astro in template literals. Requires the `prettier-plugin-astro` plugin.";
+    };
     readonly embeddedCssIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -123,6 +141,24 @@ export declare const options: {
             description: string;
         }[];
     };
+    readonly embeddedDockerfileComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["dockerfile", "containerfile"];
+        }];
+        readonly description: "Block comments that identify embedded Dockerfile in template literals. Requires the `prettier-plugin-sh` plugin.";
+    };
+    readonly embeddedDockerfileTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["dockerfile", "containerfile"];
+        }];
+        readonly description: "Tags that identify embedded Dockerfile in template literals. Requires the `prettier-plugin-sh` plugin.";
+    };
     readonly embeddedEsIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -157,10 +193,28 @@ export declare const options: {
         default: "babel";
         description: string;
         choices: {
-            value: "babel" | "babel-flow" | "acorn" | "espree" | "flow" | "meriyah";
+            value: "acorn" | "babel" | "babel-flow" | "espree" | "flow" | "meriyah";
             description: string;
         }[];
     };
+    readonly embeddedGherkinComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["gherkin", "feature"];
+        }];
+        readonly description: "Block comments that identify embedded Gherkin in template literals. Requires the `prettier-plugin-gherkin` plugin.";
+    };
+    readonly embeddedGherkinTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["gherkin", "feature"];
+        }];
+        readonly description: "Tags that identify embedded Gherkin in template literals. Requires the `prettier-plugin-gherkin` plugin.";
+    };
     readonly embeddedGlslIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -189,6 +243,24 @@ export declare const options: {
         }];
         readonly description: "Tags that make their subsequent template literals be identified as embedded GLSL language. This option requires the `prettier-plugin-glsl` plugin.";
     };
+    readonly embeddedGoTemplateComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["goTemplate", "gotmpl"];
+        }];
+        readonly description: "Block comments that identify embedded Go Template in template literals. Requires the `@htnabe/prettier-plugin-go-template` plugin.";
+    };
+    readonly embeddedGoTemplateTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["goTemplate", "gotmpl"];
+        }];
+        readonly description: "Tags that identify embedded Go Template in template literals. Requires the `@htnabe/prettier-plugin-go-template` plugin.";
+    };
     readonly embeddedGraphqlIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -217,6 +289,24 @@ export declare const options: {
         }];
         readonly description: "Tags that make their subsequent template literals be identified as embedded GraphQL language.";
     };
+    readonly embeddedHandlebarsComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["handlebars", "hbs"];
+        }];
+        readonly description: "Block comments that identify embedded Handlebars in template literals. Requires the `@poliklot/prettier-plugin-handlebars` plugin.";
+    };
+    readonly embeddedHandlebarsTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["handlebars", "hbs"];
+        }];
+        readonly description: "Tags that identify embedded Handlebars in template literals. Requires the `@poliklot/prettier-plugin-handlebars` plugin.";
+    };
     readonly embeddedHtmlIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -251,10 +341,28 @@ export declare const options: {
         default: "html";
         description: string;
         choices: {
-            value: "html" | "vue" | "angular" | "lwc";
+            value: "angular" | "html" | "lwc" | "vue";
             description: string;
         }[];
     };
+    readonly embeddedHugoComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["hugo", "hugoPost"];
+        }];
+        readonly description: "Block comments that identify embedded Hugo in template literals. Requires the `@htnabe/prettier-plugin-hugo-post` plugin.";
+    };
+    readonly embeddedHugoTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["hugo", "hugoPost"];
+        }];
+        readonly description: "Tags that identify embedded Hugo in template literals. Requires the `@htnabe/prettier-plugin-hugo-post` plugin.";
+    };
     readonly embeddedIniIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -311,6 +419,24 @@ export declare const options: {
         }];
         readonly description: "Tags that make their subsequent template literals be identified as embedded Java language. This option requires the `prettier-plugin-java` plugin.";
     };
+    readonly embeddedJinjaComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["jinja", "jinja2", "j2"];
+        }];
+        readonly description: "Block comments that identify embedded Jinja in template literals. Requires the `prettier-plugin-jinja-template` plugin.";
+    };
+    readonly embeddedJinjaTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["jinja", "jinja2", "j2"];
+        }];
+        readonly description: "Tags that identify embedded Jinja in template literals. Requires the `prettier-plugin-jinja-template` plugin.";
+    };
     readonly embeddedJsonIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -345,7 +471,7 @@ export declare const options: {
         default: "json";
         description: string;
         choices: {
-            value: "json" | "json5" | "jsonc" | "json-stringify";
+            value: "json" | "json-stringify" | "json5" | "jsonc";
             description: string;
         }[];
     };
@@ -377,6 +503,24 @@ export declare const options: {
         }];
         readonly description: "Tags that make their subsequent template literals be identified as embedded JSONata language. This option requires the `@stedi/prettier-plugin-jsonata` plugin.";
     };
+    readonly embeddedJteComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["jte"];
+        }];
+        readonly description: "Block comments that identify embedded JTE in template literals. Requires the `prettier-plugin-jte` plugin.";
+    };
+    readonly embeddedJteTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["jte"];
+        }];
+        readonly description: "Tags that identify embedded JTE in template literals. Requires the `prettier-plugin-jte` plugin.";
+    };
     readonly embeddedLatexIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -405,6 +549,24 @@ export declare const options: {
         }];
         readonly description: "Tags that make their subsequent template literals be identified as embedded LaTeX language. This option requires the `prettier-plugin-latex` plugin.";
     };
+    readonly embeddedLiquidComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["liquid"];
+        }];
+        readonly description: "Block comments that identify embedded Liquid in template literals. Requires the `@shopify/prettier-plugin-liquid` plugin.";
+    };
+    readonly embeddedLiquidTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["liquid"];
+        }];
+        readonly description: "Tags that identify embedded Liquid in template literals. Requires the `@shopify/prettier-plugin-liquid` plugin.";
+    };
     readonly embeddedMarkdownIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -443,6 +605,60 @@ export declare const options: {
             description: string;
         }[];
     };
+    readonly embeddedMarkoComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["marko"];
+        }];
+        readonly description: "Block comments that identify embedded Marko in template literals. Requires the `prettier-plugin-marko` plugin.";
+    };
+    readonly embeddedMarkoTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["marko"];
+        }];
+        readonly description: "Tags that identify embedded Marko in template literals. Requires the `prettier-plugin-marko` plugin.";
+    };
+    readonly embeddedMotokoComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["motoko", "mo"];
+        }];
+        readonly description: "Block comments that identify embedded Motoko in template literals. Requires the `prettier-plugin-motoko` plugin.";
+    };
+    readonly embeddedMotokoTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["motoko", "mo"];
+        }];
+        readonly description: "Tags that identify embedded Motoko in template literals. Requires the `prettier-plugin-motoko` plugin.";
+    };
+    readonly embeddedMustacheComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["mustache"];
+        }];
+        readonly description: "Block comments that identify embedded Mustache in template literals. Requires the `prettier-plugin-mustache` plugin.";
+    };
+    readonly embeddedMustacheTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["mustache"];
+        }];
+        readonly description: "Tags that identify embedded Mustache in template literals. Requires the `prettier-plugin-mustache` plugin.";
+    };
     readonly embeddedNginxIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -471,6 +687,24 @@ export declare const options: {
         }];
         readonly description: "Tags that make their subsequent template literals be identified as embedded NGINX language. This option requires the `prettier-plugin-nginx` plugin.";
     };
+    readonly embeddedNunjucksComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["nunjucks", "njk"];
+        }];
+        readonly description: "Block comments that identify embedded Nunjucks in template literals. Requires the `prettier-plugin-nunjucks` plugin.";
+    };
+    readonly embeddedNunjucksTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["nunjucks", "njk"];
+        }];
+        readonly description: "Tags that identify embedded Nunjucks in template literals. Requires the `prettier-plugin-nunjucks` plugin.";
+    };
     readonly embeddedPegjsIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -533,7 +767,7 @@ export declare const options: {
         default: "typescript";
         description: string;
         choices: {
-            value: "typescript" | "babel-ts";
+            value: "babel-ts" | "typescript";
             description: string;
         }[];
     };
@@ -565,6 +799,24 @@ export declare const options: {
         }];
         readonly description: "Tags that make their subsequent template literals be identified as embedded PHP language. This option requires the `@prettier/plugin-php` plugin.";
     };
+    readonly embeddedPowerShellComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["powershell", "ps1"];
+        }];
+        readonly description: "Block comments that identify embedded PowerShell in template literals. Requires the `prettier-plugin-powershell` plugin.";
+    };
+    readonly embeddedPowerShellTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["powershell", "ps1"];
+        }];
+        readonly description: "Tags that identify embedded PowerShell in template literals. Requires the `prettier-plugin-powershell` plugin.";
+    };
     readonly embeddedPrismaIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -683,7 +935,7 @@ export declare const options: {
         default: "ruby";
         description: string;
         choices: {
-            value: "ruby" | "rbs" | "haml";
+            value: "haml" | "rbs" | "ruby";
             description: string;
         }[];
     };
@@ -715,6 +967,40 @@ export declare const options: {
         }];
         readonly description: "Tags that make their subsequent template literals be identified as embedded Shell language. This option requires the `prettier-plugin-sh` plugin.";
     };
+    readonly embeddedSolidityComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["solidity", "sol"];
+        }];
+        readonly description: "Block comments that identify embedded Solidity in template literals. Requires the `prettier-plugin-solidity` plugin.";
+    };
+    readonly embeddedSolidityTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["solidity", "sol"];
+        }];
+        readonly description: "Tags that identify embedded Solidity in template literals. Requires the `prettier-plugin-solidity` plugin.";
+    };
+    readonly embeddedSolidityParser: {
+        readonly category: "Embed";
+        readonly type: "choice";
+        readonly default: "slang";
+        readonly description: "The parser used to format embedded Solidity.";
+        readonly choices: [{
+            readonly value: "slang";
+            readonly description: "Use the `slang` parser.";
+        }, {
+            readonly value: "antlr";
+            readonly description: "Use the `antlr` parser.";
+        }, {
+            readonly value: "solidity-parse";
+            readonly description: "Use the `solidity-parse` parser.";
+        }];
+    };
     readonly embeddedSqlIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -759,10 +1045,28 @@ export declare const options: {
         default: "sqlite";
         description: string;
         choices: {
-            value: "sqlite" | "bigquery" | "mysql" | "mariadb" | "postgresql";
+            value: "bigquery" | "mariadb" | "mysql" | "postgresql" | "sqlite";
             description: string;
         }[];
     };
+    readonly embeddedSvelteComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["svelte"];
+        }];
+        readonly description: "Block comments that identify embedded Svelte in template literals. Requires the `prettier-plugin-svelte` plugin.";
+    };
+    readonly embeddedSvelteTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["svelte"];
+        }];
+        readonly description: "Tags that identify embedded Svelte in template literals. Requires the `prettier-plugin-svelte` plugin.";
+    };
     readonly embeddedTomlIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -828,6 +1132,37 @@ export declare const options: {
         }];
         readonly description: "This option is read only and is used internally as a workaround to support xml fragments";
     };
+    readonly embeddedXQueryComments: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["xquery", "xq"];
+        }];
+        readonly description: "Block comments that identify embedded XQuery in template literals. Requires the `prettier-plugin-xquery` plugin.";
+    };
+    readonly embeddedXQueryTags: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["xquery", "xq"];
+        }];
+        readonly description: "Tags that identify embedded XQuery in template literals. Requires the `prettier-plugin-xquery` plugin.";
+    };
+    readonly embeddedXQueryParser: {
+        readonly category: "Embed";
+        readonly type: "choice";
+        readonly default: "xquery";
+        readonly description: "The parser used to format embedded XQuery.";
+        readonly choices: [{
+            readonly value: "xquery";
+            readonly description: "Use the `xquery` parser.";
+        }, {
+            readonly value: "xquery4";
+            readonly description: "Use the `xquery4` parser.";
+        }];
+    };
     readonly embeddedYamlIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";

package/dist/parsers.d.ts

@@ -1,10 +1,4 @@
 export declare const parsers: {
-    embeddedXml: import("prettier").Parser;
-    meriyah: import("prettier").Parser;
-    typescript: import("prettier").Parser;
-    flow: import("prettier").Parser;
-    acorn: import("prettier").Parser;
-    espree: import("prettier").Parser;
     __babel_estree: import("prettier").Parser;
     __js_expression: import("prettier").Parser;
     __ts_expression: import("prettier").Parser;
@@ -19,4 +13,10 @@ export declare const parsers: {
     "json-stringify": import("prettier").Parser;
     json5: import("prettier").Parser;
     jsonc: import("prettier").Parser;
+    acorn: import("prettier").Parser;
+    espree: import("prettier").Parser;
+    flow: import("prettier").Parser;
+    meriyah: import("prettier").Parser;
+    typescript: import("prettier").Parser;
+    embeddedXml: import("prettier").Parser;
 };

package/dist/type-utils.d.ts

@@ -0,0 +1,5 @@
+export type LiteralUnion<LiteralType, BaseType extends string> = LiteralType | (BaseType & Record<never, never>);
+export type OmitIndexSignature<T> = {
+    [K in keyof T as Record<never, never> extends Record<K, unknown> ? never : K]: T[K];
+};
+export type UnionToIntersection<T> = (T extends unknown ? (value: T) => void : never) extends (value: infer Intersection) => void ? Intersection & T : never;

package/dist/types.d.ts

@@ -1,9 +1,9 @@
 import type { TemplateLiteral } from "estree";
 import type { AstPath, Doc, Options } from "prettier";
 import type { printer } from "prettier/doc";
-import type { OmitIndexSignature } from "type-fest";
 import type { AutocompleteStringList, EmbeddedDefaultComment, EmbeddedDefaultTag, EmbeddedLanguage, makeCommentsOptionName, makeIdentifiersOptionName, makeTagsOptionName, PluginEmbedOptions } from "./embedded/index.js";
 import type { PluginEmbedLanguageAgnosticOptions } from "./options.js";
+import type { OmitIndexSignature } from "./type-utils.js";
 export type InternalPrintFun = (selector?: string | number | (string | number)[] | AstPath<TemplateLiteral>) => Doc;
 export interface EmbedderPayload {
     commentOrTag: string;

package/dist/utils.d.ts

@@ -2,18 +2,18 @@ import type { Expression, Node, TemplateLiteral } from "estree";
 import { type AstPath, type Options, type Printer } from "prettier";
 import { type EmbeddedComment, type EmbeddedLanguage, type EmbeddedTag } from "./embedded/index.js";
 import type { EmbeddedOverride } from "./types.js";
-export declare function resolveEmbeddedOverrideOptions(embeddedOverridesString: string | undefined, { commentOrTag, kind, filepath, }: {
+export declare function resolveEmbeddedOverrideOptions(options: Options, { commentOrTag, kind, }: {
     commentOrTag: EmbeddedComment | EmbeddedTag;
     kind: "comment" | "tag";
-    filepath?: string;
 }): Promise<EmbeddedOverride["options"] | undefined>;
+export declare function matchTagExpressionPattern(tagExpression: Expression, pattern: string): boolean;
 export declare const compareTagExpressionToTagString: (tagExpression: Expression, tagString: string, parse: (text: string) => Node | Promise<Node>) => boolean;
 export declare function parseCommentFromTemplateLiteralAstPath({ node, parent, }: AstPath<Node> & {
     node: TemplateLiteral;
 }): string | undefined;
 export declare function parseTagFromTemplateLiteralAstPath({ parent, }: AstPath<Node> & {
     node: TemplateLiteral;
-}): string | TemplateLiteral | import("estree").ArrayExpression | import("estree").ArrowFunctionExpression | import("estree").AssignmentExpression | import("estree").AwaitExpression | import("estree").BinaryExpression | import("estree").CallExpression | import("estree").ChainExpression | import("estree").ClassExpression | import("estree").ConditionalExpression | import("estree").FunctionExpression | import("estree").ImportExpression | import("estree").Literal | import("estree").LogicalExpression | import("estree").MemberExpression | import("estree").MetaProperty | import("estree").ObjectExpression | import("estree").SequenceExpression | import("estree").TaggedTemplateExpression | import("estree").ThisExpression | import("estree").UnaryExpression | import("estree").UpdateExpression | import("estree").YieldExpression | undefined;
+}): string | import("estree").ArrayExpression | import("estree").ArrowFunctionExpression | import("estree").AssignmentExpression | import("estree").AwaitExpression | import("estree").BinaryExpression | import("estree").ChainExpression | import("estree").ClassExpression | import("estree").ConditionalExpression | import("estree").FunctionExpression | import("estree").ImportExpression | import("estree").LogicalExpression | import("estree").MemberExpression | import("estree").MetaProperty | import("estree").ObjectExpression | import("estree").SequenceExpression | import("estree").TaggedTemplateExpression | TemplateLiteral | import("estree").ThisExpression | import("estree").UnaryExpression | import("estree").UpdateExpression | import("estree").YieldExpression | import("estree").CallExpression | import("estree").Literal | undefined;
 export declare function createCommentsInOptionsGenerator(options: Options, comment: string): (_: EmbeddedLanguage) => Generator<string, void, undefined>;
 export declare function createTagsInOptionsGenerator(options: Options, tag?: string): (_: EmbeddedLanguage) => Generator<string, void, undefined>;
 export declare function createEmbeddedDoc(node: TemplateLiteral, embeddedLanguage: EmbeddedLanguage, commentOrTag: EmbeddedComment | EmbeddedTag, kind: "comment" | "tag", options: Options): ReturnType<Exclude<Printer["embed"], undefined>>;