feat: add global specification watcher

src/commands/diff.ts

@@ -12,6 +12,8 @@ import {
   DiffOverrideFileError,
   DiffOverrideJSONError,
 } from '../errors/diff-error';
+import { specWatcher, WATCH_MESSAGES } from '../globals';
+import { watchFlag } from '../flags';
 
 const { readFile } = fs;
 
@@ -36,6 +38,7 @@ export default class Diff extends Command {
       char: 'o',
       description: 'path to JSON file containing the override properties',
     }),
+    watch: watchFlag
   };
 
   static args = [
@@ -59,7 +62,7 @@ export default class Diff extends Command {
     const outputFormat = flags['format'];
     const outputType = flags['type'];
     const overrideFilePath = flags['overrides'];
-
+    const watchMode = flags['watch'];
     let firstDocument: Specification, secondDocument: Specification;
 
     try {
@@ -125,8 +128,27 @@ export default class Diff extends Command {
         err: error,
       });
     }
+    if (watchMode) {
+      this.enableWatchMode(
+        firstDocument.getFilePath(),
+        secondDocument.getFilePath(),
+      );
+    }
   }
 
+  enableWatchMode(firstDocumentPath: string|undefined, secondDocumentPath: string|undefined) {
+    if (!firstDocumentPath) {
+      WATCH_MESSAGES.logOnAutoDisable('old');
+    } else {
+      specWatcher(firstDocumentPath, this, 'diff');
+    }
+
+    if (!secondDocumentPath) {
+      WATCH_MESSAGES.logOnAutoDisable('new');
+    } else {
+      specWatcher(secondDocumentPath, this, 'diff');
+    }
+  }
   outputJson(diffOutput: AsyncAPIDiff, outputType: string) {
     if (outputType === 'breaking') {
       this.log(JSON.stringify(diffOutput.breaking(), null, 2));

src/commands/validate.ts

@@ -3,26 +3,32 @@ import * as parser from '@asyncapi/parser';
 import Command from '../base';
 import { ValidationError } from '../errors/validation-error';
 import { load } from '../models/SpecificationFile';
+import { specWatcher } from '../globals';
+import { watchFlag } from '../flags';
 
 export default class Validate extends Command {
   static description = 'validate asyncapi file';
 
   static flags = {
-    help: flags.help({ char: 'h' })
+    help: flags.help({ char: 'h' }),
+    watch: watchFlag
   }
 
   static args = [
     { name: 'spec-file', description: 'spec path, url, or context-name', required: false },
   ]
 
   async run() {
-    const { args } = this.parse(Validate);
+    const { args, flags } = this.parse(Validate); // NOSONAR
     const filePath = args['spec-file'];
 
+    const watchMode = flags['watch'];
+
     const specFile = await load(filePath);
 
     try {
       if (specFile.getFilePath()) {
+        if (watchMode) {specWatcher(specFile.getFilePath() as string,this,'validate');}
         await parser.parse(specFile.text());
         this.log(`File ${specFile.getFilePath()} successfully validated!`);
       } else if (specFile.getFileURL()) {

src/flags.ts

@@ -0,0 +1,6 @@
+import { flags } from '@oclif/command';
+
+export const watchFlag = flags.boolean({
+  char: 'w',
+  description: 'Enable watch mode'
+});

src/globals.ts

@@ -0,0 +1,29 @@
+import chokidar from 'chokidar';
+import chalk from 'chalk';
+import Command from '@oclif/command';
+
+export const GreenLog = chalk.hex('#00FF00');
+export const OrangeLog = chalk.hex('#FFA500');
+export const RedLog = chalk.hex('#FF0000');
+const CHOKIDAR_CONFIG = {
+  // awaitWriteFinish: true
+};
+export const WATCH_MESSAGES = {
+  logOnStart: (filePath: string) => console.log(GreenLog(`Watching AsyncAPI file at ${filePath}\n`)),
+  logOnChange: (handlerName: string) => console.log(OrangeLog(`Change detected, running ${handlerName}\n`)),
+  logOnAutoDisable: (docVersion: 'old' | 'new') => console.log(RedLog(`Watch mode for ${docVersion} file was not enabled..\n`), OrangeLog('INFO: Watch works only with files from local file system\n'))
+};
+
+export const specWatcher = (filePath: string, handler: Command, handlerName: string) => {
+  try {
+    WATCH_MESSAGES.logOnStart(filePath);
+    chokidar
+      .watch(filePath, CHOKIDAR_CONFIG)
+      .on('change', async () => {
+        WATCH_MESSAGES.logOnChange(handlerName);
+        await handler.run();
+      });
+  } catch (error) {
+    console.log(error);
+  }
+};

test/commands/validate.test.ts

@@ -3,7 +3,6 @@
 import * as path from 'path';
 import { expect, test } from '@oclif/test';
 import {NO_CONTEXTS_SAVED} from '../../src/errors/context-error';
-
 import TestHelper from '../testHelper';
 
 const testHelper = new TestHelper();