Provide a changelog tab when this file is bundled in the package #12035
Conversation
|
Hi @XVincentX, I'm your friendly neighborhood Microsoft Pull Request Bot (You can call me MSBOT). Thanks for your contribution! The agreement was validated by Microsoft and real humans are currently evaluating your PR. TTYL, MSBOT; |
| } | ||
| } | ||
|
|
||
| private openReadme(extension: IExtension) { | ||
| return this.loadContents(() => this.extensionReadme.get() | ||
| private openMarkdown(extension: IExtension, content: TPromise<string>, noContentCopy: string) { |
There was a problem hiding this comment.
Given that readme and changelog are basically the same file, I've generalised the function so it can be used from both sides.
There was a problem hiding this comment.
Is it ok for you to get a non resolved Promise as parameter?
There was a problem hiding this comment.
Yeah perfect. We don't need that extension argument any way, right? I must've left it behind somehow. You can remove that.
There was a problem hiding this comment.
Probably so. I'll fix that.
|
Dude, that was FAST! I'll review it asap. |
| @@ -250,6 +254,7 @@ export class ExtensionEditor extends BaseEditor { | |||
| this.navbar.onChange(this.onNavbarChange.bind(this, extension), this, this.transientDisposables); | |||
| this.navbar.push(NavbarSection.Readme, localize('details', "Details")); | |||
| this.navbar.push(NavbarSection.Contributions, localize('contributions', "Contributions")); | |||
| this.navbar.push(NavbarSection.Changelog, localize('changelog', "Changelog")); | |||
There was a problem hiding this comment.
I'd like to show the Changelog section only if there is actually a Changelog to show.
You can add a hasChangelog(): boolean method to IExtension that will let you know this synchronously.
There was a problem hiding this comment.
Makes sense! Will fix!
There was a problem hiding this comment.
@joaomoreno
I was wondering...giving we're fundamentally trying to get the extension changelog and this value is cached thanks to Cache<string>, I'd avoid to add a new method and try to get and store the value as I made here: e0f529fb8157366c32c590c0380d7b0bd693e3e7
Let me know your thoughts!
There was a problem hiding this comment.
The problem is that the network request could be slow and you'd show the link some time later. Not to mention that you should then hook up a cancellation request to that, lest the user clicks on another extension; you wouldn't want that request to still be running, right?
The hasChangelog() method may appear ugly, but it's definitely a good solution.
There was a problem hiding this comment.
Makes sense, I didn't think that scenario.
Thanks for the clarification, I'll fix that!
There was a problem hiding this comment.
@joaomoreno
I'm a bit sad for that method, but that's the life!
Fixed in b98c3f7
There was a problem hiding this comment.
It pays off in the long run. 👍 I'll give the changes a try now.
|
Coverage increased (+0.04%) to 61.129% when pulling e0f529fb8157366c32c590c0380d7b0bd693e3e7 on XVincentX:master into fc54f4b on Microsoft:master. |
|
@joaomoreno Thanks! What's going to happen about remote file extension in the gallery? Can I do something about that? |
|
Sure, I've updated the first comment in #11940 with the next steps. |
The following PR is a clumsy way to implement #11940
Basically I've replicated the README logic as well trying to generalise it whenever possible.
I'd love to get your thoughts as well some hints about how to test this, eventually.
I put some notes in the code - I hope you might clarify those points.
//cc @joaomoreno