prettier-plugin-embed
Version:
A configurable Prettier plugin to format embedded languages in JS/TS files.
73 lines (72 loc) • 3.13 kB
TypeScript
import { type AutocompleteStringList, type StringListToInterfaceKey } from "../utils.js";
declare const DEFAULT_COMMENTS: readonly ["md", "markdown"];
type Comments = AutocompleteStringList<(typeof DEFAULT_COMMENTS)[number]>;
type DefaultCommentsHolder = StringListToInterfaceKey<typeof DEFAULT_COMMENTS>;
declare const DEFAULT_TAGS: readonly ["md", "markdown"];
type Tags = AutocompleteStringList<(typeof DEFAULT_TAGS)[number]>;
type DefaultTagsHolder = StringListToInterfaceKey<typeof DEFAULT_TAGS>;
declare const MARKDOWN_PARSERS: readonly ["markdown", "mdx", "remark"];
type MarkdownParser = (typeof MARKDOWN_PARSERS)[number];
declare const EMBEDDED_LANGUAGE_IDENTIFIERS: "embeddedMarkdownIdentifiers";
declare const EMBEDDED_LANGUAGE_COMMENTS: "embeddedMarkdownComments";
declare const EMBEDDED_LANGUAGE_TAGS: "embeddedMarkdownTags";
declare const EMBEDDED_LANGUAGE_PARSER: "embeddedMarkdownParser";
export declare const options: {
readonly embeddedMarkdownIdentifiers: {
readonly category: "Embed";
readonly type: "string";
readonly array: true;
readonly default: [{
readonly value: ["md", "markdown"];
}];
readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Markdown language.";
readonly deprecated: "Please use `embeddedMarkdownComments` or `embeddedMarkdownTags`.";
};
readonly embeddedMarkdownComments: {
readonly category: "Embed";
readonly type: "string";
readonly array: true;
readonly default: [{
readonly value: ["9ff2b366e8ca4c97b9aed1a29b5b94ed"];
}];
readonly description: "Block comments that make their subsequent template literals be identified as embedded Markdown language.";
};
readonly embeddedMarkdownTags: {
readonly category: "Embed";
readonly type: "string";
readonly array: true;
readonly default: [{
readonly value: ["9ff2b366e8ca4c97b9aed1a29b5b94ed"];
}];
readonly description: "Tags that make their subsequent template literals be identified as embedded Markdown language.";
};
readonly embeddedMarkdownParser: {
category: string;
type: "choice";
default: "markdown";
description: string;
choices: {
value: "markdown" | "mdx" | "remark";
description: string;
}[];
};
};
type Options = typeof options;
declare module "../types.js" {
interface EmbeddedOptions extends Options {
}
interface EmbeddedDefaultCommentsHolder extends DefaultCommentsHolder {
}
interface EmbeddedDefaultTagsHolder extends DefaultTagsHolder {
}
interface PluginEmbedOptions {
/**
* @deprecated Please use `embeddedMarkdownComments` or `embeddedMarkdownTags`.
*/
[EMBEDDED_LANGUAGE_IDENTIFIERS]?: (Comments[number] | Tags[number])[];
[EMBEDDED_LANGUAGE_COMMENTS]?: Comments;
[EMBEDDED_LANGUAGE_TAGS]?: Tags;
[EMBEDDED_LANGUAGE_PARSER]?: MarkdownParser;
}
}
export {};