rdflintのvscode拡張の紹介とその実装方法

takemikamiʼs note ‒ http://takemikami.com/
rdflintのvscode拡張の紹介とその実装⽅法
RDF language support via rdflint について
Copyright (C) Takeshi Mikami. All rights reserved. 1
三上威 - @takemikami
アーリース情報技術株式会社代表取締役社⻑
VS Code Meetup #14 - 拡張機能作る、作った編
2021.8.30 @online

はじめに
• テーマ
rdflintのvscode拡張の紹介とその実装⽅法
• 内容
• rdflintとvscode拡張の紹介
• rdflintのvscode拡張の実装⽅法
本LTで紹介する内容を説明します
RDF language support via rdflint
https://marketplace.visualstudio.com/items?itemName=takemikami.vscode-rdflint

⾃⼰紹介業務と経歴
• 三上威 (@takemikami)
• データエンジニア・サイエンティスト
• 分析・予測モデル開発・基盤構築 etc
• 対象: マーケティングデータ etc
• 略歴
• 甲南⼤学理学部応⽤数学科卒
• EC, CRM等のシステム構築 @ NEC系SIer
• ECサイトのマーケティングデータ分析 @ DeNA
• データ分析・予測モデル開発・基盤構築 @アーリース情報技術(株)
発表者のプロフィールを紹介します
※フリーランスの法⼈成り

⾃⼰紹介開発プロダクト/技術同⼈誌
• 開発プロダクト @GitHub
• rdflint
• RDFデータのチェックツール
• https://github.com/imas/rdflint
• digdag-plugin-shresult
• ワークフローエンジン「Digdag」のプラグイン
• シェルスクリプトの標準出⼒を変数に格納するオペレータ
• https://github.com/takemikami/digdag-plugin-shresult
• 技術同⼈誌 @Booth/技術書典
• Apache Airflow ワークフロープログラミング⼊⾨
• Apache Spark ビッグデータクエリチューニング
• Apache Hadoop & Spark ビッグデータプログラミング⼊⾨
発表者が作成したプロダクト/執筆した同⼈誌を紹介します
https://takemikami.booth.pm/

rdflintとvscode拡張の紹介

rdflintとは
• 次のチェックが⾃動化出来る
• XML/RDF、Turtle(ttl)ファイルの⽂法チェック
• 未定義の主語が、⽬的語として使われていないかのチェック
• SHACLによるデータ制約に違反していないかチェック
• GitHubでCIを⽤いたデータチェック運⽤にも利⽤可能
rdflintについて説明します
RDFデータの⾃動検査ツール
リポジトリ → https://github.com/imas/rdflint
※RDF(Resource Description Framework): Linked Open Data を記述するための枠組み

RDFデータの作成プロセス
• rdflintによるRDFデータの作成プロセスの違いを⽰す
RDFデータの作成プロセス(rdflint有無)を説明します
XML
Turtle
fuseki
等 XML
Turtle
rdflint
ロード
データ作成データ作成
クエリ実⾏
(SPARQL)
クエリ実⾏
(SPARQL)
ロード
⾃動検査
サーバ構築・データロードの⼿間と知識が必要 →確認作業が簡単できるチェックツールの整備
rdflintがある場合
rdflintが無い場合

rdflintのvscode拡張基本機能
• vscode拡張で、
データ作成の各作業を
vscode内で完結出来る。
• データの作成
• リロード指⽰
• ⾃動チェック実⾏
• クエリ実⾏
rdflintのvscode拡張の基本機能を紹介します
データの作成
リロード指⽰
⾃動チェック実⾏
クエリ実⾏

rdflintのvscode拡張 LanguageServer連携機能(Experimental)
• rdflintのLanguage Server機能で
指摘事項をvscodeに連携出来る。
• 右図では次を指摘
• リテラル末尾に空⽂字がある
• 年齢が負の値
rdflintのvscode拡張のLanguageServer連携機能を⽰します

rdflintのvscode拡張の実装⽅法

TerminalでREPLを動かす実装
• package.jsonにコマンドを定義
• extension.jsにコマンドの処理を実装
TerminalでREPLを動かす場合の実装⽅法を⽰します
"commands": [
{
"command": "rdflint.interactiveMode",
"title": "rdflint interactiveMode: SPARQL playground"
}
],
// rdflint interactive mode startup command
let disposable = vscode.commands.registerCommand('rdflint.interactiveMode', () => {
※省略※
let terminal = vscode.window.createTerminal(`rdflint`, javaHome + javaExe, ['-jar', '' + jar, '-i']);
terminal.show(true);
※省略※
});
context.subscriptions.push(disposable);
Ctrl+Shift+Pメニューに追加
createTerminalでrdflint(Java)を実⾏
commandに処理を登録

LanguageClientの利⽤部分実装 1/2
• package.jsonに対象⾔語を定義
• package.jsonに対象⾔語と拡張⼦の対応を定義
LanguageClientの利⽤部分の実装⽅法を⽰します
"activationEvents": [
"onLanguage:turtle",
"onLanguage:rdfxml"
],
"languages": [
{
"id": "rdfxml",
"extensions": [
".rdf"
],
※省略※
},
※省略※
],
rdfxml, turtle形式の時に拡張を利⽤

LanguageClientの利⽤部分実装 2/2
• extension.jsでLanguage Serverとクライアントを起動
LanguageClientの利⽤部分の実装⽅法を⽰します
let serverOptions: Executable = {
command: javaHome + javaExe,
args: ['-jar', '' + jar, '-ls']
};
let clientOptions: LanguageClientOptions = {
documentSelector: [
{ scheme: 'file', language: 'turtle' },
{ scheme: 'file', language: 'rdfxml' }
]
};
client = new LanguageClient(
'rdflintLanguageServerExperimental',
'RdfLint Language Server',
serverOptions,
clientOptions
);
client.start();
rdfxml, turtle形式の時にLanguageClientを利⽤
LanguageServerの実⾏
(rdflintを-lsオプション付きで起動)
LanguageClientを開始
(同時にLanguageServerも実⾏される)

まとめ
• RDFデータ作成プロセスに課題がある
• 確認作業（サーバを⽴ち上げて、データをロード）に⼿間と知識が必要
• RDFデータ作成プロセスの課題をrdflintで軽減した
• rdflintによって確認作業を簡単にできるようにした
• vscode拡張によって作成〜チェックをvscode内で完結できるようにした
• TerminalでREPLを動かすくらいのvscode拡張は簡単に作成できる
• ⼀連の作業をvscode内で完結させるには簡単な⼿段
本LTのまとめです

rdflintのvscode拡張の紹介とその実装方法

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (20)

Ähnlich wie rdflintのvscode拡張の紹介とその実装方法

Ähnlich wie rdflintのvscode拡張の紹介とその実装方法 (20)

Mehr von Takeshi Mikami

Mehr von Takeshi Mikami (20)

rdflintのvscode拡張の紹介とその実装方法