prettier-plugin-embed 0.4.7 → 0.4.9

package/dist/options.d.ts

@@ -1,5 +1,5 @@
-import { type AutocompleteStringList, type EmbeddedDefaultIdentifier, type PrettierPluginEmbedOptions } from "./embedded/index.js";
-type EmbeddedIdentifiers = AutocompleteStringList<EmbeddedDefaultIdentifier[]>;
+import { type AutocompleteStringList, type EmbeddedDefaultIdentifier } 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";
@@ -142,6 +142,15 @@ export declare const options: {
         }];
         readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded INI language. This option requires the `prettier-plugin-ini` plugin.";
     };
+    readonly embeddedJavaIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["java"];
+        }];
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Java language. This option requires the `prettier-plugin-java` plugin.";
+    };
     readonly embeddedJsonIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -161,6 +170,15 @@ export declare const options: {
             description: string;
         }[];
     };
+    readonly embeddedJsonataIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["jsonata"];
+        }];
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded JSONata language. This option requires the `@stedi/prettier-plugin-jsonata` plugin.";
+    };
     readonly embeddedLatexIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -189,6 +207,43 @@ export declare const options: {
             description: string;
         }[];
     };
+    readonly embeddedNginxIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["nginx"];
+        }];
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded NGINX language. This option requires the `prettier-plugin-nginx` plugin.";
+    };
+    readonly embeddedPegjsIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["pegjs", "peggy", "peg"];
+        }];
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Pegjs language. This option requires the `prettier-plugin-pegjs` plugin.";
+    };
+    readonly embeddedTsIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["ts", "tsx", "cts", "mts", "typescript"];
+        }];
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded TypeScript language.";
+    };
+    readonly embeddedTsParser: {
+        category: string;
+        type: "choice";
+        default: "typescript";
+        description: string;
+        choices: {
+            value: "typescript" | "babel-ts";
+            description: string;
+        }[];
+    };
     readonly embeddedPhpIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -198,6 +253,15 @@ export declare const options: {
         }];
         readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded PHP language. This option requires the `@prettier/plugin-php` plugin.";
     };
+    readonly embeddedPrismaIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["prisma"];
+        }];
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Prisma language. This option requires the `prettier-plugin-prisma` plugin.";
+    };
     readonly embeddedPropertiesIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -207,6 +271,15 @@ export declare const options: {
         }];
         readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Properties language. This option requires the `prettier-plugin-properties` plugin.";
     };
+    readonly embeddedPugIdentifiers: {
+        readonly category: "Embed";
+        readonly type: "string";
+        readonly array: true;
+        readonly default: [{
+            readonly value: ["pug", "jade"];
+        }];
+        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Pug language. This option requires the `@prettier/plugin-pug` plugin.";
+    };
     readonly embeddedRubyIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -260,7 +333,7 @@ export declare const options: {
         default: "sqlite";
         description: string;
         choices: {
-            value: "sqlite" | "bigquery" | "mysql" | "mariadb" | "postgresql";
+            value: "bigquery" | "mariadb" | "mysql" | "postgresql" | "sqlite";
             description: string;
         }[];
     };
@@ -273,25 +346,6 @@ export declare const options: {
         }];
         readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded TOML language. This option requires the `prettier-plugin-toml` plugin.";
     };
-    readonly embeddedTsIdentifiers: {
-        readonly category: "Embed";
-        readonly type: "string";
-        readonly array: true;
-        readonly default: [{
-            readonly value: ["ts", "tsx", "cts", "mts", "typescript"];
-        }];
-        readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded TypeScript language.";
-    };
-    readonly embeddedTsParser: {
-        category: string;
-        type: "choice";
-        default: "typescript";
-        description: string;
-        choices: {
-            value: "typescript" | "babel-ts";
-            description: string;
-        }[];
-    };
     readonly embeddedXmlIdentifiers: {
         readonly category: "Embed";
         readonly type: "string";
@@ -320,7 +374,7 @@ export declare const options: {
         readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded YAML language.";
     };
 };
-export interface PrettierPluginGlobalOptions {
+export interface PluginEmbedLanguageAgnosticOptions {
     [NO_EMBEDDED_IDENTIFICATION_BY_COMMENT]?: EmbeddedIdentifiers;
     [NO_EMBEDDED_IDENTIFICATION_BY_TAG]?: EmbeddedIdentifiers;
     [PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES]?: EmbeddedIdentifiers;
@@ -328,11 +382,7 @@ export interface PrettierPluginGlobalOptions {
     [EMBEDDED_OVERRIDES]?: string;
 }
 declare module "./embedded/types.js" {
-    interface PrettierPluginEmbedOptions extends PrettierPluginGlobalOptions {
-    }
-}
-declare module "prettier" {
-    interface Options extends PrettierPluginEmbedOptions {
+    interface PluginEmbedOptions extends PluginEmbedLanguageAgnosticOptions {
     }
 }
 export {};

package/dist/plugin-embed.d.ts

@@ -0,0 +1,6 @@
+import "prettier";
+import type { PluginEmbedOptions } from "./embedded/index.js";
+
+declare module "prettier" {
+  interface Options extends PluginEmbedOptions {}
+}

package/dist/types.d.ts

@@ -1,26 +1,8 @@
 import type { 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";
-import { RemoveIndex } from "./utils.js";
-declare module "estree" {
-    interface Comment {
-        leading: boolean;
-        trailing: boolean;
-        nodeDescription: string;
-    }
-    interface BaseNode {
-        comments?: Comment[];
-    }
-    interface File extends BaseNode {
-        type: "File";
-        sourceType: "script" | "module";
-        program: Program;
-    }
-    interface NodeMap {
-        File: File;
-    }
-}
+import type { OmitIndexSignature } from "type-fest";
+import type { AutocompleteStringList, EmbeddedDefaultIdentifier, EmbeddedLanguage, PluginEmbedOptions, makeIdentifiersOptionName } from "./embedded/index.js";
+import type { PluginEmbedLanguageAgnosticOptions } from "./options.js";
 export type InternalPrintFun = (selector?: string | number | (string | number)[] | AstPath<TemplateLiteral>) => Doc;
 export interface EmbedderPayload {
     identifier: string;
@@ -29,7 +11,6 @@ export interface EmbedderPayload {
 }
 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<RemoveIndex<Options>, keyof PrettierPluginEmbedOptions> & Omit<PrettierPluginEmbedOptions, keyof PrettierPluginGlobalOptions | ReturnType<typeof makeIdentifiersOptionName<EmbeddedLanguage>>>, "printWidth" | "endOfLine" | "useTabs" | "tabWidth" | "parser" | "filepath" | "embeddedLanguageFormatting" | `__${string}`>;
+    identifiers: AutocompleteStringList<EmbeddedDefaultIdentifier>;
+    options: Omit<Omit<OmitIndexSignature<Options>, keyof PluginEmbedOptions> & Omit<PluginEmbedOptions, keyof PluginEmbedLanguageAgnosticOptions | ReturnType<typeof makeIdentifiersOptionName<EmbeddedLanguage>>>, "printWidth" | "endOfLine" | "useTabs" | "tabWidth" | "parser" | "filepath" | "embeddedLanguageFormatting" | `__${string}`>;
 }
-export type EmbeddedOverrides = EmbeddedOverride[];

package/dist/utils.d.ts

@@ -1,8 +1,5 @@
 import type { Node } from "estree";
 import { type AstPath, type Options } from "prettier";
-export declare const resolveEmbeddedOverrideOptions: (embeddedOverridesString: string | undefined, identifier: string, sourceFilePath?: string) => Promise<Omit<Omit<RemoveIndex<Options>, keyof import("./index.js").PrettierPluginEmbedOptions> & Omit<import("./index.js").PrettierPluginEmbedOptions, "embeddedNoopIdentifiers" | "embeddedCssIdentifiers" | "embeddedEsIdentifiers" | "embeddedGlslIdentifiers" | "embeddedGraphqlIdentifiers" | "embeddedHtmlIdentifiers" | "embeddedIniIdentifiers" | "embeddedJsonIdentifiers" | "embeddedLatexIdentifiers" | "embeddedMarkdownIdentifiers" | "embeddedPhpIdentifiers" | "embeddedPropertiesIdentifiers" | "embeddedRubyIdentifiers" | "embeddedShIdentifiers" | "embeddedSqlIdentifiers" | "embeddedTomlIdentifiers" | "embeddedTsIdentifiers" | "embeddedXmlIdentifiers" | "embeddedYamlIdentifiers" | keyof import("./options.js").PrettierPluginGlobalOptions>, "parser" | "filepath" | "endOfLine" | "embeddedLanguageFormatting" | "printWidth" | "tabWidth" | "useTabs" | `__${string}`> | undefined>;
+export declare const resolveEmbeddedOverrideOptions: (embeddedOverridesString: string | undefined, identifier: string, sourceFilePath?: string) => Promise<Omit<Omit<import("type-fest").OmitIndexSignature<Options>, keyof import("./index.js").PluginEmbedOptions> & Omit<import("./index.js").PluginEmbedOptions, "embeddedNoopIdentifiers" | "embeddedCssIdentifiers" | "embeddedEsIdentifiers" | "embeddedGlslIdentifiers" | "embeddedGraphqlIdentifiers" | "embeddedHtmlIdentifiers" | "embeddedIniIdentifiers" | "embeddedJavaIdentifiers" | "embeddedJsonIdentifiers" | "embeddedJsonataIdentifiers" | "embeddedLatexIdentifiers" | "embeddedMarkdownIdentifiers" | "embeddedNginxIdentifiers" | "embeddedPegjsIdentifiers" | "embeddedTsIdentifiers" | "embeddedPhpIdentifiers" | "embeddedPrismaIdentifiers" | "embeddedPropertiesIdentifiers" | "embeddedPugIdentifiers" | "embeddedRubyIdentifiers" | "embeddedShIdentifiers" | "embeddedSqlIdentifiers" | "embeddedTomlIdentifiers" | "embeddedXmlIdentifiers" | "embeddedYamlIdentifiers" | keyof import("./options.js").PluginEmbedLanguageAgnosticOptions>, "parser" | "filepath" | "endOfLine" | "embeddedLanguageFormatting" | "printWidth" | "tabWidth" | "useTabs" | `__${string}`> | undefined>;
 export declare function getIdentifierFromComment({ node, parent }: AstPath<Node>, comments: string[], options: Options): string | undefined;
 export declare function getIdentifierFromTag({ node, parent }: AstPath<Node>, tags: string[], options: Options): string | undefined;
-export type RemoveIndex<T> = {
-    [K in keyof T as string extends K ? never : number extends K ? never : symbol extends K ? never : K]: T[K];
-};

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.4.7",
+  "version": "0.4.9",
   "type": "module",
   "files": [
     "./dist"
@@ -13,7 +13,23 @@
     ".": {
       "import": "./dist/index.js",
       "default": "./dist/index.js"
-    }
+    },
+    "./plugin-embed": {
+      "types": "./dist/plugin-embed.d.ts"
+    },
+    "./embedded/*": {
+      "types": "./dist/embedded/*.d.ts"
+    },
+    "./embedded/index": null,
+    "./embedded/register": null,
+    "./embedded/types": null,
+    "./embedded/utils": null,
+    "./embedded/*/index": null,
+    "./embedded/*/language": null,
+    "./embedded/*/options": null,
+    "./embedded/*/embedder": null,
+    "./embedded/*/parser": null,
+    "./embedded/*/printer": null
   },
   "repository": {
     "type": "git",
@@ -42,14 +58,23 @@
     "access": "public"
   },
   "scripts": {
+    "prepare": "patch-package",
+    "update-hooks": "simple-git-hooks",
+    "bump": "bumpp",
     "dev": "vite",
-    "lint": "eslint . --ext .ts",
+    "lint": "biome lint .",
     "type-check": "tsc --noEmit --emitDeclarationOnly false",
-    "format": "prettier . --write",
-    "prebuild": "npm run lint && npm run type-check && npm run format",
+    "format": "biome format . --write",
+    "check": "biome check --apply .",
+    "prebuild": "npm run check && npm run type-check",
     "build": "vite build",
     "add-glob-import-types": "tsx ./scripts/add-glob-import-types.ts",
-    "postbuild": "tsc --project ./tsconfig.production.json && npm run add-glob-import-types",
+    "nocheck-chevrotain-types": "tsx ./scripts/nocheck-chevrotain-types.ts",
+    "copy": "copy-files-from-to",
+    "postbuild": "tsc --project ./tsconfig.production.json && conc \"npm:add-glob-import-types\" \"npm:nocheck-chevrotain-types\" \"npm:copy\"",
+    "prebuild:ci": "npm run type-check",
+    "build:ci": "vite build",
+    "postbuild:ci": "npm run postbuild",
     "test": "vitest",
     "test:ui": "vitest --ui",
     "preview": "vite preview",
@@ -58,45 +83,57 @@
     "prepublishOnly": "npm run build && npm run process-readme",
     "postpublish": "npm run restore-readme",
     "ncu": "npx ncu",
-    "postncu": "npm i"
+    "postncu": "npm i",
+    "bump-biome": "npm i @biomejs/biome@latest --save-exact"
   },
   "devDependencies": {
+    "@biomejs/biome": "1.5.3",
     "@commitlint/cli": "^18.4.4",
     "@commitlint/config-conventional": "^18.4.4",
     "@prettier/plugin-php": "^0.22.1",
+    "@prettier/plugin-pug": "^3.0.0",
     "@prettier/plugin-ruby": "^4.0.4",
     "@prettier/plugin-xml": "^3.2.2",
-    "@types/estree": "^1.0.5",
+    "@stedi/prettier-plugin-jsonata": "^2.1.1",
     "@types/node": "^20.11.5",
-    "@typescript-eslint/eslint-plugin": "^6.19.0",
-    "@typescript-eslint/parser": "^6.19.0",
     "@vitest/coverage-istanbul": "^1.2.1",
     "@vitest/ui": "^1.2.1",
     "@xml-tools/parser": "^1.0.11",
+    "bumpp": "^9.3.0",
     "chevrotain": "7.1.1",
+    "concurrently": "^8.2.2",
+    "copy-files-from-to": "^3.9.1",
     "esbuild": "^0.19.11",
-    "eslint": "^8.56.0",
     "fast-glob": "^3.3.2",
+    "lint-staged": "^15.2.0",
     "npm-check-updates": "^16.14.12",
+    "patch-package": "^8.0.0",
     "prettier": "^3.2.4",
     "prettier-plugin-glsl": "^0.1.3",
     "prettier-plugin-ini": "^1.1.0",
+    "prettier-plugin-java": "^2.5.0",
     "prettier-plugin-jsdoc": "^1.3.0",
     "prettier-plugin-latex": "^2.0.1",
+    "prettier-plugin-nginx": "^1.0.3",
     "prettier-plugin-organize-imports": "^3.2.4",
+    "prettier-plugin-pegjs": "^2.0.2",
+    "prettier-plugin-prisma": "^5.0.0",
     "prettier-plugin-properties": "^0.3.0",
-    "prettier-plugin-sh": "^0.13.1",
+    "prettier-plugin-sh": "^0.14.0",
     "prettier-plugin-sql": "^0.18.0",
     "prettier-plugin-sql-cst": "^0.10.2",
     "prettier-plugin-toml": "^2.0.1",
+    "simple-git-hooks": "^2.9.0",
     "tsx": "^4.7.0",
     "typescript": "^5.3.3",
-    "vite": "^5.0.11",
+    "vite": "^5.0.12",
     "vitest": "^1.2.1"
   },
   "dependencies": {
+    "@types/estree": "^1.0.5",
     "dedent": "^1.5.1",
     "micro-memoize": "^4.1.2",
-    "package-up": "^5.0.0"
+    "package-up": "^5.0.0",
+    "type-fest": "^4.9.0"
   }
 }