search

gdelmas / IntelliJDashPlugin

A smart and simple plugin that provides keyboard shortcut access for Dash, Velocity or Zeal in IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm and Android Studio.
MIT License
1.09k stars 73 forks source link

Added language support mapping for Dart -> Flutter docs. #77

Closed gspencergoog closed 5 years ago

gspencergoog commented 5 years ago

Flutter (http://docs.flutter.io) now has docset support, but activating Dash on Flutter APIs with the plugin doesn't work because flutter is not one of the docsets searched in Dart mode.

I bumped the version number preemptively, but I'd be happy to revert that part of the change if desired.

gdelmas commented 5 years ago

hey @gspencergoog ,

how do you install the flutter docset? is this from "Dart Docsets" section in Dash? if this is the case would using the dartdocs keyword work as well? this should cover all dart docsets.

gspencergoog commented 5 years ago

Well, it's available from a feed right now: https://docs.flutter.io/offline/flutter.xml.

I may be contributing it to the default docs on Dash, but only if we can get the continuous integration system to upload them automatically, or get Dash to pull it from the feed, so that's a work in progress.

The Flutter docs won't be part of the Dart docset, because it's not part of the Dart project.

gdelmas commented 5 years ago

is this different from these:

image

what are the differences? as all downloaded docsets from the dart section should be searchable with the dartdocs keyword

gspencergoog commented 5 years ago

Yes, it is different. Those are all Dart pub package docs from pub.dartlang.org, and the "flutter" one is just an old Dart package that has no actual bearing on the real Flutter SDK: it was a placeholder for a very early version, and I've asked about getting it removed from the pub site. The others are all flutter-related Dart packages that are published on pub.dartlang.org, but they're not flutter itself.

Flutter is not a pub package, it is an entire SDK with its own docs. Since Flutter isn't published using that mechanism, it doesn't appear in that list, and you can't get to the docs that way. I've recently added the ability of our CI system to publish the docset to the feed above, and we'd like the IntelliJ plugin to be able to search through that docset, which is why I submitted this PR, since it doesn't have 'flutter' as a keyword.

gspencergoog commented 5 years ago

The flutter package has been removed from pub.dartlang.org now, so that it is no longer confusing things.

gspencergoog commented 5 years ago

Hi @gdelmas, does my comment above answer your question?

gdelmas commented 5 years ago

hey @gspencergoog,

i think it will be too much to start adding docsets that are not in the kapeli registry.

yet we could still make the flutter docset work. dart docsets seem to use DocSetPlatformFamily dartdocs. dash filters by that (see: https://github.com/gdelmas/IntelliJDashPlugin/pull/9#issuecomment-30096038). if you could add the DocSetPlatformFamily to the docset, i will add the dartdocs keyword to the plugin.

gspencergoog commented 5 years ago

Great, that works for me. I'll update the PR soon.

gspencergoog commented 5 years ago

Sorry, I see what you mean now. Closing this PR. I'll add dartdocs to the Info.plist in the Flutter docs.