開発環境の垣根を超えるLanguage Server Protocol入門 / Introduction to Language Server Protocol beyond the boundaries of the development environment

開発環境の垣根を超えるLanguage Server Protocol入門 / Introduction to Language Server Protocol beyond the boundaries of the development environment

PyCon Kyushu 2019
https://kyushu.pycon.jp/2019/

57f1ba678bdf29064f7f55c19f32cda5?s=128

Kashun Yoshida

May 18, 2019
Tweet

Transcript

  1. 開発環境の垣根 を超える Language Server Protocol 入門 @kashew_nuts

  2. • @kashew_nuts (Kashun Yoshida) • Software Developer • BeProud Inc.

    • Interest: Vim, PyCharm • Like: Climbing, PokemonGO 2 お前誰よ?/whoami?
  3. What's BeProud? • https://www.beproud.jp • 東京に本拠を置くPythonエンジニアリング会社 ◦ connpass: エンジニアをつなぐIT勉強会支援プラットフォー ム

    ◦ PyQ: Python学習用のオンラインプラットフォーム • フルリモートワーキング (5days/week) 3
  4. 発表の動機/目的 1.

  5. • どうしても好みのエディタを使いたい時があるが、そんなときでも定 番の開発ツールをいい感じに使いたい • 新しいプログラミング言語を使うのに、言語専用のプラグインを探 すのは(楽しいけど)面倒 • Language Serverを使うと開発ツールを統合して扱えるので知見 をまとめたい

    • 特定のIDEだけに依存せず開発できるようにしておきたい 5 発表の動機/目的
  6. • 最近LSP (Language Server Protocol) って聞くけど何?という人 • 好みのエディタで快適な開発環境を実現したい人 • 〇〇でいいじゃん、と思いつつも最近の開発環境事情を押さえて

    おきたい人 6 対象
  7. • LSP (Language Server Protocol) とLanguage Serverとの違い がわかる • LSPを活用できるようになる

    7 今日の目標
  8. • Language Server Protocol (LSP)とは何か • PythonのLSP実装 • LSPの導入方法 •

    PythonのLanguage Serverと連携するツール • LSPの未来と現状の課題 8 Agenda
  9. LSP(Language Server Protocol)と は何か 2.

  10. • LSP (Language Server Protocol) ◦ 各プログラミング言語の情報をJSON-RPC (Remote Procedure Call)

    経由で交換し、テキストエディタやIDEを拡張 するしくみ ◦ 2015年にMicrosoftが公開した仕様 (現在バージョン3系) • Language Server ◦ 仕様をもとに言語開発ツールを統合したもの 10 LSP(Language Server Protocol)とは
  11. • コード補完 • 定義ジャンプ • ドキュメントのホバー表示 • フォーマット • 参照先の検索

    • リネーム • etc... 11 言語開発ツールが提供するもの
  12. 12 エディタと言語サーバー通信例

  13. 13 JSON-RPC例

  14. LSP導入前と後 3.

  15. 15 LSP導入前 Python Golang Java TypeScript ... Vim Emacs VS

    Code Atom ... MxN: エディタx言語専用のプラグインが必要
  16. 16 LSP導入後 Python ✔ Golang ✔ Java ✔ TypeScript ✔

    ... Vim ✔ Emacs ✔ VS Code ✔ Atom ✔ ... M+N: 言語サーバー+クライアントがあればOK
  17. • ユーザ: 高品質な言語開発ツールの導入を簡潔化 • 言語コミュニティ: 開発リソースをLanguage Serverに集中し、高 品質な言語開発ツールを作れる • エディタ(プラグイン作成者):

    言語ごとに行っていたコード補完や定 義参照などの実装をLanguage Server Clientで一括で行えるの で、リソースを集中できる 17 得られる恩恵
  18. • Python, Golang, Bash, C/C++, C#, Java, Perl, Rubyなど有名な 約70言語のLanguage

    Serverがある • YAML, HTML, CSS, Dockerfileといった設定ファイルやマーク アップ言語向けのLanguage Serverもある 18 対応する言語
  19. PythonのLSP実装 4.

  20. • palantir/python-language-server ◦ pylsと略される ◦ Python 100%, 広く使われるLanguage Server •

    Microsoft/python-language-server ◦ mpylsと表記されることも ◦ C#:Python=7:3, 主にVS CodeのPython拡張で使用 20 PythonのLSP実装
  21. LSP導入方法 5.

  22. 22 LSPを活用するために ❖ Language Server Client ➢ エディタプラグインとしてインストール ❖ Language

    Server ➢ 言語ごとにインストール
  23. エディタごとにプラグインをインストール 23 Language Server Clientの準備 Vim vim-lsp, coc.nvim, LanguageClient-neovim, vim-lsc

    Emacs lsp-mode, eglot, emacs-lsp Atom atom-languageclient, acme-lsp Sublime Text lsp VS Code 各種言語プラグイン (Pythonなら vscode-python)
  24. $ pip install python-language-server[all] 24 Language Serverの準備

  25. 25 コード補完

  26. 26 エラーチェック (Linter)

  27. 27 関数/メソッドシグネチャの照会

  28. 28 定義参照

  29. 29 ホバー (インフォチップ)

  30. 30 参照先検索

  31. 31 ドキュメントシンボル

  32. 32 コード整形 (Formatter)

  33. • Jedi: コード補完、定義ジャンプ、ホバー表示、etc • Rope: コード補完、リネーム • Pyflakes, pycodestyle, McCabe:

    リンタ • Autopep8, YAPF, Black, Isort: フォーマッタ • mypy: 型チェッカー 33 pylsで扱う開発ツール群
  34. LSPの未来と 現状の課題 6.

  35. • 可能性は未知数 • フルセットの機能を提供 or 個々に特化した機能を提供 • LSPの仕様にまだないもの ◦ Syntax

    highlighting ◦ Run, Build, Test ◦ Debug: Debug Adapter Protocol 35 LSPの未来
  36. • Language Server Clientが群雄割拠でどれを使えばいいか迷う ◦ Vimだと最近は coc.nvim が熱い • Language

    Serverの実装によってWIPな機能がある ◦ LSP使ってるから全て解決、ではない • カラムの数え方が UTF-16 のコードポイント単位なので、マルチバ イト文字が入ると文字位置がずれる ◦ なぜ UTF-8 で統一していない... Issue ◦ UTF-16: 2バイトもしくは4バイト ◦ UTF-8: 1〜6バイトの可変長 36 現状の課題
  37. • Official page for Language Server Protocol ◦ Microsoft公式 ◦

    プロトコルの詳細や機能の把握に • Langserver.org ◦ Sourcegraphが管理するコミュニティベースのまとめサイト ◦ Language ServerやClientの対応状況の把握に 37 参考
  38. Enjoy your Edit Life!! 38