Merge pull request #2186 from rocketstack-matt/feat/enable-strict-mode-calm-models-cli

feat: enable TypeScript strict mode for calm-models and cli

Author: markscott-ms

calm-models/src/canonical/template-models.ts

@@ -59,7 +59,7 @@ export type CalmFlowCanonicalModel = {
     name: string;
     description: string;
     transitions: CalmFlowTransitionCanonicalModel[];
-    'requirement-url': string;
+    'requirement-url'?: string;
     controls?: CalmControlsCanonicalModel;
     metadata?: CalmMetadataCanonicalModel;
 };

calm-models/src/model/moment.ts

@@ -51,7 +51,7 @@ export class CalmMoment extends CalmNode implements CalmAdaptable<CalmMomentSche
             name,
             description,
             validFrom,
-            CalmNodeDetails.fromSchema(details),
+            details ? CalmNodeDetails.fromSchema(details) : undefined,
             controls ? CalmControls.fromSchema(controls) : undefined,
             metadata ? CalmMetadata.fromSchema(metadata) : undefined,
             adrs,

calm-models/tsconfig.build.json

@@ -1,6 +1,7 @@
 {
   "extends": "../tsconfig.base.json",
   "compilerOptions": {
+    "strict": true,
     "outDir": "./dist",
     "rootDir": "./src",
     "declaration": true,
@@ -17,4 +18,3 @@
     "**/*.test.ts"
   ]
 }
-

cli/src/cli-config.ts

@@ -23,11 +23,11 @@ export async function loadCliConfig(): Promise<CLIConfig | null> {
         return parsed;
     }
     catch (err) {
-        if (err.code === 'ENOENT') {
+        if (err && typeof err === 'object' && 'code' in err && err.code === 'ENOENT') {
             logger.debug('No config file found at ' + configFilePath);
             return null;
         }
-        logger.error('Unexpected error loading user config: ', err);
+        logger.error('Unexpected error loading user config: ' + String(err));
         return null;
     }
 }

cli/src/cli.e2e.spec.ts

@@ -395,8 +395,8 @@ describe('CLI Integration Tests', () => {
             try {
                 await run(calm(), ['validate', '-p', patternPath, '-a', archPath]);
                 expect.fail('Expected validation to fail');
-            } catch (error) {
-                const result = JSON.parse(error.stdout);
+            } catch (error: unknown) {
+                const result = JSON.parse((error as { stdout: string }).stdout);
                 expect(result.hasErrors).toBe(true);
                 expect(JSON.stringify(result)).toContain('owner');
             }
@@ -410,8 +410,8 @@ describe('CLI Integration Tests', () => {
             try {
                 await run(calm(), ['validate', '-p', patternPath, '-a', archPath, '-u', mappingPath]);
                 expect.fail('Expected validation to fail');
-            } catch (error) {
-                const result = JSON.parse(error.stdout);
+            } catch (error: unknown) {
+                const result = JSON.parse((error as { stdout: string }).stdout);
                 expect(result.hasErrors).toBe(true);
                 expect(JSON.stringify(result)).toContain('owner');
             }
@@ -452,7 +452,7 @@ describe('CLI Integration Tests', () => {
             expect(res.status).toBe(200);
             expect(res.data.status).toBe('OK');
         } finally {
-            process.kill(-serverProcess.pid);
+            if (serverProcess.pid) process.kill(-serverProcess.pid);
         }
     });
 
@@ -486,7 +486,7 @@ describe('CLI Integration Tests', () => {
             expect(JSON.stringify(res.data)).toContain('hasErrors');
             expect(JSON.stringify(res.data)).toContain('hasWarnings');
         } finally {
-            process.kill(-serverProcess.pid);
+            if (serverProcess.pid) process.kill(-serverProcess.pid);
         }
     });
 
@@ -834,18 +834,18 @@ describe('CLI Integration Tests', () => {
         fs.writeFileSync(filePath, JSON.stringify(obj, null, 2));
     }
 
-    function readJson(filePath: string) {
+    function readJson(filePath: string): Record<string, unknown> {
         return JSON.parse(fs.readFileSync(filePath, 'utf8'));
     }
 
-    function patchJson(filePath: string, patchFn: (o: object) => void) {
+    function patchJson(filePath: string, patchFn: (o: Record<string, unknown>) => void) {
         const obj = readJson(filePath);
         patchFn(obj);
         writeJson(filePath, obj);
     }
 
     // Utility to recursively remove specific line/character fields from JSON
-    function removeLineNumbers(obj: object) {
+    function removeLineNumbers(obj: unknown): void {
         const fieldsToRemove = [
             'line_start',
             'line_end',
@@ -854,12 +854,13 @@ describe('CLI Integration Tests', () => {
         ];
         if (Array.isArray(obj)) {
             obj.forEach(removeLineNumbers);
-        } else if (obj && typeof obj === 'object') {
-            for (const key of Object.keys(obj)) {
+        } else if (obj !== null && typeof obj === 'object') {
+            const record = obj as Record<string, unknown>;
+            for (const key of Object.keys(record)) {
                 if (fieldsToRemove.includes(key)) {
-                    delete obj[key];
+                    delete record[key];
                 } else {
-                    removeLineNumbers(obj[key]);
+                    removeLineNumbers(record[key]);
                 }
             }
         }

cli/src/cli.ts

@@ -6,7 +6,7 @@ import { CalmChoice } from '@finos/calm-shared/dist/commands/generate/components
 import { buildDocumentLoader, DocumentLoader, DocumentLoaderOptions } from '@finos/calm-shared/dist/document-loader/document-loader';
 import { loadCliConfig } from './cli-config';
 import path from 'path';
-import inquirer from 'inquirer';
+import { select } from '@inquirer/prompts';
 
 // Shared options used across multiple commands
 const ARCHITECTURE_OPTION = '-a, --architecture <file>';
@@ -242,13 +242,10 @@ Validation requires:
             const providers = AI_PROVIDER_CHOICES;
             let selectedProvider: string = options.provider;
             if (!selectedProvider) {
-                const answer = await inquirer.prompt({
-                    type: 'list',
-                    name: 'provider',
+                selectedProvider = await select({
                     message: 'Select an AI provider:',
-                    choices: providers.map((p) => ({ name: p, value: p })),
+                    choices: providers.map((p: string) => ({ name: p, value: p })),
                 });
-                selectedProvider = answer.provider;
             }
             console.log(`Selected AI provider: ${selectedProvider}`);
 
@@ -268,7 +265,7 @@ export async function parseDocumentLoaderConfig(
     urlToLocalMap?: Map<string, string>,
     basePath?: string
 ): Promise<DocumentLoaderOptions> {
-    const logger = initLogger(options.verbose, 'calm-cli');
+    const logger = initLogger(options.verbose ?? false, 'calm-cli');
     const docLoaderOpts: DocumentLoaderOptions = {
         calmHubUrl: options.calmHubUrl,
         schemaDirectoryPath: options.schemaDirectory,

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

@@ -40,7 +40,7 @@ describe('getUrlToLocalFileMap', () => {
         });
         const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
 
-        const processExitSpy = vi.spyOn(process, 'exit').mockImplementation((code?: number) => {
+        const processExitSpy = vi.spyOn(process, 'exit').mockImplementation((code?: string | number | null) => {
             throw new Error(`process.exit: ${code}`);
         });
 

cli/src/command-helpers/validate.ts

@@ -34,9 +34,9 @@ export async function runValidate(options: ValidateOptions) {
         const schemaDirectory = await buildSchemaDirectory(docLoader, options.verbose);
         await schemaDirectory.loadSchemas();
 
-        let architecture: object;
-        let pattern: object;
-        let timeline: object;
+        let architecture: object | undefined;
+        let pattern: object | undefined;
+        let timeline: object | undefined;
 
         if (options.timelinePath) {
             const result = await loadTimeline(
@@ -50,8 +50,8 @@ export async function runValidate(options: ValidateOptions) {
         }
         else {
             const result = await loadArchitectureAndPattern(
-                options.architecturePath,
-                options.patternPath,
+                options.architecturePath ?? '',
+                options.patternPath ?? '',
                 docLoader,
                 schemaDirectory,
                 logger
@@ -60,15 +60,20 @@ export async function runValidate(options: ValidateOptions) {
             pattern = result.pattern;
         }
         const documentContexts = buildDocumentContexts(options, logger);
+        if (!architecture && !pattern && !timeline) {
+            throw new Error('You must provide an architecture, a pattern, or a timeline');
+        }
         const outcome = await validate(architecture, pattern, timeline, schemaDirectory, options.verbose);
         enrichWithDocumentPositions(outcome, documentContexts);
         const content = getFormattedOutput(outcome, options.outputFormat, toFormattingOptions(documentContexts));
         writeOutputFile(options.outputPath, content);
         exitBasedOffOfValidationOutcome(outcome, options.strict);
     }
     catch (err) {
-        logger.error('An error occurred while validating: ' + err.message);
-        logger.debug(err.stack);
+        const message = err instanceof Error ? err.message : String(err);
+        const stack = err instanceof Error ? err.stack : undefined;
+        logger.error('An error occurred while validating: ' + message);
+        if (stack) logger.debug(stack);
         process.exit(1);
     }
 }

cli/src/server/routes/routes.spec.ts

@@ -31,7 +31,7 @@ vi.mock('@finos/calm-shared', () =>{
     };
 });
 describe('CLIServerRoutes', () => {
-    let schemaDirectory: SchemaDirectory;
+    const schemaDirectory = {} as SchemaDirectory;
     let cliServerRoutes: CLIServerRoutes;
     let mockRouter: Router;
 

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

@@ -60,7 +60,8 @@ export class ValidationRouter {
             const outcome = await validate(architecture, foundSchema, undefined, this.schemaDirectory, true);
             return res.status(201).type('json').send(outcome);
         } catch (error) {
-            return res.status(500).type('json').send(new ErrorResponse(error.message));
+            const message = error instanceof Error ? error.message : String(error);
+            return res.status(500).type('json').send(new ErrorResponse(message));
         }
     };
 }
@@ -72,6 +73,6 @@ class ErrorResponse {
     }
 };
 
-class ValidationRequest {
+interface ValidationRequest {
     architecture: string;
 }