@tiangong-lca/pcr 0.3.0 → 0.4.0

package/node_modules/micromark-extension-gfm-footnote/dev/lib/syntax.js

@@ -0,0 +1,558 @@
+/**
+ * @import {Event, Exiter, Extension, Resolver, State, Token, TokenizeContext, Tokenizer} from 'micromark-util-types'
+ */
+
+import {ok as assert} from 'devlop'
+import {blankLine} from 'micromark-core-commonmark'
+import {factorySpace} from 'micromark-factory-space'
+import {markdownLineEndingOrSpace} from 'micromark-util-character'
+import {normalizeIdentifier} from 'micromark-util-normalize-identifier'
+import {codes, constants, types} from 'micromark-util-symbol'
+
+const indent = {tokenize: tokenizeIndent, partial: true}
+
+// To do: micromark should support a `_hiddenGfmFootnoteSupport`, which only
+// affects label start (image).
+// That will let us drop `tokenizePotentialGfmFootnote*`.
+// It currently has a `_hiddenFootnoteSupport`, which affects that and more.
+// That can be removed when `micromark-extension-footnote` is archived.
+
+/**
+ * Create an extension for `micromark` to enable GFM footnote syntax.
+ *
+ * @returns {Extension}
+ *   Extension for `micromark` that can be passed in `extensions` to
+ *   enable GFM footnote syntax.
+ */
+export function gfmFootnote() {
+  /** @type {Extension} */
+  return {
+    document: {
+      [codes.leftSquareBracket]: {
+        name: 'gfmFootnoteDefinition',
+        tokenize: tokenizeDefinitionStart,
+        continuation: {tokenize: tokenizeDefinitionContinuation},
+        exit: gfmFootnoteDefinitionEnd
+      }
+    },
+    text: {
+      [codes.leftSquareBracket]: {
+        name: 'gfmFootnoteCall',
+        tokenize: tokenizeGfmFootnoteCall
+      },
+      [codes.rightSquareBracket]: {
+        name: 'gfmPotentialFootnoteCall',
+        add: 'after',
+        tokenize: tokenizePotentialGfmFootnoteCall,
+        resolveTo: resolveToPotentialGfmFootnoteCall
+      }
+    }
+  }
+}
+
+// To do: remove after micromark update.
+/**
+ * @this {TokenizeContext}
+ * @type {Tokenizer}
+ */
+function tokenizePotentialGfmFootnoteCall(effects, ok, nok) {
+  const self = this
+  let index = self.events.length
+  const defined = self.parser.gfmFootnotes || (self.parser.gfmFootnotes = [])
+  /** @type {Token} */
+  let labelStart
+
+  // Find an opening.
+  while (index--) {
+    const token = self.events[index][1]
+
+    if (token.type === types.labelImage) {
+      labelStart = token
+      break
+    }
+
+    // Exit if we’ve walked far enough.
+    if (
+      token.type === 'gfmFootnoteCall' ||
+      token.type === types.labelLink ||
+      token.type === types.label ||
+      token.type === types.image ||
+      token.type === types.link
+    ) {
+      break
+    }
+  }
+
+  return start
+
+  /**
+   * @type {State}
+   */
+  function start(code) {
+    assert(code === codes.rightSquareBracket, 'expected `]`')
+
+    if (!labelStart || !labelStart._balanced) {
+      return nok(code)
+    }
+
+    const id = normalizeIdentifier(
+      self.sliceSerialize({start: labelStart.end, end: self.now()})
+    )
+
+    if (id.codePointAt(0) !== codes.caret || !defined.includes(id.slice(1))) {
+      return nok(code)
+    }
+
+    effects.enter('gfmFootnoteCallLabelMarker')
+    effects.consume(code)
+    effects.exit('gfmFootnoteCallLabelMarker')
+    return ok(code)
+  }
+}
+
+// To do: remove after micromark update.
+/** @type {Resolver} */
+function resolveToPotentialGfmFootnoteCall(events, context) {
+  let index = events.length
+  /** @type {Token | undefined} */
+  let labelStart
+
+  // Find an opening.
+  while (index--) {
+    if (
+      events[index][1].type === types.labelImage &&
+      events[index][0] === 'enter'
+    ) {
+      labelStart = events[index][1]
+      break
+    }
+  }
+
+  assert(labelStart, 'expected `labelStart` to resolve')
+
+  // Change the `labelImageMarker` to a `data`.
+  events[index + 1][1].type = types.data
+  events[index + 3][1].type = 'gfmFootnoteCallLabelMarker'
+
+  // The whole (without `!`):
+  /** @type {Token} */
+  const call = {
+    type: 'gfmFootnoteCall',
+    start: Object.assign({}, events[index + 3][1].start),
+    end: Object.assign({}, events[events.length - 1][1].end)
+  }
+  // The `^` marker
+  /** @type {Token} */
+  const marker = {
+    type: 'gfmFootnoteCallMarker',
+    start: Object.assign({}, events[index + 3][1].end),
+    end: Object.assign({}, events[index + 3][1].end)
+  }
+  // Increment the end 1 character.
+  marker.end.column++
+  marker.end.offset++
+  marker.end._bufferIndex++
+  /** @type {Token} */
+  const string = {
+    type: 'gfmFootnoteCallString',
+    start: Object.assign({}, marker.end),
+    end: Object.assign({}, events[events.length - 1][1].start)
+  }
+  /** @type {Token} */
+  const chunk = {
+    type: types.chunkString,
+    contentType: 'string',
+    start: Object.assign({}, string.start),
+    end: Object.assign({}, string.end)
+  }
+
+  /** @type {Array<Event>} */
+  const replacement = [
+    // Take the `labelImageMarker` (now `data`, the `!`)
+    events[index + 1],
+    events[index + 2],
+    ['enter', call, context],
+    // The `[`
+    events[index + 3],
+    events[index + 4],
+    // The `^`.
+    ['enter', marker, context],
+    ['exit', marker, context],
+    // Everything in between.
+    ['enter', string, context],
+    ['enter', chunk, context],
+    ['exit', chunk, context],
+    ['exit', string, context],
+    // The ending (`]`, properly parsed and labelled).
+    events[events.length - 2],
+    events[events.length - 1],
+    ['exit', call, context]
+  ]
+
+  events.splice(index, events.length - index + 1, ...replacement)
+
+  return events
+}
+
+/**
+ * @this {TokenizeContext}
+ * @type {Tokenizer}
+ */
+function tokenizeGfmFootnoteCall(effects, ok, nok) {
+  const self = this
+  const defined = self.parser.gfmFootnotes || (self.parser.gfmFootnotes = [])
+  let size = 0
+  /** @type {boolean} */
+  let data
+
+  // Note: the implementation of `markdown-rs` is different, because it houses
+  // core *and* extensions in one project.
+  // Therefore, it can include footnote logic inside `label-end`.
+  // We can’t do that, but luckily, we can parse footnotes in a simpler way than
+  // needed for labels.
+  return start
+
+  /**
+   * Start of footnote label.
+   *
+   * ```markdown
+   * > | a [^b] c
+   *       ^
+   * ```
+   *
+   * @type {State}
+   */
+  function start(code) {
+    assert(code === codes.leftSquareBracket, 'expected `[`')
+    effects.enter('gfmFootnoteCall')
+    effects.enter('gfmFootnoteCallLabelMarker')
+    effects.consume(code)
+    effects.exit('gfmFootnoteCallLabelMarker')
+    return callStart
+  }
+
+  /**
+   * After `[`, at `^`.
+   *
+   * ```markdown
+   * > | a [^b] c
+   *        ^
+   * ```
+   *
+   * @type {State}
+   */
+  function callStart(code) {
+    if (code !== codes.caret) return nok(code)
+
+    effects.enter('gfmFootnoteCallMarker')
+    effects.consume(code)
+    effects.exit('gfmFootnoteCallMarker')
+    effects.enter('gfmFootnoteCallString')
+    effects.enter('chunkString').contentType = 'string'
+    return callData
+  }
+
+  /**
+   * In label.
+   *
+   * ```markdown
+   * > | a [^b] c
+   *         ^
+   * ```
+   *
+   * @type {State}
+   */
+  function callData(code) {
+    if (
+      // Too long.
+      size > constants.linkReferenceSizeMax ||
+      // Closing brace with nothing.
+      (code === codes.rightSquareBracket && !data) ||
+      // Space or tab is not supported by GFM for some reason.
+      // `\n` and `[` not being supported makes sense.
+      code === codes.eof ||
+      code === codes.leftSquareBracket ||
+      markdownLineEndingOrSpace(code)
+    ) {
+      return nok(code)
+    }
+
+    if (code === codes.rightSquareBracket) {
+      effects.exit('chunkString')
+      const token = effects.exit('gfmFootnoteCallString')
+
+      if (!defined.includes(normalizeIdentifier(self.sliceSerialize(token)))) {
+        return nok(code)
+      }
+
+      effects.enter('gfmFootnoteCallLabelMarker')
+      effects.consume(code)
+      effects.exit('gfmFootnoteCallLabelMarker')
+      effects.exit('gfmFootnoteCall')
+      return ok
+    }
+
+    if (!markdownLineEndingOrSpace(code)) {
+      data = true
+    }
+
+    size++
+    effects.consume(code)
+    return code === codes.backslash ? callEscape : callData
+  }
+
+  /**
+   * On character after escape.
+   *
+   * ```markdown
+   * > | a [^b\c] d
+   *           ^
+   * ```
+   *
+   * @type {State}
+   */
+  function callEscape(code) {
+    if (
+      code === codes.leftSquareBracket ||
+      code === codes.backslash ||
+      code === codes.rightSquareBracket
+    ) {
+      effects.consume(code)
+      size++
+      return callData
+    }
+
+    return callData(code)
+  }
+}
+
+/**
+ * @this {TokenizeContext}
+ * @type {Tokenizer}
+ */
+function tokenizeDefinitionStart(effects, ok, nok) {
+  const self = this
+  const defined = self.parser.gfmFootnotes || (self.parser.gfmFootnotes = [])
+  /** @type {string} */
+  let identifier
+  let size = 0
+  /** @type {boolean | undefined} */
+  let data
+
+  return start
+
+  /**
+   * Start of GFM footnote definition.
+   *
+   * ```markdown
+   * > | [^a]: b
+   *     ^
+   * ```
+   *
+   * @type {State}
+   */
+  function start(code) {
+    assert(code === codes.leftSquareBracket, 'expected `[`')
+    effects.enter('gfmFootnoteDefinition')._container = true
+    effects.enter('gfmFootnoteDefinitionLabel')
+    effects.enter('gfmFootnoteDefinitionLabelMarker')
+    effects.consume(code)
+    effects.exit('gfmFootnoteDefinitionLabelMarker')
+    return labelAtMarker
+  }
+
+  /**
+   * In label, at caret.
+   *
+   * ```markdown
+   * > | [^a]: b
+   *      ^
+   * ```
+   *
+   * @type {State}
+   */
+  function labelAtMarker(code) {
+    if (code === codes.caret) {
+      effects.enter('gfmFootnoteDefinitionMarker')
+      effects.consume(code)
+      effects.exit('gfmFootnoteDefinitionMarker')
+      effects.enter('gfmFootnoteDefinitionLabelString')
+      effects.enter('chunkString').contentType = 'string'
+      return labelInside
+    }
+
+    return nok(code)
+  }
+
+  /**
+   * In label.
+   *
+   * > 👉 **Note**: `cmark-gfm` prevents whitespace from occurring in footnote
+   * > definition labels.
+   *
+   * ```markdown
+   * > | [^a]: b
+   *       ^
+   * ```
+   *
+   * @type {State}
+   */
+  function labelInside(code) {
+    if (
+      // Too long.
+      size > constants.linkReferenceSizeMax ||
+      // Closing brace with nothing.
+      (code === codes.rightSquareBracket && !data) ||
+      // Space or tab is not supported by GFM for some reason.
+      // `\n` and `[` not being supported makes sense.
+      code === codes.eof ||
+      code === codes.leftSquareBracket ||
+      markdownLineEndingOrSpace(code)
+    ) {
+      return nok(code)
+    }
+
+    if (code === codes.rightSquareBracket) {
+      effects.exit('chunkString')
+      const token = effects.exit('gfmFootnoteDefinitionLabelString')
+      identifier = normalizeIdentifier(self.sliceSerialize(token))
+      effects.enter('gfmFootnoteDefinitionLabelMarker')
+      effects.consume(code)
+      effects.exit('gfmFootnoteDefinitionLabelMarker')
+      effects.exit('gfmFootnoteDefinitionLabel')
+      return labelAfter
+    }
+
+    if (!markdownLineEndingOrSpace(code)) {
+      data = true
+    }
+
+    size++
+    effects.consume(code)
+    return code === codes.backslash ? labelEscape : labelInside
+  }
+
+  /**
+   * After `\`, at a special character.
+   *
+   * > 👉 **Note**: `cmark-gfm` currently does not support escaped brackets:
+   * > <https://github.com/github/cmark-gfm/issues/240>
+   *
+   * ```markdown
+   * > | [^a\*b]: c
+   *         ^
+   * ```
+   *
+   * @type {State}
+   */
+  function labelEscape(code) {
+    if (
+      code === codes.leftSquareBracket ||
+      code === codes.backslash ||
+      code === codes.rightSquareBracket
+    ) {
+      effects.consume(code)
+      size++
+      return labelInside
+    }
+
+    return labelInside(code)
+  }
+
+  /**
+   * After definition label.
+   *
+   * ```markdown
+   * > | [^a]: b
+   *         ^
+   * ```
+   *
+   * @type {State}
+   */
+  function labelAfter(code) {
+    if (code === codes.colon) {
+      effects.enter('definitionMarker')
+      effects.consume(code)
+      effects.exit('definitionMarker')
+
+      if (!defined.includes(identifier)) {
+        defined.push(identifier)
+      }
+
+      // Any whitespace after the marker is eaten, forming indented code
+      // is not possible.
+      // No space is also fine, just like a block quote marker.
+      return factorySpace(
+        effects,
+        whitespaceAfter,
+        'gfmFootnoteDefinitionWhitespace'
+      )
+    }
+
+    return nok(code)
+  }
+
+  /**
+   * After definition prefix.
+   *
+   * ```markdown
+   * > | [^a]: b
+   *           ^
+   * ```
+   *
+   * @type {State}
+   */
+  function whitespaceAfter(code) {
+    // `markdown-rs` has a wrapping token for the prefix that is closed here.
+    return ok(code)
+  }
+}
+
+/**
+ * @this {TokenizeContext}
+ * @type {Tokenizer}
+ */
+function tokenizeDefinitionContinuation(effects, ok, nok) {
+  /// Start of footnote definition continuation.
+  ///
+  /// ```markdown
+  ///   | [^a]: b
+  /// > |     c
+  ///     ^
+  /// ```
+  //
+  // Either a blank line, which is okay, or an indented thing.
+  return effects.check(blankLine, ok, effects.attempt(indent, ok, nok))
+}
+
+/** @type {Exiter} */
+function gfmFootnoteDefinitionEnd(effects) {
+  effects.exit('gfmFootnoteDefinition')
+}
+
+/**
+ * @this {TokenizeContext}
+ * @type {Tokenizer}
+ */
+function tokenizeIndent(effects, ok, nok) {
+  const self = this
+
+  return factorySpace(
+    effects,
+    afterPrefix,
+    'gfmFootnoteDefinitionIndent',
+    constants.tabSize + 1
+  )
+
+  /**
+   * @type {State}
+   */
+  function afterPrefix(code) {
+    const tail = self.events[self.events.length - 1]
+    return tail &&
+      tail[1].type === 'gfmFootnoteDefinitionIndent' &&
+      tail[2].sliceSerialize(tail[1], true).length === constants.tabSize
+      ? ok(code)
+      : nok(code)
+  }
+}

package/node_modules/micromark-extension-gfm-footnote/index.d.ts

@@ -0,0 +1,164 @@
+export {gfmFootnoteHtml, defaultBackLabel} from './lib/html.js'
+export {gfmFootnote} from './lib/syntax.js'
+
+/**
+ * Generate a back label dynamically.
+ *
+ * For the following markdown:
+ *
+ * ```markdown
+ * Alpha[^micromark], bravo[^micromark], and charlie[^remark].
+ *
+ * [^remark]: things about remark
+ * [^micromark]: things about micromark
+ * ```
+ *
+ * This function will be called with:
+ *
+ * * `0` and `0` for the backreference from `things about micromark` to
+ *  `alpha`, as it is the first used definition, and the first call to it
+ * * `0` and `1` for the backreference from `things about micromark` to
+ *  `bravo`, as it is the first used definition, and the second call to it
+ * * `1` and `0` for the backreference from `things about remark` to
+ *  `charlie`, as it is the second used definition
+ *
+ * @param referenceIndex
+ *   Index of the definition in the order that they are first referenced,
+ *   0-indexed.
+ * @param rereferenceIndex
+ *   Index of calls to the same definition, 0-indexed.
+ * @returns
+ *   Back label to use when linking back from definitions to their reference.
+ */
+export type BackLabelTemplate = (
+  referenceIndex: number,
+  rereferenceIndex: number
+) => string
+
+/**
+ * Configuration.
+ */
+export interface HtmlOptions {
+  /**
+   * Prefix to use before the `id` attribute on footnotes to prevent them from
+   * *clobbering* (default: `'user-content-'`).
+   *
+   * Pass `''` for trusted markdown and when you are careful with
+   * polyfilling.
+   * You could pass a different prefix.
+   *
+   * DOM clobbering is this:
+   *
+   * ```html
+   * <p id="x"></p>
+   * <script>alert(x) // `x` now refers to the `p#x` DOM element</script>
+   * ```
+   *
+   * The above example shows that elements are made available by browsers, by
+   * their ID, on the `window` object.
+   * This is a security risk because you might be expecting some other variable
+   * at that place.
+   * It can also break polyfills.
+   * Using a prefix solves these problems.
+   */
+  clobberPrefix?: string | null | undefined
+  /**
+   * Textual label to use for the footnotes section (default: `'Footnotes'`).
+   *
+   * Change it when the markdown is not in English.
+   *
+   * This label is typically hidden visually (assuming a `sr-only` CSS class
+   * is defined that does that) and so affects screen readers only.
+   * If you do have such a class, but want to show this section to everyone,
+   * pass different attributes with the `labelAttributes` option.
+   */
+  label?: string | null | undefined
+  /**
+   * Attributes to use on the footnote label (default: `'class="sr-only"'`).
+   *
+   * Change it to show the label and add other attributes.
+   *
+   * This label is typically hidden visually (assuming an `sr-only` CSS class
+   * is defined that does that) and so affects screen readers only.
+   * If you do have such a class, but want to show this section to everyone,
+   * pass an empty string.
+   * You can also add different attributes.
+   *
+   * > 👉 **Note**: `id="footnote-label"` is always added, because footnote
+   * > calls use it with `aria-describedby` to provide an accessible label.
+   */
+  labelAttributes?: string | null | undefined
+  /**
+   * HTML tag name to use for the footnote label element (default: `'h2'`).
+   *
+   * Change it to match your document structure.
+   *
+   * This label is typically hidden visually (assuming a `sr-only` CSS class
+   * is defined that does that) and so affects screen readers only.
+   * If you do have such a class, but want to show this section to everyone,
+   * pass different attributes with the `labelAttributes` option.
+   */
+  labelTagName?: string | null | undefined
+  /**
+   * Textual label to describe the backreference back to references (default:
+   * `defaultBackLabel`).
+   *
+   * The default value is:
+   *
+   * ```js
+   * function defaultBackLabel(referenceIndex, rereferenceIndex) {
+   *   return (
+   *     'Back to reference ' +
+   *     (referenceIndex + 1) +
+   *     (rereferenceIndex > 1 ? '-' + rereferenceIndex : '')
+   *   )
+   * }
+   * ```
+   *
+   * Change it when the markdown is not in English.
+   *
+   * This label is used in the `aria-label` attribute on each backreference
+   * (the `↩` links).
+   * It affects users of assistive technology.
+   */
+  backLabel?: BackLabelTemplate | string | null | undefined
+}
+
+/**
+ * Augment types.
+ */
+declare module 'micromark-util-types' {
+  /**
+   * Compile data.
+   */
+  interface CompileData {
+    gfmFootnoteDefinitions?: Record<string, string>
+    gfmFootnoteDefinitionStack?: Array<string>
+    gfmFootnoteCallCounts?: Record<string, number>
+    gfmFootnoteCallOrder?: Array<string>
+  }
+
+  /**
+   * Parse context.
+   */
+  interface ParseContext {
+    gfmFootnotes?: Array<string>
+  }
+
+  /**
+   * Token types.
+   */
+  interface TokenTypeMap {
+    gfmFootnoteCall: 'gfmFootnoteCall'
+    gfmFootnoteCallLabelMarker: 'gfmFootnoteCallLabelMarker'
+    gfmFootnoteCallMarker: 'gfmFootnoteCallMarker'
+    gfmFootnoteCallString: 'gfmFootnoteCallString'
+    gfmFootnoteDefinition: 'gfmFootnoteDefinition'
+    gfmFootnoteDefinitionIndent: 'gfmFootnoteDefinitionIndent'
+    gfmFootnoteDefinitionLabel: 'gfmFootnoteDefinitionLabel'
+    gfmFootnoteDefinitionLabelMarker: 'gfmFootnoteDefinitionLabelMarker'
+    gfmFootnoteDefinitionLabelString: 'gfmFootnoteDefinitionLabelString'
+    gfmFootnoteDefinitionMarker: 'gfmFootnoteDefinitionMarker'
+    gfmFootnoteDefinitionWhitespace: 'gfmFootnoteDefinitionWhitespace'
+  }
+}

package/node_modules/micromark-extension-gfm-footnote/index.js

@@ -0,0 +1,3 @@
+// Note: types are exported from `dev/index.d.ts`.
+export { gfmFootnote } from './lib/syntax.js';
+export { gfmFootnoteHtml, defaultBackLabel } from './lib/html.js';