Replace console.log with structured logging

index.js

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 /* eslint-disable max-len */
+const { logger } = require('./src/logging/index');
+
 const argv = require('yargs/yargs')(process.argv.slice(2))
   .usage('Usage: $0 [options]')
   .options({
@@ -27,7 +29,7 @@ if (argv.v) {
   const configFile = require('./src/config/file').configFile;
 
   if (!fs.existsSync(configFile)) {
-    console.error(
+    logger.error(
       `Config file ${configFile} doesn't exist, nothing to validate! Did you forget -c/--config?`,
     );
     process.exit(1);
@@ -40,7 +42,7 @@ if (argv.v) {
 
   validate(config, schema, { required: true, throwError: true });
 
-  console.log(`${configFile} is valid`);
+  logger.info(`${configFile} is valid`);
   process.exit(0);
 }
 

nyc.config.js

@@ -1,9 +1,10 @@
+const { logger } = require('./src/logging/index');
 const opts = {
   branches: 80,
   lines: 80,
   functions: 80,
   statements: 80,
 };
 
-console.log('nyc config: ', opts);
+logger.info(`nyc config: ${opts}`);
 module.exports = opts;

package.json

@@ -59,6 +59,7 @@
     "react-html-parser": "^2.0.2",
     "react-router-dom": "6.22.3",
     "uuid": "^9.0.0",
+    "winston": "^3.12.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

packages/git-proxy-notify-hello/index.js

@@ -1,9 +1,10 @@
 const Step = require('@finos/git-proxy/src/proxy/actions').Step;
 const plugin = require('@finos/git-proxy/src/plugin');
+const { logger } = require('../../src/logging/index');
 
 const helloPlugin = new plugin.ActionPlugin(async (req, action) => {
   const step = new Step('HelloPlugin');
-  console.log('This is a message from the HelloPlugin!');
+  logger.info('This is a message from the HelloPlugin!');
   action.addStep(step);
   return action;
 });

scripts/doc-schema.js

@@ -3,6 +3,7 @@ const { execFileSync } = require('child_process');
 const { writeFileSync, readFileSync, mkdtempSync } = require('fs');
 const { tmpdir } = require('os');
 const { sep } = require('path');
+const { logger } = require('../src/logging/index');
 const JSFH_CONFIG = './jsfh.config.json';
 const SCHEMA_FILE = './config.schema.json';
 const OUTPUT_PATH = './website/docs/configuration/reference.mdx';
@@ -17,7 +18,7 @@ try {
     SCHEMA_FILE,
     `${tempdir}${sep}schema.md`,
   ]).toString('utf-8');
-  console.log(genDocOutput);
+  logger.info(genDocOutput);
 
   const schemaDoc = readFileSync(`${tempdir}${sep}schema.md`, 'utf-8')
     .replace(/\n\n<\/summary>/g, '</summary>')
@@ -30,7 +31,7 @@ description: JSON schema reference documentation for Git Proxy
 ${schemaDoc}
 `;
   writeFileSync(OUTPUT_PATH, docString);
-  console.log(`Wrote schema reference to ${OUTPUT_PATH}`);
+  logger.info(`Wrote schema reference to ${OUTPUT_PATH}`);
 } catch (err) {
-  console.error(err);
+  logger.error(err);
 }