@tiangong-lca/pcr 0.3.0 → 0.4.0

package/node_modules/mdast-util-to-markdown/lib/types.d.ts

@@ -0,0 +1,985 @@
+import type {
+  Parents,
+  PhrasingContent,
+  TableCell,
+  TableRow,
+  Association,
+  Nodes
+} from 'mdast'
+import type {Point} from 'unist'
+
+/**
+ * Get an identifier from an association to match it to others.
+ *
+ * Associations are nodes that match to something else through an ID:
+ * <https://github.com/syntax-tree/mdast#association>.
+ *
+ * The `label` of an association is the string value: character escapes and
+ * references work, and casing is intact.
+ * The `identifier` is used to match one association to another:
+ * controversially, character escapes and references don’t work in this
+ * matching: `&copy;` does not match `©`, and `\+` does not match `+`.
+ *
+ * But casing is ignored (and whitespace) is trimmed and collapsed: ` A\nb`
+ * matches `a b`.
+ * So, we do prefer the label when figuring out how we’re going to serialize:
+ * it has whitespace, casing, and we can ignore most useless character
+ * escapes and all character references.
+ *
+ * @param node
+ *   Node that includes an association.
+ * @returns
+ *   ID.
+ */
+export type AssociationId = (node: Association) => string
+
+/**
+ * Compile an unsafe pattern to a regex.
+ *
+ * @param info
+ *   Pattern.
+ * @returns
+ *   Regex.
+ */
+export type CompilePattern = (info: Unsafe) => RegExp
+
+/**
+ * Interface of registered constructs.
+ *
+ * When working on extensions that use new constructs, extend the corresponding
+ * interface to register its name:
+ *
+ * ```ts
+ * declare module 'mdast-util-to-markdown' {
+ *   interface ConstructNameMap {
+ *     // Register a new construct name (value is used, key should match it).
+ *     gfmStrikethrough: 'gfmStrikethrough'
+ *   }
+ * }
+ * ```
+ */
+export interface ConstructNameMap {
+  /**
+   * Whole autolink.
+   *
+   * ```markdown
+   * > | <https://example.com> and <admin@example.com>
+   *     ^^^^^^^^^^^^^^^^^^^^^     ^^^^^^^^^^^^^^^^^^^
+   * ```
+   */
+  autolink: 'autolink'
+  /**
+   * Whole block quote.
+   *
+   * ```markdown
+   * > | > a
+   *     ^^^
+   * > | b
+   *     ^
+   * ```
+   */
+  blockquote: 'blockquote'
+  /**
+   * Whole code (indented).
+   *
+   * ```markdown
+   * ␠␠␠␠console.log(1)
+   * ^^^^^^^^^^^^^^^^^^
+   * ```
+   */
+  codeIndented: 'codeIndented'
+  /**
+   * Whole code (fenced).
+   *
+   * ````markdown
+   * > | ```js
+   *     ^^^^^
+   * > | console.log(1)
+   *     ^^^^^^^^^^^^^^
+   * > | ```
+   *     ^^^
+   * ````
+   */
+  codeFenced: 'codeFenced'
+  /**
+   * Code (fenced) language, when fenced with grave accents.
+   *
+   * ````markdown
+   * > | ```js
+   *        ^^
+   *   | console.log(1)
+   *   | ```
+   * ````
+   */
+  codeFencedLangGraveAccent: 'codeFencedLangGraveAccent'
+  /**
+   * Code (fenced) language, when fenced with tildes.
+   *
+   * ````markdown
+   * > | ~~~js
+   *        ^^
+   *   | console.log(1)
+   *   | ~~~
+   * ````
+   */
+  codeFencedLangTilde: 'codeFencedLangTilde'
+  /**
+   * Code (fenced) meta string, when fenced with grave accents.
+   *
+   * ````markdown
+   * > | ```js eval
+   *           ^^^^
+   *   | console.log(1)
+   *   | ```
+   * ````
+   */
+  codeFencedMetaGraveAccent: 'codeFencedMetaGraveAccent'
+  /**
+   * Code (fenced) meta string, when fenced with tildes.
+   *
+   * ````markdown
+   * > | ~~~js eval
+   *           ^^^^
+   *   | console.log(1)
+   *   | ~~~
+   * ````
+   */
+  codeFencedMetaTilde: 'codeFencedMetaTilde'
+  /**
+   * Whole definition.
+   *
+   * ```markdown
+   * > | [a]: b "c"
+   *     ^^^^^^^^^^
+   * ```
+   */
+  definition: 'definition'
+  /**
+   * Destination (literal) (occurs in definition, image, link).
+   *
+   * ```markdown
+   * > | [a]: <b> "c"
+   *          ^^^
+   * > | a ![b](<c> "d") e
+   *            ^^^
+   * ```
+   */
+  destinationLiteral: 'destinationLiteral'
+  /**
+   * Destination (raw) (occurs in definition, image, link).
+   *
+   * ```markdown
+   * > | [a]: b "c"
+   *          ^
+   * > | a ![b](c "d") e
+   *            ^
+   * ```
+   */
+  destinationRaw: 'destinationRaw'
+  /**
+   * Emphasis.
+   *
+   * ```markdown
+   * > | *a*
+   *     ^^^
+   * ```
+   */
+  emphasis: 'emphasis'
+  /**
+   * Whole heading (atx).
+   *
+   * ```markdown
+   * > | # alpha
+   *     ^^^^^^^
+   * ```
+   */
+  headingAtx: 'headingAtx'
+  /**
+   * Whole heading (setext).
+   *
+   * ```markdown
+   * > | alpha
+   *     ^^^^^
+   * > | =====
+   *     ^^^^^
+   * ```
+   */
+  headingSetext: 'headingSetext'
+  /**
+   * Whole image.
+   *
+   * ```markdown
+   * > | ![a](b)
+   *     ^^^^^^^
+   * > | ![c]
+   *     ^^^^
+   * ```
+   */
+  image: 'image'
+  /**
+   * Whole image reference.
+   *
+   * ```markdown
+   * > | ![a]
+   *     ^^^^
+   * ```
+   */
+  imageReference: 'imageReference'
+  /**
+   * Label (occurs in definitions, image reference, image, link reference,
+   * link).
+   *
+   * ```markdown
+   * > | [a]: b "c"
+   *     ^^^
+   * > | a [b] c
+   *       ^^^
+   * > | a ![b][c] d
+   *       ^^^^
+   * > | a [b](c) d
+   *       ^^^
+   * ```
+   */
+  label: 'label'
+  /**
+   * Whole link.
+   *
+   * ```markdown
+   * > | [a](b)
+   *     ^^^^^^
+   * > | [c]
+   *     ^^^
+   * ```
+   */
+  link: 'link'
+  /**
+   * Whole link reference.
+   *
+   * ```markdown
+   * > | [a]
+   *     ^^^
+   * ```
+   */
+  linkReference: 'linkReference'
+  /**
+   * List.
+   *
+   * ```markdown
+   * > | * a
+   *     ^^^
+   * > | 1. b
+   *     ^^^^
+   * ```
+   */
+  list: 'list'
+  /**
+   * List item.
+   *
+   * ```markdown
+   * > | * a
+   *     ^^^
+   * > | 1. b
+   *     ^^^^
+   * ```
+   */
+  listItem: 'listItem'
+  /**
+   * Paragraph.
+   *
+   * ```markdown
+   * > | a b
+   *     ^^^
+   * > | c.
+   *     ^^
+   * ```
+   */
+  paragraph: 'paragraph'
+  /**
+   * Phrasing (occurs in headings, paragraphs, etc).
+   *
+   * ```markdown
+   * > | a
+   *     ^
+   * ```
+   */
+  phrasing: 'phrasing'
+  /**
+   * Reference (occurs in image, link).
+   *
+   * ```markdown
+   * > | [a][]
+   *        ^^
+   * ```
+   */
+  reference: 'reference'
+  /**
+   * Strong.
+   *
+   * ```markdown
+   * > | **a**
+   *     ^^^^^
+   * ```
+   */
+  strong: 'strong'
+  /**
+   * Title using single quotes (occurs in definition, image, link).
+   *
+   * ```markdown
+   * > | [a](b 'c')
+   *           ^^^
+   * ```
+   */
+  titleApostrophe: 'titleApostrophe'
+  /**
+   * Title using double quotes (occurs in definition, image, link).
+   *
+   * ```markdown
+   * > | [a](b "c")
+   *           ^^^
+   * ```
+   */
+  titleQuote: 'titleQuote'
+}
+
+/**
+ * Construct names for things generated by `mdast-util-to-markdown`.
+ *
+ * This is an enum of strings, each being a semantic label, useful to know when
+ * serializing whether we’re for example in a double (`"`) or single (`'`)
+ * quoted title.
+ */
+export type ConstructName = ConstructNameMap[keyof ConstructNameMap]
+
+/**
+ * Serialize the children of a parent that contains flow children.
+ *
+ * These children will typically be joined by blank lines.
+ * What they are joined by exactly is defined by `Join` functions.
+ *
+ * @param parent
+ *   Parent of flow nodes.
+ * @param info
+ *   Info on where we are in the document we are generating.
+ * @returns
+ *   Serialized children, joined by (blank) lines.
+ */
+export type ContainerFlow = (parent: FlowParents, info: TrackFields) => string
+
+/**
+ * Serialize the children of a parent that contains phrasing children.
+ *
+ * These children will be joined flush together.
+ *
+ * @param parent
+ *   Parent of phrasing nodes.
+ * @param info
+ *   Info on where we are in the document we are generating.
+ * @returns
+ *   Serialized children, joined together.
+ */
+export type ContainerPhrasing = (parent: PhrasingParents, info: Info) => string
+
+/**
+ * Track positional info in the output.
+ *
+ * This info isn’t used yet but such functionality will allow line wrapping,
+ * source maps, etc.
+ *
+ * @param info
+ *   Info on where we are in the document we are generating.
+ * @returns
+ *   Tracker.
+ */
+export type CreateTracker = (info: TrackFields) => Tracker
+
+/**
+ * Whether to encode things — with fields representing the relationship to a
+ * whole.
+ */
+export interface EncodeSides {
+  /**
+   * Whether to encode inside.
+   */
+  inside: boolean
+
+  /**
+   * Whether to encode before.
+   */
+  outside: boolean
+}
+
+/**
+ * Enter something.
+ *
+ * @param name
+ *   Label, more similar to a micromark event than an mdast node type.
+ * @returns
+ *   Revert.
+ */
+export type Enter = (name: ConstructName) => Exit
+
+/**
+ * Exit something.
+ *
+ * @returns
+ *   Nothing.
+ */
+export type Exit = () => undefined
+
+/**
+ * Children of flow nodes.
+ */
+export type FlowChildren = FlowParents extends {
+  children: Array<infer T>
+}
+  ? T
+  : never
+
+/**
+ * Parents that are not phrasing,
+ * or similar.
+ */
+export type FlowParents = Exclude<
+  Parents,
+  PhrasingContent | TableCell | TableRow
+>
+
+/**
+ * Handle particular nodes.
+ *
+ * Each key is a node type, each value its corresponding handler.
+ */
+export type Handlers = Record<Nodes['type'], Handle>
+
+/**
+ * Handle a particular node.
+ *
+ * @param node
+ *   Expected mdast node.
+ * @param parent
+ *   Parent of `node`.
+ * @param state
+ *   Info passed around about the current state.
+ * @param Info
+ *   Info on the surrounding of the node that is serialized.
+ * @returns
+ *   Serialized markdown representing `node`.
+ */
+export type Handle = (
+  // type-coverage:ignore-next-line
+  node: any,
+  parent: Parents | undefined,
+  state: State,
+  Info: Info
+) => string
+
+/**
+ * Serialize a node as attention (emphasis, strong, strikethrough).
+ *
+ * Set as the `attention` field of a handler (`handle.attention = x`).
+ * This switches to a different algorithm,
+ * where attention is properly handled by `containerPhrasing`.
+ *
+ * @param node
+ *   Expected mdast node.
+ * @param state
+ *   Info passed around about the current state.
+ * @returns
+ *   Info on how to serialize `node`.
+ */
+export type Attention = (
+  // type-coverage:ignore-next-line
+  node: any,
+  state: State
+) => AttentionInfo
+
+/**
+ * Info on how to serialize attention.
+ */
+export interface AttentionInfo {
+  /**
+   * Construct to enter (such as `'emphasis'`).
+   */
+  construct: ConstructName
+  /**
+   * Markers that can be used in order of preference (such as `['*', '_']`);
+   * one or more strings, each just one ASCII punctuation character.
+   */
+  markers: Array<string>
+  /**
+   * Sizes of sequences that can be used in order of preference (such as `[2]`
+   * for strong or `[2, 1]` for GFM strikethrough);
+   * one or more numbers, each a positive integer.
+   */
+  sizes: Array<number>
+}
+
+/**
+ * Pad serialized markdown.
+ *
+ * @param value
+ *   Whole fragment of serialized markdown.
+ * @param map
+ *   Map function.
+ * @returns
+ *   Padded value.
+ */
+export type IndentLines = (value: string, map: Map) => string
+
+/**
+ * Info on the surrounding of the node that is serialized.
+ */
+export interface Info extends SafeFields, TrackFields {}
+
+/**
+ * How to join two blocks.
+ *
+ * “Blocks” are typically joined by one blank line.
+ * Sometimes it’s nicer to have them flush next to each other, yet other
+ * times they cannot occur together at all.
+ *
+ * Join functions receive two adjacent siblings and their parent and what
+ * they return defines how many blank lines to use between them.
+ *
+ * @param left
+ *   First of two adjacent siblings.
+ * @param right
+ *   Second of two adjacent siblings.
+ * @param parent
+ *   Parent of the two siblings.
+ * @param state
+ *   Info passed around about the current state.
+ * @returns
+ *   How many blank lines to use between the siblings.
+ *
+ *   Where `true` is as passing `1` and `false` means the nodes cannot be
+ *   joined by a blank line, such as two adjacent block quotes or indented code
+ *   after a list, in which case a comment will be injected to break them up:
+ *
+ *   ```markdown
+ *   > Quote 1
+ *
+ *   <!---->
+ *
+ *   > Quote 2
+ *   ```
+ *
+ *    > 👉 **Note**: abusing this feature will break markdown.
+ *    > One such example is when returning `0` for two paragraphs, which will
+ *    > result in the text running together, and in the future to be seen as
+ *    > one paragraph.
+ */
+export type Join = (
+  left: FlowChildren,
+  right: FlowChildren,
+  parent: FlowParents,
+  state: State
+) => boolean | number | null | undefined | void
+
+/**
+ * Map function to pad a single line.
+ *
+ * @param value
+ *   A single line of serialized markdown.
+ * @param line
+ *   Line number relative to the fragment.
+ * @param blank
+ *   Whether the line is considered blank in markdown.
+ * @returns
+ *   Padded line.
+ */
+export type Map = (value: string, line: number, blank: boolean) => string
+
+/**
+ * Configuration (optional).
+ */
+export interface Options {
+  /**
+   * Marker to use in certain cases where the primary bullet doesn’t work
+   * (default: `'-'` when `bullet` is `'*'`, `'*'` otherwise).
+   *
+   * Cannot be equal to `bullet`.
+   */
+  bulletOther?: '*' | '+' | '-' | null | undefined
+  /**
+   * Marker to use for bullets of items in ordered lists (default: `'.'`).
+   *
+   * There is one case where the primary bullet for ordered items cannot be
+   * used:
+   *
+   * * when two ordered lists appear next to each other: `1. a\n2) b`; to
+   * solve
+   * that, `'.'` will be used when `bulletOrdered` is `')'`, and `'.'`
+   * otherwise
+   */
+  bulletOrdered?: '.' | ')' | null | undefined
+  /**
+   * Marker to use for bullets of items in unordered lists (default: `'*'`).
+   *
+   * There are three cases where the primary bullet cannot be used:
+   *
+   * * when three or more list items are on their own, the last one is empty,
+   * and `bullet` is also a valid `rule`: `* - +`; this would turn into a
+   * thematic break if serialized with three primary bullets; `bulletOther`
+   * is used for the last item
+   * * when a thematic break is the first child of a list item and `bullet` is
+   * the same character as `rule`: `- ***`; this would turn into a single
+   * thematic break if serialized with primary bullets; `bulletOther` is used
+   * for the item
+   * * when two unordered lists appear next to each other: `* a\n- b`;
+   * `bulletOther` is used for such lists
+   */
+  bullet?: '*' | '+' | '-' | null | undefined
+  /**
+   * Whether to add the same number of number signs (`#`) at the end of an ATX
+   * heading as the opening sequence (default: `false`).
+   */
+  closeAtx?: boolean | null | undefined
+  /**
+   * Preferred marker to use for emphasis (default: `'*'`).
+   *
+   * The other marker is sometimes used, to form for example emphasis next to
+   * or inside of other emphasis (`*a*_b_`).
+   */
+  emphasis?: '*' | '_' | null | undefined
+  /**
+   * List of extensions to include (optional).
+   *
+   * Each `ToMarkdownExtension` is an object with the same interface as
+   * `Options` here.
+   */
+  extensions?: Array<Options> | null | undefined
+  /**
+   * Whether to use fenced code always (default: `true`).
+   *
+   * The default is to use fenced code if there is a language defined, if the
+   * code is empty, or if it starts or ends in blank lines.
+   */
+  fences?: boolean | null | undefined
+  /**
+   * Marker to use for fenced code (default: ``'`'``).
+   */
+  fence?: '`' | '~' | null | undefined
+  /**
+   * Handle particular nodes (optional).
+   *
+   * Each key is a node type, each value its corresponding handler.
+   */
+  handlers?: Partial<Handlers> | null | undefined
+  /**
+   * Whether to increment the counter of ordered lists items (default: `true`).
+   */
+  incrementListMarker?: boolean | null | undefined
+  /**
+   * How to join blocks (optional).
+   */
+  join?: Array<Join> | null | undefined
+  /**
+   * How to indent the content of list items (default: `'one'`).
+   *
+   * Either with the size of the bullet plus one space (when `'one'`), a tab
+   * stop (`'tab'`), or depending on the item and its parent list (`'mixed'`,
+   * uses `'one'` if the item and list are tight and `'tab'` otherwise).
+   */
+  listItemIndent?: 'mixed' | 'one' | 'tab' | null | undefined
+  /**
+   * Marker to use for titles (default: `'"'`).
+   */
+  quote?: '"' | "'" | null | undefined
+  /**
+   * Whether to always use resource links (default: `false`).
+   *
+   * The default is to use autolinks (`<https://example.com>`) when possible
+   * and resource links (`[text](url)`) otherwise.
+   */
+  resourceLink?: boolean | null | undefined
+  /**
+   * Number of markers to use for thematic breaks (default: `3`).
+   */
+  ruleRepetition?: number | null | undefined
+  /**
+   * Whether to add spaces between markers in thematic breaks (default:
+   * `false`).
+   */
+  ruleSpaces?: boolean | null | undefined
+  /**
+   * Marker to use for thematic breaks (default: `'*'`).
+   */
+  rule?: '*' | '-' | '_' | null | undefined
+  /**
+   * Whether to use setext headings when possible (default: `false`).
+   *
+   * The default is to always use ATX headings (`# heading`) instead of setext
+   * headings (`heading\n=======`).
+   * Setext headings cannot be used for empty headings or headings with a rank
+   * of three or more.
+   */
+  setext?: boolean | null | undefined
+  /**
+   * Preferred marker to use for strong (default: `'*'`).
+   *
+   * The other marker is sometimes used, to form for example strong next to or
+   * inside of other strong (`**a**__b__`).
+   */
+  strong?: '*' | '_' | null | undefined
+  /**
+   * Whether to join definitions without a blank line (default: `false`).
+   *
+   * The default is to add blank lines between any flow (“block”) construct.
+   * Turning this option on is a shortcut for a join function like so:
+   *
+   * ```js
+   * function joinTightDefinitions(left, right) {
+   * if (left.type === 'definition' && right.type === 'definition') {
+   * return 0
+   * }
+   * }
+   * ```
+   */
+  tightDefinitions?: boolean | null | undefined
+  /**
+   * Schemas that define when characters cannot occur (optional).
+   */
+  unsafe?: Array<Unsafe> | null | undefined
+}
+
+/**
+ * Parent of phrasing nodes.
+ */
+export type PhrasingParents = Parents extends {
+  children: Array<infer T>
+}
+  ? PhrasingContent extends T
+    ? Parents
+    : never
+  : never
+
+/**
+ * Configuration for `safe`
+ */
+export interface SafeConfig extends SafeFields {
+  /**
+   * Extra characters that *must* be encoded (as character references) instead
+   * of escaped (character escapes) (optional).
+   *
+   * Only ASCII punctuation will use character escapes, so you never need to
+   * pass non-ASCII-punctuation here.
+   */
+  encode?: Array<string> | null | undefined
+}
+
+/**
+ * Info on the characters that are around the current thing we are generating.
+ */
+export interface SafeFields {
+  /**
+   * Characters after this (guaranteed to be one, can be more).
+   */
+  after: string
+  /**
+   * Characters before this (guaranteed to be one, can be more).
+   */
+  before: string
+}
+
+/**
+ * Make a string safe for embedding in markdown constructs.
+ *
+ * In markdown, almost all punctuation characters can, in certain cases,
+ * result in something.
+ * Whether they do is highly subjective to where they happen and in what
+ * they happen.
+ *
+ * To solve this, `mdast-util-to-markdown` tracks:
+ *
+ * * Characters before and after something;
+ * * What “constructs” we are in.
+ *
+ * This information is then used by this function to escape or encode
+ * special characters.
+ *
+ * @param input
+ *   Raw value to make safe.
+ * @param config
+ *   Configuration.
+ * @returns
+ *   Serialized markdown safe for embedding.
+ */
+export type Safe = (
+  input: string | null | undefined,
+  config: SafeConfig
+) => string
+
+/**
+ * Info passed around about the current state.
+ */
+export interface State {
+  /**
+   * Get an identifier from an association to match it to others.
+   */
+  associationId: AssociationId
+  /**
+   * List marker currently in use.
+   */
+  bulletCurrent: string | undefined
+  /**
+   * List marker previously in use.
+   */
+  bulletLastUsed: string | undefined
+  /**
+   * Compile an unsafe pattern to a regex.
+   */
+  compilePattern: CompilePattern
+  /**
+   * Serialize the children of a parent that contains phrasing children.
+   */
+  containerPhrasing: ContainerPhrasing
+  /**
+   * Serialize the children of a parent that contains flow children.
+   */
+  containerFlow: ContainerFlow
+  /**
+   * Track positional info in the output.
+   */
+  createTracker: CreateTracker
+  /**
+   * Enter a construct (returns a corresponding exit function).
+   */
+  enter: Enter
+  /**
+   * Applied handlers.
+   */
+  handlers: Handlers
+  /**
+   * Call the configured handler for the given node.
+   */
+  handle: Handle
+  /**
+   * Pad serialized markdown.
+   */
+  indentLines: IndentLines
+  /**
+   * Positions of child nodes in their parents.
+   */
+  indexStack: Array<number>
+  /**
+   * Applied join handlers.
+   */
+  join: Array<Join>
+  /**
+   * Applied user configuration.
+   */
+  options: Options
+  /**
+   * Serialize the children of a parent that contains flow children.
+   */
+  safe: Safe
+  /**
+   * Stack of constructs we’re in.
+   */
+  stack: Array<ConstructName>
+  /**
+   * Applied unsafe patterns.
+   */
+  unsafe: Array<Unsafe>
+}
+
+/**
+ * Get current tracked info.
+ *
+ * @returns
+ *   Current tracked info.
+ */
+export type TrackCurrent = () => TrackFields
+
+/**
+ * Info on where we are in the document we are generating.
+ */
+export interface TrackFields {
+  /**
+   * Number of columns each line will be shifted by wrapping nodes.
+   */
+  lineShift: number
+  /**
+   * Current point.
+   */
+  now: Point
+}
+
+/**
+ * Move past some generated markdown.
+ *
+ * @param value
+ *   Generated markdown.
+ * @returns
+ *   Given markdown.
+ */
+export type TrackMove = (value: string | null | undefined) => string
+
+/**
+ * Define a relative increased line shift (the typical indent for lines).
+ *
+ * @param value
+ *   Relative increment in how much each line will be padded.
+ * @returns
+ *   Nothing.
+ */
+export type TrackShift = (value: number) => undefined
+
+/**
+ * Track positional info in the output.
+ *
+ * This info isn’t used yet but such functionality will allow line wrapping,
+ * source maps, etc.
+ */
+export interface Tracker {
+  /**
+   * Get the current tracked info.
+   */
+  current: TrackCurrent
+  /**
+   * Move past some generated markdown.
+   */
+  move: TrackMove
+  /**
+   * Define an increased line shift (the typical indent for lines).
+   */
+  shift: TrackShift
+}
+
+/**
+ * Schema that defines when a character cannot occur.
+ */
+export interface Unsafe {
+  /**
+   * The unsafe pattern (this whole object) compiled as a regex (do not use).
+   *
+   * This is internal and must not be defined.
+   */
+  _compiled?: RegExp | null | undefined
+  /**
+   * `character` is bad when this is after it (optional).
+   */
+  after?: string | null | undefined
+  /**
+   * `character` is bad at a break (cannot be used together with `before`) (optional).
+   */
+  atBreak?: boolean | null | undefined
+  /**
+   * `character` is bad when this is before it (cannot be used together with
+   * `atBreak`) (optional).
+   */
+  before?: string | null | undefined
+  /**
+   * Single unsafe character.
+   */
+  character: string
+  /**
+   * Constructs where this is bad (optional).
+   */
+  inConstruct?: Array<ConstructName> | ConstructName | null | undefined
+  /**
+   * Constructs where this is fine again (optional).
+   */
+  notInConstruct?: Array<ConstructName> | ConstructName | null | undefined
+}