textlint-plugin-typst

textlint plugin to lint Typst

Installation

# npm
npm install textlint-plugin-typst

# Yarn
yarn add textlint-plugin-typst

# pnpm
pnpm add textlint-plugin-typst

# Bun
bun add textlint-plugin-typst

Usage

{
  "plugins": {
    "typst": true
  }
}

Options

• extensions: string[]
  • Additional file extensions for Typst

Syntax support

This plugin supports the syntax of Typst v0.11.1.

Legend for syntax support:

• ✅: Supported
• 🚫: Not in progress
• ⌛️: In progress
• ⚠️: Partially supported (with some caveats)

| Typst | textlint | Markup | Function | | --- | --- | --- | --- | | Paragraph break | Paragraph | ✅ | 🚫 | | Strong emphasis | Strong | ✅ | 🚫 | | Emphasis | Emphasis | ✅ | 🚫 | | Raw text | Code / CodeBlock | ✅ | 🚫 | | Link | Link | ✅ | 🚫 | | Label | | 🚫 | 🚫 | | Reference | | 🚫 | 🚫 | | Heading | Header | ✅ | 🚫 | | Bullet list | List / ListItem | 🚫 | 🚫 | | Numbered list | List / ListItem | 🚫 | 🚫 | | Term list | | 🚫 | 🚫 | | Math | | 🚫 | 🚫 | | Line break | Break | ✅ | 🚫 | | Smart quote | | 🚫 | 🚫 | | Symbol shorthand | | 🚫 | 🚫 | | Code expression | | 🚫 | 🚫 | | Character escape | | 🚫 | 🚫 | | Comment | Comment | ✅ | 🚫 |

Examples

textlint-filter-rule-comments

Example of how to use textlint-filter-rule-comments is shown below.

This is error text.

/* textlint-disable */

This is ignored text by rule.
Disables all rules between comments

/* textlint-enable */

This is error text.

Also, you can use single-line comments.

This is error text.

// textlint-disable

This is ignored text by rule.
Disables all rules between comments

// textlint-enable

This is error text.

Contributing

This project is still under development, so please feel free to contribute!

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Maintainers

• @3w36zj6

License

MIT License