feat: emit lint event

test: ensure we validate linting in real world setup (no mocking)

Author: nikku

src/index.js

@@ -80,9 +80,9 @@ export default function FeelEditor({
       return;
     }
 
-    const messages = diagnosticEffects.flatMap(effect => effect.value);
+    const diagnostics = diagnosticEffects.flatMap(effect => effect.value);
 
-    onLint(messages);
+    this._events.emit('lint', { diagnostics });
   });
 
   const keyHandler = EditorView.domEventHandlers(
@@ -130,6 +130,8 @@ export default function FeelEditor({
     extensions.push(EditorView.editable.of(false));
   }
 
+  this.on('lint', ({ diagnostics }) => onLint(diagnostics));
+
   this._cmEditor = new EditorView({
     state: EditorState.create({
       doc: value,

test/spec/CodeEditor.spec.js

@@ -2,12 +2,11 @@ import FeelEditor from '../../src/index.js';
 import TestContainer from 'mocha-test-container-support';
 import { EditorSelection } from '@codemirror/state';
 import { lineNumbers } from '@codemirror/view';
-import { diagnosticCount, forceLinting } from '@codemirror/lint';
 import { currentCompletions, startCompletion } from '@codemirror/autocomplete';
 import { domify } from 'min-dom';
 
 import { expect } from 'chai';
-import { spy, match } from 'sinon';
+import { spy } from 'sinon';
 
 const singleStart = window.__env__ && window.__env__.SINGLE_START;
 
@@ -501,7 +500,7 @@ return
       const diagnostics = await lint(editor);
 
       // then
-      expect(diagnostics).to.eql(0);
+      expect(diagnostics).to.be.empty;
     });
 
 
@@ -529,7 +528,7 @@ return
           const diagnostics = await lint(editor);
 
           // then
-          expect(diagnostics).to.eql(0);
+          expect(diagnostics).to.be.empty;
         });
 
       });
@@ -549,7 +548,7 @@ return
       const diagnostics = await lint(editor);
 
       // then
-      expect(diagnostics).to.eql(1);
+      expect(diagnostics).to.have.length(1);
     });
 
 
@@ -565,7 +564,7 @@ return
       const diagnostics = await lint(editor);
 
       // then
-      expect(diagnostics).to.eql(1);
+      expect(diagnostics).to.have.length(1);
     });
 
 
@@ -581,7 +580,7 @@ return
       const diagnostics = await lint(editor);
 
       // then
-      expect(diagnostics).to.eql(1);
+      expect(diagnostics).to.have.length(1);
     });
 
 
@@ -610,7 +609,9 @@ return
 
       it('without errors', async function() {
         const initialValue = '15';
-        const onLint = spy();
+        const onLint = spy((diagnostics) => {
+          expect(diagnostics).to.be.empty;
+        });
 
         const editor = new FeelEditor({
           container,
@@ -622,10 +623,76 @@ return
         await lint(editor);
 
         // then
-        // update done async
         expect(onLint).to.have.been.calledOnce;
-        expect(onLint).to.have.been.calledWith(match.array);
-        expect(onLint.args[0][0]).to.have.length(0);
+      });
+
+    });
+
+
+    it('should emit as <lint> event', async function() {
+      const initialValue = '"unclosed string';
+      const lintSpy = spy(({ diagnostics }) => {
+        expect(diagnostics).to.have.length(1);
+      });
+
+      const editor = new FeelEditor({
+        container,
+        value: initialValue
+      });
+
+      editor.on('lint', lintSpy);
+
+      // when
+      await lint(editor);
+
+      // then
+      expect(lintSpy).to.have.been.calledOnce;
+    });
+
+
+    describe('should trigger after update', function() {
+
+      it('recovering from errors', async function() {
+        const initialValue = '^15';
+
+        // given
+        const editor = new FeelEditor({
+          container,
+          value: initialValue
+        });
+
+        await lint(editor);
+
+        // when
+        editor.setValue('20');
+
+        const diagnostics = await lint(editor);
+
+        // then
+        // no more errors
+        expect(diagnostics).to.be.empty;
+      });
+
+
+      it('indicating new error', async function() {
+        const initialValue = '15';
+
+        // given
+        const editor = new FeelEditor({
+          container,
+          value: initialValue
+        });
+
+        await lint(editor);
+
+        // when
+        editor.setValue('^15');
+
+        const diagnostics = await lint(editor);
+
+        // then
+        // no more errors
+        expect(diagnostics).to.have.length(1);
       });
 
     });
@@ -1022,22 +1089,31 @@ async function expectEventually(fn) {
   throw e;
 }
 
-function wait(ms = 0) {
-  return new Promise(resolve => setTimeout(resolve, ms));
+function timeout(ms = 0) {
+  return new Promise((_resolve, reject) => setTimeout(reject, ms));
 }
 
 /**
+ * Awaits editor linting.
+ *
  * @param {FeelEditor} editor
  *
- * @return {Promise<number>}
+ * @return {Promise<import('@codemirror/lint').Diagnostic[]>}
  */
 async function lint(editor) {
-  const cm = getCm(editor);
 
-  // when
-  forceLinting(cm);
+  const lintPromise = new Promise((resolve, reject) => {
+    const handleLinted = ({ diagnostics }) => {
+      editor.off('lint', handleLinted);
+
+      resolve(diagnostics);
+    };
 
-  await wait();
+    editor.on('lint', handleLinted);
+  });
 
-  return diagnosticCount(cm.state);
+  return Promise.race([
+    timeout(1000),
+    lintPromise
+  ]);
 }