prettier-plugin-embed 0.5.1 → 0.6.0

package/README.md

@@ -11,7 +11,7 @@
 A configurable [Prettier](https://prettier.io/) [plugin](https://prettier.io/docs/en/plugins.html) to format [embedded languages](https://prettier.io/docs/en/options.html#embedded-language-formatting) in JS/TS Files.
 
 ```bash
-npm i -D prettier-plugin-embed
+npm i -D prettier prettier-plugin-embed
 ```
 
 </div>
@@ -20,19 +20,19 @@ npm i -D prettier-plugin-embed
 
 ### What?
 
-This Prettier plugin (namely [`prettier-plugin-embed`](https://github.com/Sec-ant/prettier-plugin-embed)) provides a configurable solution for formatting embedded languages in the form of [template literals](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Template_literals) within JavaScript or TypeScript files.
+This Prettier plugin formats [embedded languages](https://prettier.io/docs/options#embedded-language-formatting) in [template literals](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Template_literals) within JavaScript and TypeScript files.
 
 ### Why?
 
-Prettier has introduced an option for formatting embedded languages, named [`embedded-language-formatting`](https://prettier.io/docs/en/options.html#embedded-language-formatting). However, this option only offers two modes: `auto` and `off`. This limits its functionality, as it does not permit individual formatting adjustments for specific languages. Additionally, it lacks support for customizing which languages require formatting, as well as specifying block comments or tags for embedded language identification. These constraints hinder the feature's overall usability. For in-depth discussions on this matter, see the GitHub issues: [prettier/prettier#4424](https://github.com/prettier/prettier/issues/4424) and [prettier/prettier#5588](https://github.com/prettier/prettier/issues/5588).
+It adds per-language formatting controls, configurable block comments and tags, and per-identifier overrides to Prettier's embedded formatting. See [prettier/prettier#4424](https://github.com/prettier/prettier/issues/4424) and [prettier/prettier#5588](https://github.com/prettier/prettier/issues/5588) for related use cases.
 
 ### How?
 
-By leveraging Prettier's plugin system, this plugin overrides the default [`embed`](https://prettier.io/docs/en/plugins#optional-embed) function of the `estree` printer, so varieties of new languages can be hooked in through this function. Check [this file](./src/printers.ts) to get an idea of how this is accomplished.
+The plugin extends the [`embed`](https://prettier.io/docs/plugins#embed) method of Prettier's `estree` printer. Each integration delegates formatting to Prettier or a loaded language plugin. See [the printer implementation](./src/printers.ts) for the integration point.
 
 ## Features
 
-- **Support for Additional Languages:** Extend the embedded language formatting capability to include languages such as XML, SQL, PHP, and more.
+- **Support for Additional Languages:** Extend embedded formatting to languages such as XML, SQL, PHP, and more. See [Language-Specific Options](#language-specific-options) for the supported languages and their default identifiers.
 
 - **Dual Identification Modes:** Identify embedded languages by block comments `` /* comment */ `...` `` or tags `` tag`...` `` preceding the template literals.
 
@@ -49,9 +49,33 @@ By leveraging Prettier's plugin system, this plugin overrides the default [`embe
 ## Installation
 
 ```bash
-npm i -D prettier-plugin-embed
+npm i -D prettier prettier-plugin-embed
 ```
 
+Install Prettier 3 in the project that runs formatting. The consumer supplies the formatter and its language plugins.
+
+Install the formatter plugin for each embedded language you use as a separate project dependency; the [Language-Specific Options](#language-specific-options) section shows which integrations require one.
+
+Choose a Prettier version accepted by this plugin and every loaded language plugin. Each language plugin declares its own Prettier peer range.
+
+<details>
+<summary>Dependency resolution in strict installations</summary>
+
+The plugin loads Prettier through static imports, which resolve from the plugin's installation location. Standard project installs and Yarn's default Plug'n'Play dependency fallback allow these imports to access the project's installed Prettier.
+
+Yarn projects using `pnpFallbackMode: none`, and pnpm projects using `enableGlobalVirtualStore: true` with hoisting disabled, need an explicit dependency relationship for this resolution. For these configurations, add the following to `.yarnrc.yml` (Yarn) or `pnpm-workspace.yaml` (pnpm) to connect the plugin to the project's installed Prettier:
+
+```yaml
+packageExtensions:
+  "prettier-plugin-embed@*":
+    peerDependencies:
+      prettier: ">=3.0.0 <4"
+```
+
+Projects can also use Yarn's default `pnpFallbackMode: dependencies-only` or pnpm's project-local virtual store (`enableGlobalVirtualStore: false`).
+
+</details>
+
 ## Usage
 
 ### Getting Started
@@ -85,54 +109,75 @@ await prettier.format(code, {
 }
 ```
 
+For Yarn Plug'n'Play, load plugin objects from a JavaScript config so the imports resolve through Yarn's dependency map.
+
+```js
+import * as prettierPluginEmbed from "prettier-plugin-embed";
+
+export default {
+  plugins: [prettierPluginEmbed],
+};
+```
+
 ### Quick Start Config Examples
 
-Here're some [quick start config examples](./ConfigExamples.md) to use this plugin for various embedded languages. Check beblow for a detailed explanation of all the available options.
+See [Config Examples](./ConfigExamples.md) for complete language plugin configurations and sample output.
 
 ### An Overview of the Philosophy
 
-To use this plugin, [`embedded-language-formatting`](https://prettier.io/docs/en/options.html#embedded-language-formatting) option must be set to `auto` (which is the default setting as of now), because this option serves as the main switch for activating embedded language formatting.
+Set [`embeddedLanguageFormatting`](https://prettier.io/docs/options#embedded-language-formatting) to `"auto"` (Prettier's default) to enable embedded formatting.
 
-This plugin does not aim to implement parsers or printers to support every newly added embedded language. Rather, it aims to leverage existing [Prettier plugins](https://prettier.io/docs/en/plugins.html#official-plugins) for those languages, and only adds a thin layer of formatting support when they are embedded in template literals.
+This plugin uses Prettier's built-in parsers and existing [language plugins](https://prettier.io/docs/plugins#official-plugins), adding the integration needed to format their languages inside template literals.
 
-Therefore, to enable formatting for a specific embedded language, the corresponding Prettier plugin for that language must also be loaded. For example, if you wish to format embedded XML language, you will need to load both this plugin and [`@prettier/plugin-xml`](https://github.com/prettier/plugin-xml). To find out which other plugins are required when using this plugin, please refer to the [Language-Specific Options](#language-specific-options) section below.
+Install and load the formatter plugin for each additional language you use. For example, embedded XML requires both this plugin and [`@prettier/plugin-xml`](https://github.com/prettier/plugin-xml). The [Language-Specific Options](#language-specific-options) section lists the required plugins.
 
-Embedded languages to be formatted are required to be enclosed in the template literals, and are identified by the preceding [block comments](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#block_comments) `` /* comment */ `...` `` or [tags](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates) `` tag`...` ``. This plugin comes pre-configured with a built-in set of comments and tags for identifying various embedded languages. For instance, using comments like `/* xml */` or `/* svg */` or tags like `xml` or `svg` will trigger automatic formatting for the embedded XML language. You can specify an alternative list of comments or tags using the `embeddedXmlComments` option or the `embeddedXmlTags` option, respectively. The naming convention for these options follows the pattern of `embedded<Language>Comments` and `embedded<Language>Tags` for other languages as well. Further details on these options and how to configure them are also available in the [Language-Specific Options](#language-specific-options) section.
+A preceding [block comment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#block_comments) such as `` /* xml */ `...` `` or a [tag](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates) such as `` xml`...` `` identifies the embedded language. Configure each language with `embedded<Language>Comments` and `embedded<Language>Tags`. A leading block comment is checked first; templates without one are matched by their tag.
 
-To exclude certain comments or tags from being identified, like the default ones supported by the [`embedded-language-formatting`](https://prettier.io/docs/en/options.html#embedded-language-formatting) option, add them to the list of the `embeddedNoopComments`/`embeddedNoopTags` options. Any matching comments or tags listed in these options will take precedence over other `embedded<Language>Comments` and `embedded<Language>Tags` options, effectively disabling their formatting.
+Tags support exact identifiers, member expressions, and regular expression strings in `/pattern/flags` form. Simple identifiers support patterns too: `"/^query$/"` matches the tag `query`. Member and call expressions use a normalized form for pattern matching; for example, `factory(argument).query` becomes `factory().query`.
+
+For example, this JSON configuration matches `prisma.$queryRaw`, `client.$queryRaw`, and `ctx.prisma.$queryRaw`. JSON and JavaScript strings escape each backslash as `\\`:
+
+```json
+{
+  "plugins": ["prettier-plugin-embed", "prettier-plugin-sql"],
+  "embeddedSqlTags": ["/\\.\\$queryRaw$/"]
+}
+```
+
+Add comments or tags to `embeddedNoopComments` or `embeddedNoopTags` to preserve their template content as written. These options take priority among matching languages. Other overlapping matches use the first matching language in the internal registry; assign distinct identifiers or non-overlapping patterns to select a language explicitly.
 
 > [!IMPORTANT]
 >
-> Until this notice is removed, always specify comments or tags explicitly and do not rely on the built-in defaults, as they may be subject to change.
+> Specify comments or tags explicitly to keep language identification stable across plugin versions.
 
 ### Language-Specific Options
 
-Supported embedded languages are:
-
-- [CSS](#css)
-- [ES (ECMAScript/JavaScript)](#es-ecmascriptjavascript)
-- [GLSL](#glsl)
-- [GraphQL](#graphql)
-- [HTML](#html)
-- [INI](#ini)
-- [Java](#java)
-- [JSON](#json)
-- [JSONata](#jsonata)
-- [LaTeX](#latex)
-- [Markdown](#markdown)
-- [NGINX](#nginx)
-- [Pegjs](#pegjs)
-- [PHP](#php)
-- [Prisma](#prisma)
-- [Properties](#properties)
-- [Pug](#pug)
-- [Ruby](#ruby)
-- [Sh (Shell)](#sh-shell)
-- [SQL](#sql)
-- [TOML](#TOML)
-- [TS (TypeScript)](#ts-typescript)
-- [XML](#xml)
-- [YAML](#yaml)
+Supported embedded languages and their default comment/tag identifiers are:
+
+- [CSS](#css): `css`
+- [ES (ECMAScript/JavaScript)](#es-ecmascriptjavascript): `js`, `jsx`, `es`, `es6`, `mjs`, `cjs`, `pac`, `javascript`
+- [GLSL](#glsl): `glsl`, `shader`
+- [GraphQL](#graphql): `graphql`, `gql`
+- [HTML](#html): `html`, `xhtml`
+- [INI](#ini): `ini`, `cfg`, `pro`
+- [Java](#java): `java`
+- [JSON](#json): `json`, `jsonl`
+- [JSONata](#jsonata): `jsonata`
+- [LaTeX](#latex): `latex`, `tex`, `aux`, `cls`, `bbl`, `bib`, `toc`, `sty`
+- [Markdown](#markdown): `md`, `markdown`
+- [NGINX](#nginx): `nginx`
+- [Pegjs](#pegjs): `pegjs`, `peggy`, `peg`
+- [PHP](#php): `php`, `php5`
+- [Prisma](#prisma): `prisma`
+- [Properties](#properties): `properties`
+- [Pug](#pug): `pug`, `jade`
+- [Ruby](#ruby): `ruby`
+- [Sh (Shell)](#sh-shell): `sh`
+- [SQL](#sql): `sql`
+- [TOML](#toml): `toml`
+- [TS (TypeScript)](#ts-typescript): `ts`, `tsx`, `cts`, `mts`, `typescript`
+- [XML](#xml): `xml`, `opml`, `rss`, `svg`
+- [YAML](#yaml): `yaml`, `yml`
 
 <details open>
 <summary>
@@ -153,20 +198,7 @@ Click Here to Toggle
 - **Default**: [`[]`](./src/embedded/noop/options.ts)
 - **Description**: Tags that prevent their subsequent template literals from being identified as embedded languages and thus from being formatted.
 
-##### ~~`embeddedNoopIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`[]`](./src/embedded/noop/options.ts)
-- **Description**: Comment or tag identifiers that prevent their subsequent template literals from being identified as embedded languages and thus from being formatted.
-
-Please use `embeddedNoopComments` or `embeddedNoopTags`.
-
-</details>
-
-This "language" doesn't require other plugins and can override the native embedded language formatting. It serves as a way to turn off embedded language formatting for the specified language comments or tags.
+This built-in option can override native embedded language formatting for the specified comments or tags, preserving their template literal content as written.
 
 #### CSS
 
@@ -182,28 +214,15 @@ This "language" doesn't require other plugins and can override the native embedd
 - **Default**: [`["css"]`](./src/embedded/css/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded CSS language.
 
-##### ~~`embeddedCssIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["css"]`](./src/embedded/css/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded CSS language.
-
-Please use `embeddedCssComments` or `embeddedCssTags`.
-
-</details>
-
 ##### `embeddedCssParser`
 
 - **Type**: [`"css" | "less" | "scss"`](./src/embedded/css/options.ts)
 - **Default**: [`"scss"`](./src/embedded/css/options.ts)
 - **Description**: The parser used to parse the embedded CSS language.
 
-Formatting embedded CSS language doesn't require other plugins and uses the parsers and printers provided by Prettier natively.
+Embedded CSS uses the parsers and printers included with Prettier.
 
-This can override the native formatting bahavior for embedded CSS language. If you want to keep the native behavior, set `embeddedCssComments` or `embeddedCssTags` to `[]` or other values.
+This can override the native formatting behavior for embedded CSS language. If you want to keep the native behavior, set `embeddedCssComments` or `embeddedCssTags` to `[]` or other values.
 
 If you want to specify different parsers for different comments or tags, check [`embeddedOverrides`](#embeddedoverrides-1).
 
@@ -221,26 +240,13 @@ If you want to specify different parsers for different comments or tags, check [
 - **Default**: [`["js", "jsx", "es", "es6", "mjs", "cjs", "pac", "javascript"]`](./src/embedded/es/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded ECMAScript/JavaScript language.
 
-##### ~~`embeddedEsIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["js", "jsx", "es", "es6", "mjs", "cjs", "pac", "javascript"]`](./src/embedded/es/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded ECMAScript/JavaScript language.
-
-Please use `embeddedEsComments` or `embeddedEsTags`.
-
-</details>
-
 ##### `embeddedEsParser`
 
 - **Type**: [`"babel" | "babel-flow" | "acorn" | "espree" | "flow" | "meriyah"`](./src/embedded/es/options.ts)
 - **Default**: [`"babel"`](./src/embedded/es/options.ts)
 - **Description**: The parser used to parse the embedded ECMASCript/JavaScript language.
 
-Formatting embedded ECMAScript/JavaScript language doesn't require other plugins and uses the parsers and printers provided by Prettier natively.
+Embedded ECMAScript and JavaScript use the parsers and printers included with Prettier.
 
 If you want to specify different parsers for different comments or tags, check [`embeddedOverrides`](#embeddedoverrides-1).
 
@@ -258,19 +264,6 @@ If you want to specify different parsers for different comments or tags, check [
 - **Default**: [`["glsl", "shader"]`](./src/embedded/glsl/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded GLSL language. This option requires the `prettier-plugin-glsl` plugin.
 
-##### ~~`embeddedGlslIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["glsl", "shader"]`](./src/embedded/glsl/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded GLSL language. This option requires the `prettier-plugin-glsl` plugin.
-
-Please use `embeddedGlslComments` or `embeddedGlslTags`.
-
-</details>
-
 Formatting embedded GLSL language requires the [`prettier-plugin-glsl`](https://github.com/NaridaL/glsl-language-toolkit/tree/main/packages/prettier-plugin-glsl) plugin to be loaded as well.
 
 #### GraphQL
@@ -287,20 +280,7 @@ Formatting embedded GLSL language requires the [`prettier-plugin-glsl`](https://
 - **Default**: [`["graphql", "gql"]`](./src/embedded/graphql/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded GraphQL language.
 
-##### ~~`embeddedGraphqlIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["graphql", "gql"]`](./src/embedded/graphql/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded GraphQL language.
-
-Please use `embeddedGraphqlComments` or `embeddedGraphqlTags`.
-
-</details>
-
-Formatting embedded GraphQL language doesn't require other plugins and uses the parsers and printers provided by Prettier natively.
+Embedded GraphQL uses the parsers and printers included with Prettier.
 
 This can override the native formatting behavior for embedded GraphQL language. If you want to keep the native behavior, set `embeddedGraphqlComments` or `embeddedGraphqlTags` to `[]` or other values.
 
@@ -318,26 +298,13 @@ This can override the native formatting behavior for embedded GraphQL language.
 - **Default**: [`["html", "xhtml"]`](./src/embedded/html/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded HTML language.
 
-##### ~~`embeddedHtmlIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["html", "xhtml"]`](./src/embedded/html/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded HTML language.
-
-Please use `embeddedHtmlComments` or `embeddedHtmlTags`.
-
-</details>
-
 ##### `embeddedHtmlParser`
 
 - **Type**: [`"html" | "vue" | "angular" | "lwc"`](./src/embedded/html/options.ts)
 - **Default**: [`"html"`](./src/embedded/html/options.ts)
 - **Description**: The parser used to parse the embedded HTML language.
 
-Formatting embedded HTML language doesn't require other plugins and uses the parsers and printers provided by Prettier natively.
+Embedded HTML uses the parsers and printers included with Prettier.
 
 This can override the native formatting behavior for embedded HTML language. If you want to keep the native behavior, set `embeddedHtmlComments` or `embeddedHtmlTags` to `[]` or other values.
 
@@ -357,19 +324,6 @@ If you want to specify different parsers for different comments or tags, check [
 - **Default**: [`["ini", "cfg", "pro"]`](./src/embedded/ini/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded INI language. This option requires the `prettier-plugin-ini` plugin.
 
-##### ~~`embeddedIniIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["ini", "cfg", "pro"]`](./src/embedded/ini/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded INI language. This option requires the `prettier-plugin-ini` plugin.
-
-Please use `embeddedIniComments` or `embeddedIniTags`.
-
-</details>
-
 Formatting embedded INI language requires the [`prettier-plugin-ini`](https://github.com/kddnewton/prettier-plugin-ini) plugin to be loaded as well. And [options](https://github.com/kddnewton/prettier-plugin-ini#configuration) supported by `prettier-plugin-ini` can therefore be used to further control the formatting behavior.
 
 #### Java
@@ -386,19 +340,6 @@ Formatting embedded INI language requires the [`prettier-plugin-ini`](https://gi
 - **Default**: [`["java"]`](./src/embedded/java/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded Java language. This option requires the `prettier-plugin-java` plugin.
 
-##### ~~`embeddedJavaIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["java"]`](./src/embedded/java/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded Java language. This option requires the `prettier-plugin-java` plugin.
-
-Please use `embeddedJavaComments` or `embeddedJavaTags`.
-
-</details>
-
 Formatting embedded Java language requires the [`prettier-plugin-java`](https://github.com/jhipster/prettier-java/tree/main/packages/prettier-plugin-java) plugin to be loaded as well. And [options](https://github.com/jhipster/prettier-java/tree/main/packages/prettier-plugin-java#options) supported by `prettier-plugin-java` can therefore be used to further control the formatting behavior.
 
 #### JSON
@@ -415,26 +356,13 @@ Formatting embedded Java language requires the [`prettier-plugin-java`](https://
 - **Default**: [`["json", "jsonl"]`](./src/embedded/json/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded JSON language.
 
-##### ~~`embeddedJsonIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["json", "jsonl"]`](./src/embedded/json/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded JSON language.
-
-Please use `embeddedJsonComments` or `embeddedJsonTags`.
-
-</details>
-
 ##### `embeddedJsonParser`
 
 - **Type**: [`"json" | "json5" | "jsonc" | "json-stringify"`](./src/embedded/json/options.ts)
 - **Default**: [`"json"`](./src/embedded/json/options.ts)
 - **Description**: The parser used to parse the embedded JSON language.
 
-Formatting embedded JSON language doesn't require other plugins and uses the parsers and printers provided by Prettier natively.
+Embedded JSON uses the parsers and printers included with Prettier.
 
 If you want to specify different parsers for different comments or tags, check [`embeddedOverrides`](#embeddedoverrides-1).
 
@@ -452,19 +380,6 @@ If you want to specify different parsers for different comments or tags, check [
 - **Default**: [`["jsonata"]`](./src/embedded/jsonata/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded JSONata language. This option requires the `@stedi/prettier-plugin-jsonata` plugin.
 
-##### ~~`embeddedJsonataIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["jsonata"]`](./src/embedded/jsonata/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded JSONata language. This option requires the `@stedi/prettier-plugin-jsonata` plugin.
-
-Please use `embeddedJsonataComments` or `embeddedJsonataTags`.
-
-</details>
-
 Formatting embedded JSONata language requires the [`@stedi/prettier-plugin-jsonata`](https://github.com/Stedi/prettier-plugin-jsonata) plugin to be loaded as well.
 
 #### LaTeX
@@ -481,19 +396,6 @@ Formatting embedded JSONata language requires the [`@stedi/prettier-plugin-jsona
 - **Default**: [`["latex", "tex", "aux", "cls", "bbl", "bib", "toc", "sty"]`](./src/embedded/latex/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded LaTeX language. This option requires the `prettier-plugin-latex` plugin.
 
-##### ~~`embeddedLatexIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["latex", "tex", "aux", "cls", "bbl", "bib", "toc", "sty"]`](./src/embedded/latex/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded LaTeX language. This option requires the `prettier-plugin-latex` plugin.
-
-Please use `embeddedLatexComments` or `embeddedLatexTags`.
-
-</details>
-
 Formatting embedded LaTeX language requires the [`prettier-plugin-latex`](https://github.com/siefkenj/prettier-plugin-latex) plugin to be loaded as well.
 
 #### Markdown
@@ -510,26 +412,13 @@ Formatting embedded LaTeX language requires the [`prettier-plugin-latex`](https:
 - **Default**: [`["md", "markdown"]`](./src/embedded/markdown/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded Markdown language.
 
-##### ~~`embeddedMarkdownIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["md", "markdown"]`](./src/embedded/markdown/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded Markdown language.
-
-Please use `embeddedMarkdownComments` or `embeddedMarkdownTags`.
-
-</details>
-
 ##### `embeddedMarkdownParser`
 
 - **Type**: [`"markdown" | "mdx" | "remark"`](./src/embedded/markdown/options.ts)
 - **Default**: [`"markdown"`](./src/embedded/markdown/options.ts)
 - **Description**: The parser used to parse the embedded Markdown language.
 
-Formatting embedded Markdown language doesn't require other plugins and uses the parsers and printers provided by Prettier natively.
+Embedded Markdown uses the parsers and printers included with Prettier.
 
 This can override the native formatting for embedded Markdown language. If you want to keep the native behavior, set `embeddedMarkdownComments` or `embeddedMarkdownTags` to `[]` or other values.
 
@@ -551,19 +440,6 @@ The `remark` parser is [an alias of the `markdown` parser](https://github.com/pr
 - **Default**: [`["nginx"]`](./src/embedded/nginx/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded NGINX language. This option requires the `prettier-plugin-nginx` plugin.
 
-##### ~~`embeddedNginxIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["nginx"]`](./src/embedded/nginx/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded NGINX language. This option requires the `prettier-plugin-nginx` plugin.
-
-Please use `embeddedNginxComments` or `embeddedNginxTags`.
-
-</details>
-
 Formatting embedded NGINX language requires the [`prettier-plugin-nginx`](https://github.com/jxddk/prettier-plugin-nginx) plugin to be loaded as well. And [options](https://github.com/jxddk/prettier-plugin-nginx?tab=readme-ov-file#configuration) supported by `prettier-plugin-nginx` can therefore be used to further control the formatting behavior.
 
 #### Pegjs
@@ -580,19 +456,6 @@ Formatting embedded NGINX language requires the [`prettier-plugin-nginx`](https:
 - **Default**: [`["pegjs", "peggy", "peg"]`](./src/embedded/pegjs/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded Pegjs language. This option requires the `prettier-plugin-pegjs` plugin.
 
-##### ~~`embeddedPegjsIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["pegjs", "peggy", "peg"]`](./src/embedded/pegjs/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded Pegjs language. This option requires the `prettier-plugin-pegjs` plugin.
-
-Please use `embeddedPegjsComments` or `embeddedPegjsTags`.
-
-</details>
-
 Formatting embedded Pegjs language requires the [`prettier-plugin-pegjs`](https://github.com/siefkenj/prettier-plugin-pegjs) plugin to be loaded as well. And [options](https://github.com/siefkenj/prettier-plugin-pegjs?tab=readme-ov-file#options) supported by `prettier-plugin-pegjs` can therefore be used to further control the formatting behavior.
 
 Note that `prettier-plugin-pegjs` supports different parsers for the action blocks and they are specified by the [`actionParser` option](https://github.com/siefkenj/prettier-plugin-pegjs?tab=readme-ov-file#options). If you want to specify different action parsers for different comments or tags, check [`embeddedOverrides`](#embeddedoverrides-1).
@@ -611,19 +474,6 @@ Note that `prettier-plugin-pegjs` supports different parsers for the action bloc
 - **Default**: [`["php", "php5"]`](./src/embedded/php/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded PHP language. This option requires the `@prettier/plugin-php` plugin.
 
-##### ~~`embeddedPhpIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["php", "php5"]`](./src/embedded/php/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded PHP language. This option requires the `@prettier/plugin-php` plugin.
-
-Please use `embeddedPhpComments` or `embeddedPhpTags`.
-
-</details>
-
 Formatting embedded PHP language requires the [`@prettier/plugin-php`](https://github.com/prettier/plugin-php) plugin to be loaded as well. And [options](https://github.com/prettier/plugin-php#configuration) supported by `@prettier/plugin-php` can therefore be used to further control the formatting behavior.
 
 #### Prisma
@@ -640,19 +490,6 @@ Formatting embedded PHP language requires the [`@prettier/plugin-php`](https://g
 - **Default**: [`["prisma"]`](./src/embedded/prisma/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded Prisma language. This option requires the `prettier-plugin-prisma` plugin.
 
-##### ~~`embeddedPrismaIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["prisma"]`](./src/embedded/prisma/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded Prisma language. This option requires the `prettier-plugin-prisma` plugin.
-
-Please use `embeddedPrismaComments` or `embeddedPrismaTags`.
-
-</details>
-
 Formatting embedded Prisma language requires the [`prettier-plugin-prisma`](https://github.com/avocadowastaken/prettier-plugin-prisma) plugin to be loaded as well.
 
 #### Properties
@@ -669,19 +506,6 @@ Formatting embedded Prisma language requires the [`prettier-plugin-prisma`](http
 - **Default**: [`["properties"]`](./src/embedded/properties/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded Properties language. This option requires the `prettier-plugin-properties` plugin.
 
-##### ~~`embeddedPropertiesIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["properties"]`](./src/embedded/properties/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded Properties language. This option requires the `prettier-plugin-properties` plugin.
-
-Please use `embeddedPropertiesComments` or `embeddedPropertiesTags`.
-
-</details>
-
 Formatting embedded Properties language requires the [`prettier-plugin-properties`](https://github.com/eemeli/prettier-plugin-properties) plugin to be loaded as well. And [options](https://github.com/eemeli/prettier-plugin-properties#configuration) supported by `prettier-plugin-properties` can therefore be used to further control the formatting behavior.
 
 #### Pug
@@ -698,19 +522,6 @@ Formatting embedded Properties language requires the [`prettier-plugin-propertie
 - **Default**: [`["pug", "jade"]`](./src/embedded/pug/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded Pug language. This option requires the `@prettier/plugin-pug` plugin.
 
-##### ~~`embeddedPugIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["pug", "jade"]`](./src/embedded/pug/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded Pug language. This option requires the `@prettier/plugin-pug` plugin.
-
-Please use `embeddedPugComments` or `embeddedPugTags`.
-
-</details>
-
 Formatting embedded Pug language requires the [`@prettier/plugin-pug`](https://github.com/prettier/plugin-pug) plugin to be loaded as well. And [options](https://github.com/prettier/plugin-pug?tab=readme-ov-file#configuration) supported by `@prettier/plugin-pug` can therefore be used to further control the formatting behavior.
 
 #### Ruby
@@ -727,19 +538,6 @@ Formatting embedded Pug language requires the [`@prettier/plugin-pug`](https://g
 - **Default**: [`["ruby"]`](./src/embedded/ruby/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded Ruby language. This option requires the `@prettier/plugin-ruby` plugin.
 
-##### ~~`embeddedRubyIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["ruby"]`](./src/embedded/ruby/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded Ruby language. This option requires the `@prettier/plugin-ruby` plugin.
-
-Please use `embeddedRubyComments` or `embeddedRubyTags`.
-
-</details>
-
 ##### `embeddedRubyParser`
 
 - **Type**: [`"ruby" | "rbs" | "haml"`](./src/embedded/ruby/options.ts)
@@ -764,19 +562,6 @@ If you want to specify different parsers for different comments or tags, check [
 - **Default**: [`["sh"]`](./src/embedded/sh/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded Shell language. This option requires the `prettier-plugin-sh` plugin.
 
-##### ~~`embeddedShIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["sh"]`](./src/embedded/sh/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded Shell language. This option requires the `prettier-plugin-sh` plugin.
-
-Please use `embeddedShComments` or `embeddedShTags`.
-
-</details>
-
 Formatting embedded Shell language requires the [`prettier-plugin-sh`](https://github.com/un-ts/prettier/tree/master/packages/sh#readme) plugin to be loaded as well. And [options](https://github.com/un-ts/prettier/tree/master/packages/sh#parser-options) supported by `prettier-plugin-sh` can therefore be used to further control the formatting behavior.
 
 Note that `prettier-plugin-sh` supports different variants of shell syntaxes and they are specified by the [`variant` option](https://github.com/un-ts/prettier/tree/master/packages/sh#parser-options). If you want to specify different variants for different comments or tags, check [`embeddedOverrides`](#embeddedoverrides-1).
@@ -795,19 +580,6 @@ Note that `prettier-plugin-sh` supports different variants of shell syntaxes and
 - **Default**: [`["sql"]`](./src/embedded/sql/options.ts)
 - **Description**: Tags 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.
 
-##### ~~`embeddedSqlIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["sql"]`](./src/embedded/sql/options.ts)
-- **Description**: Comment or tag 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.
-
-Please use `embeddedSqlComments` or `embeddedSqlTags`.
-
-</details>
-
 ##### `embeddedSqlPlugin`
 
 - **Type**: [`"prettier-plugin-sql" | "prettier-plugin-sql-cst"`](./src/embedded/sql/options.ts)
@@ -838,19 +610,6 @@ Note that `prettier-plugin-sql` supports many different SQL dialects which are s
 - **Default**: [`["toml"]`](./src/embedded/toml/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded TOML language. This option requires the `prettier-plugin-toml` plugin.
 
-##### ~~`embeddedTomlIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["toml"]`](./src/embedded/toml/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded TOML language. This option requires the `prettier-plugin-toml` plugin.
-
-Please use `embeddedTomlComments` or `embeddedTomlTags`.
-
-</details>
-
 Formatting embedded TOML language requires the [`prettier-plugin-toml`](https://github.com/un-ts/prettier/tree/master/packages/toml#readme) plugin to be loaded as well. And [options](https://github.com/un-ts/prettier/blob/master/packages/toml/src/options.ts) supported by `prettier-plugin-toml` can therefore be used to further control the formatting behavior.
 
 #### TS (TypeScript)
@@ -867,26 +626,13 @@ Formatting embedded TOML language requires the [`prettier-plugin-toml`](https://
 - **Default**: [`["ts", "tsx", "cts", "mts", "typescript"]`](./src/embedded/ts/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded TypeScript language.
 
-##### ~~`embeddedTsIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["ts", "tsx", "cts", "mts", "typescript"]`](./src/embedded/ts/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded TypeScript language.
-
-Please use `embeddedTsComments` or `embeddedTsTags`.
-
-</details>
-
 ##### `embeddedTsParser`
 
 - **Type**: [`"typescript" | "babel-ts"`](./src/embedded/ts/options.ts)
 - **Default**: [`"typescript"`](./src/embedded/ts/options.ts)
 - **Description**: The parser used to parse the embedded TypeScript language.
 
-Formatting embedded TypeScript language doesn't require other plugins and uses the parsers and printers provided by Prettier natively.
+Embedded TypeScript uses the parsers and printers included with Prettier.
 
 If you want to specify different parsers for different comments or tags, check [`embeddedOverrides`](#embeddedoverrides-1).
 
@@ -904,20 +650,7 @@ If you want to specify different parsers for different comments or tags, check [
 - **Default**: [`["xml", "opml", "rss", "svg"]`](./src/embedded/xml/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded XML language. This option requires the `@prettier/plugin-xml` plugin.
 
-##### ~~`embeddedXmlIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["xml", "opml", "rss", "svg"]`](./src/embedded/xml/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded XML language. This option requires the `@prettier/plugin-xml` plugin.
-
-Please use `embeddedXmlComments` or `embeddedXmlTags`.
-
-</details>
-
-Formatting embedded XML language requires the [`@prettier/plugin-xml`](https://github.com/prettier/plugin-xml) plugin to be loaded as well. And [options](https://github.com/prettier/plugin-xml#configuration) supported by `@prettier/plugin-xml` can therefore be used to further control the formatting behavior.
+Embedded XML uses the parser provided by [`@prettier/plugin-xml`](https://github.com/prettier/plugin-xml), which must be loaded when XML formatting is enabled. Its [options](https://github.com/prettier/plugin-xml#configuration) control the XML formatting behavior.
 
 #### YAML
 
@@ -933,20 +666,7 @@ Formatting embedded XML language requires the [`@prettier/plugin-xml`](https://g
 - **Default**: [`["yaml", "yml"]`](./src/embedded/yaml/options.ts)
 - **Description**: Tags that make their subsequent template literals be identified as embedded YAML language.
 
-##### ~~`embeddedYamlIdentifiers`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: [`["yaml", "yml"]`](./src/embedded/yaml/options.ts)
-- **Description**: Comment or tag identifiers that make their subsequent template literals be identified as embedded YAML language.
-
-Please use `embeddedYamlComments` or `embeddedYamlTags`.
-
-</details>
-
-Formatting embedded YAML language doesn't require other plugins and uses the parsers and printers provided by Prettier natively.
+Embedded YAML uses the parsers and printers included with Prettier.
 
 </details>
 
@@ -954,32 +674,6 @@ Formatting embedded YAML language doesn't require other plugins and uses the par
 
 #### Language-Agnostic
 
-##### ~~`noEmbeddedIdentificationByComment`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: `[]`
-- **Description**: Turns off `` /* comment */ `...` `` comment-based embedded language identification for the specified identifiers.
-
-Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
-
-</details>
-
-##### ~~`noEmbeddedIdentificationByTag`~~
-
-<details>
-<summary>deprecated</summary>
-
-- **Type**: `string[]`
-- **Default**: `[]`
-- **Description**: Turns off `` tag`...` `` tag-based embedded language identification for the specified identifiers.
-
-Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
-
-</details>
-
 ##### `preserveEmbeddedExteriorWhitespaces`
 
 - **Type**: `string[]`
@@ -1002,11 +696,29 @@ Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure
 
 This option is provided for users to override certain options based on comments or tags. Due to the lack of support for using objects in prettier plugin options (https://github.com/prettier/prettier/issues/14671), it accepts a **stringified** json string, or a file path with an extension of `.json`, `.jsonc`, `.js`, `.cjs`, `.mjs`, `.ts`, `.cts` or `.mts` as its value. If no extension is provided, it will be treated as a `.json`/`.jsonc` file. For relative paths, it will automatically figure out the prettier config location and use that as the base path.
 
-> [!NOTE]
->
-> The support for using `.ts`, `.mts` or `.cts` files for `embeddedOverrides` requires a minimal `node` version of [18.19.0](https://nodejs.org/en/blog/release/v18.19.0#esm-and-customization-hook-changes), and [`tsx`](https://github.com/privatenumber/tsx) as a dependency in your project. And it currently doesn't work with the Prettier VSCode extension.
+TypeScript override files (`.ts`, `.mts` and `.cts`) are loaded with the active runtime's `import()`. Node.js with [native type stripping](https://nodejs.org/api/typescript.html) enabled can load erasable TypeScript, and Bun provides native TypeScript loading. The runtime determines module semantics: `.mts` uses ES modules, `.cts` uses CommonJS, and `.ts` follows the package's module type.
+
+Consumers can enable a compatible loader through Node.js startup options, such as `node --import tsx node_modules/prettier/bin/prettier.cjs . --write`. Override files are evaluated in workers, which inherit the runtime's startup preloads. Enable synchronous module hooks through a `--import` or `--require` preload so they are available in those workers. When the runtime reports unsupported module loading or TypeScript transformation, the plugin can use the consumer project's optional [`tsx`](https://github.com/privatenumber/tsx) 4.19+ installation as a fallback. This fallback uses Node.js's [`module.register()`](https://nodejs.org/api/module.html#moduleregisterspecifier-parenturl-options) API, introduced in Node.js 18.19 and 20.6. Configuration errors include their original diagnostics.
+
+The Prettier VS Code extension uses its bundled Node.js runtime; JavaScript override files provide the simplest editor setup.
+
+Each override module load uses a fresh worker and module cache, so edits to the override file and its imported modules are reflected in subsequent formatting calls. Workers are released after the configuration has been read. Relative paths follow Prettier's configuration discovery and its [`clearConfigCache()`](https://prettier.io/docs/api#prettierclearconfigcache) API.
+
+The resolved value should be an array of objects. Each object in the array must have 2 fields: `comments` and `options`, or `tags` and `options`. The `options` are considered overrides that will be applied to the global `options` of prettier for those `comments` and `tags` only. It's like the [`overrides`](https://prettier.io/docs/en/configuration.html#configuration-overrides) of `prettier`, but it is comment/tag-based instead of file-based.
+
+Per-tag overrides refer to the matching entry from `embedded<Language>Tags`, including the pattern string when a regular expression matches. The first matching override applies. For example, this JavaScript configuration gives embedded JavaScript selected by `query` its own quote style:
+
+```js
+export default {
+  plugins: ["prettier-plugin-embed"],
+  embeddedEsTags: ["/^query$/"],
+  embeddedOverrides: JSON.stringify([
+    { tags: ["/^query$/"], options: { singleQuote: true } },
+  ]),
+};
+```
 
-The resolved value should be an array of objects. Each object in the array must have 2 fields: `comments` and `options`, or `tags` and `options`. The `options` are considerred overrides that will be applied to the global `options` of prettier for those `comments` and `tags` only. It's like the [`overrides`](https://prettier.io/docs/en/configuration.html#configuration-overrides) of `prettier`, but it is comment/tag-based instead of file-based.
+Embedded parsers receive the override options. The resulting document is laid out with the surrounding JavaScript or TypeScript document, using the outer Prettier `printWidth`.
 
 In a json file, the root is the array of objects. In a JavaScript/TypeScript file, the array of objects should be a default export, or a named export with the name `embeddedOverrides`.
 
@@ -1031,7 +743,7 @@ An example `.json`/`.jsonc` file is:
 
 > [!CAUTION]
 >
-> Please note that not every option is supported to override. That largely depends on at which phase those options will kick in and take effect. For example, you can't override `tabWidth` in `embeddedOverrides` because this option is used in the [`printDocToString`](https://github.com/prettier/prettier/blob/7aecca5d6473d73f562ca3af874831315f8f2581/src/document/printer.js#L302) phase, where `prettier-plugin-embed` cannot override this option for only a set of specified comments or tags. To find the list of unsupported options, please check the interface definition of `EmbeddedOverride` in the [source code](https://github.com/Sec-ant/prettier-plugin-embed/blob/main/src/types.ts).
+> `embeddedOverrides` supports options applied during parsing and document generation. Options applied during final document printing, such as `tabWidth`, are configured globally. The [`EmbeddedOverride` interface](https://github.com/Sec-ant/prettier-plugin-embed/blob/main/src/types.ts) lists the supported override options.
 
 ### Typed Options