conventional-changelog - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

index.js

@@ -14,2 +14,3 @@
     file: 'CHANGELOG.md',
+    codename: '',
     log: console.log.bind(console),
@@ -16,0 +17,0 @@ }, options || {});

lib/writer.js

@@ -74,4 +74,4 @@ var es = require('event-stream');
 
-var PATCH_HEADER_TPL = '<a name="%s"></a>\n### %s (%s)\n\n';
-var MINOR_HEADER_TPL = '<a name="%s"></a>\n## %s (%s)\n\n';
+var PATCH_HEADER_TPL = '<a name="%s"></a>\n### %s %s (%s)\n\n';
+var MINOR_HEADER_TPL = '<a name="%s"></a>\n## %s %s (%s)\n\n';
 var EMPTY_COMPONENT = '$$';
@@ -81,4 +81,5 @@ function Writer(stream, options) {
   this.header = function(version) {
+    var codename = options.codename ? '"' + options.codename + '"' : '';
     var header = version.split('.')[2] === '0' ? MINOR_HEADER_TPL : PATCH_HEADER_TPL;
-    stream.write(util.format(header, version, version, currentDate()));
+    stream.write(util.format(header, version, version, codename, currentDate()));
   };
@@ -85,0 +86,0 @@

package.json

 {
   "name": "conventional-changelog",
-  "version": "0.0.6",
+  "codename": "delta",
+  "version": "0.0.7",
   "description": "Generate a markdown changelog from git commit metadata",
@@ -5,0 +6,0 @@ "main": "index.js",

README.md

@@ -18,3 +18,3 @@ conventional-changelog
 
-Recommended usage: use in your workflow with [https://github.com/btford/grunt-conventional-changelog](grunt-conventional-changelog) or [https://github.com/tomchentw/gulp-conventional-changelog](gulp-conventional-changelog).
+Recommended usage: use in your workflow with [https://github.com/btford/grunt-conventional-changelog](grunt-conventional-changelog).
 
@@ -44,2 +44,4 @@ ## Documentation
 
+* `codename` `{string}` - The codename to display after the version in the changelog. For example, it will show '## 1.0.0 "Super Version"' if codename 'Super Version' is given. By default, it's blank.
+
 * `repository` `{string}` - If this is provided, allows issues and commit hashes to be linked to the actual commit.  Usually used with github repositories.  For example, `{repository: 'http://github.com/joyent/node'}`
@@ -46,0 +48,0 @@

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

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

Improved metrics

Total package byte prevSize

17219

increased by1.42%

Lines of code

412

increased by0.49%

Number of lines in readme file

63

increased by3.28%

No dependency changes