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

package/dist/options.d.ts

@@ -1,9 +1,10 @@
-import { PrettierPluginEmbedOptions, EmbeddedDefaultIdentifier, AutocompleteStringList } from "./embedded/index.js";
+import { type AutocompleteStringList, type EmbeddedDefaultIdentifier, type PrettierPluginEmbedOptions } from "./embedded/index.js";
 type EmbeddedIdentifiers = AutocompleteStringList<EmbeddedDefaultIdentifier[]>;
 declare const NO_EMBEDDED_IDENTIFICATION_BY_COMMENT = "noEmbeddedIdentificationByComment";
 declare const NO_EMBEDDED_IDENTIFICATION_BY_TAG = "noEmbeddedIdentificationByTag";
 declare const PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES = "preserveEmbeddedExteriorWhitespaces";
 declare const NO_EMBEDDED_MULTI_LINE_INDENTATION = "noEmbeddedMultiLineIndentation";
+declare const EMBEDDED_OVERRIDES = "embeddedOverrides";
 export declare const options: {
     noEmbeddedIdentificationByComment: {
         category: "Global";
@@ -41,6 +42,13 @@ export declare const options: {
         }[];
         description: string;
     };
+    embeddedOverrides: {
+        category: "Global";
+        type: "string";
+        array: false;
+        default: undefined;
+        description: string;
+    };
     embeddedNoopIdentifiers: {
         category: "Global";
         type: "string";
@@ -132,7 +140,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;
     };
@@ -171,12 +179,15 @@ export declare const options: {
         description: string;
     };
 };
+export interface PrettierPluginGlobalOptions {
+    [NO_EMBEDDED_IDENTIFICATION_BY_COMMENT]?: EmbeddedIdentifiers;
+    [NO_EMBEDDED_IDENTIFICATION_BY_TAG]?: EmbeddedIdentifiers;
+    [PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES]?: EmbeddedIdentifiers;
+    [NO_EMBEDDED_MULTI_LINE_INDENTATION]?: EmbeddedIdentifiers;
+    [EMBEDDED_OVERRIDES]?: string;
+}
 declare module "./embedded/types.js" {
-    interface PrettierPluginEmbedOptions {
-        [NO_EMBEDDED_IDENTIFICATION_BY_COMMENT]?: EmbeddedIdentifiers;
-        [NO_EMBEDDED_IDENTIFICATION_BY_TAG]?: EmbeddedIdentifiers;
-        [PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES]?: EmbeddedIdentifiers;
-        [NO_EMBEDDED_MULTI_LINE_INDENTATION]?: EmbeddedIdentifiers;
+    interface PrettierPluginEmbedOptions extends PrettierPluginGlobalOptions {
     }
 }
 declare module "prettier" {

package/dist/types.d.ts

@@ -1,5 +1,7 @@
-import type { Options, Doc, AstPath } from "prettier";
-import type { Node as EsTreeNode, TemplateLiteral, Comment } from "estree";
+import type { Comment, Node as EsTreeNode, TemplateLiteral } from "estree";
+import type { AstPath, Doc, Options } from "prettier";
+import { makeIdentifiersOptionName, type AutocompleteStringList, type EmbeddedDefaultIdentifier, type EmbeddedLanguage, type PrettierPluginEmbedOptions } from "./embedded/index.js";
+import type { PrettierPluginGlobalOptions } from "./options.js";
 export type PrettierNode = EsTreeNode & {
     comments?: (Comment & {
         leading: boolean;
@@ -8,4 +10,14 @@ export type PrettierNode = EsTreeNode & {
     })[];
 };
 export type InternalPrintFun = (selector?: string | number | (string | number)[] | AstPath<TemplateLiteral>) => Doc;
-export type Embedder<T extends Options = Options> = (textToDoc: (text: string, options: T) => Promise<Doc>, print: InternalPrintFun, path: AstPath<TemplateLiteral>, options: T, identifier: string, identifiers: string[]) => Promise<Doc>;
+export interface EmbedderPayload {
+    identifier: string;
+    identifiers: string[];
+    embeddedOverrideOptions: EmbeddedOverride["options"] | undefined;
+}
+export type Embedder<T extends Options = Options> = (textToDoc: (text: string, options: T) => Promise<Doc>, print: InternalPrintFun, path: AstPath<TemplateLiteral>, options: T, embedderPayload: EmbedderPayload) => Promise<Doc>;
+export interface EmbeddedOverride {
+    identifiers: AutocompleteStringList<EmbeddedDefaultIdentifier[]>;
+    options: Omit<Omit<Options, keyof PrettierPluginEmbedOptions> & Omit<PrettierPluginEmbedOptions, keyof PrettierPluginGlobalOptions | ReturnType<typeof makeIdentifiersOptionName<EmbeddedLanguage>>>, "printWidth" | "endOfLine" | "useTabs" | "tabWidth" | "parser" | "filepath" | "embeddedLanguageFormatting" | `__${string}`>;
+}
+export type EmbeddedOverrides = EmbeddedOverride[];

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+import { type AstPath } from "prettier";
+import type { PrettierNode } from "./types.js";
+export declare const resolveEmbeddedOverrideOptions: (embeddedOverridesString: string | undefined, identifier: string, sourceFilePath?: string) => Promise<Omit<Omit<import("prettier").Options, keyof import("./index.js").PrettierPluginEmbedOptions> & Omit<import("./index.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>;
+export declare function getIdentifierFromComment({ node, parent }: AstPath<PrettierNode>, comments: string[], noIdentificationList: string[]): string | undefined;
+export declare function getIdentifierFromTag({ node, parent }: AstPath<PrettierNode>, tags: string[], noIdentificationList: string[]): string | undefined;

package/package.json

@@ -2,7 +2,7 @@
   "name": "prettier-plugin-embed",
   "description": "A configurable Prettier plugin to format embedded languages in js/ts files.",
   "private": false,
-  "version": "0.2.5",
+  "version": "0.3.0-rc.1",
   "type": "module",
   "files": [
     "./dist"
@@ -61,37 +61,42 @@
     "postncu": "npm i"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.1.0",
-    "@commitlint/config-conventional": "^18.1.0",
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/estree": "^1.0.3",
-    "@typescript-eslint/eslint-plugin": "^6.9.0",
-    "@typescript-eslint/parser": "^6.9.0",
+    "@types/estree": "^1.0.5",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
     "@vitest/browser": "^0.34.6",
     "@vitest/coverage-istanbul": "^0.34.6",
     "@vitest/ui": "^0.34.6",
     "code-tag": "^1.1.0",
-    "eslint": "^8.52.0",
-    "fast-glob": "^3.3.1",
-    "npm-check-updates": "^16.14.6",
-    "playwright": "^1.39.0",
-    "semantic-release": "^22.0.5",
-    "tsx": "^3.14.0",
-    "typescript": "^5.2.2",
-    "vite": "^4.5.0",
+    "eslint": "^8.54.0",
+    "fast-glob": "^3.3.2",
+    "npm-check-updates": "^16.14.11",
+    "playwright": "^1.40.0",
+    "prettier-plugin-organize-imports": "^3.2.4",
+    "semantic-release": "^22.0.8",
+    "tsx": "^4.2.0",
+    "typescript": "^5.3.2",
+    "vite": "^5.0.2",
     "vitest": "^0.34.6"
   },
   "peerDependencies": {
-    "@prettier/plugin-php": "^0.20.1",
+    "@prettier/plugin-php": ">=0.20.1 <1",
     "@prettier/plugin-ruby": "^4.0.0",
     "@prettier/plugin-xml": "^3.1.0",
     "@xml-tools/parser": "^1.0.11",
     "chevrotain": "7.1.1",
     "prettier": "^3.0.0",
-    "prettier-plugin-glsl": "^0.1.2",
-    "prettier-plugin-sql": "^0.15.0"
+    "prettier-plugin-glsl": ">=0.1.2 <1",
+    "prettier-plugin-sql": ">=0.15.0 <1"
   },
   "dependencies": {
-    "short-unique-id": "^5.0.3"
+    "micro-memoize": "^4.1.2",
+    "package-up": "^5.0.0"
+  },
+  "optionalDependencies": {
+    "tsx": "^4.2.0"
   }
 }