@helpers4/markdown 2.0.0-beta.3 → 2.0.0

package/lib/index.d.ts

@@ -37,7 +37,7 @@ interface EscapeOptions {
  *
  * escape('foo | bar', { cell: true })
  * // => 'foo \\| bar'
- * @since next
+ * @since 2.0.0
  */
 declare function escape(str: string, options?: EscapeOptions): string;
 

package/lib/index.js

@@ -20,7 +20,7 @@
 *
 * escape('foo | bar', { cell: true })
 * // => 'foo \\| bar'
-* @since next
+* @since 2.0.0
 */
 function escape(str, options) {
 	let result = str.replace(/[\\`*_{}[\]()#+\-.!]/g, "\\$&");

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/markdown/escape.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Options for {@link escape}.\n */\nexport interface EscapeOptions {\n  /**\n   * When `true`, additionally escapes pipe characters (`|`) and replaces\n   * newlines with spaces, making the result safe for use as a Markdown table\n   * cell value.\n   *\n   * @default false\n   */\n  cell?: boolean;\n}\n\n/**\n * Escapes all Markdown special characters in a string so they render as\n * literal text rather than formatting syntax.\n *\n * Escaped characters: `\\ \\` * _ { } [ ] ( ) # + - . !`\n *\n * Pass `{ cell: true }` to also escape pipe characters and replace newlines\n * with spaces, making the result safe for embedding in a Markdown table cell.\n *\n * @param str - The raw string to escape\n * @param options - Optional escaping options\n * @returns The escaped string\n * @example\n * escape('**bold** and _italic_')\n * // => '\\\\*\\\\*bold\\\\*\\\\* and \\\\_italic\\\\_'\n *\n * escape('[link](url)')\n * // => '\\\\[link\\\\]\\\\(url\\\\)'\n *\n * escape('foo | bar', { cell: true })\n * // => 'foo \\\\| bar'\n * @since next\n */\nexport function escape(str: string, options?: EscapeOptions): string {\n  let result = str.replace(/[\\\\`*_{}[\\]()#+\\-.!]/g, '\\\\$&');\n  if (options?.cell) {\n    result = result.replace(/\\|/g, '\\\\|').replace(/\\n/g, ' ');\n  }\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AA2CA,SAAgB,OAAO,KAAa,SAAiC;CACnE,IAAI,SAAS,IAAI,QAAQ,yBAAyB,OAAO;CACzD,IAAI,SAAS,MACX,SAAS,OAAO,QAAQ,OAAO,MAAM,CAAC,QAAQ,OAAO,IAAI;CAE3D,OAAO"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/markdown/escape.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Options for {@link escape}.\n */\nexport interface EscapeOptions {\n  /**\n   * When `true`, additionally escapes pipe characters (`|`) and replaces\n   * newlines with spaces, making the result safe for use as a Markdown table\n   * cell value.\n   *\n   * @default false\n   */\n  cell?: boolean;\n}\n\n/**\n * Escapes all Markdown special characters in a string so they render as\n * literal text rather than formatting syntax.\n *\n * Escaped characters: `\\ \\` * _ { } [ ] ( ) # + - . !`\n *\n * Pass `{ cell: true }` to also escape pipe characters and replace newlines\n * with spaces, making the result safe for embedding in a Markdown table cell.\n *\n * @param str - The raw string to escape\n * @param options - Optional escaping options\n * @returns The escaped string\n * @example\n * escape('**bold** and _italic_')\n * // => '\\\\*\\\\*bold\\\\*\\\\* and \\\\_italic\\\\_'\n *\n * escape('[link](url)')\n * // => '\\\\[link\\\\]\\\\(url\\\\)'\n *\n * escape('foo | bar', { cell: true })\n * // => 'foo \\\\| bar'\n * @since 2.0.0\n */\nexport function escape(str: string, options?: EscapeOptions): string {\n  let result = str.replace(/[\\\\`*_{}[\\]()#+\\-.!]/g, '\\\\$&');\n  if (options?.cell) {\n    result = result.replace(/\\|/g, '\\\\|').replace(/\\n/g, ' ');\n  }\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AA2CA,SAAgB,OAAO,KAAa,SAAiC;CACnE,IAAI,SAAS,IAAI,QAAQ,yBAAyB,MAAM;CACxD,IAAI,SAAS,MACX,SAAS,OAAO,QAAQ,OAAO,KAAK,EAAE,QAAQ,OAAO,GAAG;CAE1D,OAAO;AACT"}

package/llms.txt

@@ -1,7 +1,7 @@
 # @helpers4/markdown
 
 > Tree-shakable TypeScript utility functions for the `markdown` domain.
-> Package: `@helpers4/markdown` — Version: 2.0.0-beta.3
+> Package: `@helpers4/markdown` — Version: 2.0.0
 > License: LGPL-3.0-or-later
 
 ## Installation

package/meta/api.json

@@ -1,12 +1,12 @@
 {
   "category": "markdown",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0",
   "functions": [
     {
       "name": "escape",
       "kind": "function",
       "description": "Escapes all Markdown special characters in a string so they render as\nliteral text rather than formatting syntax.\n\nEscaped characters: `\\ \\` * _ { } [ ] ( ) # + - . !`\n\nPass `{ cell: true }` to also escape pipe characters and replace newlines\nwith spaces, making the result safe for embedding in a Markdown table cell.",
-      "since": "next",
+      "since": "2.0.0",
       "signatures": [
         {
           "signature": "escape(str: string, options?: EscapeOptions): string",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helpers4/markdown",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for markdown.",
   "author": "baxyz <baxy@etik.com>",
   "license": "LGPL-3.0",