prettier-plugin-embed 0.4.4 → 0.4.6

package/dist/options.d.ts

@@ -13,7 +13,7 @@ export declare const options: {
         readonly default: [{
             readonly value: [];
         }];
-        readonly description: "This option turns off \"/* identifier */ `...`\" comment-based language identification for the specified identifiers.";
+        readonly description: "Turns off `` /* identifier */ `...` `` comment-based embedded language identification for the specified identifiers.";
     };
     readonly noEmbeddedIdentificationByTag: {
         readonly category: "Embed";
@@ -22,16 +22,16 @@ export declare const options: {
         readonly default: [{
             readonly value: [];
         }];
-        readonly description: "This option turns off \"identifier`...`\" tag-based language identification for the specified identifiers.";
+        readonly description: "Turns off `` identifier`...` `` tag-based embedded language identification for the specified identifiers.";
     };
     readonly preserveEmbeddedExteriorWhitespaces: {
-        readonly category: "Config";
+        readonly category: "Embed";
         readonly type: "string";
         readonly array: true;
         readonly default: [{
             readonly value: [];
         }];
-        readonly description: "This option preserves leading and trailing whitespaces in the formatting results for the specified identifiers.";
+        readonly description: "Preserves leading and trailing whitespaces in the formatting results for the specified identifiers.";
     };
     readonly noEmbeddedMultiLineIndentation: {
         readonly category: "Embed";
@@ -40,14 +40,14 @@ export declare const options: {
         readonly default: [{
             readonly value: [];
         }];
-        readonly description: "This option turns off auto indentation in the formatting results for the specified identifiers when they are formatted to span multi lines.";
+        readonly description: "Turns off auto indentation in the formatting results for the specified identifiers when they are formatted to span multi lines.";
     };
     readonly embeddedOverrides: {
         readonly category: "Embed";
         readonly type: "string";
         readonly array: false;
         readonly default: undefined;
-        readonly description: "This option accepts option overrides for the specified identifiers. It should either be a stringified JSON or an absolute filepath to the option overrides file.";
+        readonly description: "Option overrides for the specified identifiers. It should either be a stringified JSON or an absolute filepath to the option overrides file.";
     };
     readonly embeddedNoopIdentifiers: {
         readonly category: "Embed";
@@ -56,7 +56,7 @@ export declare const options: {
         readonly default: [{
             readonly value: [];
         }];
-        readonly description: "Specify embedded language identifiers that will not be formatted.";
+        readonly description: "Tag or comment identifiers that prevent their subsequent template literals from being identified as embedded languages and thus from being formatted.";
     };
     readonly embeddedCssIdentifiers: {
         readonly category: "Embed";
@@ -65,7 +65,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["css"];
         }];
-        readonly description: "Specify embedded CSS language identifiers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded CSS language.";
     };
     readonly embeddedEsIdentifiers: {
         readonly category: "Embed";
@@ -74,7 +74,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["js", "jsx", "es", "es6", "mjs", "cjs", "pac", "javascript"];
         }];
-        readonly description: "Specify embedded ES language identifiers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded ECMAScript/JavaScript language.";
     };
     readonly embeddedEsParser: {
         category: string;
@@ -93,7 +93,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["glsl", "shader"];
         }];
-        readonly description: "Specify embedded GLSL language identifiers. This requires \"prettier-plugin-glsl\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded GLSL language. This option requires the `prettier-plugin-glsl` plugin.";
     };
     readonly embeddedGraphqlIdentifiers: {
         readonly category: "Embed";
@@ -102,7 +102,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["graphql", "gql"];
         }];
-        readonly description: "Specify embedded GraphQL language identifiers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded GraphQL language.";
     };
     readonly embeddedHtmlIdentifiers: {
         readonly category: "Embed";
@@ -111,7 +111,17 @@ export declare const options: {
         readonly default: [{
             readonly value: ["html", "xhtml"];
         }];
-        readonly description: "Specify embedded HTML language identifiers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded HTML language.";
+    };
+    readonly embeddedHtmlParser: {
+        category: string;
+        type: "choice";
+        default: "html";
+        description: string;
+        choices: {
+            value: "html" | "vue" | "angular" | "lwc";
+            description: string;
+        }[];
     };
     readonly embeddedIniIdentifiers: {
         readonly category: "Embed";
@@ -120,7 +130,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["ini", "cfg", "pro"];
         }];
-        readonly description: "Specify embedded INI language identifiers. This requires \"prettier-plugin-ini\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded INI language. This option requires the `prettier-plugin-ini` plugin.";
     };
     readonly embeddedJsonIdentifiers: {
         readonly category: "Embed";
@@ -129,7 +139,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["json", "jsonl"];
         }];
-        readonly description: "Specify embedded JSON language identifiers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded JSON language.";
     };
     readonly embeddedJsonParser: {
         category: string;
@@ -137,7 +147,7 @@ export declare const options: {
         default: "json";
         description: string;
         choices: {
-            value: "json" | "json-stringify" | "json5";
+            value: "json" | "json5" | "jsonc" | "json-stringify";
             description: string;
         }[];
     };
@@ -148,7 +158,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["latex", "tex", "aux", "cls", "bbl", "bib", "toc", "sty"];
         }];
-        readonly description: "Specify embedded LaTeX language identifiers. This requires \"prettier-plugin-latex\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded LaTeX language. This option requires the `prettier-plugin-latex` plugin.";
     };
     readonly embeddedMarkdownIdentifiers: {
         readonly category: "Embed";
@@ -157,7 +167,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["md", "markdown"];
         }];
-        readonly description: "Specify embedded Markdown language identifiers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Markdown language.";
     };
     readonly embeddedPhpIdentifiers: {
         readonly category: "Embed";
@@ -166,7 +176,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["php", "php5"];
         }];
-        readonly description: "Specify embedded PHP language identifiers. This requires \"@prettier/plugin-php\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded PHP language. This option requires the `@prettier/plugin-php` plugin.";
     };
     readonly embeddedPropertiesIdentifiers: {
         readonly category: "Embed";
@@ -175,7 +185,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["properties"];
         }];
-        readonly description: "Specify embedded Java Properties language identifiers. This requires \"prettier-plugin-properties\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Properties language. This option requires the `prettier-plugin-properties` plugin.";
     };
     readonly embeddedRubyIdentifiers: {
         readonly category: "Embed";
@@ -184,7 +194,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["ruby"];
         }];
-        readonly description: "Specify embedded Ruby language identifiers. This requires \"@prettier/plugin-ruby\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Ruby language. This option requires the `@prettier/plugin-ruby` plugin.";
     };
     readonly embeddedRubyParser: {
         category: string;
@@ -203,7 +213,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["sh"];
         }];
-        readonly description: "Specify embedded Shell language identifiers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Shell language. This option requires the `prettier-plugin-sh` plugin.";
     };
     readonly embeddedSqlIdentifiers: {
         readonly category: "Embed";
@@ -212,7 +222,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["sql"];
         }];
-        readonly description: "Specify embedded SQL language identifiers. This requires \"prettier-plugin-sql\" or \"prettier-plugin-sql-cst\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded SQL language. This option requires the `prettier-plugin-sql` plugin or the `prettier-plugin-sql-cst` plugin.";
     };
     readonly embeddedSqlPlugin: {
         category: string;
@@ -241,7 +251,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["toml"];
         }];
-        readonly description: "Specify embedded TOML language identifiers. This requires \"prettier-plugin-toml\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded TOML language. This option requires the `prettier-plugin-toml` plugin.";
     };
     readonly embeddedTsIdentifiers: {
         readonly category: "Embed";
@@ -250,7 +260,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["ts", "tsx", "cts", "mts", "typescript"];
         }];
-        readonly description: "Specify embedded TS language parsers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded TypeScript language.";
     };
     readonly embeddedTsParser: {
         category: string;
@@ -269,7 +279,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["xml", "opml", "rss", "svg"];
         }];
-        readonly description: "Specify embedded XML language identifiers. This requires \"@prettier/plugin-xml\".";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded XML language. This option requires the `@prettier/plugin-xml` plugin.";
     };
     readonly __embeddedXmlFragmentRecoverIndex: {
         readonly category: "Embed";
@@ -278,7 +288,7 @@ export declare const options: {
         readonly default: [{
             readonly value: [];
         }];
-        readonly description: "This option is read only and used as a workaround to support xml fragments";
+        readonly description: "This option is read only and is used internally as a workaround to support xml fragments";
     };
     readonly embeddedYamlIdentifiers: {
         readonly category: "Embed";
@@ -287,7 +297,7 @@ export declare const options: {
         readonly default: [{
             readonly value: ["yaml", "yml"];
         }];
-        readonly description: "Specify embedded YAML language identifiers.";
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded YAML language.";
     };
 };
 export interface PrettierPluginGlobalOptions {

package/dist/parsers.d.ts

@@ -17,5 +17,6 @@ export declare const parsers: {
     __babel_estree: import("prettier").Parser<any>;
     json: import("prettier").Parser<any>;
     json5: import("prettier").Parser<any>;
+    jsonc: import("prettier").Parser<any>;
     "json-stringify": import("prettier").Parser<any>;
 };

package/dist/types.d.ts

@@ -1,14 +1,26 @@
-import type { Comment, Node as EsTreeNode, TemplateLiteral } from "estree";
+import type { TemplateLiteral } from "estree";
 import type { AstPath, Doc, Options } from "prettier";
 import { makeIdentifiersOptionName, type AutocompleteStringList, type EmbeddedDefaultIdentifier, type EmbeddedLanguage, type PrettierPluginEmbedOptions } from "./embedded/index.js";
 import type { PrettierPluginGlobalOptions } from "./options.js";
-export type PrettierNode = EsTreeNode & {
-    comments?: (Comment & {
+import { RemoveIndex } from "./utils.js";
+declare module "estree" {
+    interface Comment {
         leading: boolean;
         trailing: boolean;
         nodeDescription: string;
-    })[];
-};
+    }
+    interface BaseNode {
+        comments?: Comment[];
+    }
+    interface File extends BaseNode {
+        type: "File";
+        sourceType: "script" | "module";
+        program: Program;
+    }
+    interface NodeMap {
+        File: File;
+    }
+}
 export type InternalPrintFun = (selector?: string | number | (string | number)[] | AstPath<TemplateLiteral>) => Doc;
 export interface EmbedderPayload {
     identifier: string;
@@ -18,6 +30,6 @@ export interface EmbedderPayload {
 export type Embedder<T extends Options = Options> = (textToDoc: (text: string, options: T) => Promise<Doc>, print: InternalPrintFun, path: AstPath<TemplateLiteral>, options: T, embedderPayload: EmbedderPayload) => Promise<Doc>;
 export interface EmbeddedOverride {
     identifiers: AutocompleteStringList<EmbeddedDefaultIdentifier[]>;
-    options: Omit<Omit<Options, keyof PrettierPluginEmbedOptions> & Omit<PrettierPluginEmbedOptions, keyof PrettierPluginGlobalOptions | ReturnType<typeof makeIdentifiersOptionName<EmbeddedLanguage>>>, "printWidth" | "endOfLine" | "useTabs" | "tabWidth" | "parser" | "filepath" | "embeddedLanguageFormatting" | `__${string}`>;
+    options: Omit<Omit<RemoveIndex<Options>, keyof PrettierPluginEmbedOptions> & Omit<PrettierPluginEmbedOptions, keyof PrettierPluginGlobalOptions | ReturnType<typeof makeIdentifiersOptionName<EmbeddedLanguage>>>, "printWidth" | "endOfLine" | "useTabs" | "tabWidth" | "parser" | "filepath" | "embeddedLanguageFormatting" | `__${string}`>;
 }
 export type EmbeddedOverrides = EmbeddedOverride[];

package/dist/utils.d.ts

@@ -1,5 +1,8 @@
-import { type AstPath } from "prettier";
-import type { PrettierNode } from "./types.js";
-export declare const resolveEmbeddedOverrideOptions: (embeddedOverridesString: string | undefined, identifier: string, sourceFilePath?: string) => Promise<Omit<Omit<import("prettier").Options, keyof import("./index.js").PrettierPluginEmbedOptions> & Omit<import("./index.js").PrettierPluginEmbedOptions, "embeddedNoopIdentifiers" | "embeddedCssIdentifiers" | "embeddedEsIdentifiers" | "embeddedGlslIdentifiers" | "embeddedGraphqlIdentifiers" | "embeddedHtmlIdentifiers" | "embeddedIniIdentifiers" | "embeddedJsonIdentifiers" | "embeddedLatexIdentifiers" | "embeddedMarkdownIdentifiers" | "embeddedPhpIdentifiers" | "embeddedPropertiesIdentifiers" | "embeddedRubyIdentifiers" | "embeddedShIdentifiers" | "embeddedSqlIdentifiers" | "embeddedTomlIdentifiers" | "embeddedTsIdentifiers" | "embeddedXmlIdentifiers" | "embeddedYamlIdentifiers" | keyof import("./options.js").PrettierPluginGlobalOptions>, "parser" | "filepath" | "endOfLine" | "embeddedLanguageFormatting" | "printWidth" | "tabWidth" | "useTabs" | `__${string}`> | undefined>;
-export declare function getIdentifierFromComment({ node, parent }: AstPath<PrettierNode>, comments: string[], noIdentificationList: string[]): string | undefined;
-export declare function getIdentifierFromTag({ node, parent }: AstPath<PrettierNode>, tags: string[], noIdentificationList: string[]): string | undefined;
+import type { Node } from "estree";
+import { type AstPath, type Options } from "prettier";
+export declare const resolveEmbeddedOverrideOptions: (embeddedOverridesString: string | undefined, identifier: string, sourceFilePath?: string) => Promise<Omit<Omit<RemoveIndex<Options>, keyof import("./index.js").PrettierPluginEmbedOptions> & Omit<import("./index.js").PrettierPluginEmbedOptions, "embeddedNoopIdentifiers" | "embeddedCssIdentifiers" | "embeddedEsIdentifiers" | "embeddedGlslIdentifiers" | "embeddedGraphqlIdentifiers" | "embeddedHtmlIdentifiers" | "embeddedIniIdentifiers" | "embeddedJsonIdentifiers" | "embeddedLatexIdentifiers" | "embeddedMarkdownIdentifiers" | "embeddedPhpIdentifiers" | "embeddedPropertiesIdentifiers" | "embeddedRubyIdentifiers" | "embeddedShIdentifiers" | "embeddedSqlIdentifiers" | "embeddedTomlIdentifiers" | "embeddedTsIdentifiers" | "embeddedXmlIdentifiers" | "embeddedYamlIdentifiers" | keyof import("./options.js").PrettierPluginGlobalOptions>, "parser" | "filepath" | "endOfLine" | "embeddedLanguageFormatting" | "printWidth" | "tabWidth" | "useTabs" | `__${string}`> | undefined>;
+export declare function getIdentifierFromComment({ node, parent }: AstPath<Node>, comments: string[], options: Options): string | undefined;
+export declare function getIdentifierFromTag({ node, parent }: AstPath<Node>, tags: string[], options: Options): string | undefined;
+export type RemoveIndex<T> = {
+    [K in keyof T as string extends K ? never : number extends K ? never : symbol extends K ? never : K]: T[K];
+};

package/package.json

@@ -2,7 +2,7 @@
   "name": "prettier-plugin-embed",
   "description": "A configurable Prettier plugin to format embedded languages in js/ts files.",
   "private": false,
-  "version": "0.4.4",
+  "version": "0.4.6",
   "type": "module",
   "files": [
     "./dist"
@@ -22,7 +22,7 @@
   "homepage": "https://github.com/Sec-ant/prettier-plugin-embed",
   "bugs": {
     "url": "https://github.com/Sec-ant/prettier-plugin-embed/issues",
-    "email": "zzwu@zju.edu.cn"
+    "email": "zezhengwu@proton.me"
   },
   "keywords": [
     "prettier",
@@ -64,21 +64,21 @@
     "@commitlint/cli": "^18.4.4",
     "@commitlint/config-conventional": "^18.4.4",
     "@prettier/plugin-php": "^0.22.1",
-    "@prettier/plugin-ruby": "^4.0.0",
-    "@prettier/plugin-xml": "^3.1.0",
+    "@prettier/plugin-ruby": "^4.0.4",
+    "@prettier/plugin-xml": "^3.2.2",
     "@types/estree": "^1.0.5",
-    "@types/node": "^20.10.7",
-    "@typescript-eslint/eslint-plugin": "^6.18.0",
-    "@typescript-eslint/parser": "^6.18.0",
-    "@vitest/coverage-istanbul": "^1.1.3",
-    "@vitest/ui": "^1.1.3",
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
+    "@vitest/coverage-istanbul": "^1.2.1",
+    "@vitest/ui": "^1.2.1",
     "@xml-tools/parser": "^1.0.11",
     "chevrotain": "7.1.1",
     "esbuild": "^0.19.11",
     "eslint": "^8.56.0",
     "fast-glob": "^3.3.2",
     "npm-check-updates": "^16.14.12",
-    "prettier": "^3.0.0",
+    "prettier": "^3.2.4",
     "prettier-plugin-glsl": "^0.1.3",
     "prettier-plugin-ini": "^1.1.0",
     "prettier-plugin-jsdoc": "^1.3.0",
@@ -87,12 +87,12 @@
     "prettier-plugin-properties": "^0.3.0",
     "prettier-plugin-sh": "^0.13.1",
     "prettier-plugin-sql": "^0.18.0",
-    "prettier-plugin-sql-cst": "^0.10.0",
+    "prettier-plugin-sql-cst": "^0.10.2",
     "prettier-plugin-toml": "^2.0.1",
     "tsx": "^4.7.0",
     "typescript": "^5.3.3",
     "vite": "^5.0.11",
-    "vitest": "^1.1.3"
+    "vitest": "^1.2.1"
   },
   "dependencies": {
     "dedent": "^1.5.1",