typopo/src/typopo.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.

/*!
 * Typopo v2.5.8 (https://typopo.org)
 * Copyright 2015–2025 Braňo Šandala (https://brano.me)
 * Licensed under MIT (https://github.com/surfinzap/typopo/blob/main/LICENSE.txt)
 */
import Locale from "./locale/locale.js";
import { removeEmptyLines } from "./modules/whitespace/lines.js";
import { fixNbsp } from "./modules/whitespace/nbsp.js";
import { fixSpaces } from "./modules/whitespace/spaces.js";
import { fixPeriod } from "./modules/punctuation/period.js";
import { fixEllipsis } from "./modules/punctuation/ellipsis.js";
import { fixDash } from "./modules/punctuation/dash.js";
import { fixDoubleQuotesAndPrimes } from "./modules/punctuation/double-quotes.js";
import { fixSingleQuotesPrimesAndApostrophes } from "./modules/punctuation/single-quotes.js";
import { fixMultiplicationSign } from "./modules/symbols/multiplication-sign.js";
import { fixSectionSign } from "./modules/symbols/section-sign.js";
import { fixCopyrights } from "./modules/symbols/copyrights.js";
import { fixNumeroSign } from "./modules/symbols/numero-sign.js";
import { fixPlusMinus } from "./modules/symbols/plus-minus.js";
import { fixMarks } from "./modules/symbols/marks.js";
import { fixExponents } from "./modules/symbols/exponents.js";
import { fixNumberSign } from "./modules/symbols/number-sign.js";
import { fixAbbreviations } from "./modules/words/abbreviations.js";
import { fixCase } from "./modules/words/case.js";
import { fixPubId } from "./modules/words/pub-id.js";
import { excludeExceptions, placeExceptions } from "./modules/words/exceptions.js";

/**
 * Fixes microtypography errors in text across multiple languages
 *
 * @param {string} string - Input text for correction
 * @param {string} [locale="en-us"] - Language locale. Supported: "en-us", "de-de", "sk", "cs", "rue"
 * @param {Object} [configuration] - Configuration options
 * @param {boolean} [configuration.removeLines=true] - Remove empty lines between paragraphs
 * @param {boolean} [configuration.removeWhitespacesBeforeMarkdownList=true] - Remove whitespaces before Markdown lists
 * @param {boolean} [configuration.keepMarkdownCodeBlocks=false] - Preserve Markdown code blocks from quote processing
 * @returns {string} Text with typography corrections applied
 */
export function fixTypos(string, locale, configuration) {
  locale = typeof locale === "undefined" ? "en-us" : locale;

  let currentLocale = new Locale(locale);

  configuration =
    typeof configuration === "undefined"
      ? {
          removeLines:                         true,
          removeWhitespacesBeforeMarkdownList: true,
          keepMarkdownCodeBlocks:              false,
        }
      : configuration;

  // exclude exceptions from fixing
  const { processedText, exceptions } = excludeExceptions(string);
  string = processedText;

  if (configuration.removeLines) {
    string = removeEmptyLines(string);
  }

  // ellipsis (since it can have different spacing around, it has to go before spaces cleanup)
  string = fixEllipsis(string, currentLocale);

  // spaces cleanup
  string = fixSpaces(string, currentLocale, configuration);

  // punctuation
  string = fixPeriod(string);
  string = fixDash(string, currentLocale);
  string = fixSingleQuotesPrimesAndApostrophes(string, currentLocale, configuration);
  string = fixDoubleQuotesAndPrimes(string, currentLocale, configuration);

  // symbols
  string = fixMultiplicationSign(string);
  string = fixSectionSign(string, currentLocale);
  string = fixCopyrights(string, currentLocale);
  string = fixNumeroSign(string, currentLocale);
  string = fixPlusMinus(string);
  string = fixMarks(string);
  string = fixExponents(string);
  string = fixNumberSign(string);

  // words
  string = fixCase(string);
  string = fixPubId(string);
  string = fixAbbreviations(string, currentLocale);

  // spaces
  string = fixNbsp(string, currentLocale);

  // place excluded exceptions
  string = placeExceptions(string, exceptions);

  return string;
}