# transparent-commitizen

> A stripped-down commitizen adapter that exposes config so that it can be modified and checked into source control

Latest version **0.5.2** (published 2020-08-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install transparent-commitizen
pnpm add transparent-commitizen
yarn add transparent-commitizen
bun add transparent-commitizen
```

Provides the command `transparent-commitizen`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.2 |
| Published | 2020-08-13 |
| First published | 2020-06-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ivo Evans |
| Maintainers | ivo-evans |
| Keywords | commitizen, commit, git |

## Links

- npm: https://www.npmjs.com/package/transparent-commitizen
- Repository: https://github.com/Ivo-Evans/transparent-commitizen
- Homepage: https://github.com/Ivo-Evans/transparent-commitizen#readme
- Issues: https://github.com/Ivo-Evans/transparent-commitizen/issues
- npm.io page: https://npm.io/package/transparent-commitizen

## Dependencies (2)

- [read-pkg](https://npm.io/package/read-pkg.md) ^5.2.0
- [write-pkg](https://npm.io/package/write-pkg.md) ^4.0.0

## Recent versions

- 0.5.2 (latest) — 2020-08-13
- 0.5.1 — 2020-08-03
- 0.5.0 — 2020-07-07
- 0.4.0 — 2020-07-06
- 0.3.0 — 2020-06-09
- 0.2.2 — 2020-06-06
- 0.2.1 — 2020-06-06
- 0.2.0 — 2020-06-06
- 0.1.0 — 2020-06-06

## README

![GitHub repo size](https://img.shields.io/github/repo-size/Ivo-Evans/transparent-commitizen)
![Version](https://img.shields.io/npm/v/transparent-commitizen)
![License](https://img.shields.io/npm/l/transparent-commitizen)

# transparent-commitizen.

A stripped-down, simple commitizen adapter that exposes its logic. This lets you check project-specific configs into source control. 

Be a transparent commitizen.

Forked from [cz-jira-smart-commit](https://www.npmjs.com/package/cz-jira-smart-commit).

## Installation

```
npm i -D transparent-commitizen
npx transparent-commitizen # This command configures tc
```

You can then edit your commit config by editing .commitconfig/index.js.

If you haven't already installed commitizen itself, you'll need to do so with `npm i -g commitizen`

## Writing your own questions and format

I recommend you look at index.js, which is extremely simple, but here are some instructions anyway.

To add a question, you need ask it by adding to the the array passed to inquirer.prompt, and handle the answer by adding to the function formatAnswers.

Questions in the array passed to inquirer.prompt are a series of objects. Each one should have a type property (`type: 'input'` is a good place to start), a name for the question, and a message that the user will see as a prompt.

Question objects take a function called validate as an optional property. I've included a helper validate function called exists. If you want to make an answer required you can add `validate: validate.exists`. You can also look at exists() for the expected input and output of validate functions. If you're curious about input types or validate functions, head over to the [inquirer.js docs](https://www.npmjs.com/package/inquirer).

Adding questions to the array of objects makes them available in the answers object. Each answer is a value keyed to the name you gave the question. So, to put to the answers to questions in your commit message, access them by their names in the formatCommit function.

## Day to day work

instead of `git commit`, use `git cz`:

```
$ git add .
$ git cz
```

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