https://github.com/gbprod/tree-sitter-gitcommit

A tree-sitter grammar for gitcommit messages
https://github.com/gbprod/tree-sitter-gitcommit

git gitcommit grammar tree-sitter tree-sitter-parser

Last synced: 6 days ago
JSON representation

A tree-sitter grammar for gitcommit messages

• Host: GitHub
• URL: https://github.com/gbprod/tree-sitter-gitcommit
• Owner: gbprod
• License: wtfpl
• Created: 2022-11-10T18:36:18.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T07:43:23.000Z (3 months ago)
• Last Synced: 2024-12-22T11:08:55.663Z (13 days ago)
• Topics: git, gitcommit, grammar, tree-sitter, tree-sitter-parser
• Language: JavaScript
• Homepage:
• Size: 3.53 MB
• Stars: 62
• Watchers: 3
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# tree-sitter-gitcommit

[![Build/test](https://github.com/gbprod/tree-sitter-gitcommit/actions/workflows/ci.yml/badge.svg)](https://github.com/gbprod/tree-sitter-gitcommit/actions/workflows/ci.yml)

`gitcommit` grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter).

## Features

- Support for [Conventional Commits](https://www.conventionalcommits.org) specifications.

- Support for different locales / languages. See [Supported locales](#supported-locales) for a full list.

## Supported locales

We aim to support all the [locales supported by git](https://github.com/git/git/tree/master/po).

The currently supported locales are listed below:

- `en`: English

- `bg`: Bulgarian

- `ca`: Catalan

- `de`: German

- `el`: Greek

- `es`: Spanish

- `fr`: French

- `id`: Indonesian (Bahasa)

- `it`: Italian

- `ko`: Korean

- `pl`: Polish

- `pt_PT`: Portugal Portugese

- `ru`: Russian

- `sv`: Swedish

- `tr`: Turkish

- `vi`: Vietnamese

- `zh_CN`: Chinese (Simplified)

- `zh_TW`: Taiwanese Mandarin

## Note about injected languages

This parser _only_ parses git commit subject, message and generated comments, it doesn't handle diff and git rebase information that could be included.

To handle that, you must have `diff` and `git_rebase` tree-sitter grammars installed and add injection queries.

If you're using Neovim and [`nvim-treesitter`](https://github.com/nvim-treesitter/nvim-treesitter), you just have to be sure that `diff` and `git_rebase` are installed (using `TSInstall diff git_rebase` for example).

## Upgrade translations

There is python script to upgrade translations from git source code. It will search for all translations in all tagged versions of git from the v2.30.2.

So this parser should be compatible with all git versions from v2.30.2.

To upgrade translations, run:

```bash

python parse-lang.py

```

## Credits

- [https://github.com/the-mikedavis/tree-sitter-git-commit](https://github.com/the-mikedavis/tree-sitter-git-commit) Good parser but [only works in English](https://github.com/the-mikedavis/tree-sitter-git-commit/issues/4).