From bb0909898d09c60f44a335acbb5d7a726e10080e Mon Sep 17 00:00:00 2001
From: LeighF <leigh_finegold@hotmail.co.uk>
Date: Mon, 10 Feb 2025 21:10:00 +0000
Subject: [PATCH] Refactoring logging to be at top level (#790)

---
 cli/src/index.ts                                             | 2 +-
 package-lock.json                                            | 2 +-
 shared/src/commands/generate/components/instantiate.spec.ts  | 2 +-
 shared/src/commands/generate/components/instantiate.ts       | 2 +-
 shared/src/commands/generate/components/metadata.spec.ts     | 2 +-
 shared/src/commands/generate/components/metadata.ts          | 2 +-
 shared/src/commands/generate/components/node.spec.ts         | 2 +-
 shared/src/commands/generate/components/node.ts              | 2 +-
 shared/src/commands/generate/components/property.spec.ts     | 2 +-
 shared/src/commands/generate/components/relationship.spec.ts | 2 +-
 shared/src/commands/generate/components/relationship.ts      | 2 +-
 shared/src/commands/generate/generate.e2e.spec.ts            | 2 +-
 shared/src/commands/generate/generate.spec.ts                | 2 +-
 shared/src/commands/generate/generate.ts                     | 2 +-
 shared/src/commands/validate/validate.spec.ts                | 2 +-
 shared/src/commands/validate/validate.ts                     | 2 +-
 shared/src/index.ts                                          | 2 +-
 shared/src/{commands/helper.ts => logger.ts}                 | 0
 shared/src/schema-directory.spec.ts                          | 2 +-
 shared/src/schema-directory.ts                               | 2 +-
 20 files changed, 19 insertions(+), 19 deletions(-)
 rename shared/src/{commands/helper.ts => logger.ts} (100%)

diff --git a/cli/src/index.ts b/cli/src/index.ts
index 35b1b87dd..8b984f3e4 100644
--- a/cli/src/index.ts
+++ b/cli/src/index.ts
@@ -6,7 +6,7 @@ import path from 'path';
 import { mkdirp } from 'mkdirp';
 import { writeFileSync } from 'fs';
 import { version } from '../package.json';
-import { initLogger } from '@finos/calm-shared/commands/helper';
+import { initLogger } from '@finos/calm-shared/logger';
 import { startServer } from './server/cli-server';
 
 const FORMAT_OPTION = '-f, --format <format>';
diff --git a/package-lock.json b/package-lock.json
index 302ad82a8..848dd6f05 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -62,7 +62,7 @@
     },
     "cli": {
       "name": "@finos/calm-cli",
-      "version": "0.4.0",
+      "version": "0.5.0",
       "license": "ISC",
       "dependencies": {
         "commander": "^13.0.0",
diff --git a/shared/src/commands/generate/components/instantiate.spec.ts b/shared/src/commands/generate/components/instantiate.spec.ts
index 466f575b6..ef186b604 100644
--- a/shared/src/commands/generate/components/instantiate.spec.ts
+++ b/shared/src/commands/generate/components/instantiate.spec.ts
@@ -3,7 +3,7 @@
 import { SchemaDirectory } from '../../../schema-directory';
 import { instantiateGenericObject } from './instantiate';
 
-jest.mock('../../helper', () => {
+jest.mock('../../../logger', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/commands/generate/components/instantiate.ts b/shared/src/commands/generate/components/instantiate.ts
index d6b50f528..b295751ba 100644
--- a/shared/src/commands/generate/components/instantiate.ts
+++ b/shared/src/commands/generate/components/instantiate.ts
@@ -1,5 +1,5 @@
 import { Logger } from 'winston';
-import { initLogger } from '../../helper.js';
+import { initLogger } from '../../../logger.js';
 import { SchemaDirectory } from '../../../schema-directory.js';
 import { appendPath, mergeSchemas, renderPath } from '../../../util.js';
 import { getConstValue, getEnumPlaceholder, getPropertyValue } from './property.js';
diff --git a/shared/src/commands/generate/components/metadata.spec.ts b/shared/src/commands/generate/components/metadata.spec.ts
index dd1516557..6609259c2 100644
--- a/shared/src/commands/generate/components/metadata.spec.ts
+++ b/shared/src/commands/generate/components/metadata.spec.ts
@@ -1,7 +1,7 @@
 import { SchemaDirectory } from '../../../schema-directory';
 import { instantiateAllMetadata, instantiateMetadataObject } from './metadata';
 
-jest.mock('../../helper', () => {
+jest.mock('../../../logger', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/commands/generate/components/metadata.ts b/shared/src/commands/generate/components/metadata.ts
index acba61761..879fd50f3 100644
--- a/shared/src/commands/generate/components/metadata.ts
+++ b/shared/src/commands/generate/components/metadata.ts
@@ -1,4 +1,4 @@
-import { initLogger } from '../../helper.js';
+import { initLogger } from '../../../logger.js';
 import { SchemaDirectory } from '../../../schema-directory.js';
 import { appendPath } from '../../../util.js';
 import { instantiateGenericObject } from './instantiate.js';
diff --git a/shared/src/commands/generate/components/node.spec.ts b/shared/src/commands/generate/components/node.spec.ts
index 733de435f..391f3e479 100644
--- a/shared/src/commands/generate/components/node.spec.ts
+++ b/shared/src/commands/generate/components/node.spec.ts
@@ -3,7 +3,7 @@
 import { SchemaDirectory } from '../../../schema-directory';
 import { instantiateNodes } from './node';
 
-jest.mock('../../helper', () => {
+jest.mock('../../../logger', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/commands/generate/components/node.ts b/shared/src/commands/generate/components/node.ts
index e3790bbe2..3c28e2a72 100644
--- a/shared/src/commands/generate/components/node.ts
+++ b/shared/src/commands/generate/components/node.ts
@@ -1,6 +1,6 @@
 /* eslint-disable  @typescript-eslint/no-explicit-any */
 
-import { initLogger } from '../../helper.js';
+import { initLogger } from '../../../logger.js';
 import { SchemaDirectory } from '../../../schema-directory.js';
 import { appendPath } from '../../../util.js';
 import { instantiateGenericObject } from './instantiate.js';
diff --git a/shared/src/commands/generate/components/property.spec.ts b/shared/src/commands/generate/components/property.spec.ts
index 12c01cf0b..ac3ddbae8 100644
--- a/shared/src/commands/generate/components/property.spec.ts
+++ b/shared/src/commands/generate/components/property.spec.ts
@@ -2,7 +2,7 @@
 
 import { getConstValue, getEnumPlaceholder, getPropertyValue } from './property';
 
-jest.mock('../../helper', () => {
+jest.mock('../../../logger', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/commands/generate/components/relationship.spec.ts b/shared/src/commands/generate/components/relationship.spec.ts
index 1f4948db5..3cb130cbc 100644
--- a/shared/src/commands/generate/components/relationship.spec.ts
+++ b/shared/src/commands/generate/components/relationship.spec.ts
@@ -3,7 +3,7 @@
 import { SchemaDirectory } from '../../../schema-directory';
 import { instantiateRelationships } from './relationship';
 
-jest.mock('../../helper', () => {
+jest.mock('../../../logger', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/commands/generate/components/relationship.ts b/shared/src/commands/generate/components/relationship.ts
index d50a8cb66..99cf3fea9 100644
--- a/shared/src/commands/generate/components/relationship.ts
+++ b/shared/src/commands/generate/components/relationship.ts
@@ -1,6 +1,6 @@
 /* eslint-disable  @typescript-eslint/no-explicit-any */
 
-import { initLogger } from '../../helper.js';
+import { initLogger } from '../../../logger.js';
 import { SchemaDirectory } from '../../../schema-directory.js';
 import { appendPath } from '../../../util.js';
 import { instantiateGenericObject } from './instantiate.js';
diff --git a/shared/src/commands/generate/generate.e2e.spec.ts b/shared/src/commands/generate/generate.e2e.spec.ts
index 823191a2f..0dff1c6a4 100644
--- a/shared/src/commands/generate/generate.e2e.spec.ts
+++ b/shared/src/commands/generate/generate.e2e.spec.ts
@@ -7,7 +7,7 @@ jest.mock('../../consts', () => ({
     get CALM_META_SCHEMA_DIRECTORY() { return 'test_fixtures/calm'; }
 }));
 
-jest.mock('../helper', () => {
+jest.mock('../../logger', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/commands/generate/generate.spec.ts b/shared/src/commands/generate/generate.spec.ts
index 393630a31..44cb43a20 100644
--- a/shared/src/commands/generate/generate.spec.ts
+++ b/shared/src/commands/generate/generate.spec.ts
@@ -3,7 +3,7 @@ import { tmpdir } from 'node:os';
 import { existsSync, mkdtempSync, readFileSync, rmSync } from 'node:fs';
 import path from 'node:path';
 
-jest.mock('../helper', () => {
+jest.mock('../../logger', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/commands/generate/generate.ts b/shared/src/commands/generate/generate.ts
index d0119bc48..b1803fb32 100644
--- a/shared/src/commands/generate/generate.ts
+++ b/shared/src/commands/generate/generate.ts
@@ -3,7 +3,7 @@ import * as path from 'node:path';
 import {mkdirp} from 'mkdirp';
 
 import * as winston from 'winston';
-import {initLogger} from '../helper.js';
+import {initLogger} from '../../logger.js';
 import {CALMArchitecture} from '../../types.js';
 import {SchemaDirectory} from '../../schema-directory.js';
 import {instantiateNodes} from './components/node.js';
diff --git a/shared/src/commands/validate/validate.spec.ts b/shared/src/commands/validate/validate.spec.ts
index 27c3cdbab..9eff7f0ec 100644
--- a/shared/src/commands/validate/validate.spec.ts
+++ b/shared/src/commands/validate/validate.spec.ts
@@ -21,7 +21,7 @@ jest.mock('@stoplight/spectral-core', () => {
     };
 });
 
-jest.mock('../helper.js', () => {
+jest.mock('../../logger.js', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/commands/validate/validate.ts b/shared/src/commands/validate/validate.ts
index 9fd08a070..7c753d2df 100644
--- a/shared/src/commands/validate/validate.ts
+++ b/shared/src/commands/validate/validate.ts
@@ -6,7 +6,7 @@ import validationRulesForPattern from '../../spectral/rules-pattern';
 import validationRulesForArchitecture from '../../spectral/rules-architecture';
 import { DiagnosticSeverity } from '@stoplight/types';
 import * as winston from 'winston';
-import { initLogger } from '../helper.js';
+import { initLogger } from '../../logger.js';
 import { ValidationOutput, ValidationOutcome } from './validation.output.js';
 import { SpectralResult } from './spectral.result.js';
 import createJUnitReport from './output-formats/junit-output.js';
diff --git a/shared/src/index.ts b/shared/src/index.ts
index e62d991b4..de055bf3a 100644
--- a/shared/src/index.ts
+++ b/shared/src/index.ts
@@ -8,5 +8,5 @@ export { runGenerate } from './commands/generate/generate.js';
 export { ValidationOutput } from './commands/validate/validation.output.js';
 export { CALM_META_SCHEMA_DIRECTORY } from './consts.js';
 export { SchemaDirectory } from './schema-directory.js';
-export { initLogger } from './commands/helper.js';
+export { initLogger } from './logger.js';
 export * from './types';
\ No newline at end of file
diff --git a/shared/src/commands/helper.ts b/shared/src/logger.ts
similarity index 100%
rename from shared/src/commands/helper.ts
rename to shared/src/logger.ts
diff --git a/shared/src/schema-directory.spec.ts b/shared/src/schema-directory.spec.ts
index f0df41c1a..6c8e2b274 100644
--- a/shared/src/schema-directory.spec.ts
+++ b/shared/src/schema-directory.spec.ts
@@ -1,7 +1,7 @@
 import { SchemaDirectory } from './schema-directory';
 import { readFile } from 'node:fs/promises';
 
-jest.mock('./commands/helper', () => {
+jest.mock('./logger', () => {
     return {
         initLogger: () => {
             return {
diff --git a/shared/src/schema-directory.ts b/shared/src/schema-directory.ts
index f6ab6db7e..ff8a29a76 100644
--- a/shared/src/schema-directory.ts
+++ b/shared/src/schema-directory.ts
@@ -3,7 +3,7 @@ import { join } from 'path';
 import pointer from 'json-pointer';
 import { mergeSchemas, updateStringValuesRecursively } from './util.js';
 import { Logger } from 'winston';
-import { initLogger } from './commands/helper.js';
+import { initLogger } from './logger.js';
 
 /**
  * Stores a directory of schemas and resolves references against that directory.