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

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.
 
@@ -50,20 +52,6 @@ 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
@@ -214,9 +202,13 @@ Formatting embedded XML code requires [`@prettier/plugin-xml`](https://github.co
 
 #### `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.
+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`.
 
-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:
+An example `.json` file is:
 
 ```json
 [

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,4 +1,4 @@
-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;

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>}`;

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 & {
@@ -22,4 +22,3 @@ 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>;

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";