fix: index known files by default, index other files explicitly

app/lib/file-context/__tests__/file-context-spec.js

@@ -63,7 +63,9 @@ describe('FileContext', function() {
 
     // when
     await waitFor(() => {
-      fileContext.addFile(filePath, 'foo');
+      fileContext.addFile(filePath, {
+        localValue: 'foo'
+      });
     });
 
     // then
@@ -76,6 +78,28 @@ describe('FileContext', function() {
   });
 
 
+  it('adding file with explicit processor', async function() {
+
+    // given
+    const filePath = path.resolve(__dirname, './fixtures/extensions/bpmn.unrecognized');
+
+    // when
+    await waitFor(() => {
+      fileContext.addFile(filePath, {
+        processor: 'bpmn'
+      });
+    });
+
+    // then
+    expectItems(fileContext, [
+      {
+        uri: toFileUrl(path.resolve(__dirname, './fixtures/extensions/bpmn.unrecognized')),
+        processor: 'bpmn'
+      }
+    ]);
+  });
+
+
   it('removing file', async function() {
 
     // given
@@ -158,35 +182,35 @@ describe('FileContext', function() {
   });
 
 
-  it('should NOT throw for unrecognized extension', async function() {
+  describe('error handling', function() {
 
-    // given
-    const filePath = path.resolve(__dirname, './fixtures/extensions/bpmn.unrecognized');
+    it('should NOT throw for unrecognized extension', async function() {
 
-    // when
-    const file = await fileContext.addFile(filePath);
+      // given
+      const filePath = path.resolve(__dirname, './fixtures/extensions/bpmn.unrecognized');
 
-    // then
-    expect(file).to.exist;
-    expect(file.metadata).to.have.property('type');
-  });
+      // when
+      const file = await fileContext.addFile(filePath);
 
+      // then
+      expect(file).to.exist;
+      expect(file.metadata).to.have.property('type');
+    });
 
-  it('should NOT throw for missing extension', async function() {
 
-    // given
-    const filePath = path.resolve(__dirname, './fixtures/extensions/no-extension');
+    it('should NOT throw for no extension', async function() {
 
-    // when
-    const file = await fileContext.addFile(filePath);
+      // given
+      const filePath = path.resolve(__dirname, './fixtures/extensions/no-extension');
 
-    // then
-    expect(file).to.exist;
-    expect(file.metadata).to.have.property('type');
-  });
+      // when
+      const file = await fileContext.addFile(filePath);
 
+      // then
+      expect(file).to.exist;
+      expect(file.metadata).to.have.property('type');
+    });
 
-  describe('broken files', function() {
 
     it('should NOT throw for empty BPMN', async function() {
 

app/lib/file-context/file-context.js

@@ -79,25 +79,20 @@ module.exports = class FileContext extends EventEmitter {
    * Add file.
    *
    * @param { string } uri
-   * @param { string } [localValue]
-   */
-  addFile(uri, localValue) {
-    return this._indexer.add(toFileUrl(uri), localValue);
-  }
-
-  /**
-   * Update file.
+   * @param { { localValue?: string, processor?: string } } [options]
    *
-   * @param { string } uri
+   * @returns { Promise<undefined> }
    */
-  updateFile(uri) {
-    return this.addFile(toFileUrl(uri));
+  addFile(uri, options) {
+    return this._indexer.add(toFileUrl(uri), options);
   }
 
   /**
    * Remove file.
    *
    * @param { string } uri
+   *
+   * @returns { undefined }
    */
   removeFile(uri) {
     return this._indexer.remove(toFileUrl(uri));
@@ -106,19 +101,24 @@ module.exports = class FileContext extends EventEmitter {
   /**
    * Handle file opened.
    *
-   * @param { { uri: string, value: string } } fileProps
+   * @param { string } uri
+   * @param { { processor?: string } }
+   *
+   * @returns { Promise<undefined> }
    */
-  fileOpened(fileProps) {
-    return this._indexer.fileOpened(fileProps);
+  fileOpened(uri, options) {
+    return this._indexer.fileOpened(uri, options);
   }
 
   /**
    * Handle file content changed.
    *
-   * @param { { uri: string, value: string } } fileProps
+   * @param { string } uri
+   * @param { string } value
+   * @param { { processor?: string } } [options]
    */
-  fileContentChanged(fileProps) {
-    return this._indexer.fileContentChanged(fileProps);
+  fileContentChanged(uri, value, options) {
+    return this._indexer.fileContentChanged(uri, value, options);
   }
 
   /**

app/lib/file-context/indexer.js

@@ -96,17 +96,24 @@ module.exports = class Indexer {
 
   /**
    * @param { string } uri
-   * @param { string } [localValue]
+   * @param { { localValue?: string, processor?: string } } [options]
+   *
+   * @returns { Promise<undefined> }
    */
-  add(uri, localValue) {
+  add(uri, options = {}) {
     uri = toFileUrl(uri);
 
-    this._logger.info('indexer:add', uri, localValue);
+    const {
+      localValue,
+      processor
+    } = options;
+
+    this._logger.info('indexer:add', uri, localValue, processor);
 
     let indexItem = this.items.get(uri);
 
     if (!indexItem) {
-      indexItem = createIndexItem({ uri, localValue });
+      indexItem = createIndexItem({ uri, localValue, processor });
 
       this.items.set(uri, indexItem);
     }
@@ -126,35 +133,30 @@ module.exports = class Indexer {
   /**
    * Notify file opened
    *
-   * @param { { uri: string, value: string } } fileProps
+   * @param { string } uri
+   * @param { { processor?: string } } [options]
+   *
+   * @returns { Promise<undefined> }
    */
-  fileOpened(fileProps) {
-
-    const {
-      uri,
-      value
-    } = fileProps;
-
+  fileOpened(uri, options = {}) {
     this._emit('file-opened', uri);
 
-    return this.add(toFileUrl(uri), value);
+    return this.add(toFileUrl(uri), options);
   }
 
   /**
    * Notify file content changed
    *
-   * @param { { uri: string, value: string } } fileProps
+   * @param { string } uri
+   * @param { string } value
+   * @param { { processor?: string } } [options]
+   *
+   * @returns { Promise<undefined> }
    */
-  fileContentChanged(fileProps) {
-
-    const {
-      uri,
-      value
-    } = fileProps;
-
+  fileContentChanged(uri, value, options = {}) {
     this._emit('file-content-changed', uri);
 
-    return this.add(toFileUrl(uri), value);
+    return this.add(toFileUrl(uri), value, options);
   }
 
   /**
@@ -345,7 +347,8 @@ module.exports = class Indexer {
 /**
  * @param { {
  *  uri: string,
- *  localValue?: string
+ *  localValue?: string,
+ *  processor?: string
  * } } item
  *
  * @return {IndexItem}
@@ -355,6 +358,7 @@ function createIndexItem(item) {
   const {
     uri,
     localValue,
+    processor,
     ...rest
   } = item;
 
@@ -373,7 +377,8 @@ function createIndexItem(item) {
       this.localValue = value;
     },
     file,
-    localValue
+    localValue,
+    processor
   };
 
 }

app/lib/file-context/processor.js

@@ -38,6 +38,16 @@ module.exports = class Processor {
   process(item) {
     this._logger.info('processor:process', item.uri);
 
+    if (item.processor) {
+      const processor = this._processors.find(processor => processor.id === item.processor);
+
+      if (processor) {
+        return processor.process(item);
+      }
+
+      this._logger.warn('processor:process', `Processor with id ${ item.processor } not found`);
+    }
+
     const processor = this._processors.find(processor => processor.extensions.includes(getFileExtension(item.file.path)));
 
     if (!processor) {

app/lib/file-context/processors/bpmnProcessor.js

@@ -21,7 +21,8 @@ const {
 } = require('./util');
 
 module.exports = {
-  extensions: [ '.bpmn', '.xml' ],
+  id: 'bpmn',
+  extensions: [ '.bpmn' ],
   process: async (item) => {
     let rootElement, ids, linkedIds;
 

app/lib/file-context/processors/dmnProcessor.js

@@ -18,6 +18,7 @@ const {
 } = require('./util');
 
 module.exports = {
+  id: 'dmn',
   extensions: [ '.dmn' ],
   process: async (item) => {
     let rootElement, ids;

app/lib/file-context/processors/formProcessor.js

@@ -11,6 +11,7 @@
 const assert = require('node:assert');
 
 module.exports = {
+  id: 'form',
   extensions: [ '.form' ],
   process: async (item) => {
     let formId;

app/lib/file-context/processors/processApplicationProcessor.js

@@ -9,6 +9,7 @@
  */
 
 module.exports = {
+  id: 'processApplication',
   extensions: [ '.process-application' ],
   process: async (item) => {
     return {

app/lib/file-context/types.d.ts

@@ -22,6 +22,7 @@ export type IndexItem = {
   file: File,
   localValue?: any,
   metadata: Metadata,
+  processor?: string,
   uri: string,
   value: any,
   [key: string]: any

app/lib/index.js

@@ -224,26 +224,30 @@ renderer.on('system-clipboard:write-text', function(options, done) {
 });
 
 // file context //////////
-renderer.on('file-context:add-root', function(filePath, done) {
+renderer.on('file-context:add-root', function(options, done) {
+  const { filePath } = options;
+
   fileContext.addRoot(filePath);
 
   done(null);
 });
 
-renderer.on('file-context:remove-root', function(filePath, done) {
+renderer.on('file-context:remove-root', function(options, done) {
+  const { filePath } = options;
+
   fileContext.removeRoot(filePath);
 
   done(null);
 });
 
-renderer.on('file-context:file-opened', function(filePath, value, done) {
-  fileContext.fileOpened({ uri: toFileUrl(filePath), value });
+renderer.on('file-context:file-opened', function(filePath, options, done) {
+  fileContext.fileOpened(toFileUrl(filePath), options);
 
   done(null);
 });
 
-renderer.on('file-context:file-content-changed', function(filePath, value, done) {
-  fileContext.fileContentChanged({ uri: toFileUrl(filePath), value });
+renderer.on('file-context:file-content-changed', function(filePath, value, options, done) {
+  fileContext.fileContentChanged(toFileUrl(filePath), value, options);
 
   done(null);
 });
@@ -254,15 +258,6 @@ renderer.on('file-context:file-closed', function(filePath, done) {
   done(null);
 });
 
-renderer.on('file:content-changed', function(filePath, contents, done) {
-  fileContext.fileContentChanged({
-    uri: toFileUrl(filePath),
-    value: contents
-  });
-
-  done(null);
-});
-
 // filesystem //////////
 
 renderer.on('file:read', function(filePath, options = {}, done) {