conventional-changelog-conventionalcommits 4.0.0 → 4.2.3

package/CHANGELOG.md

@@ -3,6 +3,62 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.2.3](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.2.2...conventional-changelog-conventionalcommits@4.2.3) (2019-11-07)
+
+
+### Bug Fixes
+
+* revertPattern match default git revert format ([#545](https://github.com/conventional-changelog/conventional-changelog/issues/545)) ([fe449f8](https://github.com/conventional-changelog/conventional-changelog/commit/fe449f899567574a36d1819b313e2caa899052ff))
+
+
+
+
+
+## [4.2.2](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.2.1...conventional-changelog-conventionalcommits@4.2.2) (2019-10-24)
+
+
+### Bug Fixes
+
+* **deps:** update lodash to fix security issues ([#535](https://github.com/conventional-changelog/conventional-changelog/issues/535)) ([ac43f51](https://github.com/conventional-changelog/conventional-changelog/commit/ac43f51de1f3b597c32f7f8442917a2d06199018))
+
+
+
+
+
+# [4.2.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.1.0...conventional-changelog-conventionalcommits@4.2.0) (2019-10-02)
+
+
+### Bug Fixes
+
+* **preset, conventionalcommits:** fix handling conventionalcommits preset without config object ([c0566ce](https://github.com/conventional-changelog/conventional-changelog/commit/c0566ce)), closes [#512](https://github.com/conventional-changelog/conventional-changelog/issues/512)
+* **preset, conventionalcommits:** pass issuePrefixes to parser ([#510](https://github.com/conventional-changelog/conventional-changelog/issues/510)) ([958d243](https://github.com/conventional-changelog/conventional-changelog/commit/958d243))
+* use full commit hash in commit link ([7a60dec](https://github.com/conventional-changelog/conventional-changelog/commit/7a60dec)), closes [#476](https://github.com/conventional-changelog/conventional-changelog/issues/476)
+
+
+### Features
+
+* sort sections of CHANGELOG based on priority ([#513](https://github.com/conventional-changelog/conventional-changelog/issues/513)) ([a3acc32](https://github.com/conventional-changelog/conventional-changelog/commit/a3acc32))
+
+
+
+
+
+# [4.1.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.0.0...conventional-changelog-conventionalcommits@4.1.0) (2019-07-29)
+
+
+### Bug Fixes
+
+* **preset, conventionalcommits:** Ensure proper substitutions for the conventionalcommit preset by using commit context for values where possible. ([#463](https://github.com/conventional-changelog/conventional-changelog/issues/463)) ([0b7ed0b](https://github.com/conventional-changelog/conventional-changelog/commit/0b7ed0b))
+
+
+### Features
+
+* **preset, conventionalcommits:** add handling of issue prefixes ([#498](https://github.com/conventional-changelog/conventional-changelog/issues/498)) ([85c17bb](https://github.com/conventional-changelog/conventional-changelog/commit/85c17bb))
+
+
+
+
+
 # [4.0.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@3.0.2...conventional-changelog-conventionalcommits@4.0.0) (2019-05-18)
 
 

package/index.js

@@ -1,11 +1,32 @@
 'use strict'
 const Q = require(`q`)
+const _ = require(`lodash`)
 const conventionalChangelog = require(`./conventional-changelog`)
 const parserOpts = require(`./parser-opts`)
 const recommendedBumpOpts = require(`./conventional-recommended-bump`)
 const writerOpts = require(`./writer-opts`)
 
-module.exports = function (config) {
+module.exports = function (parameter) {
+  // parameter passed can be either a config object or a callback function
+  if (_.isFunction(parameter)) {
+    // parameter is a callback object
+    const config = {}
+    // FIXME: use presetOpts(config) for callback
+    Q.all([
+      conventionalChangelog(config),
+      parserOpts(config),
+      recommendedBumpOpts(config),
+      writerOpts(config)
+    ]).spread((conventionalChangelog, parserOpts, recommendedBumpOpts, writerOpts) => {
+      parameter(null, { gitRawCommitsOpts: { noMerges: null }, conventionalChangelog, parserOpts, recommendedBumpOpts, writerOpts })
+    })
+  } else {
+    const config = parameter || {}
+    return presetOpts(config)
+  }
+}
+
+function presetOpts (config) {
   return Q.all([
     conventionalChangelog(config),
     parserOpts(config),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conventional-changelog-conventionalcommits",
-  "version": "4.0.0",
+  "version": "4.2.3",
   "description": "conventional-changelog conventionalcommits.org preset",
   "main": "index.js",
   "scripts": {
@@ -35,7 +35,8 @@
   "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular#readme",
   "dependencies": {
     "compare-func": "^1.3.1",
+    "lodash": "^4.17.15",
     "q": "^1.5.1"
   },
-  "gitHead": "38f5508191f8afc1a8503d1fd24e2de6d05b8738"
+  "gitHead": "741e90744cdb58e82e71feb36018047d7baca768"
 }

package/parser-opts.js

@@ -1,6 +1,7 @@
 'use strict'
 
 module.exports = function (config) {
+  config = defaultConfig(config)
   return {
     headerPattern: /^(\w*)(?:\((.*)\))?!?: (.*)$/,
     breakingHeaderPattern: /^(\w*)(?:\((.*)\))?!: (.*)$/,
@@ -10,7 +11,15 @@ module.exports = function (config) {
       `subject`
     ],
     noteKeywords: [`BREAKING CHANGE`],
-    revertPattern: /^revert:\s([\s\S]*?)\s*This reverts commit (\w*)\./,
-    revertCorrespondence: [`header`, `hash`]
+    revertPattern: /^(?:Revert|revert:)\s"?([\s\S]+?)"?\s*This reverts commit (\w*)\./i,
+    revertCorrespondence: [`header`, `hash`],
+    issuePrefixes: config.issuePrefixes
   }
 }
+
+// merge user set configuration with default configuration.
+function defaultConfig (config) {
+  config = config || {}
+  config.issuePrefixes = config.issuePrefixes || ['#']
+  return config
+}

package/templates/commit.hbs

@@ -6,9 +6,9 @@
 {{~/if}}
 
 {{~!-- commit link --}} {{#if @root.linkReferences~}}
-  ([{{hash}}]({{commitUrlFormat}}))
+  ([{{shortHash}}]({{commitUrlFormat}}))
 {{~else}}
-  {{~hash}}
+  {{~shortHash}}
 {{~/if}}
 
 {{~!-- commit references --}}
@@ -19,12 +19,12 @@
     {{~#if this.owner}}
       {{~this.owner}}/
     {{~/if}}
-    {{~this.repository}}#{{this.issue}}]({{issueUrlFormat}})
+    {{~this.repository}}{{this.prefix}}{{this.issue}}]({{issueUrlFormat}})
   {{~else}}
     {{~#if this.owner}}
       {{~this.owner}}/
     {{~/if}}
-    {{~this.repository}}#{{this.issue}}
+    {{~this.repository}}{{this.prefix}}{{this.issue}}
   {{~/if}}{{/each}}
 {{~/if}}
 

package/writer-opts.js

@@ -6,23 +6,31 @@ const Q = require(`q`)
 const readFile = Q.denodeify(require(`fs`).readFile)
 const resolve = require(`path`).resolve
 
+/**
+ * Handlebar partials for various property substitutions based on commit context.
+ */
+const owner = '{{#if this.owner}}{{~this.owner}}{{else}}{{~@root.owner}}{{/if}}'
+const host = '{{~@root.host}}'
+const repository = '{{#if this.repository}}{{~this.repository}}{{else}}{{~@root.repository}}{{/if}}'
+
 module.exports = function (config) {
   config = defaultConfig(config)
   const commitUrlFormat = expandTemplate(config.commitUrlFormat, {
-    host: '{{~@root.host}}',
-    owner: '{{~@root.owner}}',
-    repository: '{{~@root.repository}}'
+    host,
+    owner,
+    repository
   })
   const compareUrlFormat = expandTemplate(config.compareUrlFormat, {
-    host: '{{~@root.host}}',
-    owner: '{{~@root.owner}}',
-    repository: '{{~@root.repository}}'
+    host,
+    owner,
+    repository
   })
   const issueUrlFormat = expandTemplate(config.issueUrlFormat, {
-    host: '{{~@root.host}}',
-    owner: '{{~@root.owner}}',
-    repository: '{{~@root.repository}}',
-    id: '{{this.issue}}'
+    host,
+    owner,
+    repository,
+    id: '{{this.issue}}',
+    prefix: '{{this.prefix}}'
   })
 
   return Q.all([
@@ -57,7 +65,7 @@ function getWriterOpts (config) {
     transform: (commit, context) => {
       let discard = true
       const issues = []
-      const typeKey = (commit.type || '').toLowerCase()
+      const typeKey = (commit.revert ? 'revert' : (commit.type || '')).toLowerCase()
 
       // adds additional breaking change notes
       // for the special case, test(system)!: hello world, where there is
@@ -80,20 +88,25 @@ function getWriterOpts (config) {
       }
 
       if (typeof commit.hash === `string`) {
-        commit.hash = commit.hash.substring(0, 7)
+        commit.shortHash = commit.hash.substring(0, 7)
       }
 
       if (typeof commit.subject === `string`) {
         // Issue URLs.
-        commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
-          issues.push(issue)
+        config.issuePrefixes.join('|')
+        let issueRegEx = '(' + config.issuePrefixes.join('|') + ')' + '([0-9]+)'
+        let re = new RegExp(issueRegEx, 'g')
+
+        commit.subject = commit.subject.replace(re, (_, prefix, issue) => {
+          issues.push(prefix + issue)
           const url = expandTemplate(config.issueUrlFormat, {
             host: context.host,
             owner: context.owner,
             repository: context.repository,
-            id: issue
+            id: issue,
+            prefix: prefix
           })
-          return `[#${issue}](${url})`
+          return `[${prefix}${issue}](${url})`
         })
         // User URLs.
         commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, user) => {
@@ -115,7 +128,7 @@ function getWriterOpts (config) {
 
       // remove references that already appear in the subject
       commit.references = commit.references.filter(reference => {
-        if (issues.indexOf(reference.issue) === -1) {
+        if (issues.indexOf(reference.prefix + reference.issue) === -1) {
           return true
         }
 
@@ -125,7 +138,18 @@ function getWriterOpts (config) {
       return commit
     },
     groupBy: `type`,
-    commitGroupsSort: `title`,
+    // the groupings of commit messages, e.g., Features vs., Bug Fixes, are
+    // sorted based on their probable importance:
+    commitGroupsSort: (a, b) => {
+      const commitGroupOrder = ['Reverts', 'Performance Improvements', 'Bug Fixes', 'Features']
+      const gRankA = commitGroupOrder.indexOf(a.title)
+      const gRankB = commitGroupOrder.indexOf(b.title)
+      if (gRankA >= gRankB) {
+        return -1
+      } else {
+        return 1
+      }
+    },
     commitsSort: [`scope`, `subject`],
     noteGroupsSort: `title`,
     notesSort: compareFunc
@@ -156,6 +180,7 @@ function defaultConfig (config) {
     '{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}'
   config.userUrlFormat = config.userUrlFormat ||
     '{{host}}/{{user}}'
+  config.issuePrefixes = config.issuePrefixes || ['#']
 
   return config
 }