typopo/src/modules/words/pub-id.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.

import { base } from "../../const.js";

/**
  Identifies wrongly formatted ISSN and corrects it
  Wiki: https://en.wikipedia.org/wiki/International_Standard_Serial_Number

  Since the ISSN format is 0000-0000, the script will only catch ISSN
  for correction if there is ISSN abbreviation placed before digits

  Examples
  ISSN 0000 - 0000 → ISSN 0000-0000
  issn 0000 - 0000 → ISSN 0000-0000
  ISSN 0000—0000 → ISSN 0000-0000
  ISSN: 0000 - 0000 → ISSN: 0000-0000 // the use of colon

  @param {string} string — input text for identification
  @returns {string} — output with correct ISSN format
*/
export function fixISSN(string) {
  // prettier-ignore
  return string.replace(
    new RegExp(
      `(issn)` +
      `(:?)` +
      `([${base.spaces}]?)` +
      `(\\d{4})` +
      `([${base.spaces}]?[${base.hyphen}${base.enDash}${base.emDash}][${base.spaces}]?)` +
      `(\\d{4})`,
      "gi"
    ),
    `ISSN$2${base.nbsp}$4-$6`
  );
}

//

/**
  Identifies wrongly formatted ISBN10 and corrects it
  Wiki: https://en.wikipedia.org/wiki/International_Standard_Book_Numbe

  Since the ISBN10 format varies among publishers, the function will try
  to catch possible variations

  Examples
  Isbn 80- 902734—1-6 → ISBN 80-902734-1-6
  Isbn 80- 902734—1-6 → ISBN 80-902734-1-6
  Isbn: 0-9752298-0-X → ISBN: 0-9752298-0-X // the use of colon

  @param {string} string — input text for identification
  @returns {string} — output with correct ISBN format
*/
export function fixISBN10(string) {
  // prettier-ignore
  let dashedSpace = `([${base.spaces}]?[${base.hyphen}${base.enDash}${base.emDash}][${base.spaces}]?)`;
  // prettier-ignore
  return string.replace(
    new RegExp(
      `(isbn)` +
      `(:?)` +
      `([${base.spaces}]?)` +
      `(\\d+)` +
      dashedSpace +
      `(\\d+)` +
      dashedSpace +
      `(\\d+)` +
      dashedSpace +
      `(X|\\d+)`,
      "gi"
    ),
    `ISBN$2${base.nbsp}$4-$6-$8-$10`
  );
}

//

/**
  Identifies wrongly formatted ISBN13 and corrects it
  Wiki: https://en.wikipedia.org/wiki/International_Standard_Book_Numbe

  Since the ISBN13 format varies among publishers, the function will try
  to catch possible variations

  Examples
  Isbn 978-80- 902734—1-6 → ISBN 80-902734-1-6
  Isbn 978-80- 902734—1-6 → ISBN 80-902734-1-6
  Isbn: 978-0-9752298-0-X → ISBN: 0-9752298-0-X // the use of colon

  @param {string} string — input text for identification
  @returns {string} — output with correct ISBN format
*/
export function fixISBN13(string) {
  // prettier-ignore
  let dashedSpace = `([${base.spaces}]?[${base.hyphen}${base.enDash}${base.emDash}][${base.spaces}]?)`;
  // prettier-ignore
  return string.replace(
    new RegExp(
      `(isbn)` +
      `(:?)` +
      `([${base.spaces}]?)` +
      `(\\d+)` +
      dashedSpace +
      `(\\d+)` +
      dashedSpace +
      `(\\d+)` +
      dashedSpace +
      `(\\d+)` +
      dashedSpace +
      `(X|\\d+)`,
      "gi"
    ),
    `ISBN$2${base.nbsp}$4-$6-$8-$10-$12`
  );
}

//

/**
  Identifies wrongly formatted ISBN13 number and corrects it
  Wiki: https://en.wikipedia.org/wiki/International_Standard_Book_Numbe

  When ISBN number is standalone, it fixes hyphens and spaces in between.

  Examples
  978-80- 902734—1-6 → 80-902734-1-6
  978-80- 902734—1-6 → 80-902734-1-6
  978-0-9752298- 0-X → 0-9752298-0-X // the use of colon

  @param {string} string — input text for identification
  @returns {string} — output with correct ISBN format
*/
export function fixISBNnumber(string) {
  // prettier-ignore
  let dashedSpace = `([${base.spaces}]?[${base.hyphen}${base.enDash}${base.emDash}][${base.spaces}]?)`;
  // prettier-ignore
  return string.replace(
    new RegExp(
      `(\\d+)` +
      dashedSpace +
      `(\\d+)` +
      dashedSpace +
      `(\\d+)` +
      dashedSpace +
      `(\\d+)` +
      dashedSpace +
      `(X|\\d+?)`,
      "g"
    ),
    `$1-$3-$5-$7-$9`
  );
}

//

/**
  Fixes publication identifiers — ISSN, ISBN

  @param {string} string — input text for identification
  @returns {string} — output with fixed publication identifiers
*/
export function fixPubId(string) {
  string = fixISSN(string);
  string = fixISBN10(string);
  string = fixISBN13(string);
  string = fixISBNnumber(string);

  return string;
}