https://github.com/skalt/cconvention
A language server to help write conventional commits.
https://github.com/skalt/cconvention
conventional-commits git language-server language-server-protocol lsp lsp-server
Last synced: 5 months ago
JSON representation
A language server to help write conventional commits.
- Host: GitHub
- URL: https://github.com/skalt/cconvention
- Owner: SKalt
- Created: 2023-04-07T15:26:13.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-11T12:57:44.000Z (over 1 year ago)
- Last Synced: 2025-04-07T12:30:59.661Z (about 1 year ago)
- Topics: conventional-commits, git, language-server, language-server-protocol, lsp, lsp-server
- Language: Rust
- Homepage: https://marketplace.visualstudio.com/items?itemName=kalt-dot-cloud.git-conventional-commit-ls-basic
- Size: 519 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSES/APACHE-2.0.md
Awesome Lists containing this project
README
# `cconvention`
A language server to help write [conventional commits][ccs].
`git commit` on the command-line opens a [`${GIT_DIR}/COMMIT_EDITMSG`](https://git-scm.com/docs/git-commit#_files) file in your `$EDITOR` of choice.
`cconvention` acts as a language server to provide completion, linting, and formatting.
Pairs well with [`git-cc`][git-cc], a TUI for writing conventional commits.
### Warning: this is alpha software
Any part of the public-API may change with little or no warning until the first major-version release.
This includes the names of any published tools, libraries, binaries, or extensions.
## Command-line Usage
```sh
cconvention --help | sed 's/^/# /g'
# Usage: cconvention
#
# Commands:
# serve Run a language server
# check Lint commit message(s)
# help Print this message or the help of the given subcommand(s)
#
# Options:
# -h, --help Print help
# -V, --version Print version
```
## Licensing
`cconvention` comes in flavors -- an open-source (OSS) edition which you can build upon and use for any purpose, and a source-provided version with commercial use restrictions.
Summarized, the source-provided license states:
> To use `cconvention` to make money or for work, you need to buy a license.
> You can try before you buy for a month to make sure the software works for you.
| Feature | OSS | Source-provided |
| :------------------------------: | :---------------: | :-------------------------------------------------------: |
| License | [Apache-2.0][oss] | [noncommercial OR free-trial OR COMMERCIAL][src-provided] |
| error & performance monitoring | opt-**out** | opt-**in** |
| configuration file | ❌ no | ✅ yes |
| ability to write your own checks | ❌ no | ✅ yes |
The OSS editions are located in:
- `pkg/base/`
- `editors/*/base`
The source-provided editions are located in:
- `pkg/pro/`
- `editors/*/pro`
If you're ever confused which license applies, check the nearest file header.
[ccs]: https://conventionalcommits.org
[git-cc]: https://github.com/skalt/git-cc
[oss]: ./LICENSES/APACHE-2.0.md
[src-provided]: ./editors/code/pro/LICENSE.md