refactor: Cleanup in generateChangelog

src/helpers/generateChangelog.js

@@ -1,17 +1,39 @@
 const fs = require('fs')
 const conventionalChangelog = require('conventional-changelog')
 
-module.exports.generateStringChangelog = (tagPrefix, preset, jsonPackage, releaseCount) => new Promise((resolve, reject) => {
+/**
-  const changelogStream = conventionalChangelog({
+ * Generates a changelog stream with the given arguments
-      preset,
+ *
-      releaseCount: parseInt(releaseCount, 10),
+ * @param tagPrefix
-      tagPrefix,
+ * @param preset
-    },
+ * @param version
-    {
+ * @param releaseCount
-      version: jsonPackage.version,
+ * @returns {*}
-      currentTag: `${tagPrefix}${jsonPackage.version}`,
+ */
-    },
+const getChangelogStream = (tagPrefix, preset, version, releaseCount) => conventionalChangelog({
-  )
+    preset,
+    releaseCount: parseInt(releaseCount, 10),
+    tagPrefix,
+  },
+  {
+    version,
+    currentTag: `${tagPrefix}${version}`,
+  },
+)
+
+module.exports = getChangelogStream
+
+/**
+ * Generates a string changelog
+ *
+ * @param tagPrefix
+ * @param preset
+ * @param version
+ * @param releaseCount
+ * @returns {Promise<string>}
+ */
+module.exports.generateStringChangelog = (tagPrefix, preset, version, releaseCount) => new Promise((resolve, reject) => {
+  const changelogStream = getChangelogStream(tagPrefix, preset, version, releaseCount)
 
   let changelog = ''
 
@@ -22,17 +44,18 @@ module.exports.generateStringChangelog = (tagPrefix, preset, jsonPackage, releas
     .on('end', () => resolve(changelog))
 })
 
-module.exports.generateFileChangelog = (tagPrefix, preset, jsonPackage, fileName, releaseCount) => new Promise((resolve) => {
+/**
-  const changelogStream = conventionalChangelog({
+ * Generates a file changelog
-      preset,
+ *
-      releaseCount: parseInt(releaseCount, 10),
+ * @param tagPrefix
-      tagPrefix,
+ * @param preset
-    },
+ * @param version
-    {
+ * @param fileName
-      version: jsonPackage.version,
+ * @param releaseCount
-      currentTag: `${tagPrefix}${jsonPackage.version}`,
+ * @returns {Promise<>}
-    },
+ */
-  )
+module.exports.generateFileChangelog = (tagPrefix, preset, version, fileName, releaseCount) => new Promise((resolve) => {
+  const changelogStream = getChangelogStream(tagPrefix, preset, version, releaseCount)
 
   changelogStream
     .pipe(fs.createWriteStream(fileName))