marked 5.1.2 → 7.0.0

package/src/{helpers.js → helpers.ts}

@@ -1,3 +1,7 @@
+import type { MarkedOptions } from './MarkedOptions.ts';
+import type { ResultCallback } from './marked.ts';
+import type { Rule } from './rules.ts';
+
 /**
  * Helpers
  */
@@ -12,8 +16,9 @@ const escapeReplacements = {
   '"': '"',
   "'": '''
 };
-const getEscapeReplacement = (ch) => escapeReplacements[ch];
-export function escape(html, encode) {
+const getEscapeReplacement = (ch: string) => escapeReplacements[ch];
+
+export function escape(html: string, encode?: boolean) {
   if (encode) {
     if (escapeTest.test(html)) {
       return html.replace(escapeReplace, getEscapeReplacement);
@@ -29,10 +34,7 @@ export function escape(html, encode) {
 
 const unescapeTest = /&(#(?:\d+)|(?:#x[0-9A-Fa-f]+)|(?:\w+));?/ig;
 
-/**
- * @param {string} html
- */
-export function unescape(html) {
+export function unescape(html: string) {
   // explicitly match decimal, hex, and named HTML entities
   return html.replace(unescapeTest, (_, n) => {
     n = n.toLowerCase();
@@ -48,18 +50,14 @@ export function unescape(html) {
 
 const caret = /(^|[^\[])\^/g;
 
-/**
- * @param {string | RegExp} regex
- * @param {string} opt
- */
-export function edit(regex, opt) {
+export function edit(regex: Rule, opt?: string) {
   regex = typeof regex === 'string' ? regex : regex.source;
   opt = opt || '';
   const obj = {
-    replace: (name, val) => {
-      val = val.source || val;
+    replace: (name: string | RegExp, val: string | RegExp) => {
+      val = typeof val === 'object' && 'source' in val ? val.source : val;
       val = val.replace(caret, '$1');
-      regex = regex.replace(name, val);
+      regex = (regex as string).replace(name, val);
       return obj;
     },
     getRegex: () => {
@@ -72,12 +70,7 @@ export function edit(regex, opt) {
 const nonWordAndColonTest = /[^\w:]/g;
 const originIndependentUrl = /^$|^[a-z][a-z0-9+.-]*:|^[?#]/i;
 
-/**
- * @param {boolean} sanitize
- * @param {string} base
- * @param {string} href
- */
-export function cleanUrl(sanitize, base, href) {
+export function cleanUrl(sanitize: boolean | undefined, base: string | undefined | null, href: string) {
   if (sanitize) {
     let prot;
     try {
@@ -102,16 +95,12 @@ export function cleanUrl(sanitize, base, href) {
   return href;
 }
 
-const baseUrls = {};
+const baseUrls: Record<string, string> = {};
 const justDomain = /^[^:]+:\/*[^/]*$/;
 const protocol = /^([^:]+:)[\s\S]*$/;
 const domain = /^([^:]+:\/*[^/]*)[\s\S]*$/;
 
-/**
- * @param {string} base
- * @param {string} href
- */
-export function resolveUrl(base, href) {
+export function resolveUrl(base: string, href: string) {
   if (!baseUrls[' ' + base]) {
     // we can ignore everything in base after the last slash of its path component,
     // but we might need to add _that_
@@ -140,9 +129,9 @@ export function resolveUrl(base, href) {
   }
 }
 
-export const noopTest = { exec: function noopTest() {} };
+export const noopTest = { exec: () => null };
 
-export function splitCells(tableRow, count) {
+export function splitCells(tableRow: string, count: number) {
   // ensure that every cell-delimiting pipe has a space
   // before it to distinguish it from an escaped pipe
   const row = tableRow.replace(/\|/g, (match, offset, str) => {
@@ -162,8 +151,12 @@ export function splitCells(tableRow, count) {
   let i = 0;
 
   // First/last cell in a row cannot be empty if it has no leading/trailing pipe
-  if (!cells[0].trim()) { cells.shift(); }
-  if (cells.length > 0 && !cells[cells.length - 1].trim()) { cells.pop(); }
+  if (!cells[0].trim()) {
+    cells.shift();
+  }
+  if (cells.length > 0 && !cells[cells.length - 1].trim()) {
+    cells.pop();
+  }
 
   if (cells.length > count) {
     cells.splice(count);
@@ -182,11 +175,11 @@ export function splitCells(tableRow, count) {
  * Remove trailing 'c's. Equivalent to str.replace(/c*$/, '').
  * /c*$/ is vulnerable to REDOS.
  *
- * @param {string} str
- * @param {string} c
- * @param {boolean} invert Remove suffix of non-c chars instead. Default falsey.
+ * @param str
+ * @param c
+ * @param invert Remove suffix of non-c chars instead. Default falsey.
  */
-export function rtrim(str, c, invert) {
+export function rtrim(str: string, c: string, invert?: boolean) {
   const l = str.length;
   if (l === 0) {
     return '';
@@ -210,7 +203,7 @@ export function rtrim(str, c, invert) {
   return str.slice(0, l - suffLen);
 }
 
-export function findClosingBracket(str, b) {
+export function findClosingBracket(str: string, b: string) {
   if (str.indexOf(b[1]) === -1) {
     return -1;
   }
@@ -232,7 +225,7 @@ export function findClosingBracket(str, b) {
   return -1;
 }
 
-export function checkDeprecations(opt, callback) {
+export function checkDeprecations(opt: MarkedOptions, callback?: ResultCallback) {
   if (!opt || opt.silent) {
     return;
   }

package/src/marked.ts

@@ -0,0 +1,144 @@
+import { _Lexer } from './Lexer.ts';
+import { _Parser } from './Parser.ts';
+import { _Tokenizer } from './Tokenizer.ts';
+import { _Renderer } from './Renderer.ts';
+import { _TextRenderer } from './TextRenderer.ts';
+import { _Slugger } from './Slugger.ts';
+import { _Hooks } from './Hooks.ts';
+import { Marked } from './Instance.ts';
+import {
+  _getDefaults,
+  changeDefaults,
+  _defaults
+} from './defaults.ts';
+import type { MarkedExtension, MarkedOptions } from './MarkedOptions.ts';
+import type { Token, TokensList } from './Tokens.ts';
+
+export type ResultCallback = (error: Error | null, parseResult?: string) => undefined | void;
+
+const markedInstance = new Marked();
+
+/**
+ * Compiles markdown to HTML asynchronously.
+ *
+ * @param src String of markdown source to be compiled
+ * @param options Hash of options, having async: true
+ * @return Promise of string of compiled HTML
+ */
+export function marked(src: string, options: MarkedOptions & { async: true }): Promise<string>;
+
+/**
+ * Compiles markdown to HTML synchronously.
+ *
+ * @param src String of markdown source to be compiled
+ * @param options Optional hash of options
+ * @return String of compiled HTML
+ */
+export function marked(src: string, options?: MarkedOptions): string;
+
+/**
+ * Compiles markdown to HTML asynchronously with a callback.
+ *
+ * @param src String of markdown source to be compiled
+ * @param callback Function called when the markdownString has been fully parsed when using async highlighting
+ */
+export function marked(src: string, callback: ResultCallback): void;
+
+/**
+ * Compiles markdown to HTML asynchronously with a callback.
+ *
+ * @param src String of markdown source to be compiled
+ * @param options Hash of options
+ * @param callback Function called when the markdownString has been fully parsed when using async highlighting
+ */
+export function marked(
+    src: string,
+    options: MarkedOptions,
+    callback: ResultCallback,
+): void;
+export function marked(src: string, opt?: MarkedOptions | ResultCallback, callback?: ResultCallback): string | Promise<string | undefined> | undefined {
+  return markedInstance.parse(src, opt, callback);
+}
+
+/**
+ * Sets the default options.
+ *
+ * @param options Hash of options
+ */
+marked.options =
+marked.setOptions = function(options: MarkedOptions) {
+  markedInstance.setOptions(options);
+  marked.defaults = markedInstance.defaults;
+  changeDefaults(marked.defaults);
+  return marked;
+};
+
+/**
+ * Gets the original marked default options.
+ */
+marked.getDefaults = _getDefaults;
+
+marked.defaults = _defaults;
+
+/**
+ * Use Extension
+ */
+
+marked.use = function(...args: MarkedExtension[]) {
+  markedInstance.use(...args);
+  marked.defaults = markedInstance.defaults;
+  changeDefaults(marked.defaults);
+  return marked;
+};
+
+/**
+ * Run callback for every token
+ */
+
+marked.walkTokens = function <T = void>(tokens: Token[] | TokensList, callback: (token: Token) => T | T[]) {
+  return markedInstance.walkTokens(tokens, callback);
+};
+
+/**
+ * Compiles markdown to HTML without enclosing `p` tag.
+ *
+ * @param src String of markdown source to be compiled
+ * @param options Hash of options
+ * @return String of compiled HTML
+ */
+marked.parseInline = markedInstance.parseInline;
+
+/**
+ * Expose
+ */
+marked.Parser = _Parser;
+marked.parser = _Parser.parse;
+marked.Renderer = _Renderer;
+marked.TextRenderer = _TextRenderer;
+marked.Lexer = _Lexer;
+marked.lexer = _Lexer.lex;
+marked.Tokenizer = _Tokenizer;
+marked.Slugger = _Slugger;
+marked.Hooks = _Hooks;
+marked.parse = marked;
+
+export const options = marked.options;
+export const setOptions = marked.setOptions;
+export const use = marked.use;
+export const walkTokens = marked.walkTokens;
+export const parseInline = marked.parseInline;
+export const parse = marked;
+export const parser = _Parser.parse;
+export const lexer = _Lexer.lex;
+export { _defaults as defaults, _getDefaults as getDefaults } from './defaults.ts';
+export { _Lexer as Lexer } from './Lexer.ts';
+export { _Parser as Parser } from './Parser.ts';
+export { _Tokenizer as Tokenizer } from './Tokenizer.ts';
+export { _Renderer as Renderer } from './Renderer.ts';
+export { _TextRenderer as TextRenderer } from './TextRenderer.ts';
+export { _Slugger as Slugger } from './Slugger.ts';
+export { _Hooks as Hooks } from './Hooks.ts';
+export { Marked } from './Instance.ts';
+export type * from './MarkedOptions.ts';
+export type * from './rules.ts';
+export type * from './Tokens.ts';

package/src/{rules.js → rules.ts}

@@ -1,12 +1,73 @@
 import {
   noopTest,
   edit
-} from './helpers.js';
+} from './helpers.ts';
+
+export type Rule = RegExp | string;
+
+export interface Rules {
+  [ruleName: string]: Pick<RegExp, 'exec'> | Rule | Rules;
+}
+
+type BlockRuleNames =
+    | 'newline'
+    | 'code'
+    | 'fences'
+    | 'hr'
+    | 'heading'
+    | 'blockquote'
+    | 'list'
+    | 'html'
+    | 'def'
+    | 'lheading'
+    | '_paragraph'
+    | 'text'
+    | '_label'
+    | '_title'
+    | 'bullet'
+    | 'listItemStart'
+    | '_tag'
+    | '_comment'
+    | 'paragraph'
+    | 'uote' ;
+
+type BlockSubRuleNames = 'normal' | 'gfm' | 'pedantic';
+
+type InlineRuleNames =
+    | 'escape'
+    | 'autolink'
+    | 'tag'
+    | 'link'
+    | 'reflink'
+    | 'nolink'
+    | 'reflinkSearch'
+    | 'code'
+    | 'br'
+    | 'text'
+    | '_punctuation'
+    | 'punctuation'
+    | 'blockSkip'
+    | 'escapedEmSt'
+    | '_comment'
+    | '_escapes'
+    | '_scheme'
+    | '_email'
+    | '_attribute'
+    | '_label'
+    | '_href'
+    | '_title'
+    | 'strong'
+    | '_extended_email'
+    | '_backpedal';
+
+type InlineSubRuleNames = 'gfm' | 'emStrong' | 'normal' | 'pedantic'| 'breaks';
 
 /**
  * Block-Level Grammar
  */
-export const block = {
+// Not all rules are defined in the object literal
+// @ts-expect-error
+export const block: Record<BlockRuleNames, Rule> & Record<BlockSubRuleNames, Rules> & Rules = {
   newline: /^(?: *(?:\n|$))+/,
   code: /^( {4}[^\n]+(?:\n(?: *(?:\n|$))*)?)+/,
   fences: /^ {0,3}(`{3,}(?=[^`\n]*(?:\n|$))|~{3,})([^\n]*)(?:\n|$)(?:|([\s\S]*?)(?:\n|$))(?: {0,3}\1[~`]* *(?=\n|$)|$)/,
@@ -101,7 +162,7 @@ block.gfm = {
     + '(?:\\n((?:(?! *\\n|hr|heading|blockquote|code|fences|list|html).*(?:\\n|$))*)\\n*|$)' // Cells
 };
 
-block.gfm.table = edit(block.gfm.table)
+block.gfm.table = edit(block.gfm.table as Rule)
   .replace('hr', block.hr)
   .replace('heading', ' {0,3}#{1,6} ')
   .replace('blockquote', ' {0,3}>')
@@ -116,7 +177,7 @@ block.gfm.paragraph = edit(block._paragraph)
   .replace('hr', block.hr)
   .replace('heading', ' {0,3}#{1,6} ')
   .replace('|lheading', '') // setex headings don't interrupt commonmark paragraphs
-  .replace('table', block.gfm.table) // interrupt paragraphs with table
+  .replace('table', block.gfm.table as RegExp) // interrupt paragraphs with table
   .replace('blockquote', ' {0,3}>')
   .replace('fences', ' {0,3}(?:`{3,}(?=[^`\\n]*\\n)|~{3,})[^\\n]*\\n')
   .replace('list', ' {0,3}(?:[*+-]|1[.)]) ') // only lists starting from 1 can interrupt
@@ -143,7 +204,7 @@ block.pedantic = {
   heading: /^(#{1,6})(.*)(?:\n+|$)/,
   fences: noopTest, // fences not supported
   lheading: /^(.+?)\n {0,3}(=+|-+) *(?:\n+|$)/,
-  paragraph: edit(block.normal._paragraph)
+  paragraph: edit(block.normal._paragraph as Rule)
     .replace('hr', block.hr)
     .replace('heading', ' *#{1,6} *[^\n]')
     .replace('lheading', block.lheading)
@@ -157,7 +218,9 @@ block.pedantic = {
 /**
  * Inline-Level Grammar
  */
-export const inline = {
+// Not all rules are defined in the object literal
+// @ts-expect-error
+export const inline: Record<InlineRuleNames, Rule> & Record<InlineSubRuleNames, Rules> & Rules = {
   escape: /^\\([!"#$%&'()*+,\-./:;<=>?@\[\]\\^_`{|}~])/,
   autolink: /^<(scheme:[^\s\x00-\x1f<>]*|email)>/,
   url: noopTest,
@@ -196,19 +259,19 @@ inline._escapes = /\\([punct])/g;
 
 inline._comment = edit(block._comment).replace('(?:-->|$)', '-->').getRegex();
 
-inline.emStrong.lDelim = edit(inline.emStrong.lDelim, 'u')
+inline.emStrong.lDelim = edit(inline.emStrong.lDelim as Rule, 'u')
   .replace(/punct/g, inline._punctuation)
   .getRegex();
 
-inline.emStrong.rDelimAst = edit(inline.emStrong.rDelimAst, 'gu')
+inline.emStrong.rDelimAst = edit(inline.emStrong.rDelimAst as Rule, 'gu')
   .replace(/punct/g, inline._punctuation)
   .getRegex();
 
-inline.emStrong.rDelimUnd = edit(inline.emStrong.rDelimUnd, 'gu')
+inline.emStrong.rDelimUnd = edit(inline.emStrong.rDelimUnd as Rule, 'gu')
   .replace(/punct/g, inline._punctuation)
   .getRegex();
 
-inline.anyPunctuation = edit(inline.anyPunctuation, 'gu')
+inline.anyPunctuation = edit(inline.anyPunctuation as Rule, 'gu')
   .replace(/punct/g, inline._punctuation)
   .getRegex();
 
@@ -300,8 +363,8 @@ inline.gfm = {
   text: /^([`~]+|[^`~])(?:(?= {2,}\n)|(?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@)|[\s\S]*?(?:(?=[\\<!\[`*~_]|\b_|https?:\/\/|ftp:\/\/|www\.|$)|[^ ](?= {2,}\n)|[^a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-](?=[a-zA-Z0-9.!#$%&'*+\/=?_`{\|}~-]+@)))/
 };
 
-inline.gfm.url = edit(inline.gfm.url, 'i')
-  .replace('email', inline.gfm._extended_email)
+inline.gfm.url = edit(inline.gfm.url as Rule, 'i')
+  .replace('email', inline.gfm._extended_email as RegExp)
   .getRegex();
 /**
  * GFM + Line Breaks Inline Grammar
@@ -310,7 +373,7 @@ inline.gfm.url = edit(inline.gfm.url, 'i')
 inline.breaks = {
   ...inline.gfm,
   br: edit(inline.br).replace('{2,}', '*').getRegex(),
-  text: edit(inline.gfm.text)
+  text: edit(inline.gfm.text as Rule)
     .replace('\\b_', '\\b_| {2,}\\n')
     .replace(/\{2,\}/g, '*')
     .getRegex()

package/src/Hooks.js

@@ -1,26 +0,0 @@
-import { defaults } from './defaults.js';
-
-export class Hooks {
-  constructor(options) {
-    this.options = options || defaults;
-  }
-
-  static passThroughHooks = new Set([
-    'preprocess',
-    'postprocess'
-  ]);
-
-  /**
-   * Process markdown before marked
-   */
-  preprocess(markdown) {
-    return markdown;
-  }
-
-  /**
-   * Process HTML after marked is finished
-   */
-  postprocess(html) {
-    return html;
-  }
-}

package/src/marked.js

@@ -1,91 +0,0 @@
-import { Lexer } from './Lexer.js';
-import { Parser } from './Parser.js';
-import { Tokenizer } from './Tokenizer.js';
-import { Renderer } from './Renderer.js';
-import { TextRenderer } from './TextRenderer.js';
-import { Slugger } from './Slugger.js';
-import { Hooks } from './Hooks.js';
-import { Marked } from './Instance.js';
-import { changeDefaults, getDefaults, defaults } from './defaults.js';
-
-const markedInstance = new Marked(defaults);
-
-/**
- * Marked
- */
-export function marked(src, opt, callback) {
-  return markedInstance.parse(src, opt, callback);
-}
-
-/**
- * Options
- */
-
-marked.options =
-marked.setOptions = function(opt) {
-  markedInstance.setOptions(opt);
-  marked.defaults = markedInstance.defaults;
-  changeDefaults(marked.defaults);
-  return marked;
-};
-
-marked.getDefaults = getDefaults;
-
-marked.defaults = defaults;
-
-/**
- * Use Extension
- */
-
-marked.use = function(...args) {
-  markedInstance.use(...args);
-  marked.defaults = markedInstance.defaults;
-  changeDefaults(marked.defaults);
-  return marked;
-};
-
-/**
- * Run callback for every token
- */
-
-marked.walkTokens = function(tokens, callback) {
-  return markedInstance.walkTokens(tokens, callback);
-};
-
-/**
- * Parse Inline
- * @param {string} src
- */
-marked.parseInline = markedInstance.parseInline;
-
-/**
- * Expose
- */
-marked.Parser = Parser;
-marked.parser = Parser.parse;
-marked.Renderer = Renderer;
-marked.TextRenderer = TextRenderer;
-marked.Lexer = Lexer;
-marked.lexer = Lexer.lex;
-marked.Tokenizer = Tokenizer;
-marked.Slugger = Slugger;
-marked.Hooks = Hooks;
-marked.parse = marked;
-
-export const options = marked.options;
-export const setOptions = marked.setOptions;
-export const use = marked.use;
-export const walkTokens = marked.walkTokens;
-export const parseInline = marked.parseInline;
-export const parse = marked;
-export const parser = Parser.parse;
-export const lexer = Lexer.lex;
-export { defaults, getDefaults } from './defaults.js';
-export { Lexer } from './Lexer.js';
-export { Parser } from './Parser.js';
-export { Tokenizer } from './Tokenizer.js';
-export { Renderer } from './Renderer.js';
-export { TextRenderer } from './TextRenderer.js';
-export { Slugger } from './Slugger.js';
-export { Hooks } from './Hooks.js';
-export { Marked } from './Instance.js';