feat: add validate command

Signed-off-by: seven <zilisheng1996@gmail.com>

Author: Blankll

package-lock.json

@@ -52,6 +52,7 @@
     "@alicloud/ros-cdk-core": "^1.2.0",
     "@alicloud/ros-cdk-fc": "^1.2.0",
     "ajv": "^8.17.1",
+    "chalk": "^4.1.2",
     "commander": "^11.1.0",
     "i18n": "^0.15.1",
     "pino": "^8.17.2",
@@ -71,6 +72,6 @@
     "prettier": "^3.2.4",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.6.2"
   }
 }

package.json

@@ -2,8 +2,8 @@
 
 import { Command } from 'commander';
 import { lang } from '../lang';
-import { logger } from '../common/logger';
-import { getVersion } from '../common/getVersion';
+import { logger, getVersion } from '../common';
+import { validate } from './validate';
 
 const program = new Command();
 
@@ -22,11 +22,11 @@ program
   });
 
 program
-  .command('validate')
+  .command('validate [location]')
   .description('validate serverless Iac yaml')
-  .action((str) => {
+  .action((location) => {
     logger.debug('log command info');
-    console.log(`${str} ${lang.__('hello')}`);
+    validate(location);
   });
 
 program.parse();

src/commands/index.ts

@@ -0,0 +1,13 @@
+import { parseYaml } from '../iac';
+import path from 'node:path';
+import { printer } from '../common';
+
+export const validate = (location?: string) => {
+  const projectRoot = path.resolve(process.cwd());
+  const yamlPath = location
+    ? path.resolve(projectRoot, location)
+    : path.resolve(projectRoot, 'serverless-insight.yml');
+
+  parseYaml(yamlPath);
+  printer.success('Yaml is valid! 🎉');
+};

src/commands/validate.ts

@@ -0,0 +1,4 @@
+export * from './printer';
+export * from './provider';
+export * from './logger';
+export * from './getVersion';

src/common/index.ts

@@ -0,0 +1,8 @@
+import chalk from 'chalk';
+
+export const printer = {
+  success: (message: string) =>
+    console.log(`${chalk.bgYellow(chalk.black('ServerlessInsight'))}: ${chalk.green(message)}`),
+  error: (message: string) =>
+    console.log(`${chalk.bgRed(chalk.black('ServerlessInsight'))}: ${chalk.red(message)}`),
+};

src/common/printer.ts

@@ -0,0 +1,2 @@
+export * from './parse';
+export * from './iacSchema';

src/iac/index.ts

@@ -1,30 +1,40 @@
 import { parse } from 'yaml';
-import { readFileSync } from 'node:fs';
-import { RawServerlessIac } from '../types';
+import { existsSync, readFileSync } from 'node:fs';
+import { IacFunction, RawServerlessIac, ServerlessIac, Event } from '../types';
+import { validateYaml } from './iacSchema';
 
 const mapToArr = (obj: Record<string, Record<string, unknown> | string>) => {
   return Object.entries(obj).map(([key, value]) =>
     typeof value === 'string' ? { [key]: value } : { id: key, ...value },
   );
 };
 
-const transformYaml = (iacJson: RawServerlessIac) => {
+const validateExistence = (path: string) => {
+  if (!existsSync(path)) {
+    throw new Error(`File does not exist at path: ${path}`);
+  }
+};
+
+const transformYaml = (iacJson: RawServerlessIac): ServerlessIac => {
   return {
     service: iacJson.service,
     version: iacJson.version,
     provider: iacJson.provider,
     vars: iacJson.vars,
     stages: iacJson.stages,
-    functions: mapToArr(iacJson.functions),
-    events: mapToArr(iacJson.events),
-    tags: mapToArr(iacJson.tags),
+    functions: mapToArr(iacJson.functions) as unknown as Array<IacFunction>,
+    events: mapToArr(iacJson.events) as unknown as Array<Event>,
+    tags: mapToArr(iacJson.tags) as unknown as Array<string>,
   };
 };
 
-export const parseYaml = (path: string) => {
-  // read yaml from path
+export const parseYaml = (path: string): ServerlessIac => {
+  validateExistence(path);
+
   const yamlContent = readFileSync(path, 'utf8');
   const iacJson = parse(yamlContent) as RawServerlessIac;
 
+  validateYaml(iacJson);
+
   return transformYaml(iacJson);
 };

src/iac/parse.ts

@@ -14,8 +14,8 @@ type FunctionEnvironment = {
   NODE_ENV: string;
 };
 
-type IacFunction = {
-  fc_name: string;
+export type IacFunction = {
+  name: string;
   runtime: string;
   handler: string;
   code: string;
@@ -28,7 +28,7 @@ type Functions = {
   [key: string]: IacFunction;
 };
 
-type Event = {
+export type Event = {
   type: string;
   source: string;
   function: string;

src/types.ts

@@ -1,4 +1,4 @@
-import { validateYaml } from '../src/iac/iacSchema';
+import { validateYaml } from '../src/iac';
 import { readFileSync } from 'node:fs';
 import * as path from 'node:path';
 import { parse } from 'yaml';
@@ -90,7 +90,7 @@ describe('unit test for validate', () => {
           },
         },
       },
-    };
+    } as unknown as RawServerlessIac;
     expect(() => validateYaml(invalidYaml)).toThrow('Invalid yaml');
   });