Skip to content

SKalt/cconvention

Repository files navigation

cconvention

A language server to help write conventional commits.

git commit on the command-line opens a ${GIT_DIR}/COMMIT_EDITMSG file in your $EDITOR of choice. cconvention acts as a language server to provide completion, linting, and formatting.

Pairs well with 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

cconvention --help | sed 's/^/# /g'
# Usage: cconvention <COMMAND>
#
# 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 noncommercial OR free-trial OR COMMERCIAL
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.