prettier-plugin-embed 0.3.2 → 0.4.1

package/dist/options.d.ts

@@ -6,177 +6,294 @@ declare const PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES = "preserveEmbeddedExterior
 declare const NO_EMBEDDED_MULTI_LINE_INDENTATION = "noEmbeddedMultiLineIndentation";
 declare const EMBEDDED_OVERRIDES = "embeddedOverrides";
 export declare const options: {
-    noEmbeddedIdentificationByComment: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: never[];
-        }[];
-        description: string;
+    readonly noEmbeddedIdentificationByComment: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: [];
+        }];
+        readonly description: "This option turns off \"/* identifier */ `...`\" comment-based language identification for the specified identifiers.";
     };
-    noEmbeddedIdentificationByTag: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: never[];
-        }[];
-        description: string;
+    readonly noEmbeddedIdentificationByTag: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: [];
+        }];
+        readonly description: "This option turns off \"identifier`...`\" tag-based language identification for the specified identifiers.";
     };
-    preserveEmbeddedExteriorWhitespaces: {
-        category: "Config";
-        type: "string";
-        array: true;
-        default: {
-            value: never[];
-        }[];
-        description: string;
+    readonly preserveEmbeddedExteriorWhitespaces: {
+        readonly category: "Config";
+        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.";
     };
-    noEmbeddedMultiLineIndentation: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: never[];
-        }[];
-        description: string;
+    readonly noEmbeddedMultiLineIndentation: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        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.";
     };
-    embeddedOverrides: {
-        category: "Global";
-        type: "string";
-        array: false;
-        default: undefined;
-        description: string;
+    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.";
     };
-    embeddedNoopIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: never[];
-        }[];
-        description: string;
+    readonly embeddedNoopIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: [];
+        }];
+        readonly description: "Specify embedded language identifiers that will not be formatted.";
     };
-    embeddedCssIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: "css"[];
-        }[];
-        description: string;
+    readonly embeddedCssIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["css"];
+        }];
+        readonly description: "Specify embedded CSS language identifiers.";
     };
-    embeddedEsIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("js" | "jsx" | "es" | "es6" | "mjs" | "cjs" | "pac" | "javascript")[];
-        }[];
-        description: string;
+    readonly embeddedEsIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["js", "jsx", "es", "es6", "mjs", "cjs", "pac", "javascript"];
+        }];
+        readonly description: "Specify embedded ES language identifiers.";
     };
-    embeddedEsParser: {
-        category: "Global";
-        type: "string";
-        array: false;
-        default: string;
+    readonly embeddedEsParser: {
+        category: string;
+        type: "choice";
+        default: "babel";
         description: string;
-    };
-    embeddedGlslIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("glsl" | "fp" | "frag" | "frg" | "fs" | "fsh" | "fshader" | "geo" | "geom" | "glslf" | "glslv" | "gs" | "gshader" | "rchit" | "rmiss" | "shader" | "tesc" | "tese" | "vert" | "vrx" | "vsh" | "vshader")[];
+        choices: {
+            value: "babel" | "babel-flow" | "acorn" | "espree" | "flow" | "meriyah";
+            description: string;
         }[];
-        description: string;
     };
-    embeddedHtmlIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("html" | "htm" | "shtml" | "xhtml" | "xht" | "mdoc" | "jsp" | "asp" | "aspx" | "jshtm" | "volt" | "rhtml")[];
-        }[];
-        description: string;
+    readonly embeddedGlslIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["glsl", "shader"];
+        }];
+        readonly description: "Specify embedded GLSL language identifiers. This requires \"prettier-plugin-glsl\".";
     };
-    embeddedMarkdownIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("md" | "livemd" | "markdown" | "mdown" | "mdwn" | "mkd" | "mkdn" | "mkdown" | "ronn" | "scd" | "workbook")[];
-        }[];
-        description: string;
+    readonly embeddedGraphqlIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["graphql", "gql"];
+        }];
+        readonly description: "Specify embedded GraphQL language identifiers.";
     };
-    embeddedPhpIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("php" | "php5" | "phtml" | "ctp")[];
-        }[];
-        description: string;
+    readonly embeddedHtmlIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["html", "xhtml"];
+        }];
+        readonly description: "Specify embedded HTML language identifiers.";
     };
-    embeddedRubyIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("ruby" | "rbs" | "haml" | "arb" | "axlsx" | "builder" | "eye" | "fcgi" | "gemfile" | "gemspec" | "god" | "jb" | "jbuilder" | "mspec" | "opal" | "pluginspec" | "podspec" | "rabl" | "rake" | "rb" | "rbi" | "rbuild" | "rbw" | "rbx" | "ru" | "thor" | "watchr")[];
-        }[];
-        description: string;
+    readonly embeddedIniIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["ini", "cfg", "pro"];
+        }];
+        readonly description: "Specify embedded INI language identifiers. This requires \"prettier-plugin-ini\".";
     };
-    embeddedRubyParser: {
-        category: "Global";
-        type: "string";
-        array: false;
-        default: undefined;
-        description: string;
+    readonly embeddedJsonIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["json", "jsonl"];
+        }];
+        readonly description: "Specify embedded JSON language identifiers.";
     };
-    embeddedSqlIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: "sql"[];
-        }[];
+    readonly embeddedJsonParser: {
+        category: string;
+        type: "choice";
+        default: "json";
         description: string;
-    };
-    embeddedTsIdentifiers: {
-        category: "Global";
-        type: "string";
-        array: true;
-        default: {
-            value: ("ts" | "tsx" | "cts" | "mts" | "typescript")[];
+        choices: {
+            value: "json" | "json-stringify" | "json5";
+            description: string;
         }[];
+    };
+    readonly embeddedLatexIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        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 embeddedMarkdownIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["md", "markdown"];
+        }];
+        readonly description: "Specify embedded Markdown language identifiers.";
+    };
+    readonly embeddedPhpIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["php", "php5"];
+        }];
+        readonly description: "Specify embedded PHP language identifiers. This requires \"@prettier/plugin-php\".";
+    };
+    readonly embeddedPropertiesIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["properties"];
+        }];
+        readonly description: "Specify embedded Java Properties language identifiers. This requires \"prettier-plugin-properties\".";
+    };
+    readonly embeddedRubyIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["ruby"];
+        }];
+        readonly description: "Specify embedded Ruby language identifiers. This requires \"@prettier/plugin-ruby\".";
+    };
+    readonly embeddedRubyParser: {
+        category: string;
+        type: "choice";
+        default: "ruby";
         description: string;
+        choices: {
+            value: "ruby" | "rbs" | "haml";
+            description: string;
+        }[];
+    };
+    readonly embeddedShIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["sh"];
+        }];
+        readonly description: "Specify embedded Shell language identifiers.";
+    };
+    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\".";
     };
-    embeddedTsParser: {
-        category: "Global";
-        type: "string";
-        array: false;
-        default: string;
+    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;
+        })[];
     };
-    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")[];
-        }[];
+    readonly embeddedSqlParser: {
+        category: string;
+        type: "choice";
+        default: "sqlite";
         description: string;
+        choices: ({
+            value: "sqlite";
+            description: string;
+        } | {
+            value: "bigquery";
+            description: string;
+        })[];
     };
-    __embeddedXmlFragmentRecoverIndex: {
-        category: "Global";
-        type: "int";
-        array: true;
-        default: {
-            value: never[];
-        }[];
+    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\".";
+    };
+    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.";
+    };
+    readonly embeddedTsParser: {
+        category: string;
+        type: "choice";
+        default: "typescript";
         description: string;
+        choices: {
+            value: "typescript" | "babel-ts";
+            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\".";
+    };
+    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";
+    };
+    readonly embeddedYamlIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["yaml", "yml"];
+        }];
+        readonly description: "Specify embedded YAML language identifiers.";
     };
 };
 export interface PrettierPluginGlobalOptions {

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
 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" | "embeddedHtmlIdentifiers" | "embeddedMarkdownIdentifiers" | "embeddedPhpIdentifiers" | "embeddedRubyIdentifiers" | "embeddedSqlIdentifiers" | "embeddedTsIdentifiers" | "embeddedXmlIdentifiers" | keyof import("./options.js").PrettierPluginGlobalOptions>, "parser" | "filepath" | "endOfLine" | "embeddedLanguageFormatting" | "printWidth" | "tabWidth" | "useTabs" | `__${string}`> | undefined>;
+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;

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.3.2",
+  "version": "0.4.1",
   "type": "module",
   "files": [
     "./dist"
@@ -61,35 +61,38 @@
     "postncu": "npm i"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.4.3",
-    "@commitlint/config-conventional": "^18.4.3",
-    "@prettier/plugin-php": "^0.21.0",
+    "@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",
-    "@semantic-release/git": "^10.0.1",
     "@types/estree": "^1.0.5",
-    "@types/node": "^20.10.4",
-    "@typescript-eslint/eslint-plugin": "^6.13.2",
-    "@typescript-eslint/parser": "^6.13.2",
-    "@vitest/browser": "^1.0.4",
-    "@vitest/coverage-istanbul": "^1.0.4",
-    "@vitest/ui": "^1.0.4",
+    "@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",
     "@xml-tools/parser": "^1.0.11",
     "chevrotain": "7.1.1",
-    "esbuild": "^0.19.9",
-    "eslint": "^8.55.0",
+    "esbuild": "^0.19.11",
+    "eslint": "^8.56.0",
     "fast-glob": "^3.3.2",
-    "npm-check-updates": "^16.14.11",
-    "playwright": "^1.40.1",
+    "npm-check-updates": "^16.14.12",
     "prettier": "^3.0.0",
     "prettier-plugin-glsl": "^0.1.3",
+    "prettier-plugin-ini": "^1.1.0",
+    "prettier-plugin-jsdoc": "^1.3.0",
+    "prettier-plugin-latex": "^2.0.1",
     "prettier-plugin-organize-imports": "^3.2.4",
-    "prettier-plugin-sql": "^0.17.1",
-    "semantic-release": "^22.0.10",
-    "tsx": "^4.6.2",
+    "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-toml": "^2.0.1",
+    "tsx": "^4.7.0",
     "typescript": "^5.3.3",
-    "vite": "^5.0.7",
-    "vitest": "^1.0.4"
+    "vite": "^5.0.11",
+    "vitest": "^1.1.3"
   },
   "dependencies": {
     "dedent": "^1.5.1",

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedCss";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedEs";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedGlsl";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedHtml";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedMarkdown";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedNoop";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedPhp";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedRuby";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedSql";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedTs";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const embeddedLanguage = "embeddedXml";
-declare module "../types.js" {
-    interface EmbeddedLanguagesHolder {
-        [embeddedLanguage]: void;
-    }
-}