O-semantic CLI

O-semantic is a library that allows to write commits following the conventions, it has two types of configurations to establish the structure of the commit:

Default

feat(lang): add Polish language

docs: correct spelling of CHANGELOG

fix: prevent racing of requests

Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.

Remove timeouts which were used to mitigate the racing issue but are
obsolete now.

Reviewed-by: Z
Refs: #123

Jira

feat(lang): [SKCH-1789] add Polish language

docs: [SKCH-1789] correct spelling of CHANGELOG

fix: [SKCH-1789] prevent racing of requests

Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.

Remove timeouts which were used to mitigate the racing issue but are
obsolete now.

Reviewed-by: Z
Refs: [SKCH-1789]

Installing the command line tool

O-semantic is currently tested against Node.js 14, 16 & 18, although it may work in older versions of Node.js. You should also have npm 6 or greater.

Installation is as simple as running the following command (if you see EACCES error, reading fixing npm permissions may help):

npm install -g o-semantic

Using the command line tool

Simply use o-semantic or just oc instead of git commit when committing.

Alternatively, if you are using npm 5.2+ you can use npx instead of installing globally:

npx oc

or as an npm script:

  ...
  "scripts": {
    "commit": "oc"
  }

oc -h  #show help you can use --help flag

Usage: o-semantic [options]

CLI to create semantic commits

Options:
  -V, --version  output the version number
  -d, --default  use default convention
  -j, --jira     use jira convention
  -h, --help     display help for command

Related projects

• conventional-changelog – Generate a changelog from conventional commit history
• commitlint - Lint commit messages