fix: improve logging

Author: EndBug

lib/index.js

@@ -1,12 +1,20 @@
 require('pretty-error').start()
 
-import { endGroup, getInput, info, setFailed, startGroup } from '@actions/core'
+import * as core from '@actions/core'
 import githubLabelSync, { LabelInfo } from 'github-label-sync'
 import fs from 'fs'
 import path from 'path'
 import yaml from 'yamljs'
 import axios from 'axios'
 
+const { endGroup, getInput, startGroup } = core
+const log = {
+  info: (str: string) => core.info('🛈 ' + str),
+  success: (str: string) => core.info('✓ ' + str),
+  warning: (str: string, showInReport = true) => core[(showInReport ? 'warning' : 'info')]('⚠ ' + str),
+  error: (str: string, showInReport = true) => core[(showInReport ? 'error' : 'info')]('✗ ' + str),
+  fatal: (str: string) => core.setFailed('✗ ' + str)
+}
 let usingLocalFile: boolean
 
 (async () => {
@@ -28,9 +36,9 @@ let usingLocalFile: boolean
     })
 
     startGroup('Label diff')
-    info(JSON.stringify(diff, null, 2))
+    core.info(JSON.stringify(diff, null, 2))
     endGroup()
-  } catch (e) { setFailed(e) }
+  } catch (e) { log.fatal(e) }
 })()
 
 function isProperConfig(value: any): value is LabelInfo[] {
@@ -92,13 +100,13 @@ async function fetchRepoLabels(repo: string, token?: string): Promise<LabelInfo[
 
   const url = `https://api.github.com/repos/${repo}/labels`,
     headers = token ? { Authorization: `token ${token}` } : undefined
-  info(`Using following URL: ${url}`)
+  log.info(`Using following URL: ${url}`)
 
   const { data } = await axios.get(url, { headers })
   if (!data || !(data instanceof Array))
     throw 'Can\'t get label data from GitHub API'
 
-  info(`${data.length} labels fetched.`)
+  log.success(`${data.length} labels fetched.`)
   endGroup()
 
   return data.map(element => ({
@@ -111,24 +119,24 @@ async function fetchRepoLabels(repo: string, token?: string): Promise<LabelInfo[
 
 function checkInputs() {
   if (!getInput('token'))
-    setFailed('The token parameter is required.')
+    throw 'The token parameter is required.'
 
   const configFile = getInput('config-file'),
     sourceRepo = getInput('source-repo')
 
   if (!!configFile == !!sourceRepo)
-    setFailed('You can\'t use a config file and a source repo at the same time. Choose one!')
+    throw 'You can\'t use a config file and a source repo at the same time. Choose one!'
 
   // config-file: doesn't need evaluation, will be evaluated when parsing
   usingLocalFile = !!configFile
 
   if (sourceRepo && sourceRepo.split('/').length != 2)
-    setFailed('Source repo should be in the owner/repo format, like EndBug/label-sync!')
+    throw 'Source repo should be in the owner/repo format, like EndBug/label-sync!'
   if (sourceRepo && !getInput('source-repo-token'))
-    info('You\'re using a source repo without a token: if your repository is private the action won\'t be able to read the labels.')
+    log.warning('You\'re using a source repo without a token: if your repository is private the action won\'t be able to read the labels.', false)
 
   if (!['true', 'false'].includes(getInput('delete-other-labels')))
-    setFailed('The only values you can use for the `delete-other-labels` option are `true` and `false`')
+    throw 'The only values you can use for the `delete-other-labels` option are `true` and `false`'
   if (!['true', 'false'].includes(getInput('dry-run')))
-    setFailed('The only values you can use for the `dry-run` option are `true` and `false`')
+    throw 'The only values you can use for the `dry-run` option are `true` and `false`'
 }