prettier-plugin-embed 0.0.6 → 0.2.0

package/dist/options.d.ts

@@ -1,13 +1,186 @@
-import type { SupportOptions } from "prettier";
-import { PrettierPluginEmbedOptions } from "./embedded/index.js";
-export declare const options: SupportOptions;
+import { PrettierPluginEmbedOptions, EmbeddedDefaultIdentifier, AutocompleteStringList } 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";
+export declare const options: {
+    noEmbeddedIdentificationByComment: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: never[];
+        }[];
+        description: string;
+    };
+    noEmbeddedIdentificationByTag: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: never[];
+        }[];
+        description: string;
+    };
+    preserveEmbeddedExteriorWhitespaces: {
+        category: "Config";
+        type: "string";
+        array: true;
+        default: {
+            value: never[];
+        }[];
+        description: string;
+    };
+    noEmbeddedMultiLineIndentation: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: never[];
+        }[];
+        description: string;
+    };
+    embeddedNoopIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: never[];
+        }[];
+        description: string;
+    };
+    embeddedCssIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: "css"[];
+        }[];
+        description: string;
+    };
+    embeddedEsIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("js" | "es" | "es6" | "mjs" | "cjs" | "pac" | "javascript")[];
+        }[];
+        description: string;
+    };
+    embeddedEsParser: {
+        category: "Global";
+        type: "string";
+        array: false;
+        default: string;
+        description: string;
+    };
+    embeddedGlslIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("glsl" | "fp" | "frag" | "frg" | "fs" | "fsh" | "fshader" | "geo" | "geom" | "glslf" | "glslv" | "gs" | "gshader" | "rchit" | "rmiss" | "shader" | "tesc" | "tese" | "vert" | "vrx" | "vsh" | "vshader")[];
+        }[];
+        description: string;
+    };
+    embeddedHtmlIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("html" | "htm" | "shtml" | "xhtml" | "xht" | "mdoc" | "jsp" | "asp" | "aspx" | "jshtm" | "volt" | "rhtml")[];
+        }[];
+        description: string;
+    };
+    embeddedMarkdownIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("md" | "livemd" | "markdown" | "mdown" | "mdwn" | "mkd" | "mkdn" | "mkdown" | "ronn" | "scd" | "workbook")[];
+        }[];
+        description: string;
+    };
+    embeddedPhpIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("php" | "php5" | "phtml" | "ctp")[];
+        }[];
+        description: string;
+    };
+    embeddedRubyIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("ruby" | "rbs" | "haml" | "arb" | "axlsx" | "builder" | "eye" | "fcgi" | "gemfile" | "gemspec" | "god" | "jb" | "jbuilder" | "mspec" | "opal" | "pluginspec" | "podspec" | "rabl" | "rake" | "rb" | "rbi" | "rbuild" | "rbw" | "rbx" | "ru" | "thor" | "watchr")[];
+        }[];
+        description: string;
+    };
+    embeddedRubyParser: {
+        category: "Global";
+        type: "string";
+        array: false;
+        default: undefined;
+        description: string;
+    };
+    embeddedSqlIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("sql" | "bigquery" | "hive" | "mariadb" | "mysql" | "postgresql" | "db2" | "plsql" | "n1ql" | "redshift" | "singlestoredb" | "spark" | "sqlite" | "transactsql" | "tsql" | "trino")[];
+        }[];
+        description: string;
+    };
+    embeddedTsIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("ts" | "cts" | "mts" | "typescript")[];
+        }[];
+        description: string;
+    };
+    embeddedTsParser: {
+        category: "Global";
+        type: "string";
+        array: false;
+        default: string;
+        description: string;
+    };
+    embeddedXmlIdentifiers: {
+        category: "Global";
+        type: "string";
+        array: true;
+        default: {
+            value: ("xml" | "xsd" | "ascx" | "atom" | "axml" | "axaml" | "bpmn" | "cpt" | "csl" | "csproj" | "dita" | "ditamap" | "dtd" | "ent" | "mod" | "dtml" | "fsproj" | "fxml" | "iml" | "isml" | "jmx" | "launch" | "menu" | "nuspec" | "opml" | "owl" | "proj" | "props" | "pt" | "publishsettings" | "pubxml" | "rbxlx" | "rbxmx" | "rdf" | "rng" | "rss" | "shproj" | "storyboard" | "svg" | "targets" | "tld" | "tmx" | "vbproj" | "vcxproj" | "wsdl" | "wxi" | "wxl" | "wxs" | "xaml" | "xbl" | "xib" | "xlf" | "xliff" | "xpdl" | "xul" | "xoml")[];
+        }[];
+        description: string;
+    };
+    __embeddedXmlFragmentRecoverIndex: {
+        category: "Global";
+        type: "int";
+        array: true;
+        default: {
+            value: never[];
+        }[];
+        description: string;
+    };
+};
 declare module "./embedded/types.js" {
     interface PrettierPluginEmbedOptions {
-        noEmbeddedDetectionByComment?: string[];
-        noEmbeddedDetectionByTag?: string[];
+        [NO_EMBEDDED_IDENTIFICATION_BY_COMMENT]?: EmbeddedIdentifiers;
+        [NO_EMBEDDED_IDENTIFICATION_BY_TAG]?: EmbeddedIdentifiers;
+        [PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES]?: EmbeddedIdentifiers;
+        [NO_EMBEDDED_MULTI_LINE_INDENTATION]?: EmbeddedIdentifiers;
     }
 }
 declare module "prettier" {
     interface Options extends PrettierPluginEmbedOptions {
     }
 }
+export {};

package/dist/types.d.ts

@@ -8,4 +8,4 @@ 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, lang: string, langs: string[]) => Promise<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>;

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "prettier-plugin-embed",
-  "description": "A prettier plugin to format embedded languages in js/ts files.",
+  "description": "A configurable Prettier plugin to format embedded languages in js/ts files.",
   "private": false,
-  "version": "0.0.6",
+  "version": "0.2.0",
   "type": "module",
   "files": [
     "./dist"
   ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -51,36 +53,45 @@
     "test": "vitest",
     "test:ui": "vitest --ui",
     "preview": "vite preview",
-    "prepublishOnly": "npm run build",
+    "process-readme": "tsx ./scripts/process-readme",
+    "restore-readme": "tsx ./scripts/restore-readme",
+    "prepublishOnly": "npm run build && npm run process-readme",
+    "postpublish": "npm run restore-readme",
     "ncu": "npx npm-check-updates -u",
     "postncu": "npm i"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.7.2",
-    "@commitlint/config-conventional": "^17.7.0",
-    "@prettier/plugin-php": "^0.20.1",
-    "@prettier/plugin-xml": "^3.2.1",
+    "@commitlint/cli": "^18.0.0",
+    "@commitlint/config-conventional": "^18.0.0",
     "@semantic-release/git": "^10.0.1",
-    "@types/estree": "^1.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.7.4",
-    "@typescript-eslint/parser": "^6.7.4",
+    "@types/estree": "^1.0.3",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
     "@vitest/browser": "^0.34.6",
     "@vitest/coverage-istanbul": "^0.34.6",
     "@vitest/ui": "^0.34.6",
     "code-tag": "^1.1.0",
-    "eslint": "^8.50.0",
+    "eslint": "^8.51.0",
     "fast-glob": "^3.3.1",
-    "npm-check-updates": "^16.14.5",
-    "playwright": "^1.38.1",
-    "prettier-plugin-sql": "^0.15.1",
+    "npm-check-updates": "^16.14.6",
+    "playwright": "^1.39.0",
     "semantic-release": "^22.0.5",
-    "tsx": "^3.13.0",
+    "tsx": "^3.14.0",
     "typescript": "^5.2.2",
-    "vite": "^4.4.11",
+    "vite": "^4.5.0",
     "vitest": "^0.34.6"
   },
   "peerDependencies": {
+    "@prettier/plugin-php": "^0.20.1",
+    "@prettier/plugin-ruby": "^4.0.2",
+    "@prettier/plugin-xml": "^3.2.1",
     "@xml-tools/parser": "^1.0.11",
-    "prettier": "^3.0.3"
+    "chevrotain": "7.1.1",
+    "prettier": "^3.0.3",
+    "prettier-plugin-glsl": "^0.1.2",
+    "prettier-plugin-sql": "^0.15.1"
+  },
+  "dependencies": {
+    "short-unique-id": "^5.0.3"
   }
 }

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

@@ -1,6 +0,0 @@
-export declare const name = "embeddedNoop";
-declare module "../types.js" {
-    interface EmbeddedNamesHolder {
-        [name]: void;
-    }
-}

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

@@ -1,11 +0,0 @@
-import type { SupportOption } from "prettier";
-import { name } from "./name.js";
-export declare const option: SupportOption;
-declare module "../types.js" {
-    interface EmbeddedOptions {
-        [name]: typeof option;
-    }
-    interface PrettierPluginEmbedOptions {
-        [name]?: string[];
-    }
-}

package/dist/embedded/php/name.d.ts

@@ -1,6 +0,0 @@
-export declare const name = "embeddedPhp";
-declare module "../types.js" {
-    interface EmbeddedNamesHolder {
-        [name]: void;
-    }
-}

package/dist/embedded/php/option.d.ts

@@ -1,20 +0,0 @@
-import type { SupportOption } from "prettier";
-import { name } from "./name.js";
-export declare const option: SupportOption;
-export interface PrettierPluginDepsOptions {
-    phpVersion?: "5.0" | "5.1" | "5.2" | "5.3" | "5.4" | "5.5" | "5.6" | "7.0" | "7.1" | "7.2" | "7.3" | "7.4" | "8.0" | "8.1" | "8.2";
-    trailingCommaPHP?: boolean;
-    braceStyle?: "psr-2" | "per-cs" | "1tbs";
-}
-declare module "../types.js" {
-    interface EmbeddedOptions {
-        [name]: typeof option;
-    }
-    interface PrettierPluginEmbedOptions {
-        [name]?: string[];
-    }
-}
-declare module "prettier" {
-    interface Options extends PrettierPluginDepsOptions {
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const name = "embeddedSql";
-declare module "../types.js" {
-    interface EmbeddedNamesHolder {
-        [name]: void;
-    }
-}

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

@@ -1,21 +0,0 @@
-import type { SupportOption } from "prettier";
-import type { SqlBaseOptions as PrettierPluginDepsOptions } from "prettier-plugin-sql";
-import { name } from "./name.js";
-export declare const option: SupportOption;
-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 type SqlFormatterLanguage = (typeof SQL_FORMATTER_LANGUAGES)[number];
-export type NodeSqlParserDataBase = (typeof NODE_SQL_PARSER_DATABASES)[number];
-export { PrettierPluginDepsOptions };
-declare module "../types.js" {
-    interface EmbeddedOptions {
-        [name]: typeof option;
-    }
-    interface PrettierPluginEmbedOptions {
-        [name]?: SqlFormatterLanguage[] | NodeSqlParserDataBase[] | string[];
-    }
-}
-declare module "prettier" {
-    interface Options extends PrettierPluginDepsOptions {
-    }
-}

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

@@ -1,6 +0,0 @@
-export declare const name = "embeddedXml";
-declare module "../types.js" {
-    interface EmbeddedNamesHolder {
-        [name]: void;
-    }
-}

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

@@ -1,21 +0,0 @@
-import type { SupportOption } from "prettier";
-import { name } from "./name.js";
-export declare const option: SupportOption;
-export interface PrettierPluginDepsOptions {
-    xmlSelfClosingSpace?: boolean;
-    xmlWhitespaceSensitivity?: "strict" | "preserve" | "ignore";
-    xmlSortAttributesByKey?: boolean;
-    xmlQuoteAttributes?: "preserve" | "single" | "double";
-}
-declare module "../types.js" {
-    interface EmbeddedOptions {
-        [name]: typeof option;
-    }
-    interface PrettierPluginEmbedOptions {
-        [name]?: string[];
-    }
-}
-declare module "prettier" {
-    interface Options extends PrettierPluginDepsOptions {
-    }
-}