Skip to content
This repository has been archived by the owner on Jun 16, 2021. It is now read-only.

patch: 🩹 bump version for npm publish file reduction #60

Merged
merged 5 commits into from
May 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ yarn.lock
/build/
/docs/
# fork
.editorconfig
.env
.eslintignore
.eslintrc.js
Expand All @@ -30,7 +31,9 @@ yarn.lock
.prettierrc.js
CHANGELOG.md
data/gitmoji/init.json
jsconfig.json
lint-staged.config.js
release.config.js
renovate.json
scripts/
scripts/
tsconfig.json
170 changes: 0 additions & 170 deletions CHANGELOG.md

This file was deleted.

48 changes: 31 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,46 @@
# git-cz
# @jeromefitz/git-cz

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

![image](https://user-images.githubusercontent.com/9773803/49760520-fa6c6f00-fcc4-11e8-84c4-80727f071487.png)
## Why this Fork

```bash
npm i -g git-cz
added 1 package in 0.612s
```

Installs in 0.6s vs 31.1s.

### But Why _this_ Fork

I needed to customize some things, and seemed like the intent was breaking away from [`streamich/git-cz`](https://github.com/streamich/git-cz).

- [x] Package Upgrades
- [x] Node12 Support
- [x] Subject Customization
- [x] Theming: Gitmoji ✨️
- Semantic Versioning Requirements for CI/CD
- [x] Gitflow Brancing
- CLI Customizations
- [x] Codestyle Preference
- Getting there
- [ ] TypeScript Migration
- Eventually getting there

## Install

### Without installation

```shell
npx git-cz
yarn git-cz
# or
npx git-cz -e
yarn git-cz -e
```

### Install globally standalone

```shell
npm install -g git-cz
yarn global install @jeromefitz/git-cz
git-cz
# or
git-cz -e
Expand All @@ -26,8 +49,8 @@ git-cz -e
### Install locally with Commitizen

```shell
npm install -g commitizen
npm install --save-dev git-cz
yarn global install commitizen
yarn install --save-dev @jeromefitz/git-cz
```

`package.json`:
Expand All @@ -51,7 +74,7 @@ git cz
### Install globally with Commitizen

```shell
npm install -g commitizen git-cz
yarn global install commitizen @jeromefitz/git-cz
commitizen init git-cz --save-dev --save-exact
```

Expand Down Expand Up @@ -294,15 +317,6 @@ Select the packages the commit affected.

The footer is the place to reference any tasks related to this commit.

## Why this Fork

```bash
npm i -g git-cz
added 1 package in 0.612s
```

Installs in 0.6s vs 31.1s.

```bash
npm i -g mol-conventional-changelog
added 345 packages in 31.076s
Expand Down
22 changes: 21 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@
"git-cz": "./bin/git-cz.js",
"gitcz": "./bin/git-cz.js"
},
"author": {
"name": "Vadim Dalecky",
"url": "http://onp4.com/@vadim/~js"
},
"contributors": [
{
"name": "Jerome Fitzgerald",
"email": "j@jeromefitzgerald.com",
"url": "https://jeromefitzgerald.com"
}
],
"repository": {
"type": "git",
"url": "git+ssh://git@github.com/jeromefitz/git-cz.git"
Expand All @@ -16,9 +27,18 @@
"engines": {
"node": ">=12"
},
"keywords": [
"commit",
"commitizen",
"conventional changelog",
"format",
"gitflow",
"gitmoji",
"pretty"
],
"scripts": {
"branch": "git-cz --branch --allow-empty",
"build:binaries": "mkdirp binaries && pkg lib/cli.js --out-path binaries",
"build:binaries": "mkdirp binaries && pkg lib/cli.js --out-path binaries --targets node12",
"build:cli": "browserify --node -o dist/cli.js lib/cli.js",
"build:cz": "browserify --node -o dist/cz.js --standalone prompter lib/cz.js",
"build": "yarn build:cli && yarn build:cz",
Expand Down