-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature: show Metals' release notes directly in vscode
- Loading branch information
Showing
4 changed files
with
242 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| import { env, ExtensionContext } from "vscode"; | ||
| import * as vscode from "vscode"; | ||
| import * as semver from "semver"; | ||
| import { Remarkable } from "remarkable"; | ||
| import http from "https"; | ||
|
|
||
| const versionKey = "metals-server-version"; | ||
|
|
||
| // prettier-ignore | ||
| const releaseNotesMarkdownUrl: Record<string, string> = { | ||
| "0.11.5": "https://raw.githubusercontent.com/scalameta/metals/main/website/blog/2022-04-28-aluminium.md", | ||
| "0.11.6": "https://raw.githubusercontent.com/scalameta/metals/main/website/blog/2022-06-03-aluminium.md", | ||
| }; | ||
|
|
||
| /** | ||
| * Show release notes if possible, swallow errors since its not a crucial feature. | ||
| * Treats snapshot versions like 0.11.6+67-926ec9a3-SNAPSHOT as a 0.11.6. | ||
| */ | ||
| export async function showReleaseNotesIfNeeded( | ||
| context: ExtensionContext, | ||
| serverVersion: string, | ||
| outputChannel: vscode.OutputChannel | ||
| ) { | ||
| try { | ||
| await showReleaseNotes(context, serverVersion); | ||
| } catch (error) { | ||
| outputChannel.appendLine( | ||
| `Couldn't show release notes for Metals ${serverVersion}` | ||
| ); | ||
| outputChannel.appendLine(`${error}`); | ||
| } | ||
| } | ||
|
|
||
| async function showReleaseNotes( | ||
| context: ExtensionContext, | ||
| currentVersion: string | ||
| ): Promise<void> { | ||
| const state = context.globalState; | ||
|
|
||
| const version = getVersion(); | ||
| const releaseNotesUrl = version | ||
| ? releaseNotesMarkdownUrl[version] | ||
| : undefined; | ||
| if (isNotRemote() && version && releaseNotesUrl) { | ||
| await showPanel(version, releaseNotesUrl); | ||
| } | ||
|
|
||
| async function showPanel(version: string, releaseNotesUrl: string) { | ||
| const releaseNotes = await getReleaseNotesMarkdown(releaseNotesUrl); | ||
|
|
||
| if (typeof releaseNotes === "string") { | ||
| const panel = vscode.window.createWebviewPanel( | ||
| `scalameta.metals.whatsNew`, | ||
| `Metals ${version} release notes`, | ||
| vscode.ViewColumn.One | ||
| ); | ||
|
|
||
| panel.webview.html = releaseNotes; | ||
| panel.reveal(); | ||
|
|
||
| // set wrong value for local development | ||
| // const newVersion = "0.11.5"; | ||
|
|
||
| const newVersion = version; | ||
|
|
||
| // Update current device's latest server version when there's no value or it was a older one. | ||
| // Then sync this value across other devices. | ||
| state.update(versionKey, newVersion); | ||
| state.setKeysForSync([versionKey]); | ||
|
|
||
| context.subscriptions.push(panel); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Don't show panel for remote environment because it installs extension on every time. | ||
| * TODO: what about wsl? | ||
| */ | ||
| function isNotRemote(): boolean { | ||
| const isNotRemote = env.remoteName == null; | ||
| // const isWsl = env.remoteName === "wsl"; | ||
| return isNotRemote; | ||
| } | ||
|
|
||
| /** | ||
| * Return version for which release notes should be displayed | ||
| * or | ||
| * undefined if notes shouldn't be displayed | ||
| */ | ||
| function getVersion(): string | undefined { | ||
| const previousVersion: string | undefined = state.get(versionKey); | ||
| // strip version to 'major.minor.patch' | ||
| const cleanVersion = semver.clean(currentVersion); | ||
| if (cleanVersion) { | ||
| if (previousVersion) { | ||
| const compare = semver.compare(cleanVersion, previousVersion); | ||
| const diff = semver.diff(cleanVersion, previousVersion); | ||
|
|
||
| // take into account only major, minor and patch, ignore snapshot releases | ||
| const isNewerVersion = | ||
| compare === 1 && | ||
| (diff === "major" || diff === "minor" || diff === "patch"); | ||
|
|
||
| return isNewerVersion ? cleanVersion : undefined; | ||
| } | ||
|
|
||
| // if there was no previous version then show release notes for current cleaned version | ||
| return currentVersion; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| async function getReleaseNotesMarkdown( | ||
| releaseNotesUrl: string | ||
| ): Promise<string | { error: unknown }> { | ||
| const ps = new Promise<string>((resolve, reject) => { | ||
| http.get(releaseNotesUrl, (resp) => { | ||
| let body = ""; | ||
| resp.on("data", (chunk) => (body += chunk)); | ||
| resp.on("end", () => resolve(body)); | ||
| resp.on("error", (e) => reject(e)); | ||
| }); | ||
| }); | ||
|
|
||
| const text = await ps; | ||
| // every release notes starts with that | ||
| const beginning = "We're happy to announce the release of"; | ||
| const notesStartIdx = text.indexOf(beginning); | ||
| const releaseNotes = text.substring(notesStartIdx); | ||
|
|
||
| // cut metadata yaml from release notes, it start with --- and ends with --- | ||
| const metadata = text | ||
| .substring(0, notesStartIdx - 1) | ||
| .replace("---", "") | ||
| .replace("---", "") | ||
| .trim() | ||
| .split("\n"); | ||
| const author = metadata[0].slice("author: ".length); | ||
| const title = metadata[1].slice("title: ".length); | ||
| const authorUrl = metadata[2].slice("authorURL: ".length); | ||
|
|
||
| const md = new Remarkable({ html: true }); | ||
| const renderedNotes = md.render(releaseNotes); | ||
|
|
||
| const notes = getHtmlContent(renderedNotes, author, title, authorUrl); | ||
| return notes; | ||
| } | ||
|
|
||
| function getHtmlContent( | ||
| renderedNotes: string, | ||
| author: string, | ||
| title: string, | ||
| authorURL: string | ||
| ): string { | ||
| return ` | ||
| <!DOCTYPE html> | ||
| <html lang="en" style="height: 100%; width: 100%;"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| </head> | ||
| <body> | ||
| <h1>${title}</h1> | ||
| <hr> | ||
| <p> | ||
| Showing Metals' release notes embedded in vscode is an experimental feature, in case of any issues report them at | ||
| <a href="https://github.com/scalameta/metals-vscode">https://github.com/scalameta/metals-vscode</a>. | ||
| </p> | ||
| <hr> | ||
| <p> | ||
| <a href="${authorURL}" target="_blank" itemprop="url"> | ||
| <span itemprop="name">${author}</span> | ||
| </a> | ||
| </p> | ||
| <hr> | ||
| ${renderedNotes} | ||
| </body> | ||
| </html> | ||
| `; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters