migrate to pino

Author: bjohansebas

index.js

@@ -20,7 +20,7 @@ project
     try {
       await runAddProjectCommand(knex, options)
     } catch (error) {
-      logger.error('Error adding project:', error.message)
+      logger.error(error)
       process.exit(1)
     } finally {
       await knex.destroy()
@@ -38,7 +38,7 @@ workflow
     try {
       await runWorkflowCommand(knex, options)
     } catch (error) {
-      logger.error('Error running workflow:', error.message)
+      logger.error(error)
       process.exit(1)
     } finally {
       await knex.destroy()
@@ -62,7 +62,7 @@ check
     try {
       await listCheckCommand(knex, options)
     } catch (error) {
-      logger.error('Error running check:', error.message)
+      logger.error(error)
       process.exit(1)
     } finally {
       await knex.destroy()
@@ -77,7 +77,7 @@ check
     try {
       await runCheckCommand(knex, options)
     } catch (error) {
-      logger.error('Error running check:', error.message)
+      logger.error(error)
       process.exit(1)
     } finally {
       await knex.destroy()

package.json

@@ -39,6 +39,8 @@
     "knex": "3.1.0",
     "octokit": "3.2.1",
     "pg": "8.13.1",
+    "pino": "^9.5.0",
+    "pino-pretty": "^13.0.0",
     "validator": "13.12.0"
   },
   "devDependencies": {

src/cli/workflows.js

@@ -24,8 +24,8 @@ const commandList = [{
 const validCommandNames = commandList.map(({ name }) => name)
 
 function listWorkflowCommand (options = {}) {
-  logger.log('Available workflows:')
-  logger.log(commandList.map(({ name, description }) => `- ${name}: ${description}`).join('\n'))
+  logger.log('Available workflows: \n')
+  commandList.forEach(({ name, description }) => logger.log(`- ${name}: ${description}`))
   return commandList
 }
 

src/providers/index.js

@@ -65,7 +65,7 @@ const performScorecardAnalysis = async (repo) => {
   const start = new Date().getTime()
   const { stdout, stderr } = await exec(`docker run -e GITHUB_AUTH_TOKEN=${process.env.GITHUB_TOKEN} --rm ${ossfScorecardSettings.dockerImage} --repo=${repo.html_url} --show-details --format=json`)
   if (stderr) {
-    console.error(stderr)
+    logger.error(stderr)
     throw new Error(`Error running OSSF Scorecard for repository (${repo.full_name})`)
   }
   const data = JSON.parse(stdout)

src/utils/index.js

@@ -1,5 +1,11 @@
 const { add, parseISO, isBefore } = require('date-fns')
 const isURL = require('validator/lib/isURL.js')
+const pino = require('pino')({
+  transport: {
+    target: 'pino-pretty'
+  },
+  level: process.env.PINO_LOG_LEVEL || 'trace'
+})
 
 const validateGithubUrl = (url) => isURL(url, { protocols: ['https'], require_protocol: true }) && url.includes('github.com')
 
@@ -13,14 +19,15 @@ const defineLog = (type) => function () {
   if (process.env.NODE_ENV === 'test') {
     return () => {}
   }
-  return console[type](...arguments)
+
+  return pino[type](...arguments)
 }
 
 const logger = {
   info: defineLog('info'),
   error: defineLog('error'),
   warn: defineLog('warn'),
-  log: defineLog('log')
+  log: defineLog('trace')
 }
 
 const getSeverityFromPriorityGroup = (priorityGroup) => {