@tophat/conventional-changelog-config - npm Package Compare versions

Comparing version 0.0.9 to 0.1.0

package.json

 {
   "name": "@tophat/conventional-changelog-config",
-  "version": "0.0.9",
+  "version": "0.0.0",
   "description": "Top Hat's conventional changelog config for changelog generation",
@@ -27,8 +27,8 @@ "author": "Top Hat",
   "dependencies": {
-    "@tophat/commit-utils-core": "^0.0.9"
+    "@tophat/commit-utils-core": "*",
+    "compare-func": "^2.0.0"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "afcdddf590ac9c69d2fccbfa700b4d3c9ed6b6df"
-}
+  }
+}

README.md

@@ -1,11 +0,120 @@
-# `conventional-changelog-config`
+# @tophat/conventional-changelog-config
 
-> TODO: description
+[![npm version](https://badge.fury.io/js/%40tophat%2Fconventional-changelog-config.svg)](https://badge.fury.io/js/%40tophat%2Fconventional-changelog-config)
+[![npm downloads](https://img.shields.io/npm/dm/%40tophat%2Fconventional-changelog-config.svg)](https://npm-stat.com/charts.html?package=%40tophat%2Fconventional-changelog-config)
 
+Top Hat's shareable configuration for [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
+
+## Installation
+
+Using Yarn:
+
+`yarn add @tophat/conventional-changelog-config --dev`
+
+Or using npm:
+
+`npm install @tophat/conventional-changelog-config --save-dev`
+
+
 ## Usage
 
+Using [Lerna](https://github.com/lerna/lerna):
+
+`lerna publish --skip-git --conventional-commits --changelog-preset 
+@tophat/conventional-changelog-config --yes`
+
+Note: The `lerna` above should be the path to your Lerna executable if 
+Lerna is not installed globally.
+
+## Convention
+
+The changelog uses the commit message format from the 
+[Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular#commit-message-format).
+
+### Included Commit Types
+
+The full list of commit types are listed [here](https://github.com/tophat/commit-utils#commit-convention).
+However, only the following types will be included in the changelog generation.
+ 
+#### feat:
+
+This commit is a new feature.
+
+Example:
 ```
-const conventionalChangelogConfig = require('conventional-changelog-config');
+feat: add bold and italics options to formatting toolbar
+```
 
-// TODO: DEMONSTRATE API
+In the changelog, this may look like:
 ```
+1.1.0 (2019-04-26)
+------------------
+Features
+- add bold and italics options to formatting toolbar (#100) (1ab23c4)
+```
+
+#### fix
+
+This commit is a bug fix.
+
+Example:
+```
+fix: adjust page preview height
+```
+
+In the changelog, this may look like:
+```
+1.1.1 (2019-04-26)
+------------------
+Bug Fixes
+- adjust page preview height (#101) (z987y65)
+```
+
+#### perf
+
+This commit makes performance improvements.
+
+Example:
+```
+perf: reduce number of re-renders in the preview
+```
+
+In the changelog, this may look like:
+```
+1.1.2 (2019-04-26)
+------------------
+Performance Improvements
+- reduce number of re-renders in the preview (#103) (m56np7)
+```
+   
+### revert
+
+This commit reverts a specified commit.
+
+Example:
+```
+revert: "feat: add bold and italics options to formatting toolbar (#100)"
+
+This reverts commit 1ab23c4.
+```
+
+In the changelog, this may look like:
+```
+1.1.3 (2019-04-26)
+------------------
+Reverts
+- add bold and italics options to formatting toolbar (1ab23c4)
+```
+    
+### Breaking Changes
+
+This commit indicates that there is some major change that is 
+non-backwards compatible and requires consumers to take action.
+
+In the changelog, this may look like:
+```
+2.0.0 (2019-04-26)
+------------------
+Breaking Changes
+- the formatter v2 endpoint has been deprecated (q12rs34)
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Wildcard dependency

Quality

Package 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 risk

This 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

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 2 instances in 1 package

Improved metrics

Number of lines in readme file

120

increased by900%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

16335

decreased by-67.05%

Dependency count

2

increased by100%

Number of package files

13

decreased by-18.75%

Number of medium quality alerts

2

increased by100%

Dependency changes

• + Addedcompare-func@^2.0.0

• + Added@tophat/commit-utils-core@1.0.0(transitive)

• + Addedarray-ify@1.0.0(transitive)

• + Addedcompare-func@2.0.0(transitive)

• + Addeddot-prop@5.3.0(transitive)

• + Addedis-obj@2.0.0(transitive)

• - Removed@tophat/commit-utils-core@0.0.9(transitive)

• Updated@tophat/commit-utils-core@*