Merge pull request #4 from Belar/feat/hyperclick-provider

feat: add hyperclick provider

Author: ryanolsonx

README.md

@@ -19,6 +19,9 @@ A replacement of the definitions functionality from the original Atom-IDE / Nucl
 
   You can also search for [packages](https://atom.io/packages/search?q=IDE) in Atom.
 
+3. (Optional) Install [hyperclick](https://atom.io/packages/hyperclick) for `cmd/ctrl+click` support  
+  You can set [priority and grammar scope](https://github.com/facebookarchive/hyperclick#details) in extension settings
+
 ## Contributing
 
 Please see the [contributing guidelines](CONTRIBUTING.md).

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

@@ -1,11 +1,16 @@
 'use babel';
 
 import { CompositeDisposable } from 'atom';
+import { install as installPackageDependencies } from 'atom-package-deps';
 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() {
@@ -17,6 +22,8 @@ function package() {
           goToDefinition(providerRegistry),
       })
     );
+
+    installPackageDependencies('atom-ide-definitions');
   }
 
   function deactivate() {
@@ -27,7 +34,12 @@ function package() {
     providerRegistry.addProvider(provider);
   }
 
-  return { activate, deactivate, consumeDefinitionsService };
+  return {
+    activate,
+    deactivate,
+    consumeDefinitionsService,
+    getClickProvider: clickProvider.getProvider,
+  };
 }
 
 export default package();

package-lock.json

@@ -8,15 +8,13 @@
     "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": {
     "atom": ">=1.0.0 <2.0.0"
   },
   "dependencies": {
+    "atom-package-deps": "^5.0.0",
     "atom-languageclient": "^0.9.9"
   },
   "devDependencies": {
@@ -44,11 +42,40 @@
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
   },
+  "package-deps": [
+    "hyperclick"
+  ],
   "consumedServices": {
     "definitions": {
       "versions": {
         "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"
+      }
+    }
   }
 }

package.json

@@ -0,0 +1,73 @@
+'use babel';
+
+import { ClickProvider } from '../lib/clickProvider';
+
+// Use the command `window:run-package-specs` (cmd-alt-ctrl-p) to run specs.
+//
+// To run a specific `it` or `describe` block add an `f` to the front (e.g. `fit`
+// or `fdescribe`). Remove the `f` to unfocus the block.
+
+let clickProvider;
+const clickHandlers = {
+  goToDefinitions: () => {},
+};
+
+describe('AtomIdeClick', () => {
+  beforeEach(function() {
+    spyOn(atom.config, 'get').andCallFake(function(value) {
+      const config = {
+        'atom-ide-definitions.clickGrammarScopes': [],
+        'atom-ide-definitions.clickPriority': 0,
+      };
+      return config[value];
+    });
+
+    spyOn(clickHandlers, 'goToDefinitions');
+
+    clickProvider = new ClickProvider({
+      clickHandler: clickHandlers.goToDefinitions,
+    });
+  });
+
+  it('verify provider result', () => {
+    const provider = clickProvider.getProvider();
+
+    expect(provider.priority).toEqual(0);
+    expect(provider.grammarScopes).toBeNull();
+    expect(typeof provider.getSuggestionForWord).toEqual('function');
+  });
+
+  it('verify suggestionForWord result', () => {
+    const suggestionForWord = clickProvider.suggestionForWordHandler(
+      'FakeEditor',
+      'FakeText',
+      'FakeRange'
+    );
+
+    expect(suggestionForWord.range).toEqual('FakeRange');
+    expect(typeof suggestionForWord.callback).toEqual('function');
+  });
+
+  it('verify suggestionForWord handler stops if there is no text value', () => {
+    const suggestionForWord = clickProvider.suggestionForWordHandler(
+      'FakeEditor',
+      '',
+      'FakeRange'
+    );
+
+    expect(suggestionForWord).toBeUndefined();
+  });
+
+  it('verify suggestionForWord callback assignment', () => {
+    const suggestionForWord = clickProvider.suggestionForWordHandler(
+      'FakeEditor',
+      'FakeText',
+      'FakeRange'
+    );
+
+    expect(typeof suggestionForWord.callback).toEqual('function');
+
+    suggestionForWord.callback();
+    expect(clickHandlers.goToDefinitions).toHaveBeenCalled();
+  });
+});