@semantic-release/release-notes-generator 6.0.11 → 7.0.0

package/README.md

@@ -38,7 +38,9 @@ Additional options can be set within the plugin definition in `package.json` to
 | `parserOpts` | Additional [conventional-commits-parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#conventionalcommitsparseroptions) options that will extends ones loaded by `preset` or `config`. See [Parser options](#parser-options). | -         |
 | `writerOpts` | Additional [conventional-commits-writer](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer#options) options that will extends ones loaded by `preset` or `config`. See [Writer options](#writer-options).                        | -         |
 
-**NOTE:** `options.config` will be overwritten by the values of preset. You should use either `preset` or `config`, but not both. Individual properties of `parserOpts` and `writerOpts` will overwrite ones loaded with `preset` or `config`.
+**Note**: `config` will be overwritten by the values of `preset`. You should use either `preset` or `config`, but not both.
+
+**Note**: Individual properties of `parserOpts` and `writerOpts` will override ones loaded with an explicitly set `preset` or `config`. If `preset` or `config` are not set, only the properties set in `parserOpts` and `writerOpts` will be used.
 
 ### Parser Options
 

package/index.js

@@ -3,8 +3,9 @@ const {find} = require('lodash');
 const getStream = require('get-stream');
 const intoStream = require('into-stream');
 const gitUrlParse = require('git-url-parse');
-const conventionalCommitsParser = require('conventional-commits-parser').sync;
-const conventionalChangelogWriter = require('conventional-changelog-writer');
+const parser = require('conventional-commits-parser').sync;
+const writer = require('conventional-changelog-writer');
+const filter = require('conventional-commits-filter');
 const debug = require('debug')('semantic-release:release-notes-generator');
 const loadChangelogConfig = require('./lib/load-changelog-config');
 const HOSTS_CONFIG = require('./lib/hosts-config');
@@ -12,34 +13,42 @@ const HOSTS_CONFIG = require('./lib/hosts-config');
 /**
  * Generate the changelog for all the commits in `options.commits`.
  *
- * @param {Object} [pluginConfig={}] semantic-release configuration.
+ * @param {Object} pluginConfig The plugin configuration.
  * @param {String} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint').
- * @param {String} pluginConfig.config requierable npm package with a custom conventional-changelog preset
- * @param {Object} pluginConfig.parserOpts additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
- * @param {Object} pluginConfig.writerOpts additional `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
- * @param {Object} options semantic-release options.
- * @param {Array<Object>} options.commits array of commits, each containing `hash` and `message`.
- * @param {Object} options.lastRelease last release with `gitHead` corresponding to the commit hash used to make the last release and `gitTag` corresponding to the git tag associated with `gitHead`.
- * @param {Object} options.nextRelease next release with `gitHead` corresponding to the commit hash used to make the  release, the release `version` and `gitTag` corresponding to the git tag associated with `gitHead`.
- * @param {Object} options.options.repositoryUrl git repository URL.
+ * @param {String} pluginConfig.config Requierable npm package with a custom conventional-changelog preset
+ * @param {Object} pluginConfig.parserOpts Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} pluginConfig.writerOpts Additional `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} context The semantic-release context.
+ * @param {Array<Object>} context.commits The commits to analyze.
+ * @param {Object} context.lastRelease The last release with `gitHead` corresponding to the commit hash used to make the last release and `gitTag` corresponding to the git tag associated with `gitHead`.
+ * @param {Object} context.nextRelease The next release with `gitHead` corresponding to the commit hash used to make the  release, the release `version` and `gitTag` corresponding to the git tag associated with `gitHead`.
+ * @param {Object} context.options.repositoryUrl The git repository URL.
  *
- * @returns {String} the changelog for all the commits in `options.commits`.
+ * @returns {String} The changelog for all the commits in `context.commits`.
  */
-async function releaseNotesGenerator(pluginConfig, {commits, lastRelease, nextRelease, options: {repositoryUrl}}) {
-  const {parserOpts, writerOpts} = await loadChangelogConfig(pluginConfig);
+async function releaseNotesGenerator(pluginConfig, context) {
+  const {
+    commits,
+    lastRelease,
+    nextRelease,
+    options: {repositoryUrl},
+  } = context;
+  const {parserOpts, writerOpts} = await loadChangelogConfig(pluginConfig, context);
 
   const {resource: hostname, port, name: repository, owner, protocols} = gitUrlParse(repositoryUrl);
   const protocol = protocols.includes('https') ? 'https' : protocols.includes('http') ? 'http' : 'https';
 
   const {issue, commit, referenceActions, issuePrefixes} =
     find(HOSTS_CONFIG, conf => conf.hostname === hostname) || HOSTS_CONFIG.default;
-  const parsedCommits = commits.map(rawCommit => ({
-    ...rawCommit,
-    ...conventionalCommitsParser(rawCommit.message, {referenceActions, issuePrefixes, ...parserOpts}),
-  }));
+  const parsedCommits = filter(
+    commits.map(rawCommit => ({
+      ...rawCommit,
+      ...parser(rawCommit.message, {referenceActions, issuePrefixes, ...parserOpts}),
+    }))
+  );
   const previousTag = lastRelease.gitTag || lastRelease.gitHead;
   const currentTag = nextRelease.gitTag || nextRelease.gitHead;
-  const context = {
+  const changelogContext = {
     version: nextRelease.version,
     host: url.format({protocol, hostname, port}),
     owner,
@@ -58,7 +67,7 @@ async function releaseNotesGenerator(pluginConfig, {commits, lastRelease, nextRe
   debug('previousTag: %o', previousTag);
   debug('currentTag: %o', currentTag);
 
-  return getStream(intoStream.obj(parsedCommits).pipe(conventionalChangelogWriter(context, writerOpts)));
+  return getStream(intoStream.obj(parsedCommits).pipe(writer(changelogContext, writerOpts)));
 }
 
 module.exports = releaseNotesGenerator;

package/lib/load-changelog-config.js

@@ -1,26 +1,30 @@
 const {promisify} = require('util');
 const importFrom = require('import-from');
-const {mergeWith} = require('lodash');
 const conventionalChangelogAngular = require('conventional-changelog-angular');
 
 /**
  * Load `conventional-changelog-parser` options. Handle presets that return either a `Promise<Array>` or a `Promise<Function>`.
  *
- * @param {Object} preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint')
- * @param {string} config requierable npm package with a custom conventional-changelog preset
- * @param {Object} parserOpts additionnal `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
- * @param {Object} writerOpts additionnal `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} pluginConfig The plugin configuration.
+ * @param {Object} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint')
+ * @param {string} pluginConfig.config Requierable npm package with a custom conventional-changelog preset
+ * @param {Object} pluginConfig.parserOpts Additionnal `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} pluginConfig.writerOpts Additionnal `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
+ * @param {Object} context The semantic-release context.
+ * @param {Array<Object>} context.commits The commits to analyze.
+ * @param {String} context.cwd The current working directory.
+ *
  * @return {Promise<Object>} a `Promise` that resolve to the `conventional-changelog-core` config.
  */
-module.exports = async ({preset, config, parserOpts, writerOpts}) => {
-  let loadedConfig = {};
+module.exports = async ({preset, config, parserOpts, writerOpts}, {cwd}) => {
+  let loadedConfig;
 
   if (preset) {
     const presetPackage = `conventional-changelog-${preset.toLowerCase()}`;
-    loadedConfig = importFrom.silent(__dirname, presetPackage) || importFrom(process.cwd(), presetPackage);
+    loadedConfig = importFrom.silent(__dirname, presetPackage) || importFrom(cwd, presetPackage);
   } else if (config) {
-    loadedConfig = importFrom.silent(__dirname, config) || importFrom(process.cwd(), config);
-  } else if (!parserOpts || !writerOpts) {
+    loadedConfig = importFrom.silent(__dirname, config) || importFrom(cwd, config);
+  } else {
     loadedConfig = conventionalChangelogAngular;
   }
 
@@ -30,12 +34,8 @@ module.exports = async ({preset, config, parserOpts, writerOpts}) => {
     loadedConfig = await loadedConfig;
   }
 
-  return mergeWith(
-    {},
-    !preset && !config && parserOpts ? {parserOpts} : {parserOpts: loadedConfig.parserOpts},
-    {parserOpts},
-    !preset && !config && writerOpts ? {writerOpts} : {writerOpts: loadedConfig.writerOpts},
-    {writerOpts},
-    (value, source) => (Array.isArray(value) ? source : undefined)
-  );
+  return {
+    parserOpts: !preset && !config && parserOpts ? parserOpts : {...loadedConfig.parserOpts, ...parserOpts},
+    writerOpts: !preset && !config && writerOpts ? writerOpts : {...loadedConfig.writerOpts, ...writerOpts},
+  };
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@semantic-release/release-notes-generator",
   "description": "Customizable release-notes-generator plugin for semantic-release",
-  "version": "6.0.11",
+  "version": "7.0.0",
   "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
   "bugs": {
     "url": "https://github.com/semantic-release/release-notes-generator/issues"
@@ -16,12 +16,13 @@
     "Gregor Martynus (https://twitter.com/gr2m)"
   ],
   "dependencies": {
-    "conventional-changelog-angular": "^4.0.0",
+    "conventional-changelog-angular": "^5.0.0",
     "conventional-changelog-writer": "^4.0.0",
+    "conventional-commits-filter": "^2.0.0",
     "conventional-commits-parser": "^3.0.0",
     "debug": "^3.1.0",
     "get-stream": "^3.0.0",
-    "git-url-parse": "^9.0.0",
+    "git-url-parse": "^10.0.1",
     "import-from": "^2.1.0",
     "into-stream": "^3.1.0",
     "lodash": "^4.17.4"
@@ -30,14 +31,14 @@
     "ava": "^0.25.0",
     "codecov": "^3.0.0",
     "commitizen": "^2.9.6",
-    "conventional-changelog-atom": "^1.0.0",
-    "conventional-changelog-ember": "^1.0.0",
-    "conventional-changelog-eslint": "^2.0.0",
-    "conventional-changelog-express": "^1.0.0",
-    "conventional-changelog-jshint": "^1.0.0",
+    "conventional-changelog-atom": "^2.0.0",
+    "conventional-changelog-ember": "^2.0.0",
+    "conventional-changelog-eslint": "^3.0.0",
+    "conventional-changelog-express": "^2.0.0",
+    "conventional-changelog-jshint": "^2.0.0",
     "cz-conventional-changelog": "^2.0.0",
     "escape-string-regexp": "^1.0.5",
-    "nyc": "^11.1.0",
+    "nyc": "^12.0.1",
     "semantic-release": "^15.0.0",
     "xo": "^0.21.0"
   },
@@ -73,6 +74,9 @@
     ],
     "all": true
   },
+  "peerDependencies": {
+    "semantic-release": ">=15.8.0 <16.0.0"
+  },
   "prettier": {
     "printWidth": 120,
     "trailingComma": "es5"