feat: add yaml check support

Author: tomastrajan

lib/checks/json.check.ts

@@ -90,7 +90,7 @@ export function jsonCheckTaskFactory(
             return;
           }
 
-          if (result.length) {
+          if (result?.length) {
             matches.push({
               file,
               matches: result.map((r) => ({

lib/checks/yaml.check.ts

@@ -0,0 +1,121 @@
+import YAML from 'yaml';
+import ObjectPath from 'object-path';
+import { ListrDefaultRenderer, ListrTaskWrapper } from 'listr2';
+
+import {
+  DEFAULT_CHECK_EXECUTION_TIMEOUT,
+  DEFAULT_EXCLUDE_FILES_PATTERN_CONTENT,
+} from '../consts';
+import {
+  Context,
+  ParentTask,
+  ProjectCheckMatch,
+  YAMLCheckDefinition,
+} from '../interface';
+import * as fs from '../services/fs.service';
+
+import {
+  CheckResultSymbol,
+  getCheckFiles,
+  resolveCheckParentTaskProgress,
+  resolveCheckTaskFulfilledTitle,
+} from './check.service';
+
+export function yamlCheckTaskFactory(
+  definition: YAMLCheckDefinition,
+  parentTask: ParentTask
+) {
+  async function yamlCheckTask(
+    ctx: Context,
+    task: ListrTaskWrapper<Context, ListrDefaultRenderer>
+  ) {
+    const { name, type, yamlPropertyPath } = definition;
+
+    const files = getCheckFiles(
+      definition,
+      DEFAULT_EXCLUDE_FILES_PATTERN_CONTENT
+    );
+
+    task.title = `${task.title}, found ${files.length} files`;
+
+    if (!files.length) {
+      ctx.results.checks![name] = {
+        name,
+        type,
+        value: false,
+      };
+      task.title = `${CheckResultSymbol.UNFULFILLED} ${task.title}`;
+      resolveCheckParentTaskProgress(parentTask);
+      return;
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      setTimeout(
+        () => reject(`Check "${name}" timeout`),
+        DEFAULT_CHECK_EXECUTION_TIMEOUT
+      );
+
+      let finishedCounter = 0;
+
+      const errors: Error[] = [];
+      const matches: ProjectCheckMatch[] = [];
+
+      for (const file of files) {
+        setTimeout(() => {
+          let data: any;
+          let result: any[];
+          try {
+            data = YAML.parse(fs.readFile(file), { strict: false });
+            result = ObjectPath.get(data, yamlPropertyPath);
+          } catch (err: any) {
+            const error = new Error(
+              `[yaml] "${name}" - ${file} - ${err.message}`
+            );
+            errors.push(error);
+            ctx.handledCheckFailures.push(error);
+            finishedCounter++;
+            if (finishedCounter === files.length) {
+              resolve();
+            }
+            task.title = `${CheckResultSymbol.ERROR} ${task.title} - ${file} - ${err.message}`;
+            resolveCheckParentTaskProgress(parentTask);
+            return;
+          }
+
+          if (result?.length) {
+            matches.push({
+              file,
+              matches: [
+                {
+                  match: yamlPropertyPath,
+                  groups: {
+                    [yamlPropertyPath]: result,
+                  },
+                },
+              ],
+            });
+          }
+
+          finishedCounter++;
+
+          if (finishedCounter === files.length) {
+            ctx.results.checks![name] = {
+              name,
+              type,
+              value: matches.length > 0,
+              matches,
+            };
+
+            task.title = errors.length
+              ? errors.map((e) => e.message).join(',')
+              : resolveCheckTaskFulfilledTitle(task, matches);
+            resolveCheckParentTaskProgress(parentTask);
+
+            resolve();
+          }
+        });
+      }
+    });
+  }
+  return yamlCheckTask;
+}

lib/interface.ts

@@ -136,13 +136,18 @@ export interface JSONCheckDefinition extends BaseCheckDefinition {
   jsonPropertyPath: string;
 }
 
+export interface YAMLCheckDefinition extends BaseCheckDefinition {
+  yamlPropertyPath: string;
+}
+
 export enum CheckType {
   CONTENT = 'content',
   XPATH = 'xpath',
   SIZE = 'size',
   META = 'meta',
   FILE = 'file',
   JSON = 'json',
+  YAML = 'yaml',
 }
 
 export enum ProjectType {

lib/tasks/run-checks.task.ts

@@ -17,6 +17,7 @@ import {
 } from '../checks/check.service';
 import { fileCheckTaskFactory } from '../checks/file.check';
 import { jsonCheckTaskFactory } from '../checks/json.check';
+import { yamlCheckTaskFactory } from '../checks/yaml.check';
 
 const DEFAULT_PROJECT_NAME_PATTERN_FLAGS = 'i';
 
@@ -111,6 +112,8 @@ function buildTasks(ctx: Context, parentTask: ParentTask): ListrTask[] {
         return fileCheckTaskFactory(definition, parentTask);
       } else if (definition.type === CheckType.JSON) {
         return jsonCheckTaskFactory(definition, parentTask);
+      } else if (definition.type === CheckType.YAML) {
+        return yamlCheckTaskFactory(definition, parentTask);
       } else {
         return function unknownCheckTask(
           ctx: Context,

package-lock.json

@@ -27,19 +27,22 @@
     "got": "^11.8.2",
     "jsonpath-plus": "^6.0.1",
     "listr2": "^6.3.1",
+    "object-path": "^0.11.8",
     "rxjs": "^7.8.0",
     "strip-json-comments": "^3.1.1",
     "strip-json-trailing-commas": "^1.1.0",
     "xml2js": "^0.4.23",
     "xmldom": "^0.6.0",
     "xpath": "0.0.32",
+    "yaml": "^2.4.1",
     "yargs": "^17.1.1"
   },
   "devDependencies": {
     "@airbnb/node-memwatch": "^2.0.0",
     "@types/airbnb__node-memwatch": "^2.0.0",
     "@types/jest": "^27.0.1",
     "@types/node": "^16.7.2",
+    "@types/object-path": "^0.11.4",
     "@types/xml2js": "^0.4.9",
     "@types/xmldom": "^0.1.31",
     "@types/yargs": "^17.0.2",