fix: use helpUrl from config when present

wagoid · wagoid · commit 6f0b49bb7b70 · 2021-10-11T15:46:36.000-03:00
Fixes #234
diff --git a/fixtures/custom-help-url/commitlint.config.js b/fixtures/custom-help-url/commitlint.config.js
@@ -0,0 +1,4 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  helpUrl: 'https://example.org',
+}
diff --git a/src/action.js b/src/action.js
@@ -91,12 +91,12 @@ function getOptsFromConfig(config) {
   }
 }
 
-const formatErrors = (lintedCommits) =>
+const formatErrors = (lintedCommits, { config }) =>
   format(
     { results: lintedCommits.map((commit) => commit.lintResult) },
     {
       color: true,
-      helpUrl: getInput('helpURL'),
+      helpUrl: config.helpUrl || getInput('helpURL'),
     },
   )
 
@@ -129,7 +129,7 @@ const showLintResults = async ([from, to]) => {
       hash: commit.hash,
     })),
   )
-  const formattedResults = formatErrors(lintedCommits)
+  const formattedResults = formatErrors(lintedCommits, { config })
 
   generateOutputs(lintedCommits)
 
diff --git a/src/action.test.js b/src/action.test.js
@@ -76,6 +76,13 @@ describe('Commit Linter action', () => {
     await runAction()
 
     td.verify(core.setFailed(contains('You have commit messages with errors')))
+    td.verify(
+      core.setFailed(
+        contains(
+          'https://github.com/conventional-changelog/commitlint/#what-is-commitlint',
+        ),
+      ),
+    )
   })
 
   it('should fail for single push with incorrect message', async () => {
@@ -577,4 +584,25 @@ describe('Commit Linter action', () => {
       td.verify(console.log('Lint free! 🎉'))
     })
   })
+
+  describe('when a different helpUrl is provided in the config', () => {
+    beforeEach(async () => {
+      cwd = await git.bootstrap('fixtures/custom-help-url')
+      await gitEmptyCommit(cwd, 'wrong message')
+      const [to] = await getCommitHashes(cwd)
+      await createPushEventPayload(cwd, { to })
+      updatePushEnvVars(cwd, to)
+      td.replace(process, 'cwd', () => cwd)
+      td.replace(console, 'log')
+    })
+
+    it('should show custom URL from helpUrl', async () => {
+      await runAction()
+
+      td.verify(
+        core.setFailed(contains('You have commit messages with errors')),
+      )
+      td.verify(core.setFailed(contains(' https://example.org')))
+    })
+  })
 })

Original file line number	Diff line number	Diff line change
`@@ -91,12 +91,12 @@ function getOptsFromConfig(config) {`
`91`	`91`	`}`
`92`	`92`	`}`
`93`	`93`
`94`		`-const formatErrors = (lintedCommits) =>`
	`94`	`+const formatErrors = (lintedCommits, { config }) =>`
`95`	`95`	`format(`
`96`	`96`	`{ results: lintedCommits.map((commit) => commit.lintResult) },`
`97`	`97`	`{`
`98`	`98`	`color: true,`
`99`		`- helpUrl: getInput('helpURL'),`
	`99`	`+ helpUrl: config.helpUrl \|\| getInput('helpURL'),`
`100`	`100`	`},`
`101`	`101`	`)`
`102`	`102`
`@@ -129,7 +129,7 @@ const showLintResults = async ([from, to]) => {`
`129`	`129`	`hash: commit.hash,`
`130`	`130`	`})),`
`131`	`131`	`)`
`132`		`- const formattedResults = formatErrors(lintedCommits)`
	`132`	`+ const formattedResults = formatErrors(lintedCommits, { config })`
`133`	`133`
`134`	`134`	`generateOutputs(lintedCommits)`
`135`	`135`