prettier-plugin-embed 0.2.5 → 0.3.0-rc.1

package/README.md

@@ -1,10 +1,12 @@
 <div align="center">
 
-![prettier-plugin-embed-light](./public/prettier-plugin-embed-wide-light.svg)
+![prettier-plugin-embed-light](./asset/prettier-plugin-embed-wide-light.svg)
 
 # Prettier Plugin Embed
 
-[![npm](https://img.shields.io/npm/v/prettier-plugin-embed)](https://www.npmjs.com/package/prettier-plugin-embed/v/latest) [![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/prettier-plugin-embed)](https://www.npmjs.com/package/prettier-plugin-embed/v/latest) [![jsDelivr hits (npm scoped)](https://img.shields.io/jsdelivr/npm/hm/prettier-plugin-embed?color=%23ff5627)](https://cdn.jsdelivr.net/npm/prettier-plugin-embed@latest/)
+[![npm version](https://badgen.net/npm/v/prettier-plugin-embed?cache=300)](https://www.npmjs.com/package/prettier-plugin-embed/v/latest) [![npm downloads](https://badgen.net/npm/dm/prettier-plugin-embed?cache=300)](https://www.npmjs.com/package/prettier-plugin-embed/v/latest) [![npm license](https://badgen.net/npm/license/prettier-plugin-embed?cache=300)](https://www.npmjs.com/package/prettier-plugin-embed/v/latest)
+
+[![github last commit](https://badgen.net/github/last-commit/Sec-ant/prettier-plugin-embed?cache=300)](https://github.com/Sec-ant/prettier-plugin-embed) [![bundlephobia minzipped](https://badgen.net/bundlephobia/minzip/prettier-plugin-embed?cache=300)](https://bundlephobia.com/package/prettier-plugin-embed@latest) [![](https://data.jsdelivr.com/v1/package/npm/prettier-plugin-embed/badge?style=rounded)](https://www.jsdelivr.com/package/npm/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.
 
@@ -181,7 +183,7 @@ Formatting embedded Ruby code requires [`@prettier/plugin-ruby`](https://github.
 
 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 `embeddedSqlIdentifiers`.
+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 `embeddedSqlIdentifiers`, or use [`embeddedOverrides`](#embeddedoverrides).
 
 #### TS
 
@@ -204,12 +206,42 @@ Formatting embedded XML code requires [`@prettier/plugin-xml`](https://github.co
 
 ### 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`    |  `[]`   | Turns off auto indentation in the formatting results when they are formatted to span multi lines for the specified identifiers |
+|                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`    |    `[]`     | Turns off auto indentation in the formatting results when they are formatted to span multi lines for the specified identifiers                            |
+|          `embeddedOverrides`          | `undefined` | Option overrides for the specified identifiers. This option accepts a string if not undefined. See [below](#embeddedoverrides) for a detailed explanation |
+
+#### `embeddedOverrides`
+
+This option is provided for users to override certain options based on identifiers. 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` or `.js` or `.cjs` or `.mjs` as its value. If no extension is provided, it will be treated as a `.json` file. For relative paths, it will automatically figure out the prettier config location and use that as the base path.
+
+The resolved value should be an array of objects. Each object in the array must have 2 fields: `identifiers` and `options`. The `options` are considerred overrides that will be applied to the global `options` of prettier for those `idenfitiers` only. It's like the [`overrides`](https://prettier.io/docs/en/configuration.html#configuration-overrides) of `prettier`, but it is identifier-based instead of file-based.
+
+In a json file, the root is the array of objects. In a javascript file, the array of objects should be a default export, or a named export with the name `embeddedOverrides`.
+
+An example `.json` file is:
+
+```json
+[
+  {
+    "identifiers": ["sql"],
+    "options": {
+      "keywordCase": "lower"
+    }
+  },
+  {
+    "identifiers": ["mysql"],
+    "options": {
+      "keywordCase": "upper"
+    }
+  }
+]
+```
+
+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
 

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

@@ -1,4 +1,4 @@
-import { type Options } from "prettier";
+import type { Options } from "prettier";
 import type { Embedder } from "../../types.js";
 import { embeddedLanguage } from "./embedded-language.js";
 export declare const embedder: Embedder<Options>;

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

@@ -1,4 +1,4 @@
-import { type Options } from "prettier";
+import type { Options } from "prettier";
 import type { Embedder } from "../../types.js";
 import { embeddedLanguage } from "./embedded-language.js";
 export declare const embedder: Embedder<Options>;

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

@@ -1,4 +1,4 @@
-import { type Options } from "prettier";
+import type { Options } from "prettier";
 import type { Embedder } from "../../types.js";
 import { embeddedLanguage } from "./embedded-language.js";
 export declare const embedder: Embedder<Options>;

package/dist/embedded/index.d.ts

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

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

@@ -1,5 +1,5 @@
-import { type AutocompleteStringList } from "../utils.js";
 import type { EmbeddedDefaultIdentifier } from "../types.js";
+import { type AutocompleteStringList } from "../utils.js";
 type EmbeddedIdentifiers = AutocompleteStringList<EmbeddedDefaultIdentifier[]>;
 declare const embeddedLanguageIdentifiers: "embeddedNoopIdentifiers";
 export declare const options: {

package/dist/embedded/register.d.ts

@@ -1,15 +1,15 @@
-import type { EmbeddedEmbedders, EmbeddedLanguage, EmbeddedParsers, EmbeddedOptions } from "./types.js";
+import type { EmbeddedEmbedders, EmbeddedLanguage, EmbeddedOptions, EmbeddedParsers } 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 "./css/index.js";
-import * as __glob__0_1 from "./es/index.js";
-import * as __glob__0_2 from "./html/index.js";
-import * as __glob__0_3 from "./glsl/index.js";
-import * as __glob__0_4 from "./markdown/index.js";
-import * as __glob__0_5 from "./php/index.js";
-import * as __glob__0_6 from "./noop/index.js";
+import * as __glob__0_1 from "./glsl/index.js";
+import * as __glob__0_2 from "./markdown/index.js";
+import * as __glob__0_3 from "./noop/index.js";
+import * as __glob__0_4 from "./es/index.js";
+import * as __glob__0_5 from "./html/index.js";
+import * as __glob__0_6 from "./php/index.js";
 import * as __glob__0_7 from "./ruby/index.js";
 import * as __glob__0_8 from "./sql/index.js";
 import * as __glob__0_9 from "./ts/index.js";

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

@@ -1,10 +1,10 @@
 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/214a5ff53c2485aabc6e78e1c346b69b712bee42/packages/sql/src/index.ts
+ * - https://github.com/un-ts/prettier/blob/a5f1aae6464aa54749377d69a8237a70a6509a13/packages/sql/src/index.ts
  */
-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"];
+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];
@@ -17,7 +17,7 @@ export declare const options: {
         type: "string";
         array: true;
         default: {
-            value: ("sql" | "bigquery" | "hive" | "mariadb" | "mysql" | "postgresql" | "db2" | "plsql" | "n1ql" | "redshift" | "singlestoredb" | "spark" | "sqlite" | "transactsql" | "tsql" | "trino")[];
+            value: string[];
         }[];
         description: string;
     };

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

@@ -1,4 +1,4 @@
-import { type Options } from "prettier";
+import type { Options } from "prettier";
 import type { Embedder } from "../../types.js";
 import { embeddedLanguage } from "./embedded-language.js";
 export declare const embedder: Embedder<Options>;

package/dist/embedded/types.d.ts

@@ -1,4 +1,4 @@
-import type { Parser, SupportOption, Options } from "prettier";
+import type { Options, Parser, SupportOption } from "prettier";
 import type { Embedder } from "../types.js";
 import type { Satisfies } from "./utils.js";
 type EmbeddedLanguageNamingConvention = `embedded${Capitalize<string>}`;
@@ -16,8 +16,4 @@ export interface EmbeddedDefaultIdentifiersHolder {
 export type EmbeddedDefaultIdentifier = keyof EmbeddedDefaultIdentifiersHolder;
 export interface PrettierPluginEmbedOptions {
 }
-declare module "prettier" {
-    interface Options extends PrettierPluginEmbedOptions {
-    }
-}
 export {};

package/dist/embedded/utils.d.ts

@@ -1,5 +1,5 @@
-import type { Expression, Comment, TemplateLiteral } from "estree";
-import type { AstPath, Options, Doc } from "prettier";
+import type { Comment, Expression, TemplateLiteral } from "estree";
+import type { AstPath, Doc, Options } from "prettier";
 import { builders } from "prettier/doc";
 import type { InternalPrintFun } from "../types.js";
 export declare function printTemplateExpression(path: AstPath<Expression & {
@@ -9,7 +9,7 @@ export declare function printTemplateExpressions(path: AstPath<TemplateLiteral>,
 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 const randomUUID: () => string;
 export declare function preparePlaceholder(leading?: string, trailing?: string): {
     createPlaceholder: (index: number) => string;
     placeholderRegex: RegExp;

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

@@ -1,4 +1,4 @@
-import { type Options } from "prettier";
+import type { Options } from "prettier";
 import type { Embedder } from "../../types.js";
 import { embeddedLanguage } from "./embedded-language.js";
 export declare const embedder: Embedder<Options>;

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

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

package/dist/embedded/xml/parser.d.ts

@@ -1,5 +1,5 @@
-import type { Parser } from "prettier";
 import type { CstNode } from "chevrotain";
+import type { Parser } from "prettier";
 import { embeddedLanguage } from "./embedded-language.js";
 export declare const parser: Parser<CstNode>;
 declare module "../types.js" {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
+export * from "./embedded/index.js";
+export { options } from "./options.js";
 export { parsers } from "./parsers.js";
 export { printers } from "./printers.js";
-export { options } from "./options.js";
 export type * from "./types.js";
-export * from "./embedded/index.js";