import { VFile } from 'vfile';
import { Options as RemarkStringifyOptions } from 'remark-stringify';

interface MarkdownFormatterOptions {
  // Add a watermark with a link to this repository's home page
  watermark?:
    'none' // No watermark
    | 'top' // Watermark inserted at the top of the document
    | 'toc'; // Watermark added to the ToC's end tag

  // Escape the opening bracket in admonitions like : > \[!TIP]
  // Use this to avoid breaking formatting after migrating to v6
  escapeGithubAdmonitions: boolean;
}

export {
  MarkdownFormatterOptions,
  RemarkStringifyOptions,
};

export function formatFromString (
  sourceMarkdownString: string,
  markdownFormatterOptions?: MarkdownFormatterOptions,
  stringifyOptions?: RemarkStringifyOptions,
): Promise<VFile>;

export function formatFromFile (
  sourceMarkdownFilePath: string,
  markdownFormatterOptions?: MarkdownFormatterOptions,
  stringifyOptions?: RemarkStringifyOptions,
): Promise<VFile>;