conventional-changelog-conventionalcommits 4.2.3 → 4.5.0

package/CHANGELOG.md

@@ -3,6 +3,51 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.5.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.4.0...conventional-changelog-conventionalcommits@4.5.0) (2020-11-05)
+
+
+### Features
+
+* **conventionalcommits:** allow matching scope ([#669](https://github.com/conventional-changelog/conventional-changelog/issues/669)) ([e01e027](https://github.com/conventional-changelog/conventional-changelog/commit/e01e027af60f5fa3e9146223b96797793930aeb4))
+
+
+
+
+
+# [4.4.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.3.1...conventional-changelog-conventionalcommits@4.4.0) (2020-08-12)
+
+
+### Features
+
+* **templates:** if hash is nullish, do not display in CHANGELOG ([#664](https://github.com/conventional-changelog/conventional-changelog/issues/664)) ([f10256c](https://github.com/conventional-changelog/conventional-changelog/commit/f10256c635687de0a85c4db2bf06292902924f77))
+
+
+
+
+
+## [4.3.1](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.3.0...conventional-changelog-conventionalcommits@4.3.1) (2020-06-20)
+
+
+### Bug Fixes
+
+* **deps:** update dependency compare-func to v2 ([#647](https://github.com/conventional-changelog/conventional-changelog/issues/647)) ([de4f630](https://github.com/conventional-changelog/conventional-changelog/commit/de4f6309403ca0d46b7c6235052f4dca61ea15bc))
+* pass config to parserOpts and writerOpts ([73c7a1b](https://github.com/conventional-changelog/conventional-changelog/commit/73c7a1b92c2a47c498f42972acbffa156172a341))
+
+
+
+
+
+# [4.3.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-changelog-conventionalcommits@4.2.3...conventional-changelog-conventionalcommits@4.3.0) (2020-05-08)
+
+
+### Features
+
+* add support for 'feature' as alias for 'feat' ([#582](https://github.com/conventional-changelog/conventional-changelog/issues/582)) ([94c40f7](https://github.com/conventional-changelog/conventional-changelog/commit/94c40f755e6c329311d89a47c634b91cf0276da3))
+
+
+
+
+
 ## [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)
 
 

package/README.md

@@ -6,6 +6,40 @@ A concrete implementation of the specification described at
 [conventionalcommits.org](https://conventionalcommits.org/) for automated
 CHANGELOG generation and version management.
 
+
+## Indirect Usage (as preset)
+
+Use the [Conventional Changelog CLI Quick Start](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#quick-start) with the `-p conventionalcommits` option.
+
+## Direct Usage (as a base preset so you can customize it)
+
+If you want to use this package directly and pass options, you can use the [Conventional Changelog CLI Quick Start](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli#quick-start) and with the `--config` or `-n` parameter, pass a js config that looks like this
+```
+'use strict'
+const config = require('conventional-changelog-conventionalcommits')
+
+module.exports = config({
+    "issuePrefixes": ["TEST-"],
+    "issueUrlFormat": "myBugTracker.com/{prefix}{id}"
+})
+```
+
+or json config like that:
+```
+{
+    "options": {
+        "preset": {
+            "name": "conventionalchangelog",
+            "issuePrefixes": ["TEST-"],
+            "issueUrlFormat": "myBugTracker.com/{prefix}{id}"
+        }
+    }
+}
+```
+This last json config way passes the `preset` object to the `conventional-changelog-preset-loader` package, that in turn, passes this same `preset` object as the config for the `conventional-changelog-conventionalcommits`.
+
+
+
 See [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec) for available
 configuration options.
 

package/conventional-changelog.js

@@ -1,11 +1,11 @@
 'use strict'
 
-const Q = require(`q`)
-const parserOpts = require(`./parser-opts`)
-const writerOpts = require(`./writer-opts`)
+const Q = require('q')
+const parserOpts = require('./parser-opts')
+const writerOpts = require('./writer-opts')
 
 module.exports = function (config) {
-  return Q.all([parserOpts, writerOpts])
+  return Q.all([parserOpts(config), writerOpts(config)])
     .spread((parserOpts, writerOpts) => {
       return { parserOpts, writerOpts }
     })

package/conventional-recommended-bump.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const addBangNotes = require('./add-bang-notes')
-const parserOpts = require(`./parser-opts`)
+const parserOpts = require('./parser-opts')
 
 module.exports = function (config) {
   return {
@@ -20,7 +20,7 @@ module.exports = function (config) {
         if (commit.notes.length > 0) {
           breakings += commit.notes.length
           level = 0
-        } else if (commit.type === `feat`) {
+        } else if (commit.type === 'feat' || commit.type === 'feature') {
           features += 1
           if (level === 2) {
             level = 1

package/index.js

@@ -1,10 +1,10 @@
 '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`)
+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 (parameter) {
   // parameter passed can be either a config object or a callback function

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conventional-changelog-conventionalcommits",
-  "version": "4.2.3",
+  "version": "4.5.0",
   "description": "conventional-changelog conventionalcommits.org preset",
   "main": "index.js",
   "scripts": {
@@ -26,7 +26,7 @@
   ],
   "author": "Ben Coe",
   "engines": {
-    "node": ">=6.9.0"
+    "node": ">=10"
   },
   "license": "ISC",
   "bugs": {
@@ -34,9 +34,9 @@
   },
   "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular#readme",
   "dependencies": {
-    "compare-func": "^1.3.1",
+    "compare-func": "^2.0.0",
     "lodash": "^4.17.15",
     "q": "^1.5.1"
   },
-  "gitHead": "741e90744cdb58e82e71feb36018047d7baca768"
+  "gitHead": "cc567b98facf71315f4b1620d81ce01d155efaca"
 }

package/parser-opts.js

@@ -6,13 +6,13 @@ module.exports = function (config) {
     headerPattern: /^(\w*)(?:\((.*)\))?!?: (.*)$/,
     breakingHeaderPattern: /^(\w*)(?:\((.*)\))?!: (.*)$/,
     headerCorrespondence: [
-      `type`,
-      `scope`,
-      `subject`
+      'type',
+      'scope',
+      'subject'
     ],
-    noteKeywords: [`BREAKING CHANGE`],
+    noteKeywords: ['BREAKING CHANGE'],
     revertPattern: /^(?:Revert|revert:)\s"?([\s\S]+?)"?\s*This reverts commit (\w*)\./i,
-    revertCorrespondence: [`header`, `hash`],
+    revertCorrespondence: ['header', 'hash'],
     issuePrefixes: config.issuePrefixes
   }
 }

package/templates/commit.hbs

@@ -5,11 +5,11 @@
   {{~header}}
 {{~/if}}
 
-{{~!-- commit link --}} {{#if @root.linkReferences~}}
+{{~!-- commit link --}}{{~#if hash}} {{#if @root.linkReferences~}}
   ([{{shortHash}}]({{commitUrlFormat}}))
 {{~else}}
   {{~shortHash}}
-{{~/if}}
+{{~/if}}{{~/if}}
 
 {{~!-- commit references --}}
 {{~#if references~}}

package/writer-opts.js

@@ -1,10 +1,10 @@
 'use strict'
 
 const addBangNotes = require('./add-bang-notes')
-const compareFunc = require(`compare-func`)
-const Q = require(`q`)
-const readFile = Q.denodeify(require(`fs`).readFile)
-const resolve = require(`path`).resolve
+const compareFunc = require('compare-func')
+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.
@@ -34,10 +34,10 @@ module.exports = function (config) {
   })
 
   return Q.all([
-    readFile(resolve(__dirname, `./templates/template.hbs`), `utf-8`),
-    readFile(resolve(__dirname, `./templates/header.hbs`), `utf-8`),
-    readFile(resolve(__dirname, `./templates/commit.hbs`), `utf-8`),
-    readFile(resolve(__dirname, `./templates/footer.hbs`), `utf-8`)
+    readFile(resolve(__dirname, './templates/template.hbs'), 'utf-8'),
+    readFile(resolve(__dirname, './templates/header.hbs'), 'utf-8'),
+    readFile(resolve(__dirname, './templates/commit.hbs'), 'utf-8'),
+    readFile(resolve(__dirname, './templates/footer.hbs'), 'utf-8')
   ])
     .spread((template, header, commit, footer) => {
       const writerOpts = getWriterOpts(config)
@@ -54,18 +54,27 @@ module.exports = function (config) {
     })
 }
 
+function findTypeEntry (types, commit) {
+  const typeKey = (commit.revert ? 'revert' : (commit.type || '')).toLowerCase()
+  return types.find((entry) => {
+    if (entry.type !== typeKey) {
+      return false
+    }
+    if (entry.scope && entry.scope !== commit.scope) {
+      return false
+    }
+    return true
+  })
+}
+
 function getWriterOpts (config) {
   config = defaultConfig(config)
-  const typesLookup = {}
-  config.types.forEach(type => {
-    typesLookup[type.type] = type
-  })
 
   return {
     transform: (commit, context) => {
       let discard = true
       const issues = []
-      const typeKey = (commit.revert ? 'revert' : (commit.type || '')).toLowerCase()
+      const entry = findTypeEntry(config.types, commit)
 
       // adds additional breaking change notes
       // for the special case, test(system)!: hello world, where there is
@@ -73,29 +82,29 @@ function getWriterOpts (config) {
       addBangNotes(commit)
 
       commit.notes.forEach(note => {
-        note.title = `BREAKING CHANGES`
+        note.title = 'BREAKING CHANGES'
         discard = false
       })
 
       // breaking changes attached to any type are still displayed.
-      if (discard && (typesLookup[typeKey] === undefined ||
-          typesLookup[typeKey].hidden)) return
+      if (discard && (entry === undefined ||
+          entry.hidden)) return
 
-      if (typesLookup[typeKey]) commit.type = typesLookup[typeKey].section
+      if (entry) commit.type = entry.section
 
-      if (commit.scope === `*`) {
-        commit.scope = ``
+      if (commit.scope === '*') {
+        commit.scope = ''
       }
 
-      if (typeof commit.hash === `string`) {
+      if (typeof commit.hash === 'string') {
         commit.shortHash = commit.hash.substring(0, 7)
       }
 
-      if (typeof commit.subject === `string`) {
+      if (typeof commit.subject === 'string') {
         // Issue URLs.
         config.issuePrefixes.join('|')
-        let issueRegEx = '(' + config.issuePrefixes.join('|') + ')' + '([0-9]+)'
-        let re = new RegExp(issueRegEx, 'g')
+        const issueRegEx = '(' + config.issuePrefixes.join('|') + ')' + '([0-9]+)'
+        const re = new RegExp(issueRegEx, 'g')
 
         commit.subject = commit.subject.replace(re, (_, prefix, issue) => {
           issues.push(prefix + issue)
@@ -137,7 +146,7 @@ function getWriterOpts (config) {
 
       return commit
     },
-    groupBy: `type`,
+    groupBy: 'type',
     // the groupings of commit messages, e.g., Features vs., Bug Fixes, are
     // sorted based on their probable importance:
     commitGroupsSort: (a, b) => {
@@ -150,8 +159,8 @@ function getWriterOpts (config) {
         return 1
       }
     },
-    commitsSort: [`scope`, `subject`],
-    noteGroupsSort: `title`,
+    commitsSort: ['scope', 'subject'],
+    noteGroupsSort: 'title',
     notesSort: compareFunc
   }
 }
@@ -161,6 +170,7 @@ function defaultConfig (config) {
   config = config || {}
   config.types = config.types || [
     { type: 'feat', section: 'Features' },
+    { type: 'feature', section: 'Features' },
     { type: 'fix', section: 'Bug Fixes' },
     { type: 'perf', section: 'Performance Improvements' },
     { type: 'revert', section: 'Reverts' },