https://github.com/stsewd/tree-sitter-rst

reStructuredText grammar for tree-sitter
https://github.com/stsewd/tree-sitter-rst

grammar restructuredtext rst tree-sitter tree-sitter-parser

Last synced: 5 days ago
JSON representation

reStructuredText grammar for tree-sitter

• Host: GitHub
• URL: https://github.com/stsewd/tree-sitter-rst
• Owner: stsewd
• License: mit
• Created: 2020-06-02T02:51:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T03:12:24.000Z (7 months ago)
• Last Synced: 2024-05-21T11:25:32.334Z (6 months ago)
• Topics: grammar, restructuredtext, rst, tree-sitter, tree-sitter-parser
• Language: C
• Homepage: https://stsewd.dev/tree-sitter-rst/
• Size: 1.66 MB
• Stars: 49
• Watchers: 5
• Forks: 7
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# tree-sitter-rst

[![CI](https://github.com/stsewd/tree-sitter-rst/workflows/CI/badge.svg)](https://github.com/stsewd/tree-sitter-rst/actions?query=workflow%3ACI+branch%3Amaster)

reStructuredText grammar for [tree-sitter](https://tree-sitter.github.io/tree-sitter/).

Based on the specification from  .

Check the playground at .

**Note: this grammar is still under development, a lot of things may change!**

## TODO

- Allow lists with blank lines between items

- Refactor parse citation and footer reference

- Nested line blocks

- Option lists

- Add some nodes to inline?

- Check if there is a way to re-implement some nodes to JS instead of C?

- A definition list with classifiers can't be separated by a blank line.

- tests, tests, and more tests!

## Design notes

- Nodes that contain body elements inside (like lists or directives),

  are inside a node named `body`.

- In RST sections are a big node that contains body elements,

  here they are just a node containing the title.

  This is to avoid guessing the level of subtitles.

- In RST standalone hyperlinks are `reference` nodes,

  here they are `standalone_hyperlink` nodes.

  This is to avoid confusion with inline references nodes

  (that are a `reference` node).

- Literal blocks are part of the paragraph they precede, not a separate node,

  except for the expanded form of literal blocks.

- In rst directives only have "body" node,

  here the body is parsed as arguments/options/content.

## Design decisions

- Implement tables?

- Validate length of adornments in sections?

  The spec doesn't mention this, but this paragraph does.

  > The underline/overline must be at least as long as the title text.

  https://docutils.sourceforge.io/docs/user/rst/quickstart.html

## Projects using this grammar

- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)

- [helix](https://github.com/helix-editor/helix)

- Yours?

## Contributing

Check the [CONTRIBUTING.md](CONTRIBUTING.md) file

## Other grammars

- [tree-sitter-comment](https://github.com/stsewd/tree-sitter-comment): grammar for comment tags like `TODO`, `FIXME(user)`.