prettier-plugin-embed 0.0.6 → 0.1.0

package/README.md

@@ -1,5 +1,185 @@
-# prettier-plugin-embed
+<div align="center">
 
-A prettier plugin to format embedded languages in js/ts files.
+![prettier-plugin-embed-light](./public/prettier-plugin-embed-wide-light.svg#gh-light-mode-only)
+![prettier-plugin-embed-dark](./public/prettier-plugin-embed-wide-dark.svg#gh-dark-mode-only)
 
-🚧WIP🚧
+# Prettier Plugin Embed
+
+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
+```
+
+</div>
+
+## Introduction
+
+### 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.
+
+### Why?
+
+Although Prettier has introduced the [`embedded-language-formatting`](https://prettier.io/docs/en/options.html#embedded-language-formatting) option for formatting embedded languages, it only supports two modes: `auto` and `off`. Therefore it doesn't allow for individual formatting adjustments for specific languages, nor does it support customizing the languages that require formatting and identifiers for identification. These limitations restrict the usability of this feature. For more detailed discussions, refer to: https://github.com/prettier/prettier/issues/4424 and https://github.com/prettier/prettier/issues/5588.
+
+### 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.
+
+## Features
+
+- **Support for Additional Languages:** Extend the embedded language formatting capability to include languages such as XML, SQL, PHP, and more.
+
+- **Dual Identification Modes:** Identify embedded languages by tags `` identifier`...` `` or comments `` /* identifier */ `...` `` preceding the template literals.
+
+- **Customizable Language Identifiers:** Customize the identifiers used for identifying the embedded languages.
+
+- **Formatting Opt-out Mechanism:** Offer the capability to deactivate formatting for certain identifiers, including the default ones (`html`, `css`...) supported by the `embedded-language-formatting` option.
+
+- **Configurable Formatting Style:** Provide additional options to tailor the formatting style for embedded languages.
+
+- **Strongly Typed API:** Benefit from comprehensive type support for configuring this plugin's options when employing the [Prettier API](https://prettier.io/docs/en/api) in TypeScript.
+
+- **Easy Integration:** Integrate with the existing Prettier setup seamlessly, requiring minimal configuration to get started.
+
+## Installation
+
+```bash
+npm i -D prettier-plugin-embed
+```
+
+## Usage
+
+### Getting Started
+
+This is a Prettier plugin, which follows the [standard usage pattern](https://prettier.io/docs/en/plugins.html#using-plugins) of many other Prettier plugins:
+
+#### [CLI](https://prettier.io/docs/en/cli):
+
+Via `--plugin`:
+
+```bash
+prettier --write main.ts --plugin=prettier-plugin-embed
+```
+
+#### [API](https://prettier.io/docs/en/api):
+
+Via the `plugins` options:
+
+```ts
+await prettier.format(code, {
+  filepath: "main.ts",
+  plugins: ["prettier-plugin-embed"],
+});
+```
+
+#### [Configuration File](https://prettier.io/docs/en/configuration):
+
+```json
+{
+  "plugins": ["prettier-plugin-embed"]
+}
+```
+
+### An Overview of the Philosophy
+
+To use this plugin, `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.
+
+This plugin does not aim to implement parsers or printers to support every newly added embedded language. Instead, ideally, it makes use of existing [Prettier plugins](https://prettier.io/docs/en/plugins.html#official-plugins) for those languages and only adds formatting support when they are embedded.
+
+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 code, 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.
+
+Embedded languages to be formatted are required to be enclosed in the template literals, and are identified by the preceding [tags](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates) `` identifier`...` `` or block comments `` /* identifier */ `...` ``. This plugin comes pre-configured with a built-in set of identifiers for identifying various embedded languages. For instance, using identifiers like `xml` or `svg` will trigger automatic formatting for the embedded XML code. You can specify an alternative list of identifiers using the `embeddedXML` option. The naming convention for these options follows the pattern of `embedded{CapitalizedLanguageName}` 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.
+
+To exclude certain identifiers from being identified, including the default ones supported by the `embedded-language-formatting` option, add them to the list of the `embeddedNoop` option. Any matching identifiers listed in this option will take precedence over other `embedded{CapitalizedLanguageName}` options, effectively disabling their formatting.
+
+### Language-Specific Options
+
+<details>
+<summary>
+Click Here
+</summary>
+
+#### NOOP
+
+|     Option     | Default | Description                                                                                                                                     |
+| :------------: | :-----: | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| `embeddedNoop` |  `[]`   | Tag or comment identifiers that prevent their subsequent template literals from being identified as embedded languages and from being formatted |
+
+This doesn't require other plugins and can override the native embedded language formatting for ECMAScript code. It serves as a way to turn off embedded language formatting for specific language identifiers.
+
+#### ES
+
+|       Option       |                  Default                  | Description                                                                                                           |
+| :----------------: | :---------------------------------------: | --------------------------------------------------------------------------------------------------------------------- |
+|    `embeddedEs`    |  [`[...]`](./src/embedded/es/options.ts)  | Tag or comment identifiers that make their subsequent template literals be identified as ECMAScript (JavaScript) code |
+| `embeddedEsParser` | [`"babel"`](./src/embedded/es/options.ts) | The parser used to parse the ECMASCript (JavaScript) code                                                             |
+
+Formatting embedded ECMAScript code doesn't require other plugins and uses the parsers and printers provided by Prettier natively. This can override the native embedded language formatting for ECMAScript code.
+
+#### HTML
+
+|     Option     |                  Default                  | Description                                                                                                           |
+| :------------: | :---------------------------------------: | --------------------------------------------------------------------------------------------------------------------- |
+| `embeddedHtml` | [`[...]`](./src/embedded/html/options.ts) | Tag or comment identifiers that make their subsequent template literals be identified as ECMAScript (JavaScript) code |
+
+Formatting embedded HTML code doesn't require other plugins and uses the parsers and printers provided by Prettier natively. This can override the native embedded language formatting for HTML code.
+
+#### PHP
+
+|    Option     |                 Default                  | Description                                                                                       |
+| :-----------: | :--------------------------------------: | ------------------------------------------------------------------------------------------------- |
+| `embeddedPhp` | [`[...]`](./src/embedded/php/options.ts) | Tag or comment identifiers that make their subsequent template literals be identified as PHP code |
+
+Formatting embedded PHP code requires [`@prettier/plugin-php`](https://github.com/prettier/plugin-php) 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.
+
+#### SQL
+
+|    Option     |                 Default                  | Description                                                                                       |
+| :-----------: | :--------------------------------------: | ------------------------------------------------------------------------------------------------- |
+| `embeddedSql` | [`[...]`](./src/embedded/sql/options.ts) | Tag or comment identifiers that make their subsequent template literals be identified as SQL code |
+
+Formatting embedded SQL code requires [`prettier-plugin-sql`](https://github.com/un-ts/prettier/tree/master/packages/sql#readme) to be loaded as well. And [options](https://github.com/un-ts/prettier/tree/master/packages/sql#parser-options) supported by `prettier-plugin-sql` can therefore be used to further control the formatting behavior.
+
+Note that `prettier-plugin-sql` supports many different SQL dialects, and there's a one-to-one correspondence between the dialects and the identifiers. To support custom identifiers for a specific dialect, put the identifiers after that specific dialect in the identifier list in option `embeddedSql`.
+
+#### TS
+
+|       Option       |                    Default                     | Description                                                                                              |
+| :----------------: | :--------------------------------------------: | -------------------------------------------------------------------------------------------------------- |
+|    `embeddedTs`    |    [`[...]`](./src/embedded/ts/options.ts)     | Tag or comment identifiers that make their subsequent template literals be identified as TypeScript code |
+| `embeddedTsParser` | [`"typescript"`](./src/embedded/ts/options.ts) | The parser used to parse the TypeScript code                                                             |
+
+Formatting embedded TypeScript code doesn't require other plugins and uses the parsers and printers provided by Prettier natively. This can override the native embedded language formatting for TypeScript code.
+
+#### XML
+
+|    Option     |                 Default                  | Description                                                                                       |
+| :-----------: | :--------------------------------------: | ------------------------------------------------------------------------------------------------- |
+| `embeddedXml` | [`[...]`](./src/embedded/xml/options.ts) | Tag or comment identifiers that make their subsequent template literals be identified as XML code |
+
+Formatting embedded XML code requires [`@prettier/plugin-xml`](https://github.com/prettier/plugin-xml) 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.
+
+</details>
+
+### Language-Agnostic Options
+
+|                Option                 | Default | Description                                                                                                                     |
+| :-----------------------------------: | :-----: | ------------------------------------------------------------------------------------------------------------------------------- |
+|  `noEmbeddedIdentificationByComment`  |  `[]`   | Turns off `` /* identifier */ `...` `` comment-based language identification for the specified identifiers                      |
+|    `noEmbeddedIdentificationByTag`    |  `[]`   | Turns off `` identifier`...` `` tag-based language identification for the specified identifiers                                 |
+| `preserveEmbeddedExteriorWhitespaces` |  `[]`   | Preserves leading and trailing whitespaces in the formatting results for the specified identifiers                              |
+|   `noEmbeddedMultiLineIndentation`    |  `[]`   | Tsurns off auto indentation in the formatting results for the specified identifiers when they are formatted to span multi lines |
+
+## Demos
+
+TBD.
+
+## Contributing
+
+To add support for new languages, create a new directory named after the language within the [`src/embedded`](./src/embedded) directory. Then, export the required variables in the `index.ts` file. Check the existing directories for guidance.
+
+## License
+
+MIT

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

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

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

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

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

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

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

@@ -0,0 +1,44 @@
+import { embeddedLanguage } from "./embedded-language.js";
+import type { MakeIdentifiersType, MakeIdentifiersHolderType } from "../utils.js";
+declare const DEFAULT_IDENTIFIERS: readonly ["js", "es", "es6", "mjs", "cjs", "pac", "javascript"];
+type Identifiers = MakeIdentifiersType<typeof DEFAULT_IDENTIFIERS>;
+type DefaultIdentifiersHolder = MakeIdentifiersHolderType<typeof DEFAULT_IDENTIFIERS>;
+declare const DEFAULT_ES_PARSERS: readonly ["babel", "babel-flow", "acorn", "espree", "flow", "meriyah"];
+type EsParser = (typeof DEFAULT_ES_PARSERS)[number];
+declare const EMBEDDED_ES_PARSER = "embeddedEsParser";
+export interface PrettierPluginDepsOptions {
+}
+export declare const options: {
+    embeddedEs: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("js" | "es" | "es6" | "mjs" | "cjs" | "pac" | "javascript")[];
+        }[];
+        description: string;
+    };
+    embeddedEsParser: {
+        category: "Global";
+        type: "string";
+        array: false;
+        default: string;
+        description: string;
+    };
+};
+type Options = typeof options;
+declare module "../types.js" {
+    interface EmbeddedOptions extends Options {
+    }
+    interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
+    }
+    interface PrettierPluginEmbedOptions {
+        [embeddedLanguage]?: Identifiers;
+        [EMBEDDED_ES_PARSER]?: EsParser;
+    }
+}
+declare module "prettier" {
+    interface Options extends PrettierPluginDepsOptions {
+    }
+}
+export {};

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

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

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

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

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

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

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

@@ -0,0 +1,33 @@
+import { embeddedLanguage } from "./embedded-language.js";
+import type { MakeIdentifiersType, MakeIdentifiersHolderType } from "../utils.js";
+declare const DEFAULT_IDENTIFIERS: readonly ["html", "htm", "shtml", "xhtml", "xht", "mdoc", "jsp", "asp", "aspx", "jshtm", "volt", "rhtml"];
+type Identifiers = MakeIdentifiersType<typeof DEFAULT_IDENTIFIERS>;
+type DefaultIdentifiersHolder = MakeIdentifiersHolderType<typeof DEFAULT_IDENTIFIERS>;
+export interface PrettierPluginDepsOptions {
+}
+export declare const options: {
+    embeddedHtml: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("html" | "htm" | "shtml" | "xhtml" | "xht" | "mdoc" | "jsp" | "asp" | "aspx" | "jshtm" | "volt" | "rhtml")[];
+        }[];
+        description: string;
+    };
+};
+type Options = typeof options;
+declare module "../types.js" {
+    interface EmbeddedOptions extends Options {
+    }
+    interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
+    }
+    interface PrettierPluginEmbedOptions {
+        [embeddedLanguage]?: Identifiers;
+    }
+}
+declare module "prettier" {
+    interface Options extends PrettierPluginDepsOptions {
+    }
+}
+export {};

package/dist/embedded/index.d.ts

@@ -1,2 +1,2 @@
 export * from "./register.js";
-export type { EmbeddedName, EmbeddedParsers, EmbeddedEmbedders, EmbeddedOptions, PrettierPluginEmbedOptions, } from "./types.js";
+export type { EmbeddedLanguage, EmbeddedParsers, EmbeddedEmbedders, EmbeddedOptions, EmbeddedDefaultIdentifier, PrettierPluginEmbedOptions, } from "./types.js";

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

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

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

@@ -1,2 +1,2 @@
-export * from "./name.js";
-export * from "./option.js";
+export * from "./embedded-language.js";
+export * from "./options.js";

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

@@ -0,0 +1,21 @@
+import { embeddedLanguage } from "./embedded-language.js";
+export declare const options: {
+    embeddedNoop: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: never[];
+        }[];
+        description: string;
+    };
+};
+type Options = typeof options;
+declare module "../types.js" {
+    interface EmbeddedOptions extends Options {
+    }
+    interface PrettierPluginEmbedOptions {
+        [embeddedLanguage]?: string[];
+    }
+}
+export {};

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

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

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

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

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

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

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

@@ -0,0 +1,36 @@
+import { embeddedLanguage } from "./embedded-language.js";
+import type { MakeIdentifiersType, MakeIdentifiersHolderType } from "../utils.js";
+declare const DEFAULT_IDENTIFIERS: readonly ["php", "php5", "phtml", "ctp"];
+type Identifiers = MakeIdentifiersType<typeof DEFAULT_IDENTIFIERS>;
+type DefaultIdentifiersHolder = MakeIdentifiersHolderType<typeof DEFAULT_IDENTIFIERS>;
+export declare const options: {
+    embeddedPhp: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("php" | "php5" | "phtml" | "ctp")[];
+        }[];
+        description: string;
+    };
+};
+type Options = typeof options;
+export interface PrettierPluginDepsOptions {
+    phpVersion?: "5.0" | "5.1" | "5.2" | "5.3" | "5.4" | "5.5" | "5.6" | "7.0" | "7.1" | "7.2" | "7.3" | "7.4" | "8.0" | "8.1" | "8.2";
+    trailingCommaPHP?: boolean;
+    braceStyle?: "psr-2" | "per-cs" | "1tbs";
+}
+declare module "../types.js" {
+    interface EmbeddedOptions extends Options {
+    }
+    interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
+    }
+    interface PrettierPluginEmbedOptions {
+        [embeddedLanguage]?: Identifiers;
+    }
+}
+declare module "prettier" {
+    interface Options extends PrettierPluginDepsOptions {
+    }
+}
+export {};

package/dist/embedded/register.d.ts

@@ -1,9 +1,12 @@
-import type { EmbeddedEmbedders, EmbeddedName, EmbeddedParsers, EmbeddedOptions } from "./types.js";
-export declare const embeddedNames: EmbeddedName[];
+import type { EmbeddedEmbedders, EmbeddedLanguage, EmbeddedParsers, EmbeddedOptions } from "./types.js";
+export declare const embeddedLanguages: EmbeddedLanguage[];
 export declare const embeddedParsers: EmbeddedParsers;
 export declare const embeddedEmbedders: EmbeddedEmbedders;
 export declare const embeddedOptions: EmbeddedOptions;
-import * as __glob__0_0 from "./noop/index.js";
-import * as __glob__0_1 from "./php/index.js";
-import * as __glob__0_2 from "./sql/index.js";
-import * as __glob__0_3 from "./xml/index.js";
+import * as __glob__0_0 from "./es/index.js";
+import * as __glob__0_1 from "./html/index.js";
+import * as __glob__0_2 from "./noop/index.js";
+import * as __glob__0_3 from "./php/index.js";
+import * as __glob__0_4 from "./sql/index.js";
+import * as __glob__0_5 from "./ts/index.js";
+import * as __glob__0_6 from "./xml/index.js";

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

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

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

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

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

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

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

@@ -0,0 +1,35 @@
+import type { SqlBaseOptions as PrettierPluginDepsOptions } from "prettier-plugin-sql";
+import { embeddedLanguage } from "./embedded-language.js";
+import { MakeIdentifiersType, MakeIdentifiersHolderType } from "../utils.js";
+export declare const SQL_FORMATTER_LANGUAGES: readonly ["sql", "bigquery", "hive", "mariadb", "mysql", "postgresql", "db2", "plsql", "n1ql", "redshift", "singlestoredb", "spark", "sqlite", "transactsql", "tsql", "trino"];
+export declare const NODE_SQL_PARSER_DATABASES: readonly ["bigquery", "db2", "hive", "mariadb", "mysql", "postgresql", "transactsql", "flinksql"];
+type Identifiers = MakeIdentifiersType<typeof SQL_FORMATTER_LANGUAGES | typeof NODE_SQL_PARSER_DATABASES>;
+type DefaultIdentifiersHolder = MakeIdentifiersHolderType<typeof SQL_FORMATTER_LANGUAGES | typeof NODE_SQL_PARSER_DATABASES>;
+export type SqlFormatterLanguage = (typeof SQL_FORMATTER_LANGUAGES)[number];
+export type NodeSqlParserDataBase = (typeof NODE_SQL_PARSER_DATABASES)[number];
+export { PrettierPluginDepsOptions };
+export declare const options: {
+    embeddedSql: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("sql" | "bigquery" | "hive" | "mariadb" | "mysql" | "postgresql" | "db2" | "plsql" | "n1ql" | "redshift" | "singlestoredb" | "spark" | "sqlite" | "transactsql" | "tsql" | "trino")[];
+        }[];
+        description: string;
+    };
+};
+type Options = typeof options;
+declare module "../types.js" {
+    interface EmbeddedOptions extends Options {
+    }
+    interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
+    }
+    interface PrettierPluginEmbedOptions {
+        [embeddedLanguage]?: Identifiers;
+    }
+}
+declare module "prettier" {
+    interface Options extends PrettierPluginDepsOptions {
+    }
+}

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

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

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

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

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

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

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

@@ -0,0 +1,44 @@
+import { embeddedLanguage } from "./embedded-language.js";
+import type { MakeIdentifiersType, MakeIdentifiersHolderType } from "../utils.js";
+declare const DEFAULT_IDENTIFIERS: readonly ["ts", "cts", "mts", "typescript"];
+type Identifiers = MakeIdentifiersType<typeof DEFAULT_IDENTIFIERS>;
+type DefaultIdentifiersHolder = MakeIdentifiersHolderType<typeof DEFAULT_IDENTIFIERS>;
+declare const DEFAULT_TS_PARSERS: readonly ["typescript", "babel-ts"];
+type TsParser = (typeof DEFAULT_TS_PARSERS)[number];
+declare const EMBEDDED_TS_PARSER = "embeddedTsParser";
+export interface PrettierPluginDepsOptions {
+}
+export declare const options: {
+    embeddedTs: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("ts" | "cts" | "mts" | "typescript")[];
+        }[];
+        description: string;
+    };
+    embeddedTsParser: {
+        category: "Global";
+        type: "string";
+        array: false;
+        default: string;
+        description: string;
+    };
+};
+type Options = typeof options;
+declare module "../types.js" {
+    interface EmbeddedOptions extends Options {
+    }
+    interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
+    }
+    interface PrettierPluginEmbedOptions {
+        [embeddedLanguage]?: Identifiers;
+        [EMBEDDED_TS_PARSER]?: TsParser;
+    }
+}
+declare module "prettier" {
+    interface Options extends PrettierPluginDepsOptions {
+    }
+}
+export {};

package/dist/embedded/types.d.ts

@@ -1,18 +1,19 @@
 import type { Parser, SupportOption, Options } from "prettier";
 import type { Embedder } from "../types.js";
-type EmbeddedNameConvention = `embedded${string}`;
-export interface EmbeddedParsers {
-    [name: EmbeddedNameConvention]: Parser | undefined;
+import type { Satisfies } from "./utils.js";
+type EmbeddedLanguageNamingConvention = `embedded${Capitalize<string>}`;
+export interface EmbeddedParsers extends Record<EmbeddedLanguageNamingConvention, Parser | undefined> {
 }
-export interface EmbeddedEmbedders {
-    [name: EmbeddedNameConvention]: Embedder<Options> | undefined;
+export interface EmbeddedEmbedders extends Record<EmbeddedLanguageNamingConvention, Embedder<Options> | undefined> {
 }
-export interface EmbeddedOptions {
-    [name: EmbeddedNameConvention]: SupportOption | undefined;
+export interface EmbeddedOptions extends Record<EmbeddedLanguageNamingConvention, SupportOption | undefined> {
 }
-export interface EmbeddedNamesHolder {
+export interface EmbeddedLanguagesHolder {
 }
-export type EmbeddedName = keyof EmbeddedNamesHolder;
+export type EmbeddedLanguage = Satisfies<EmbeddedLanguageNamingConvention, keyof EmbeddedLanguagesHolder>;
+export interface EmbeddedDefaultIdentifiersHolder {
+}
+export type EmbeddedDefaultIdentifier = keyof EmbeddedDefaultIdentifiersHolder;
 export interface PrettierPluginEmbedOptions {
 }
 declare module "prettier" {

package/dist/embedded/utils.d.ts

@@ -1,11 +1,22 @@
 import type { Expression, Comment, TemplateLiteral } from "estree";
-import type { AstPath, Options } from "prettier";
+import type { AstPath, Options, Doc } from "prettier";
 import { builders } from "prettier/doc";
 import type { InternalPrintFun } from "../types.js";
 export declare function printTemplateExpression(path: AstPath<Expression & {
     comments?: Comment[];
 }>, print: InternalPrintFun): builders.Doc[];
 export declare function printTemplateExpressions(path: AstPath<TemplateLiteral>, print: InternalPrintFun): builders.Doc[][];
-export declare function throwIfPluginIsNotFound(pluginName: string, options: Options, lang: string): void;
-export declare function insertEmbeddedLanguageName(names: string[], name: string, headName: string): void;
-export declare function uuidV4(): string;
+export declare function simpleRehydrateDoc(doc: Doc, placeholderRegex: RegExp, expressionDocs: Doc[]): builders.Doc[] | builders.DocCommand;
+export declare function throwIfPluginIsNotFound(pluginName: string, options: Options, identifier: string): void;
+export declare function insertEmbeddedLanguage(embeddedLanguages: string[], embeddedLanguage: string, firstEmbeddedLanguage: string): void;
+export declare const randomUUID: (uuidLength?: number | undefined) => string;
+export declare function preparePlaceholder(leading?: string, trailing?: string): {
+    createPlaceholder: (index: number) => string;
+    placeholderRegex: RegExp;
+};
+export declare function escapeRegExp(text: string): string;
+export type MakeIdentifiersType<T extends readonly string[]> = (T[number][] & string[]) | string[];
+export type MakeIdentifiersHolderType<T extends readonly string[]> = {
+    [key in T[number]]: void;
+};
+export type Satisfies<U, T extends U> = T;