@tophat/commitizen-adapter
Advanced tools
@tophat/commitizen-adapter - npm Package Compare versions
Comparing version 0.0.11 to 0.1.0
| { | ||
| "name": "@tophat/commitizen-adapter", | ||
| "version": "0.0.11", | ||
| "version": "0.0.0", | ||
| "description": "A customized Commitizen adapter for commit message standardization and automatic semantic versioning.", | ||
@@ -14,5 +14,5 @@ "author": "Top Hat", | ||
| "dependencies": { | ||
| "@tophat/commit-utils-core": "^0.0.9", | ||
| "@tophat/commit-utils-core": "*", | ||
| "lodash": "^4.17.10", | ||
| "longest": "^1.0.1", | ||
| "longest": "^2.0.1", | ||
| "word-wrap": "^1.0.3" | ||
@@ -38,4 +38,3 @@ }, | ||
| "access": "public" | ||
| }, | ||
| "gitHead": "6a8090b9807edd3eb046b2bb23fd1f5d3a54da37" | ||
| } | ||
| } | ||
| } |
@@ -1,42 +0,47 @@ | ||
| We are standardizing our commit messages to pave the way for automatic semantic | ||
| package versioning, and to do so, we are using Commitizen as an interactive | ||
| commit message builder. We've customized the conventional Commitizen adapter to | ||
| suit our needs. | ||
| # @tophat/commitizen-adapter | ||
| ## Commit Types | ||
| [](https://badge.fury.io/js/%40tophat%2Fcommitizen-adapter) | ||
| [](https://npm-stat.com/charts.html?package=%40tophat%2Fcommitizen-adapter) | ||
| You will see the following commit types when you run the command | ||
| <span style="color: #e60031">`git cz`</span>: | ||
| A [commitizen](https://github.com/commitizen/cz-cli) adapter that lets you interactively build commit messages using Top Hat's commit convention. | ||
| --- | ||
| ## Installation | ||
| First, make sure you have commitizen installed and configured globally | ||
| **wip**: Changes that are part of some work in progress | ||
| ```sh | ||
| npm install -g commitizen | ||
| ``` | ||
| **feat**: A new feature (NOTE: This will be added to the changelog) | ||
| Then install the Top Hat commitizen adapter: | ||
| **fix**: A bug fix (NOTE: This will be added to the changelog) | ||
| Using Yarn | ||
| ```sh | ||
| yarn add @tophat/commitizen-adapter --dev | ||
| ``` | ||
| **cr**: Changes resulting from code review | ||
| or using npm | ||
| ```sh | ||
| npm install @tophat/commitizen-adapter --save-dev | ||
| ``` | ||
| **style**: Changes that don't affect the code's meaning (whitespace, formatting, etc) | ||
| Add the following snippet to your package.json file | ||
| **refactor**: Changes that neither fix a bug nor add a feature | ||
| ```js | ||
| "config": { | ||
| "commitizen": { | ||
| "path": "./node_modules/@tophat/commitizen-adapter" | ||
| } | ||
| } | ||
| ``` | ||
| **perf**: Changes that improve performance (NOTE: This will be added to the changelog) | ||
| Alternatively, if you're using a `.czrc` file, add this | ||
| ```js | ||
| { | ||
| "path": "@tophat/commitizen-adapter" | ||
| } | ||
| ``` | ||
| **docs**: Changes to documentation only | ||
| ## Usage | ||
| Running `git cz` should now bring up an interactive prompt that lets you build commit messages | ||
| **test**: Adding missing tests or correcting existing tests | ||
| **revert**: Reverts a previous commit | ||
| **build**: Changes that affect the build system or external dependencies | ||
| **ci**: Changes to our CI configuration files and scripts | ||
| **chore**: Other changes that don't modify src or test files | ||
| ## Maximum Character Limit | ||
| There is a maximum character limit of 72 for the header of the commit message | ||
| which is composed of the commit type and subject. | ||
| <span><img align="center" src="../../docs/tophat-cz-screenshot.png" alt="Screenshot"></span> |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Wildcard dependency
QualityPackage has a dependency with a floating version range. This can cause issues if the dependency publishes a new major version.
Found 1 instance in 1 package
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by11.63%
48
Worsened metrics
- Total package byte prevSize
- decreased by-57.03%
8689
- Number of package files
- decreased by-16.67%
5
- Number of medium quality alerts
- increased by100%
2
- Number of medium supply chain risk alerts
- increased byInfinity%
1
Dependency changes
+ Added@tophat/commit-utils-core@1.0.0(transitive)
+ Addedlongest@2.0.1(transitive)
- Removed@tophat/commit-utils-core@0.0.9(transitive)
- Removedlongest@1.0.1(transitive)
Updated@tophat/commit-utils-core@*
Updatedlongest@^2.0.1