Dartを支えるツール
先日、私は当ブログで「プログラミング言語Dartの紹介」という記事を書きました。
今回は、そのDartによる開発を支えるDart公式のツールを紹介いたします。
Dartのツールに関する内容は、Dartのバージョン1.4.2にて確認しています。
Dart Editor
まずは基本のDart Editorです。こちらはDart開発向けのIDEで、Eclipseベースで開発されています。
依存パッケージ管理や補完機能、DartSDKの更新など便利な機能を利用することができます。
今回、このDart Editorの詳しい機能についての紹介はせず、以下より、このDart Editorのバックグラウンドで動いているツールにスポットを当ててみます。
pub
pubは、Dartのプロジェクトローカルでのパッケージ管理に関する操作を行います。
Dartでは、作成するプロジェクトも1つのパッケージとして管理され、その開発を行うパッケージや依存するパッケージの管理を行うツールとして、利用される頻度が高いツールです。
DartSDKに対してパスが通った環境であれば、コマンドラインからpubを利用することができ、サブコマンドを指定することで、各種機能を利用することが出来ます。
pubの詳細な仕様に関しては Pub Package and Asset Manager にて確認できます。
pubが持っているサブコマンドの代表的な機能を以下に簡単に紹介します。
pub build
現行のパッケージをビルドします。
Dartのプログラムを直接DartVMで動かす場合や、Dartiumで動かす場合はこの作業は必要なく、DartのプログラムをJavaScriptに変換し、現行のWebブラウザで動かすものを作りたい場合に、この作業が必要になります。
pub get
現行のパッケージが依存しているパッケージをダウンロードします。
依存するパッケージに関する情報は、pubspec.yamlというYAML形式のファイルに記述します。
|
1 2 3 4 5 6 |
# pubspec.yamlの例 name: sample_package_name dependencies: browser: any path: any |
依存するパッケージは、pub.dartlang.org にアップロードされているパッケージや、ローカルに存在するライブラリを指定することが出来ます。
pubspec.yamlのフォーマットの仕様に関しては Pubspec Format にて確認することができます。
pub publish
現行のパッケージを pub.dartlang.org にアップロードします。
pub serve
ローカルでWebサーバーを立ち上げWebアプリケーションの動作テストが可能になります。
dartanalyzer
dartanalyzerはDartのコードの静的な解析を行います。Dartの言語仕様に基いて、エラーや警告を確認することができます。
|
1 2 |
dartanalyzer sample.dart |
このようにDartのソースコードのファイルを指定し実行すると、解析の結果が出力されます。
dartanalyzerの詳細については dartanalyzer: The Static Analyzer from Dart: Up and Running で確認することができます。
dartfmt
dartfmtはDartのコードフォーマッターで、Dart Style Guide に沿ってコードの整形を行います。
|
1 2 |
dartfmt sample.dart |
このようにDartのソースコードのファイルを指定すると、整形された結果が出力されるだけなのですが、
|
1 2 |
dartfmt -w sample.dart |
このように-wオプションをつけると、元のソースコードのファイルに整形された結果が上書き保存されます。
dartfmtに関する詳細は dartfmt: The Dart Code Formatter で確認することができます。
docgen
docgenはDartのソースコードからドキュメントを生成します。
|
1 2 |
docgen . |
このように、Dartのソースコードがあるディレクトリを指定すると、dartdoc-viewer というドキュメント閲覧用サーバー向けのJSONファイルが生成されます。
|
1 2 |
docgen --serve . |
このように --serve オプションをつけることで、ローカルでドキュメント閲覧用のサーバーが立ち上がります。
ドキュメント向けのコメントの記述方法については Guidelines for Dart Doc Comments | Dart こちらにガイドラインとしてまとめられています。
docgenに関する詳細は docgen: The API Documentation Generator で確認することができます。
また、pub.dartlang.org にアップロードしたライブラリは、自動でdocgenによるドキュメント生成が行われ、dartdocs.org で確認できるようになります。
まとめ
このように、Dartは開発を支えるためのツールが充実しており、その恩恵を多く受けることができます。
冒頭でも紹介したように、今回紹介したツールはDart Editorのバックグラウンドで動いているものですので、Dart EditorではGUIによってさらに直感的に各種機能を利用することができます。
Dart Editorを使う場合でも、今回紹介したツールがバックグラウンドで動いていることを意識することで、問題が起きた時に細やかな対処ができるようになると思います。
Dartによる開発を行う場合は、ぜひツールを活用しましょう。
※アイキャッチの画像は https://www.dartlang.org/logos/ こちらで配布されている画像をCC BY 3.0のライセンスに基づき利用させていただきました。
