feat: add hyperclick provider

Author: Belar

lib/clickProvider.js

@@ -0,0 +1,35 @@
+'use babel';
+
+export class ClickProvider {
+  constructor(options) {
+    this.clickHandler = options.clickHandler;
+
+    this.suggestionForWordHandler = this.suggestionForWordHandler.bind(this);
+    this.getProvider = this.getProvider.bind(this);
+  }
+
+  suggestionForWordHandler(textEditor, text, range) {
+    const targetValue = text && text.trim();
+    if (!targetValue) return;
+
+    return {
+      range,
+      callback: () => this.clickHandler(),
+    };
+  }
+
+  getProvider() {
+    const grammarScopes = atom.config.get(
+      'atom-ide-definitions.clickGrammarScopes'
+    );
+    const priority = atom.config.get('atom-ide-definitions.clickPriority');
+
+    return {
+      priority,
+      // Assign value only if at least one scope is available. Falsey triggers default behaviour, "apply to all".
+      grammarScopes:
+        (grammarScopes && !!grammarScopes[0] && grammarScopes) || null,
+      getSuggestionForWord: this.suggestionForWordHandler,
+    };
+  }
+}

lib/main.js

@@ -3,9 +3,13 @@
 import { CompositeDisposable } from 'atom';
 import goToDefinition from './goToDefinition';
 import createProviderRegistry from './providerRegistry';
+import { ClickProvider } from './clickProvider';
 
 function package() {
   const providerRegistry = createProviderRegistry();
+  const clickProvider = new ClickProvider({
+    clickHandler: () => goToDefinition(providerRegistry),
+  });
   let subscriptions;
 
   function activate() {
@@ -27,7 +31,12 @@ function package() {
     providerRegistry.addProvider(provider);
   }
 
-  return { activate, deactivate, consumeDefinitionsService };
+  return {
+    activate,
+    deactivate,
+    consumeDefinitionsService,
+    getClickProvider: clickProvider.getProvider,
+  };
 }
 
 export default package();

package.json

@@ -8,9 +8,6 @@
     "atom-ide",
     "defintion"
   ],
-  "activationCommands": {
-    "atom-workspace": "atom-ide-go-to-definition:go-to-definition"
-  },
   "repository": "https://github.com/atom-ide-community/atom-ide-definitions",
   "license": "MIT",
   "engines": {
@@ -50,5 +47,31 @@
         "0.1.0": "consumeDefinitionsService"
       }
     }
+  },
+  "providedServices": {
+    "hyperclick": {
+      "versions": {
+        "0.1.0": "getClickProvider"
+      }
+    }
+  },
+  "configSchema": {
+    "clickPriority": {
+      "order": 1,
+      "title": "Hyperclick Provider Priority",
+      "description": "Provider priority relative to other providers. For more details see [Hyperclick's provider documentation](https://github.com/facebookarchive/hyperclick#details).",
+      "type": "number",
+      "default": 0
+    },
+    "clickGrammarScopes": {
+      "order": 2,
+      "title": "Hyperclick Grammar Scopes",
+      "description": "List of scopes to allow action on. For example, `source.js, source.ts, source.go` *Requires reload to take effect.*",
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "string"
+      }
+    }
   }
 }