typopo/src/utils/markdown.js

Fix frequent microtypography errors in multiple languages. Write neat texts without bothering about typography rules. Typopo works for English, German, Slovak, Czech and Rusyn language.

/* 
  Utility functions to identify and handle exceptions for Markdown files.
*/

const TICK = "{{typopo__markdown_tick}}";

/** 
  Identify markdown code ticks that wrap code blocks, so they’re not fixed as apostrophes

  Examples
  inline `code block`

  ``escaping inline `code block` in Markdown file``


  ```
  fenced code block
  ```

  Docs
  https://www.markdownguide.org/basic-syntax

  @param {string} string: input text for identification
  @returns {string} output with identified markdown ticks that wrap code blocks
*/
export function identifyMarkdownCodeTicks(string, configuration) {
  if (!configuration.keepMarkdownCodeBlocks) return string;

  return string
    .replace(/(\s*)(```)/g, `$1${TICK}${TICK}${TICK}`)
    .replace(/(``)(.*?)(``)/g, `${TICK}${TICK}$2${TICK}${TICK}`)
    .replace(/(`)(.*?)(`)/g, `${TICK}$2${TICK}`);
}

//

/**
  Place markdown code ticks, identified in identifyMarkdownCodeTicks

  Docs
  https://www.markdownguide.org/basic-syntax

  @param {string} string: input text for identification
  @returns {string} output with placed Markdown code tick
*/
export function placeMarkdownCodeTicks(string, configuration) {
  if (!configuration.keepMarkdownCodeBlocks) return string;

  // prettier-ignore
  return string.replace(
    new RegExp(
      `${TICK}`,
      "g"
    ),
      `\``
  )
}