Merge pull request #1082 from LeighFinegold/esm_integration_docify_endpoint

Remediate issue with calm docify on 0.6.0 release

Author: Thels

cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finos/calm-cli",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "A set of tools for interacting with the Common Architecture Language Model (CALM)",
   "main": "dist/index.js",
   "files": [
@@ -13,7 +13,7 @@
     "build": "tsup && npm run copy-calm-schema && npm run copy-docify-templates",
     "watch": "node watch.mjs",
     "copy-calm-schema": "copyfiles \"../calm/draft/2024-10/meta/*\" dist/calm/",
-    "copy-docify-templates": "copyfiles \"../shared/src/docify/template-bundles/**/*\" dist --up 4",
+    "copy-docify-templates": "copyfiles \"../shared/dist/template-bundles/**/*\" dist --up 3",
     "test": "vitest run",
     "lint": "eslint src",
     "lint-fix": "eslint src --fix",

cli/src/cli.e2e.spec.ts

@@ -5,7 +5,7 @@ import * as os from 'os';
 import { parseStringPromise } from 'xml2js';
 import util from 'util';
 import axios from 'axios';
-
+import { Mock } from 'vitest';
 // Mock axios
 vi.mock('axios');
 
@@ -189,7 +189,7 @@ describe('CLI Integration Tests', () => {
 
 
     test('server command starts and responds to /health', async () => {
-        (axios.get as vi.Mock).mockResolvedValue({ status: 200, data: { status: 'ok' } });
+        (axios.get as Mock).mockResolvedValue({ status: 200, data: { status: 'ok' } });
         const serverCmd = calm('server -p 3002 --schemaDirectory ../../dist/calm/');
         const serverProcess = exec(serverCmd);
 
@@ -222,8 +222,7 @@ describe('CLI Integration Tests', () => {
         expect(actualContent).toEqual(expectedContent);
     });
 
-    //TODO: This simulates Issue 2 of https://github.com/finos/architecture-as-code/issues/1043. Remove skip once fixed.
-    test.skip('docify command generates expected files', async () => {
+    test('docify command generates expected files', async () => {
         const fixtureDir = path.resolve(__dirname, '../test_fixtures/template');
         const testModelPath = path.join(fixtureDir, 'model/document-system.json');
         const localDirectory = path.join(fixtureDir, 'model/url-to-file-directory.json');

cli/src/command-helpers/validate.spec.ts

@@ -1,20 +1,18 @@
 import { getFormattedOutput, validate, exitBasedOffOfValidationOutcome } from '@finos/calm-shared';
-import { initLogger } from '@finos/calm-shared/logger';
+import { initLogger } from '@finos/calm-shared';
 import { mkdirp } from 'mkdirp';
 import { writeFileSync } from 'fs';
 import path from 'path';
 import {runValidate, writeOutputFile, checkValidateOptions} from './validate';
 import { Command } from 'commander';
+import { Mock } from 'vitest';
 
 vi.mock('@finos/calm-shared', async () => ({
     ...vi.importActual('@finos/calm-shared'),
     validate: vi.fn(),
     getFormattedOutput: vi.fn(),
     exitBasedOffOfValidationOutcome: vi.fn(),
-}));
-
-vi.mock('@finos/calm-shared/logger', () => ({
-    initLogger: vi.fn(),
+    initLogger: vi.fn()
 }));
 
 vi.mock('mkdirp', () => ({
@@ -43,8 +41,8 @@ describe('runValidate', () => {
         };
 
         const fakeOutcome = { valid: true };
-        (validate as vi.Mock).mockResolvedValue(fakeOutcome);
-        (getFormattedOutput as vi.Mock).mockReturnValue('formatted output');
+        (validate as Mock).mockResolvedValue(fakeOutcome);
+        (getFormattedOutput as Mock).mockReturnValue('formatted output');
 
         await runValidate(options);
 
@@ -69,9 +67,9 @@ describe('runValidate', () => {
         };
 
         const error = new Error('Validation failed');
-        (validate as vi.Mock).mockRejectedValue(error);
+        (validate as Mock).mockRejectedValue(error);
         const loggerMock = { error: vi.fn(), debug: vi.fn() };
-        (initLogger as vi.Mock).mockReturnValue(loggerMock);
+        (initLogger as Mock).mockReturnValue(loggerMock);
         const exitSpy = vi.spyOn(process, 'exit').mockImplementation((code?: number) => {
             throw new Error(`process.exit called with ${code}`);
         });

cli/src/command-helpers/validate.ts

@@ -1,6 +1,6 @@
 
 import { getFormattedOutput, validate, exitBasedOffOfValidationOutcome } from '@finos/calm-shared';
-import { initLogger } from '@finos/calm-shared/logger';
+import { initLogger } from '@finos/calm-shared';
 import path from 'path';
 import { mkdirp } from 'mkdirp';
 import { writeFileSync } from 'fs';

cli/src/index.ts

@@ -1,4 +1,3 @@
-#! /usr/bin/env node
 import { program } from 'commander';
 import { setupCLI } from './cli';
 

cli/src/server/routes/validation-route.ts

@@ -5,7 +5,7 @@ import path from 'path';
 import os from 'os';
 import { v4 as uuidv4 } from 'uuid';
 import winston from 'winston';
-import { ValidationOutcome } from '@finos/calm-shared/commands/validate/validation.output';
+import { ValidationOutcome } from '@finos/calm-shared';
 import rateLimit from 'express-rate-limit';
 
 export class ValidationRouter {

cli/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["**/*.spec.ts"]
+}

cli/tsconfig.json

@@ -1,32 +1,13 @@
 {
-  "extends": "../tsconfig.json",
+  "extends": "../tsconfig.base.json",
+  "module": "Preserve",
+  "moduleResolution": "bundler",
   "compilerOptions": {
-    "outDir": "./dist",
-    "module": "CommonJS",
-    "target": "ES6",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "sourceMap": true,
-    "moduleResolution": "node",
-    "types": [
-      "node",
-      "jest",
-      "../vitest/globals"
-    ],
-    "typeRoots": [
-      "node_modules/@types",
-      "../node_modules/@types"
-    ]
+    "outDir": "dist",
   },
-  "references": [
-    {
-      "path": "../shared"
-    }
-  ],
-  "include": [
-    "src/**/*",
-    "package.json"
+  "include": ["src", "../vitest-globals.d.ts"],
+  "lib": [
+    "esnext"
   ]
-}
+
+}

cli/tsup.config.ts

@@ -15,4 +15,11 @@ export default defineConfig({
     shims: true,
     target: 'es2021',
     treeshake: true,
+    banner: ({ format }) => {
+        if (format === 'cjs') {
+            return {
+                js: '#! /usr/bin/env node'
+            };
+        }
+    }
 });

cli/vitest.config.ts

@@ -1,5 +1,4 @@
 import {defineConfig} from 'vitest/config';
-import path from 'path';
 import {CoverageV8Options} from "vitest/node";
 
 const v8CoverageSettings: CoverageV8Options = {
@@ -14,13 +13,9 @@ const v8CoverageSettings: CoverageV8Options = {
 }
 
 export default defineConfig({
-    resolve: {
-        alias: {
-            '@finos/calm-shared': path.resolve(__dirname, '../shared/src'),
-        }
-    },
     test: {
         globals: true,
+        environment: 'node',
         coverage: {
             provider: 'v8',
             ...v8CoverageSettings,