Kotlin の ReadMe.md を訳してみた #ktac2014

Kotlin Advent Calendar 2014 の 12 日目です。

JetBrains/kotlin の ReadMe.md を訳してみました。

プログラミング言語 Kotlin

ようこそ Kotlin へ ! 関連するリンク :

• Kotlin Site
• Getting Started Guide
• Web Demo
• API
• Issue Tracker
• Forum
• Kotlin Blog
• Follow Kotlin on Twitter
• TeamCity CI build

Kotlin を書く

• Kotlin IntelliJ IDEA Plugin
• Kotlin TextMate Bundle

ビルド

このプロジェクトをビルドするには、まず下記のコマンドを実行します (Apache Ant 1.8 以上) :

ant -f update_dependencies.xml

すると、下記がセットアップされます。

• intellij-core: コマンドラインのコンパイラの一部で、必要な API を含みます。
• idea-full: IntelliJ IDEA Community Edition に使われるプラグインです。

そして、下記のコマンドを実行します。

ant -f build.xml

すると、dist ディレクトリにコンパイラのバイナリが作成されます。 ヒープサイズを増やしたい場合は
ANT_OPTS の heap size を利用してください。

オプション : Maven ディストリビューションを別に構築する場合は下記のコマンドを実行してください。

mvn package

コンパイラのビルド後、'libraries' ディレクトリとは別に構築します。詳細は `libraries/ReadMe.md' を参照してください。

IntelliJ IDEA でこのプロジェクトを編集する

root kotlin project の IntelliJ IDEA 用のプロジェクトはすでに用意されています。これを IntelliJ IDEA で開いてください。

プロジェクト SDK を File -> Project Structure -> Project で設定する必要があります。
tools.jar を File -> Project Structure -> SDKs -> -> Classpath から SDK に追加し、
JDK の lib ディレクトリから tools.jar を選択してください。

Android が不要な場合は Android プラグインを無効にしてください。

Kotlin プロジェクトが Kotlin 自体で書かれているコードを含むので、IntelliJ IDEA でプロジェクトを構築するためには Kotlin プラグインが必要です。
他のチームと同じプラグインのバージョンに保つため、Continuous Integration server と同期してください。
下の指示 に従ってインストールしてください。

Kotlin プラグインを含んだ IntelliJ IDEA とは別に Kotlin プラグインを除いた IntelliJ IDEA をインストールしたい場合は、このドキュメントを読んでください。
複数の IntelliJ IDEA をインストールする方法が記載されています。

このプロジェクトから IDEA やコンパイラのテストを実行/デバッグできます。IDEA プラグインを試したいなら、

• VCS -> Git -> Pull
• Run IntelliJ IDEA
• Kotlin プラグインを含んだ Intelli J IDEA が起動します。
• Kotlin ライブラリプロジェクトなどを開けるようになっています。

IntelliJ IDEA で既にビルド済みの Kotlin プラグインを使う

Kotlin プラグインを入手する方法はいくつかあります。安定版は、他のプラグインのように IntelliJ IDEA のプラグインから入手できます。

Preferences -> Plugins -> Install JetBrains plugin... -> "Kotlin"で検索する

最新版は IDEA Plugin and Tests CI build からダウンロードできます。
ダウンロードしたら "Install plugin from disk..." でインストールします。

Preferences -> Plugins -> Install plugin from disk...

これで Kotlin ベースのプロジェクトを開けるようになります。

コントリビュータの注: もし Kotlin プロジェクトに貢献するつもりなら、ローカルにビルドサーバが利用している同じバージョンのプラグインがほしくなるでしょう。
このプラグインのバージョンは絶えず更新されています。プラグインを常に更新したいなら、IntelliJ IDEA へ通知させるのが最適です。

リポジトリの設定を開き、

Preferences -> Plugins -> Browse Repositories -> Manage Repositories...

下記の URL をリポジトリに追加しましよう。

https://teamcity.jetbrains.com/guestAuth/repository/download/bt345/bootstrap.tcbuildtag/updatePlugins.xml

そして、"Browse Repositories"でプラグインのリストを更新してください。そこにある 2 つのバージョンを見て、より高いバージョンのプラグインをインストールします。

貢献する

我々はコントリビュータを歓迎します！ Kotlin や標準ライブラリでたくさんの問題があります。あなたが興味を持っていることについてフォーラムで話しませんか？

もし軽めの問題から始めたいなら、"up-for-grabs" タグのついた問題を探しましょう。

問題にアサインできるのはコミッターだけです。もしその問題に着手しているならコメントを加えましょう。

上手に貢献する方法は API ドキュメントをチェックすることです。ドキュメント化されていないクラスやメソッドがあったらパッチを送りましょう。

特に、すべての機能において、例えば Collection の filter() のような、よい使い方の例が含まれていると素晴らしいです。これは、テスト機能からコードを含むために @inludeFunctionBody マクロを利用して実行されます。これにより、ユーザには素晴らしい API の例を、コードはテストカバレッジを得ることができます。

また、JavaScript 変換が助けになるでしょう。詳細は JavaScript 変換 を確認してください。

コンパイラに貢献する

Kotlin のコンパイラは Java と Kotlin で書かれています(純粋な Kotlin に徐々に移行しています) 。最も簡単に着手するには、

• クリーンな IDEA 14 EAP build をダウンロードする
• Kotlin プラグインをインストールする
• root kotlin project を IDEA で開く(Kotlin ディレクトリを開く)

実行/デバッグの設定で下記を起動できます。

• IDEA
• コンパイラのすべてのテスト
• IDEA プラグインのすべてのテスト

Kotlin ライブラリに貢献する

• クリーンな IDEA 14 EAP build をダウンロードする
• Kotlin プラグインをインストールする
• kotlin ライブラリプロジェクトを開く

そして、下記でビルドします。

cd libraries
mvn install

標準ライブラリの一部はテンプレートからコードを生成します。既存のテンプレートからコードがどのように生成されるか、stdlib の README を確認してください。

パッチを送る

パッチを送る最適な方法は github のプロジェクトを fork して、github から pull request することです。

fork した場合、rebase してから pull すると、あなたのローカルのリポジトリに多くのマージがコミットされることを避けられ、あなたの pull request をシンプルで簡潔に保ちます。

コミットコメント

コミットコメントに下記を含めると、Issue Tracker の KT-1234 が自動的に解決のステータスになります。

#KT-1234 Fixed