マークアップ言語のリンクを作成するVSCodeの拡張機能をTypeScriptで開発してみた
概要
Markdown などのマークアップ言語で Web ページへのリンクを作る場合、以下の手順で作ります。
- リンクを作る URL を決める。
- URL の Web ページを開く。
- 開いた Web ページから HTML のソースコードを表示する。
- title タグを検索して、タイトル文字列を選択、コピーする。
- 最初に決めた URL とコピーしたタイトル文字列でリンクを作る。
これらの手順+α に対応した VSCode の拡張機能を開発しました。+α とは以下の機能です。
- カーソル位置にある URL を選択する。
- タイトルの前後のサイト名などを削除する。
- URL に追加されているアクセス経路の集計などのためのフラグなどを削除する。
具体的な例で説明します。
たとえば、https://xtech.nikkei.com/atcl/nxt/column/18/00849/00081/?n_cid=nbpnxt_mled_itmh というページへのリンクを作るとします。まず、この URL を Markdown ファイルに書き込みます。次に書き込んだ URL の上にカーソルを移動して、コマンドパレットからMust: Select URLコマンドを実行すると、この URL が選択されます。
続いて、コマンドパレットからMust: Format Link from URLコマンドを実行すると、選択されている URL は以下の文字列に置き替えられます。
[「IE 終了でも IE モードで大丈夫」は本当か、ブラウザー移行の先送りで訪れる悲劇](https://xtech.nikkei.com/atcl/nxt/column/18/00849/00081/)
結果
+α 機能その 1: URL の選択
カーソルがある URL を選択します。
+α 機能その 2: URL の整形
この URL の?以降はなくても同じ web ページにアクセスできるようなので、リンクを作成する URL 文字列をhttps://xtech.nikkei.com/atcl/nxt/column/18/00849/00081/とします。
+α 機能その 3: タイトルの整形
この URL のソースコードを見て、<title></title>タグから、タイトルとして 「IE 終了でも IE モードで大丈夫」は本当か、ブラウザー移行の先送りで訪れる悲劇 | 日経クロステック（xTECH）を取り出せます。
タイトルの最後の | 日経クロステック（xTECH）はサイト名であり、リンクの見出しに含めないことにすると、リンクを作成するタイトル文字列は「IE終了でもIEモードで大丈夫」は本当か、ブラウザー移行の先送りで訪れる悲劇となります。
URL 文字列とタイトル文字列を組み合わせて、上記のリンクが作成できます。
リポジトリ
kubotama/must-vscode: markup language support tool of Visual Studio Code extension
導入環境
以下の環境であれば導入可能だと思います。Linux(Ubuntu 20.04.4 LTS)で開発および検証しています。
- node.js: V16.15.1
- VScode: 1.68.1
導入手順
- 上記 GitHub のリポジトリを適当なローカル環境にクローンします。
$ git clone git@github.com:kubotama/must-vscode.git
- 必要なパッケージをダウンロードします。
$ yarn
- 拡張機能のパッケージを作成します。
$ npx vsce package
- 作成されたパッケージをインストールします。拡張機能のサイドバーの右上のメニューから「VSIX からのインストール...」を選択して、作成されたパッケージファイル(must-vscode-X.Y.Z.vsix)をインストールします。
利用方法
-
Markdown ファイル(README.md など)でリンクを作成したい URL の上にカーソルを移動します。
-
コマンドパレットから
Must: Select URLコマンドを実行します。リンクを作成したい URL が選択されていることを確認します。URL と.(ピリオド)などが続いている場合には、あわせて選択されてしまいますので注意して下さい。 -
コマンドパレットから
Must: Format Link from URLコマンドを実行します。 -
選択されている URL がリンクに置き替えられます。
設定方法
settings.json などに設定が可能です。
- URL の正規表現
- 言語ごとのリンク形式の指定
- タイトル文字列のフォーマットの指定
- URL のフォーマットの指定
URL の正規表現 (must-vscode.urlRegex)
URL を選択するときの範囲を決める正規表現を指定します。デフォルトでは以下の正規表現が指定されています。
{
"description": "The regular expression of URL.",
"type": "string",
"default": "https?:\\/\\/[\\w\\/:%#\\$&\\?~\\.=\\+\\-]+"
}
言語ごとのリンク形式の指定 (must-vscode.linkFormats)
言語ごとにリンク形式を指定します。デフォルトでは Markdown のリンク形式が指定されています。
{
"languageId": "markdown",
"format": "[${title}](${url})"
}
languageId 属性は Visual Studio Code language identifiers で定義されている identifiers を指定します。format 属性で定義されている
たとえば以下の指定を追加すると、LaTeX ファイルで適切なリンクが作成できるようになります。
{
"languageId": "latex",
"format": "\\href{${url}}{${title}}"
}
タイトル文字列のフォーマットの指定 (must-vscode.titlePatterns)
タイトル文字列のフォーマットを指定します。デフォルトでは以下のサイトのタイトル文字列のフォーマットが指定されています。
- Qiita
- 日経クロステック
- GitHub
{
"url": "https://qiita.com/",
"pattern": "(.*) - Qiita",
"format": "$1"
},
{
"url": "https://xtech.nikkei.com/.*",
"pattern": "(.*) \\| 日経クロステック（xTECH）",
"format": "$1"
},
{
"url": "https://github.com/.*",
"pattern": "GitHub - (.*)",
"format": "$1"
}
url 属性と一致する web サイトのタイトル文字列のフォーマットを定義します。replace メソッドを第一引数を pattern 属性、第二引数を format 属性で呼び出して、タイトル文字列を置き替えます。
URL のフォーマットの指定 (must-vscode.urlPatterns)
URL のフォーマットを指定します。デフォルトでは以下のサイトの URL のフォーマットが指定されています。
-日経クロステック
{
"url": "(https://xtech.nikkei.com/.*)\\?.*",
"format": "$1"
}
url 属性と一致する web サイトの URL 文字列のフォーマットを定義します。replace メソッドを第一引数を url 属性、第二引数を format 属性でで呼び出して、URL 文字列を置き替えます。
プログラムの説明
1. コマンドを登録および設定します
settings.json にコマンドを登録します。command 属性にプログラムから呼び出されるコマンド文字列、title 属性にコマンドパレットに表示される文字列を設定します。
"activationEvents": [
"onCommand:must-vscode.urlToLink",
"onCommand:must-vscode.selectUrl"
],
"contributes": {
"commands": [
{
"command": "must-vscode.urlToLink",
"title": "Must: Format Link from URL"
},
{
"command": "must-vscode.selectUrl",
"title": "Must: Select URL"
}
],
...
}
コマンドが初めて実行されるタイミングで拡張機能をアクティブにするように設定します。
export const activate = (context: vscode.ExtensionContext) => {
const linkDisposable = vscode.commands.registerCommand(
"must-vscode.urlToLink",
...
const selectDisposable = vscode.commands.registerCommand(
"must-vscode.selectUrl",
...
2. 設定から URL の正規表現を取得します
const config = vscode.workspace.getConfiguration("must-vscode");
const urlRegex: string | undefined = config.get("urlRegex");
return urlRegex;
3. カーソルの位置にある URL の範囲を取得します
const selected = editor.document.getWordRangeAtPosition(
editor.selection.active,
new RegExp(urlRegex)
);
if (selected) {
editor.selection = new vscode.Selection(selected.start, selected.end);
}
4. アクティブなエディタの言語を取得します
import * as vscode from "vscode";
const editor = vscode.window.activeTextEditor;
const languageId = editor.document.languageId;
5. 設定からリンクのフォーマットを取得します
const config = vscode.workspace.getConfiguration("must-vscode");
const linkFormats: { languageId: string; format: string }[] | undefined =
config.get("linkFormats");
const linkFormat = linkFormats.find(
(linkFormat) => linkFormat.languageId === languageId
);
if (linkFormat) {
return linkFormat.format;
}
6. 選択されているテキスト(=URL)を取得します
const selection = editor.selection;
const selectedText = editor.document.getText(selection);
7. URL からタイトルを取得します
axios.get で取得した HTML コードを JSDOM に読み込ませて title 属性を取得します
const response = await axios.get(url);
const dom = new JSDOM(response.data);
const title = dom.window.document.title;
8. タイトルを整形します
titleInfo は、設定から取得したタイトルのフォーマットの配列です。URL に該当するタイトルのフォーマットが見つかれば、そのフォーマットに整形します。なければ、そのままとします。
const pattern = titleInfo.titlePatterns.find((pattern) => {
const reUrl = new RegExp(pattern.url);
return reUrl.test(titleInfo.url);
});
if (pattern) {
const rePattern = new RegExp(pattern.pattern);
return titleInfo.title.replace(rePattern, pattern.format);
}
9. URL を整形します
urlPatterns は、設定から取得した URL のフォーマットの配列です。URL に該当するフォーマットが見つかれば、そのフォーマットに整形します。なければ、そのままとします。
const urlPattern = urlPatterns.find((urlPattern) => {
const reUrl = new RegExp(urlPattern.url);
return reUrl.test(url);
});
if (urlPattern) {
const formatUrl = urlPattern.format;
const reUrl = new RegExp(urlPattern.url);
const displayUrl = url.replace(reUrl, formatUrl);
return displayUrl;
}
10. 言語ごとに定義されているフォーマットでリンクを作成します
const linkText = format
.replace("${title}", displayTitle)
.replace("${url}", url);
return linkText;
11. 作成したリンクで選択されているテキストを置き替えます
const editor = vscode.window.activeTextEditor;
if (editor) {
const selection = editor.selection;
const selectedText = editor.document.getText(selection);
if (selectedText) {
if (text) {
editor.edit((editBuilder) => {
editBuilder.replace(selection, text);
});
}
}
}
まとめ
URL からリンクを作成するという単純な作業を VSCode の拡張機能に任せることができるようになりました。この記事を書くときにも、何度かリンクを作成するときに利用しています。
Discussion