Skip to main content
Version: 2.x.x

@yozora/ast

Npm VersionNpm DownloadNpm LicenseModule formats: cjs, esmNode.js VersionCode Style: prettier

Install

npm install --save @yozora/ast

Core Types

Node

/**
* Syntactic units of the yozora AST.
* @see https://github.com/syntax-tree/unist#node
*/
export interface Node<T extends NodeType = NodeType> {
/**
* The variant of a node.
*/
readonly type: T
/**
* Location of a node in a source document.
* Must not be present if a node is generated.
*/
position?: Position
}

Parent

/**
* Nodes containing other nodes.
* @see https://github.com/syntax-tree/mdast#parent
*/
export interface Parent<T extends NodeType = NodeType>
extends Node<T> {
/**
* List representing the children of a node.
*/
children: Node[]
}

Literal

/**
* Nodes containing a value.
*/
export interface Literal<T extends NodeType = NodeType>
extends Node<T> {
/**
* Literal value.
*/
value: string
}

Resource

/**
* A reference to resource.
* @see https://github.com/syntax-tree/mdast#resource
*/
export interface Resource {
/**
* A URL to the referenced resource.
*/
url: string
/**
* Advisory information for the resource, such as would be
* appropriate for a tooltip.
*/
title?: string
}

Association

/**
* An internal relation from one node to another.
* @see https://github.com/syntax-tree/mdast#association
*/
export interface Association {
/**
* It can match an identifier field on another node.
*/
identifier: string
/**
* The original value of the normalized identifier field.
*/
label: string
}

Reference

/**
* A marker that is associated to another node.
* @see https://github.com/syntax-tree/mdast#reference
*/
export interface Reference {
/**
* The explicitness of a reference:
* - shortcut: the reference is implicit, its identifier inferred from its content
* - collapsed: the reference is explicit, its identifier inferred from its content
* - full: the reference is explicit, its identifier explicitly set
* @see https://github.com/syntax-tree/mdast#referencetype
*/
referenceType: 'full' | 'collapsed' | 'shortcut'
}

Alternative

/**
* Alternative represents a node with a fallback.
* @see https://github.com/syntax-tree/mdast#alternative
*/
export interface Alternative {
/**
* Equivalent content for environments that cannot represent the
* node as intended.
*/
alt: string
}

Point

/**
* One place in the source file.
* @see https://github.com/syntax-tree/unist#point
*/
export interface Point {
/**
* Line in a source file.
* @minimum 1
*/
readonly line: number
/**
* Column column in a source file.
* @minimum 1
*/
readonly column: number
/**
* Character in a source file.
* @minimum 0
*/
readonly offset?: number
}

Position

/**
* Location of a node in a source file.
* @see https://github.com/syntax-tree/unist#position
*/
export interface Position {
/**
* Place of the first character of the parsed source region.
*/
start: Point
/**
* Place of the first character after the parsed source region.
*/
end: Point
/**
* start column at each index (plus start line) in the source region,
* for elements that span multiple lines
*/
indent?: number[]
}

NodeType

/**
* Variant of a node of yozora AST.
*/
export type NodeType = string

AlignType

/**
* AlignType represents how phrasing content is aligned
* @see https://github.com/syntax-tree/mdast#aligntype
*/
export type AlignType = 'left' | 'right' | 'center' | null

Yast nodes

Admonition

export const AdmonitionType = 'admonition'
export type AdmonitionType = typeof AdmonitionType

/**
* Admonitions are block elements. The titles can include inline markdown and
* the body can include any block markdown except another admonition.
* @see https://github.com/elviswolcott/remark-admonitions
*/
export interface Admonition extends Parent<AdmonitionType> {
/**
* Keyword of an admonition.
*/
keyword: 'note' | 'important' | 'tip' | 'caution' | 'warning' | string
/**
* Admonition title.
*/
title: Node[]
}

Blockquote

export const BlockquoteType = 'blockquote'
export type BlockquoteType = typeof BlockquoteType

/**
* Blockquote represents a section quoted from somewhere else.
* @see https://github.com/syntax-tree/mdast#blockquote
* @see https://github.github.com/gfm/#block-quotes
*/
export type Blockquote = Parent<BlockquoteType>

Break

export const BreakType = 'break'
export type BreakType = typeof BreakType

/**
* Break represents a line break, such as in poems or addresses.
* @see https://github.com/syntax-tree/mdast#break
* @see https://github.github.com/gfm/#hard-line-breaks
* @see https://github.github.com/gfm/#soft-line-breaks
*/
export type Break = Node<BreakType>

Code

export const CodeType = 'code'
export type CodeType = typeof CodeType

/**
* Code represents a block of preformatted text, such as ASCII art or computer
* code.
* @see https://github.com/syntax-tree/mdast#code
* @see https://github.github.com/gfm/#code-fence
*/
export interface Code extends Literal<CodeType> {
/**
* Language of the codes
*/
lang?: string
/**
* Meta info string
*/
meta?: string
}

Definition

export const DefinitionType = 'definition'
export type DefinitionType = typeof DefinitionType

/**
* Definition represents a resource.
* @see https://github.com/syntax-tree/mdast#definition
* @see https://github.github.com/gfm/#link-reference-definitions
*/
export interface Definition
extends Node<DefinitionType>,
Association,
Resource {}

Delete

export const DeleteType = 'delete'
export type DeleteType = typeof DeleteType

/**
* Delete represents contents that are no longer accurate or no longer relevant.
* @see https://github.com/syntax-tree/mdast#delete
* @see https://github.github.com/gfm/#strikethrough-extension-
*/
export type Delete = Parent<DeleteType>

Emphasis

export const EmphasisType = 'emphasis'
export type EmphasisType = typeof EmphasisType

/**
* Emphasis represents stress emphasis of its contents.
* @see https://github.com/syntax-tree/mdast#emphasis
* @see https://github.github.com/gfm/#emphasis-and-strong-emphasis
*/
export type Emphasis = Parent<EmphasisType>

FootnoteDefinition

export const FootnoteDefinitionType = 'footnoteDefinition'
export type FootnoteDefinitionType = typeof FootnoteDefinitionType

/**
* FootnoteDefinition represents content relating to the document that is
* outside its flow.
* @see https://github.com/syntax-tree/mdast#footnotedefinition
*/
export interface FootnoteDefinition
extends Parent<FootnoteDefinitionType>, Association {}

FootnoteReference

export const FootnoteReferenceType = 'footnoteReference'
export type FootnoteReferenceType = typeof FootnoteReferenceType

/**
* FootnoteReference represents a marker through association.
*
* Similar to imageReference and linkReference, the difference is that it has
* only 'collapsed' reference type instead of 'full' and 'shortcut'
* @see https://github.com/syntax-tree/mdast#footnotereference
* @see https://github.com/syntax-tree/mdast#imagereference
* @see https://github.com/syntax-tree/mdast#linkreference
*/
export interface FootnoteReference
extends Node<FootnoteReferenceType>, Association {}

Footnote

export const FootnoteType = 'footnote'
export type FootnoteType = typeof FootnoteType

/**
* Footnote represents content relating to the document that is outside its flow.
* @see https://github.com/syntax-tree/mdast#footnote
*/
export type Footnote = Parent<FootnoteType>

Frontmatter (not supportted yet)

export const FrontmatterType = 'frontmatter'
export type FrontmatterType = typeof FrontmatterType

/**
* Frontmatter content represent out-of-band information about the document.
* @see https://github.com/syntax-tree/mdast#frontmattercontent
* @see https://github.com/syntax-tree/mdast#yaml
* @see https://github.github.com/gfm/#code-fence
*/
export interface Frontmatter extends Literal<FrontmatterType> {
/**
* Language of the frontmatter
* @default 'yaml'
*/
lang: string
/**
* Meta info string
*/
meta?: string
}

Heading

export const HeadingType = 'heading'
export type HeadingType = typeof HeadingType

/**
* Frontmatter represents a heading of a section.
* @see https://github.com/syntax-tree/mdast#heading
* @see https://github.github.com/gfm/#atx-heading
*/
export interface Heading extends Parent<HeadingType> {
/**
* level of heading
*/
depth: 1 | 2 | 3 | 4 | 5 | 6
}

Html

export const HtmlType = 'html'
export type HtmlType = typeof HtmlType

/**
* HTML (Literal) represents a fragment of raw HTML.
* @see https://github.com/syntax-tree/mdast#html
* @see https://github.github.com/gfm/#html-blocks
* @see https://github.github.com/gfm/#raw-html
*/
export type Html = Literal<HtmlType>

Image

export const ImageType = 'image'
export type ImageType = typeof ImageType

/**
* Image represents an image.
* @see https://github.com/syntax-tree/mdast#image
* @see https://github.github.com/gfm/#images
*/
export interface Image
extends Node<ImageType>,
Resource,
Alternative {}

ImageReference

export const ImageReferenceType = 'imageReference'
export type ImageReferenceType = typeof ImageReferenceType

/**
* ImageReference represents an image through association, or its original
* source if there is no association.
* @see https://github.github.com/gfm/#images
* @see https://github.com/syntax-tree/mdast#imagereference
*/
export interface ImageReference
extends Node<ImageReferenceType>,
Association,
Reference,
Alternative {}

InlineCode

export const InlineCodeType = 'inlineCode'
export type InlineCodeType = typeof InlineCodeType

/**
* InlineCode represents a fragment of computer code, such as a file name,
* computer program, or anything a computer could parse.
* @see https://github.com/syntax-tree/mdast#inline-code
* @see https://github.github.com/gfm/#code-span
*/
export type InlineCode = Literal<InlineCodeType>

InlineMath

export const InlineMathType = 'inlineMath'
export type InlineMathType = typeof InlineMathType

/**
* Inline math content.
*/
export type InlineMath = Literal<InlineMathType>
export const LinkType = 'link'
export type LinkType = typeof LinkType

/**
* Link represents a hyperlink.
* @see https://github.com/syntax-tree/mdast#link
* @see https://github.github.com/gfm/#inline-link
*/
export interface Link extends Parent<LinkType>, Resource {}

LinkReference

export const LinkReferenceType = 'linkReference'
export type LinkReferenceType = typeof LinkReferenceType

/**
* LinkReference represents a hyperlink through association, or its original
* source if there is no association.
* @see https://github.com/syntax-tree/mdast#linkreference
* @see https://github.github.com/gfm/#reference-link
*/
export interface LinkReference
extends Parent<LinkReferenceType>,
Association,
Reference {}

List

export const ListType = 'list'
export type ListType = typeof ListType

/**
* List represents a list of items.
* @see https://github.com/syntax-tree/mdast#list
* @see https://github.github.com/gfm/#list
*/
export interface List extends Parent<ListType> {
/**
* Whether it is an ordered lit.
*/
ordered: boolean
/**
* Marker type of the list.
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ol#attr-type
*
* The 'i' and 'I' which represented the roman numerals are not supported yet.
*/
orderType?: '1' | 'a' | 'A' | 'i' | 'I'
/**
* The starting number of a ordered list-item.
*/
start?: number
/**
* Marker of a unordered list-item, or delimiter of an ordered list-item.
*/
marker: number
/**
* Whether if the list is loose.
* @see https://github.github.com/gfm/#loose
*/
spread: boolean
/**
* Lists are container block.
*/
children: ListItem[]
}

ListItem

export const ListItemType = 'listItem'
export type ListItemType = typeof ListItemType

/**
* Status of a task list item.
* @see https://github.github.com/gfm/#task-list-items-extension-
*/
export enum TaskStatus {
/**
* To do, not yet started.
*/
TODO = 'todo',
/**
* In progress.
*/
DOING = 'doing',
/**
* Completed.
*/
DONE = 'done',
}

/**
* ListItem represents an item in a List.
* @see https://github.com/syntax-tree/mdast#listitem
* @see https://github.github.com/gfm/#list-items
*/
export interface ListItem extends Parent<ListItemType> {
/**
* Status of a todo task.
*/
status?: TaskStatus
}

Math

export const MathType = 'math'
export type MathType = typeof MathType

/**
* Math content.
*/
export type Math = Literal<MathType>

Paragraph

export const ParagraphType = 'paragraph'
export type ParagraphType = typeof ParagraphType

/**
* Paragraph represents a unit of discourse dealing with a particular
* point or idea.
* @see https://github.com/syntax-tree/mdast#paragraph
* @see https://github.github.com/gfm/#paragraphs
*/
export type Paragraph = Parent<ParagraphType>

Strong

export const StrongType = 'strong'
export type StrongType = typeof StrongType

/**
* Strong represents strong importance, seriousness, or urgency for its
* contents.
* @see https://github.com/syntax-tree/mdast#strong
* @see https://github.github.com/gfm/#emphasis-and-strong-emphasis
*/
export type Strong = Parent<StrongType>

Table

export const TableType = 'table'
export type TableType = typeof TableType

/**
* Table column configs.
*/
export interface TableColumn {
/**
* An align field can be present. If present, it must be a list of alignTypes.
* It represents how cells in columns are aligned.
*/
align: AlignType
}

/**
* @see https://github.github.com/gfm/#table
* @see https://github.com/syntax-tree/mdast#table
*/
export interface Table extends Parent<TableType> {
/**
* Table column configuration items
*/
columns: TableColumn[]
/**
* Table rows (include table headers)
*/
children: TableRow[]
}

TableCell

export const TableCellType = 'tableCell'
export type TableCellType = typeof TableCellType

/**
* TableCell represents a header cell in a Table, if its parent is a head,
* or a data cell otherwise.
* @see https://github.com/syntax-tree/mdast#tablecell
* @see https://github.github.com/gfm/#tables-extension-
*/
export type TableCell = Parent<TableCellType>

TableRow

export const TableRowType = 'tableRow'
export type TableRowType = typeof TableRowType

/**
* TableRow represents a row of cells in a table.
* @see https://github.com/syntax-tree/mdast#tablerow
* @see https://github.github.com/gfm/#tables-extension-
*/
export interface TableRow extends Parent<TableRowType> {
/**
* Table cells
*/
children: TableCell[]
}

Text

export const TextType = 'text'
export type TextType = typeof TextType

/**
* Text represents everything that is just text.
* @see https://github.com/syntax-tree/mdast#text
* @see https://github.github.com/gfm/#textual-content
*/
export type Text = Literal<TextType>

ThematicBreak

export const ThematicBreakType = 'thematicBreak'
export type ThematicBreakType = typeof ThematicBreakType

/**
* ThematicBreak represents a thematic break, such as a scene change in
* a story, a transition to another topic, or a new document.
* @see https://github.com/syntax-tree/mdast#thematicbreak
* @see https://github.github.com/gfm/#thematic-break
*/
export type ThematicBreak = Node<ThematicBreakType>