prettier-plugin-embed 0.3.0 → 0.3.2

package/README.md

@@ -85,6 +85,10 @@ await prettier.format(code, {
 }
 ```
 
+### 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.
+
 ### 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.
@@ -97,6 +101,8 @@ Embedded languages to be formatted are required to be enclosed in the template l
 
 To exclude certain identifiers from being identified, including 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 `embeddedNoopIdentifiers` option. Any matching identifiers listed in this option will take precedence over other `embedded<Language>Identifiers` options, effectively disabling their formatting.
 
+**Important: Until this notice is removed, always specify identifiers explicitly and do not rely on the built-in defaults, as they may be subject to change.**
+
 ### Language-Specific Options
 
 <details>
@@ -129,6 +135,14 @@ Formatting embedded CSS code doesn't require other plugins and uses the parsers
 
 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.
 
+#### GLSL
+
+|          Option           |                  Default                  | Description                                                                                        |
+| :-----------------------: | :---------------------------------------: | -------------------------------------------------------------------------------------------------- |
+| `embeddedGlslIdentifiers` | [`[...]`](./src/embedded/glsl/options.ts) | Tag or comment identifiers that make their subsequent template literals be identified as GLSL code |
+
+Formatting embedded GLSL code requires [`prettier-plugin-glsl`](https://github.com/NaridaL/glsl-language-toolkit/tree/main/packages/prettier-plugin-glsl) to be loaded as well.
+
 #### HTML
 
 |          Option           |                  Default                  | Description                                                                                        |
@@ -230,10 +244,6 @@ An example `.json` file is:
 
 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 identifiers. 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).
 
-## Demos
-
-TBD.
-
 ## Contributing
 
 Bug fixes, new language support and tests are welcome. Please have a look at the project structure before getting started. Feel free to leave questions or suggestions.

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

@@ -6,7 +6,7 @@ import { type AutocompleteStringList, type StringListToInterfaceKey } from "../u
 declare const DEFAULT_IDENTIFIERS: readonly ["css"];
 type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
 type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
-declare const embeddedLanguageIdentifiersOptionName: "embeddedCssIdentifiers";
+declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedCssIdentifiers";
 export interface PrettierPluginDepsOptions {
 }
 export declare const options: {
@@ -27,7 +27,7 @@ declare module "../types.js" {
     interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
     }
     interface PrettierPluginEmbedOptions {
-        [embeddedLanguageIdentifiersOptionName]?: Identifiers;
+        [EMBEDDED_LANGUAGE_IDENTIFIERS]?: Identifiers;
     }
 }
 declare module "prettier" {

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

@@ -8,8 +8,8 @@ type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
 type DefaultIdentifiersHolder = StringListToInterfaceKey<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 embeddedLanguageIdentifiersOptionName: "embeddedEsIdentifiers";
-declare const embeddedLanguageParserOptionName: "embeddedEsParser";
+declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedEsIdentifiers";
+declare const EMBEDDED_LANGUAGE_PARSER: "embeddedEsParser";
 export interface PrettierPluginDepsOptions {
 }
 export declare const options: {
@@ -37,8 +37,8 @@ declare module "../types.js" {
     interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
     }
     interface PrettierPluginEmbedOptions {
-        [embeddedLanguageIdentifiersOptionName]?: Identifiers;
-        [embeddedLanguageParserOptionName]?: EsParser;
+        [EMBEDDED_LANGUAGE_IDENTIFIERS]?: Identifiers;
+        [EMBEDDED_LANGUAGE_PARSER]?: EsParser;
     }
 }
 declare module "prettier" {

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

@@ -6,7 +6,7 @@ import { type AutocompleteStringList, type StringListToInterfaceKey } from "../u
 declare const DEFAULT_IDENTIFIERS: readonly ["md", "livemd", "markdown", "mdown", "mdwn", "mkd", "mkdn", "mkdown", "ronn", "scd", "workbook"];
 type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
 type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
-declare const embeddedLanguageIdentifiersOptionName: "embeddedMarkdownIdentifiers";
+declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedMarkdownIdentifiers";
 export interface PrettierPluginDepsOptions {
     __inJsTemplate?: boolean;
 }
@@ -28,7 +28,7 @@ declare module "../types.js" {
     interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
     }
     interface PrettierPluginEmbedOptions {
-        [embeddedLanguageIdentifiersOptionName]?: Identifiers;
+        [EMBEDDED_LANGUAGE_IDENTIFIERS]?: Identifiers;
     }
 }
 declare module "prettier" {

package/dist/embedded/register.d.ts

@@ -4,8 +4,8 @@ export declare const embeddedParsers: EmbeddedParsers;
 export declare const embeddedEmbedders: EmbeddedEmbedders;
 export declare const embeddedOptions: EmbeddedOptions;
 import * as __glob__0_0 from "./css/index.js";
-import * as __glob__0_1 from "./glsl/index.js";
-import * as __glob__0_2 from "./html/index.js";
+import * as __glob__0_1 from "./html/index.js";
+import * as __glob__0_2 from "./glsl/index.js";
 import * as __glob__0_3 from "./es/index.js";
 import * as __glob__0_4 from "./markdown/index.js";
 import * as __glob__0_5 from "./noop/index.js";

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

@@ -1,14 +1,12 @@
 import type { SqlBaseOptions as PrettierPluginDepsOptions } from "prettier-plugin-sql";
 import { type AutocompleteStringList, type StringListToInterfaceKey } from "../utils.js";
 /** References
- * - https://github.com/un-ts/prettier/blob/a5f1aae6464aa54749377d69a8237a70a6509a13/packages/sql/src/index.ts
+ * - https://github.com/un-ts/prettier/blob/master/packages/sql/src/index.ts
+ * "sql" is the default dialect, so we only have "sql" as the default identifier to avoid confusion.
  */
-export declare const SQL_FORMATTER_LANGUAGES: readonly ["sql", "bigquery", "db2", "db2i", "hive", "mariadb", "mysql", "n1ql", "postgresql", "plsql", "redshift", "singlestoredb", "snowflake", "spark", "sqlite", "transactsql", "tsql", "trino"];
-export declare const NODE_SQL_PARSER_DATABASES: readonly ["bigquery", "db2", "hive", "mariadb", "mysql", "postgresql", "transactsql", "flinksql", "snowflake"];
-type Identifiers = AutocompleteStringList<typeof SQL_FORMATTER_LANGUAGES | typeof NODE_SQL_PARSER_DATABASES>;
-type DefaultIdentifiersHolder = StringListToInterfaceKey<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];
+declare const DEFAULT_IDENTIFIERS: readonly ["sql"];
+type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
+type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
 declare const embeddedLanguageIdentifiers: "embeddedSqlIdentifiers";
 export { PrettierPluginDepsOptions };
 export declare const options: {
@@ -17,7 +15,7 @@ export declare const options: {
         type: "string";
         array: true;
         default: {
-            value: string[];
+            value: "sql"[];
         }[];
         description: string;
     };

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

@@ -8,8 +8,8 @@ type Identifiers = AutocompleteStringList<typeof DEFAULT_IDENTIFIERS>;
 type DefaultIdentifiersHolder = StringListToInterfaceKey<typeof DEFAULT_IDENTIFIERS>;
 declare const DEFAULT_TS_PARSERS: readonly ["typescript", "babel-ts"];
 type TsParser = (typeof DEFAULT_TS_PARSERS)[number];
-declare const EMBEDDED_LANGUAGE_PARSER = "embeddedTsParser";
-declare const embeddedLanguageIdentifiers: "embeddedTsIdentifiers";
+declare const EMBEDDED_LANGUAGE_PARSER: "embeddedTsParser";
+declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedTsIdentifiers";
 export interface PrettierPluginDepsOptions {
 }
 export declare const options: {
@@ -37,7 +37,7 @@ declare module "../types.js" {
     interface EmbeddedDefaultIdentifiersHolder extends DefaultIdentifiersHolder {
     }
     interface PrettierPluginEmbedOptions {
-        [embeddedLanguageIdentifiers]?: Identifiers;
+        [EMBEDDED_LANGUAGE_IDENTIFIERS]?: Identifiers;
         [EMBEDDED_LANGUAGE_PARSER]?: TsParser;
     }
 }