prettier-plugin-embed 0.2.4 → 0.3.0-rc.0

package/README.md

@@ -50,6 +50,20 @@ By leveraging Prettier's plugin system, this plugin overrides the default [`embe
 npm i -D prettier-plugin-embed
 ```
 
+Peer dependecies are automatically installed by default if you're using npm v7 or higher versions. The peer dependencies of this plugin are mainly packages to support parsing and formatting for different languages. If you only plan to use this plugin for a very specific language and don't want to bloat your node modules folder, you can omit the peer dependencies by changing the installation command to either:
+
+```bash
+npm i -D --legacy-peer-deps prettier-plugin-embed
+```
+
+or:
+
+```bash
+npm i -D --omit=peer prettier-plugin-embed
+```
+
+For other package managers, refer to their documents on how to achieve the same result.
+
 ## Usage
 
 ### Getting Started
@@ -167,7 +181,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
 
@@ -190,12 +204,38 @@ 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 an **absolute** json file path as its value.
+
+The value should be an array of objects. Each object 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. An example 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/index.d.ts

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

package/dist/embedded/register.d.ts

@@ -4,9 +4,9 @@ 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 "./html/index.js";
+import * as __glob__0_1 from "./es/index.js";
 import * as __glob__0_2 from "./glsl/index.js";
-import * as __glob__0_3 from "./es/index.js";
+import * as __glob__0_3 from "./html/index.js";
 import * as __glob__0_4 from "./markdown/index.js";
 import * as __glob__0_5 from "./noop/index.js";
 import * as __glob__0_6 from "./php/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/types.d.ts

@@ -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

@@ -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;
@@ -22,3 +22,4 @@ export type StringListToInterfaceKey<T extends readonly string[]> = {
     [key in T[number]]: void;
 };
 export type Satisfies<U, T extends U> = T;
+export declare const parseEmbeddedOverrideOptions: import("micro-memoize").Memoized<(embeddedOverrides: string | undefined, identifier: string) => Omit<Omit<Options, keyof import("./types.js").PrettierPluginEmbedOptions> & Omit<import("./types.js").PrettierPluginEmbedOptions, "embeddedNoopIdentifiers" | "embeddedCssIdentifiers" | "embeddedEsIdentifiers" | "embeddedGlslIdentifiers" | "embeddedHtmlIdentifiers" | "embeddedMarkdownIdentifiers" | "embeddedPhpIdentifiers" | "embeddedRubyIdentifiers" | "embeddedSqlIdentifiers" | "embeddedTsIdentifiers" | "embeddedXmlIdentifiers" | keyof import("../options.js").PrettierPluginGlobalOptions>, "parser" | "filepath" | "endOfLine" | "embeddedLanguageFormatting" | "printWidth" | "tabWidth" | "useTabs" | `__${string}`> | undefined>;