Skip to content

Commit

Permalink
fix: remove outdated aliases feature
Browse files Browse the repository at this point in the history
  • Loading branch information
sheerlox committed Jun 7, 2023
1 parent 2f4f4d8 commit 135600e
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 107 deletions.
14 changes: 0 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,20 +88,6 @@ conventionalChangelog({ config }).pipe(process.stdout);
| `chore` | Chores | Other changes that don't modify src or test files | ♻️ | - | `true` |
| `revert` | Reverts | Reverts a previous commit | 🗑 | - | `true` |

## Commit aliases

Aliases allow to have additional commit types (in a tool like [commitizen](https://github.com/commitizen/cz-cli) for example) that can be formatted to follow [AngularJS Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit).

For example the [commitizen](https://github.com/commitizen/cz-cli) CLI can present the choice `initial` and the final commit message will be 'feat: Initial commit 🎉'

| Commit Type | Maps to | Title | Description | Emoji |
| :---------: | ------- | ----------------- | ------------------------------- | :---: |
| `initial` | `feat` | Initial | Initial commit | 🎉 |
| `deps` | `fix` | Dependencies | Update dependencies | ⬆️ |
| `devdeps` | `chore` | Dev dependencies | Update development dependencies | ⬆️ |
| `peerdeps` | `fix` | Peer dependencies | Update peer dependencies | ⬆️ |
| `metadata` | `fix` | Metadata | Update metadata (package.json) | 📦 |

## Related

- [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog)
Expand Down
15 changes: 0 additions & 15 deletions aliases.js

This file was deleted.

6 changes: 2 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@
"lib/*.js",
"index.js",
"release-rules.js",
"types.js",
"aliases.js"
"types.js"
],
"publishConfig": {
"access": "public"
Expand All @@ -85,8 +84,7 @@
"lib/*.js",
"index.js",
"release-rules.js",
"types.js",
"aliases.js"
"types.js"
],
"reporter": [
"html",
Expand Down
74 changes: 0 additions & 74 deletions test/aliases.test.js

This file was deleted.

0 comments on commit 135600e

Please sign in to comment.