com.paperetto.dash
- Dash Launcher
- 1.0
- David Brittain
+ Dash
+ 3.3
+ Gerard Delmàs
- Dash is a Mac OSX utility that can be obtained from the Apple Store
- ]]>
+A smart and simple plugin that provides keyboard shortcut access for Dash, Velocity or Zeal in IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm, DataGrip, CLion, GoLand and Android Studio.
+
+Usage
+The default shortcut assigned to smart-search is Cmd-Shift-D (Mac OS X) or Ctrl-Shift-D (Windows, Linux).
+A menubar command named either "Smart-Search Documentation" can be found in the "Tools" menu.
+The plugin either searches for the statement at caret position or the current selection. It will identify the programming language in use and request filtered results accordingly. A non filtered search over all documentation entries can be invoked by adding the Alt modifier key to the shortcut. "Search all Documentation" is also available in the tools menu.
+
+
Configuration
+Shortcut
+You can change the shortcut at Preferences -> Keymap -> Plug-ins -> Dash.
+Toolbar Icon
+You can add a button to the toolbar. Right-click the menubar -> Customize […]. You will find the button under "Plug-ins -> Dash".
+
+Supported API Documentation Browsers
+Kapeli Dash (Mac OS X)
+Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snippets of code and instantly searches offline documentation sets for 150+ APIs (for a full list, see below). You can even generate your own docsets or request docsets to be included. http://kapeli.com/dash
+Velocity (Windows)
+Velocity gives your Windows desktop offline access to over 150 API documentation sets (provided by Dash for OS X). https://velocity.silverlakesoftware.com
+Zeal (Linux & Windows)
+Zeal is a simple offline API documentation browser inspired by Dash (OS X app). http://zealdocs.org
+]]>
- ]]>
+
+3.3
+ - Added non-smart "Search all Documentation" option
+ - Java 9 SDK detection
+3.2.5
+ - Fixed Zeal Support
+ - Go, Elixir & Erlang support
+3.2.4
+ - Dockerfile support
+3.2.3
+ - Dash 2.3 Remote redirection support
+ - Clojure support
+3.2.2 ActionScript support
+3.2.1 Fixed an issue where
+ context filters would not work
+3.2
+ - Toolbar icon support
+ - Velocity support on Windows
+ - Zeal support on Linux
+3.1
+ - language detection support in strings
+ - project settings sql dialect will be used
+ to filter search results
+ - android project support
+ - java search results according to projects
+ sdk version
+ - python search results according to
+ projects sdk version
+ - added language support for: Bash, Go,
+ Haskell, Lua, Markdown, Scala, TypoScript
+ - extended language support for: angularjs,
+ momen, require, awsjs, jasmine, sinon,
+ tornado, sqlalchemy, numpy, scipy, salt,
+ polymerdart, angulardart
+ - performance and stability improvements
+3.0.1 Fixed missing Ruby context recognition
+3.0 Added Context aware search
+2.2 Compatibility and stability fixes
+2.1 Added Ruby syntax support, stability fixes
+2.0 Added Dash docset keyword support
+
+]]>
-
+
com.intellij.modules.lang
+ com.intellij.sql
@@ -31,14 +90,18 @@
-
+
+
+
+
+
+
-
\ No newline at end of file
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1c8ea06
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+A smart and simple plugin that provides keyboard shortcut access for Dash, Velocity or Zeal in IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm, DataGrip, CLion, GoLand and Android Studio.
+
+## Installation
+To install the plugin in your IDE go to **Preferences -> Plugins -> Browse repositories** and **search for "Dash"**.
+
+## Usage
+The default **shortcut** assigned to smart-search is **Cmd-Shift-D** (Mac OS X) or **Ctrl-Shift-D** (Windows, Linux).
+
+
+A **menubar command** named "**Smart-Search Documentation**" can be found in the "Tools" menu.
+
+
+The plugin either searches for the statement at caret position or the current selection. It will identify the programming language in use and request filtered results accordingly. A non filtered search over all documentation entries can be invoked by adding the **Alt** modifier key to the shortcut. "**Search all Documentation**" is also available in the tools menu.
+
+## Configuration
+### Shortcut
+You can change the shortcut at Preferences -> Keymap -> Plug-ins -> Dash.
+
+### Toolbar Icon
+You can add a button to the toolbar. Right-click the menubar -> Customize […]. You will find the button under "Plug-ins -> Dash".
+
+## Supported API Documentation Browsers
+### Kapeli Dash (Mac OS X)
+Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snippets of code and instantly searches offline documentation sets for 150+ APIs (for a full list, see below). You can even generate your own docsets or request docsets to be included.
+[http://kapeli.com/dash](http://kapeli.com/dash)
+
+### Velocity (Windows)
+Velocity gives your Windows desktop offline access to over 150 API documentation sets (provided by Dash for OS X).
+[https://velocity.silverlakesoftware.com](https://velocity.silverlakesoftware.com)
+
+### Zeal (Linux & Windows)
+Zeal is a simple offline API documentation browser inspired by Dash (OS X app).
+[http://zealdocs.org](http://zealdocs.org)
+
+
+## Troubleshooting
+###### On Windows, when using Zeal the IDE shows `Failed to open dash-plugin://...` in the Event Log
+It looks like the URL handler has not been registered for Zeal. Please run `zeal.exe --register`.
+
+###### The plugin does not work on old IDEs
+Older IDE versions like **AppCode 1.x** are not supported anymore. Please manually install version 2.2 of the plugin: https://github.com/gdelmas/IntelliJDashPlugin/releases/tag/2.2
+
+###### In rare conditions the installation from the repositories does not work
+It looks like there is an IntelliJ/Java bug with OS X Mavericks which prevents to install plugins from the repositories. Please install the plugin manually from [here](https://github.com/gdelmas/IntelliJDashPlugin/releases). For additional information check [issue #13](https://github.com/gdelmas/IntelliJDashPlugin/issues/13).
diff --git a/README.txt b/README.txt
deleted file mode 100644
index a6e0d32..0000000
--- a/README.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-A simple plugin for AppCode (and other IntelliJ based IDEs) that provides keyboard shortcut access to Dash. This is necessary as the 'Services' menu is not populated in AppCode (apparently a Java limitation).
-
-Download Dash.jar from here: https://github.com/combinatorial/AppCodeDashSearch/releases/download/1.0/Dash.jar
-
-Install Dash.jar in this folder as a plugin.
-
-Dash is a Mac application for rapid search of developer documentation. It is free with nags to persuade you to pay and lose the nags. The free version is fully functional and super-useful. Get karma for buying and supporting the developer :) It can be downloaded here:
-
-http://itunes.apple.com/us/app/dash/id458034879?ls=1&mt=12
-
-The default shortcut assigned in the plugin is Mac-Shift-D. It either uses the current selection for the search, or the caret position.
-
-Please feel free to request improvements, or fork-it and make them yourself!
diff --git a/resources/dash.png b/resources/dash.png
new file mode 100644
index 0000000..6d3fb27
Binary files /dev/null and b/resources/dash.png differ
diff --git a/resources/dash@2x.png b/resources/dash@2x.png
new file mode 100644
index 0000000..70750bd
Binary files /dev/null and b/resources/dash@2x.png differ
diff --git a/src/com/paperetto/dash/DashLauncherAction.java b/src/com/paperetto/dash/DashLauncherAction.java
deleted file mode 100644
index 090cfad..0000000
--- a/src/com/paperetto/dash/DashLauncherAction.java
+++ /dev/null
@@ -1,98 +0,0 @@
-package com.paperetto.dash;
-
-
-import com.intellij.execution.ExecutionException;
-import com.intellij.execution.configurations.GeneralCommandLine;
-import com.intellij.execution.util.ExecUtil;
-import com.intellij.openapi.actionSystem.AnAction;
-import com.intellij.openapi.actionSystem.AnActionEvent;
-import com.intellij.openapi.actionSystem.DataKeys;
-import com.intellij.openapi.actionSystem.PlatformDataKeys;
-import com.intellij.openapi.editor.Editor;
-import com.intellij.openapi.editor.SelectionModel;
-
-import java.io.UnsupportedEncodingException;
-import java.net.URLEncoder;
-
-public class DashLauncherAction extends AnAction {
-
- @Override
- public void update(AnActionEvent e) {
- e.getPresentation().setEnabled(PlatformDataKeys.EDITOR.getData(e.getDataContext()) != null);
- }
-
-
-
- private String getWordAtCursor(CharSequence editorText, int cursorOffset) {
- if(editorText.length() == 0) return null;
- if(cursorOffset > 0 && !Character.isJavaIdentifierPart(editorText.charAt(cursorOffset)) &&
- Character.isJavaIdentifierPart(editorText.charAt(cursorOffset - 1))) {
- cursorOffset--;
- }
-
- if(Character.isJavaIdentifierPart(editorText.charAt(cursorOffset))) {
- int start = cursorOffset;
- int end = cursorOffset;
-
- while(start > 0 && Character.isJavaIdentifierPart(editorText.charAt(start-1))) {
- start--;
- }
-
- while(end < editorText.length() && Character.isJavaIdentifierPart(editorText.charAt(end))) {
- end++;
- }
-
- return editorText.subSequence(start,end).toString();
- }
- return null;
- }
-
- public void actionPerformed(AnActionEvent e) {
-
- Editor editor = PlatformDataKeys.EDITOR.getData(e.getDataContext());
-
- //Editor editor = DataKeys.EDITOR.getData(e.getDataContext());
- int offset = editor.getCaretModel().getOffset();
- CharSequence editorText = editor.getDocument().getCharsSequence();
-
- String word = null;
-
- SelectionModel selectionModel = editor.getSelectionModel();
- if(selectionModel.hasSelection())
- {
- word = selectionModel.getSelectedText();
- }
- else
- {
- word = getWordAtCursor(editorText,offset);
- }
-
- if(word!=null) {
-
- String searchWord;
- try {
- searchWord = URLEncoder.encode(word, "UTF-8");
- } catch (UnsupportedEncodingException el){
- ///where do I print an error
- return;
- }
- //URLEncoder turns spaces in to '+' we need them to be %20
- searchWord = searchWord.replace("+", "%20");
-
- String request = "dash://" + searchWord;
-
- //now open the URL with the 'open' command
- String[] command = new String[]{ExecUtil.getOpenCommandPath()};
- try {
- final GeneralCommandLine commandLine = new GeneralCommandLine(command);
- commandLine.addParameter(request);
- commandLine.createProcess();
-
- }
- catch (ExecutionException ee) {
- ///where do I print an error
- return;
- }
- }
- }
-}
diff --git a/src/de/dreamlab/dash/AbstractMenuAction.java b/src/de/dreamlab/dash/AbstractMenuAction.java
new file mode 100644
index 0000000..cc9d23c
--- /dev/null
+++ b/src/de/dreamlab/dash/AbstractMenuAction.java
@@ -0,0 +1,57 @@
+package de.dreamlab.dash;
+
+import com.intellij.openapi.actionSystem.AnAction;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.PlatformDataKeys;
+import com.intellij.openapi.actionSystem.Presentation;
+import com.intellij.openapi.util.IconLoader;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import javax.swing.*;
+
+abstract public class AbstractMenuAction extends AnAction {
+ protected @Nonnull String title = "";
+ protected @Nonnull String description = "";
+ protected @Nullable String iconFilename = null;
+
+
+ private boolean isPresentationInitialized = false;
+
+ private void initPresentation()
+ {
+ String docAppName = "";
+
+ if ( SystemUtil.isIsOSMac() ) {
+ docAppName = " in Dash";
+ }
+
+ Presentation presentation = this.getTemplatePresentation();
+ presentation.setText(title + docAppName);
+ presentation.setDescription(description + docAppName);
+
+ if ( iconFilename != null ) {
+ Icon icon = IconLoader.getIcon("/" + iconFilename, AbstractMenuAction.class);
+ presentation.setIcon(icon);
+ }
+ }
+
+ @Override
+ public void update(AnActionEvent e) {
+ super.update(e);
+
+ Presentation presentation = e.getPresentation();
+
+ if ( !isPresentationInitialized ) {
+ isPresentationInitialized = true;
+ initPresentation();
+
+ Presentation templatePresentation = getTemplatePresentation();
+ presentation.setText(templatePresentation.getText());
+ presentation.setDescription(templatePresentation.getDescription());
+ presentation.setIcon(templatePresentation.getIcon());
+ }
+
+ presentation.setEnabled(PlatformDataKeys.EDITOR.getData(e.getDataContext()) != null);
+ }
+}
diff --git a/src/de/dreamlab/dash/KeywordLookup.java b/src/de/dreamlab/dash/KeywordLookup.java
new file mode 100644
index 0000000..172f60d
--- /dev/null
+++ b/src/de/dreamlab/dash/KeywordLookup.java
@@ -0,0 +1,176 @@
+package de.dreamlab.dash;
+
+import com.intellij.lang.Language;
+import com.intellij.notification.Notification;
+import com.intellij.notification.NotificationType;
+import com.intellij.notification.Notifications;
+import de.dreamlab.dash.keywords.*;
+
+import java.util.*;
+
+public class KeywordLookup {
+ private HashMap