🥅 Handle functional errors

Author: frinyvonnick

packages/gitmoji-changelog-cli/src/cli.e2e.js

@@ -18,11 +18,11 @@ expect.extend({
 })
 
 expect.extend({
-  toDisplayError(str) {
-    const pass = str.includes('Error')
+  toDisplayError(str, message = '') {
+    const pass = str.includes('Error') && str.includes(message)
     return {
       pass,
-      message: () => pass ? 'It passes' : `Expected ${str} to includes Error`,
+      message: () => pass ? 'It passes' : `Expected ${str} to includes Error and "${message}"`,
     }
   },
 })
@@ -336,7 +336,7 @@ describe('generate changelog', () => {
       const output = gitmojiChangelog()
 
       expect(getChangelog()).includes(['1.0.0'])
-      expect(output.toString('utf8')).toDisplayError()
+      expect(output.toString('utf8')).toDisplayError('No changes found.')
     })
 
     it('should get two versions 1.0.0 and next after two generation while updating changelog by calling cli without arguments', async () => {

packages/gitmoji-changelog-cli/src/cli.js

@@ -100,26 +100,30 @@ async function main(options = {}) {
     }
     logger.success(`changelog updated into ${options.output}`)
   } catch (e) {
-    const repository = await getRepositoryInfo()
-    await issueReporter({
-      error: e,
-      user: 'frinyvonnick',
-      repo: 'gitmoji-changelog',
-      sections: [
-        {
-          title: 'CLI options',
-          content: options,
-        },
-        {
-          title: 'Project info',
-          content: projectInfo,
-        },
-        {
-          title: 'Repository info',
-          content: repository,
-        },
-      ],
-    })
+    if (e.name !== 'FunctionalError') {
+      const repository = await getRepositoryInfo()
+      await issueReporter({
+        error: e,
+        user: 'frinyvonnick',
+        repo: 'gitmoji-changelog',
+        sections: [
+          {
+            title: 'CLI options',
+            content: options,
+          },
+          {
+            title: 'Project info',
+            content: projectInfo,
+          },
+          {
+            title: 'Repository info',
+            content: repository,
+          },
+        ],
+      })
+    } else {
+      logger.error(e)
+    }
   }
 
   // force quit (if the latest version request is pending, we don't wait for it)

packages/gitmoji-changelog-core/src/errors.js

@@ -0,0 +1,10 @@
+class FunctionalError extends Error {
+  constructor(message) {
+    super(message)
+    this.name = 'FunctionalError'
+  }
+}
+
+module.exports = {
+  FunctionalError,
+}

packages/gitmoji-changelog-core/src/index.js

@@ -6,6 +6,7 @@ const { isEmpty } = require('lodash')
 const { parseCommit, getMergedGroupMapping } = require('./parser')
 const logger = require('./logger')
 const { groupSentencesByDistance } = require('./utils')
+const { FunctionalError } = require('./errors')
 const fromGitFileClient = require('./fromGitFile')
 
 const HEAD = ''
@@ -31,10 +32,17 @@ function makeGroups(commits) {
 }
 
 function sanitizeVersion(version) {
-  return semver.valid(version, {
-    loose: false,
-    includePrerelease: true,
-  })
+  try {
+    return semver.valid(version, {
+      loose: false,
+      includePrerelease: true,
+    })
+  } catch (e) {
+    if (e.name === 'TypeError') {
+      throw FunctionalError(e.message)
+    }
+    return null
+  }
 }
 
 function filterCommits(commits) {
@@ -84,7 +92,14 @@ function sortVersions(c1, c2) {
 
 function hasNextVersion(tags, release) {
   if (!release || release === 'next') return true
-  return tags.some(tag => semver.eq(tag, release))
+  try {
+    return tags.some(tag => semver.eq(tag, release))
+  } catch (e) {
+    if (e.name === 'TypeError') {
+      throw FunctionalError(e.message)
+    }
+    return null
+  }
 }
 
 async function generateVersions({
@@ -120,11 +135,17 @@ async function generateChangelog(from, to, {
   if (from === TAIL) {
     tagsToProcess = [...tagsToProcess, TAIL]
   } else {
-    const fromIndex = tagsToProcess.findIndex(tag => semver.eq(tag, from))
-    tagsToProcess.splice(fromIndex + 1)
+    try {
+      const fromIndex = tagsToProcess.findIndex(tag => semver.eq(tag, from))
+      tagsToProcess.splice(fromIndex + 1)
 
-    if (hasNext && isEmpty(tagsToProcess)) {
-      tagsToProcess.push(HEAD)
+      if (hasNext && isEmpty(tagsToProcess)) {
+        tagsToProcess.push(HEAD)
+      }
+    } catch (e) {
+      if (e.name === 'TypeError') {
+        throw FunctionalError(e.message)
+      }
     }
   }
 
@@ -137,7 +158,7 @@ async function generateChangelog(from, to, {
   })
 
   if (from !== TAIL && changes.length === 1 && isEmpty(changes[0].groups)) {
-    throw new Error('No changes found. You may need to fetch or pull the last changes.')
+    throw new FunctionalError('No changes found. You may need to fetch or pull the last changes.')
   }
 
   return {