# o-semantic

> CLI semantic commit

Latest version **1.0.2** (published 2022-10-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install o-semantic
pnpm add o-semantic
yarn add o-semantic
bun add o-semantic
```

Provides the commands `oc`, `o-semantic`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-10-01 |
| First published | 2022-09-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | oscles |
| Keywords | semantic, commit, cli, conventional |

## Links

- npm: https://www.npmjs.com/package/o-semantic
- Repository: https://github.com/oscles/o-semantic
- Homepage: https://github.com/oscles/o-semantic#readme
- Issues: https://github.com/oscles/o-semantic/issues
- npm.io page: https://npm.io/package/o-semantic

## Dependencies (6)

- [inquirer](https://npm.io/package/inquirer.md) 8.0.0
- [commander](https://npm.io/package/commander.md) 9.4.1
- [commitizen](https://npm.io/package/commitizen.md) 4.2.5
- [standard-version](https://npm.io/package/standard-version.md) 9.5.0
- [@ryansonshine/commitizen](https://npm.io/package/@ryansonshine/commitizen.md) 4.2.8
- [@digitalroute/cz-conventional-changelog-for-jira](https://npm.io/package/@digitalroute/cz-conventional-changelog-for-jira.md) 7.4.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-10-01
- 1.0.1 — 2022-10-01
- 1.0.0 — 2022-09-30

## README

## O-semantic CLI

<br>

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

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

```bash
feat(lang): add Polish language
```

```bash
docs: correct spelling of CHANGELOG
```

```bash
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

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

```bash
docs: [SKCH-1789] correct spelling of CHANGELOG
```

```bash
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]
```

<br>

## 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](https://docs.npmjs.com/getting-started/fixing-npm-permissions) may help):

```sh
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`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) instead of installing globally:

```sh
npx oc
```

or as an npm script:

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

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

```bash
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](https://github.com/conventional-changelog/conventional-changelog) – Generate a changelog from conventional commit history
- [commitlint](https://github.com/conventional-changelog/commitlint) - Lint commit messages

---
_Source: https://npm.io/package/o-semantic · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._