Add dartdoc support to DartCode #2807

Activity

1. timsneath

   added

   is enhancementAn enhancement or improvement that should be listed in release notes but is not a bug fix.An enhancement or improvement that should be listed in release notes but is not a bug fix.

   on Sep 19, 2020
2. DanTup commented on Sep 20, 2020

   

   DanTup

   on Sep 20, 2020

   Last edited by DanTup

   Member

   More actions

   It may make sense to contribute this with a task provider (similar to #2718). That way it's easy to lift into your own tasks.json if you want to customise it (eg. pass other args) and/or set it as a preLaunchTask or similar. We could probably still optionally wrap it as a command (hopefully in a way that if a user had overridden it in tasks.json, it'd run that version).

   @devoncarew is the dartdoc binary likely to be folded into dartdev?
3. DanTup

   added this to the v3.15.0 milestone on Sep 20, 2020
4. DanTup

   added

   in commandsRelates to commands (usually invoked from the command Palette)Relates to commands (usually invoked from the command Palette)

   in tasksRelates to VS Code tasks, such as those provided by Task ProvidersRelates to VS Code tasks, such as those provided by Task Providers

   on Sep 20, 2020
5. DanTup

   closed this as completedin 99bfcc1on Sep 21, 2020
6. DanTup commented on Sep 21, 2020

   

   DanTup

   on Sep 21, 2020

   Member

   More actions

   I've implemented in a task provider (because of the advantages mentioned above), but also added a command that wraps it (to make it easier to find). It'll show up in a few places:

   • Command palette
   • Toolbar icon when you have a dartdoc_options.yaml file open
   • Context menu of dartdoc_options.yaml in the explorer tree
   • In the Run Task section

   Unfortunately the args can't be customised in task.json as I expected yet (there's an open issue about this at microsoft/vscode#58836), though for this particular command I think using the yaml file is probably more common.
7. devoncarew commented on Sep 21, 2020

   

   devoncarew

   on Sep 21, 2020

   Contributor

   More actions

   Yes, dartdoc will almost certainty be rolled into dartdev (exact timing TBD).

   I don't think this command is typically run by users. It's much more likely to be a CI type thing - run by dart.dev, flutter.dev, and pub.dev/documentation. Myself, I wouldn't worry about having an easy IDE entrypoint.
8. DanTup commented on Sep 21, 2020

   

   DanTup

   on Sep 21, 2020

   Member

   More actions

   Even if it's not used much, it was a good way to try out a task provider without disrupting the existing commands. We have a bunch things with a lot of custom code (things like pub get, pub upgrade, flutter doctor, flutter upgrade, etc.) that would be simpler as tasks (and get some benefit from running in the terminal, like clickable links for filenames and being able to press Ctrl+C for users to terminate - which might help sidestep things like flutter/flutter#61357).
9. timsneath commented on Sep 21, 2020

   

   timsneath

   on Sep 21, 2020 via email

   ContributorAuthor

   More actions

   Thanks Danny! Devon, I agree that might be the steady-state, particularly for larger projects. But as with other CI journeys (build, test) that are accessible through DartCode, I suspect the typical pattern is: - Customer discovers that the feature exists (DartCode can help here) - Customer tries out the feature and gets it configured (DartCode can help here) - Some customers integrate it into CI Added to that, this feature can be confusing from the CLI -- the docs are conflicted about whether a user should pub global activate <https://pub.dev/packages/dartdoc/install> it or add the Dart SDK <https://pub.dev/packages/dartdoc> to their path. If we can make this easier, I'm delighted! Look forward to trying this out.

   …

   On Mon, Sep 21, 2020 at 8:33 AM Danny Tuppeny ***@***.***> wrote: Even if it's not used much, it was a good way to try out a task provider without disrupting the existing commands. We have a bunch things with a lot of custom code (things like pub get, pub upgrade, flutter doctor, flutter upgrade, etc.) that would be simpler as tasks (and get some benefit from running in the terminal, like clickable links for filenames and being able to press Ctrl+C for users to terminate - which might help sidestep things like flutter/flutter#61357 <flutter/flutter#61357>). — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#2807 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AARWL64UHOZ3GCYC26GHUOTSG5W25ANCNFSM4RTE6QWQ> .