Liskテンプレートのためのブートストラップ・スクリプト
Lisk(リスク)はオープンソースのブロックチェーンプロジェクトです。ブロックチェーン技術の仕事で一番優先度が高いのはセキュリティです。そしてオープンソースプロジェクトの場合は、開発者が社内メンバーであってもコミュニティメンバーであっても、できるだけ簡単に良いコードを書けるようにしてあげたいと思うでしょう。
この、セキュリティと容易なコーディングという、両方の目標を心に留めておきながら、私たちは常にコード標準を改良しようとしています。Liskエコシステム全体にわたる標準を改良し統合するための専用のリポジトリであるLiskテンプレートを、コミュニティの皆様に紹介できることを嬉しく思います。
標準を取りまとめる
Liskテンプレートリポジトリの主な目的は標準に取り入れるものを調整することです。このリポジトリは次のもので構成されます。
- デフォルトのディレクトリ構造とファイル構造
- デフォルトのpackage.jsonファイル。プロジェクトの情報、npmスクリプト、ESLint設定のような基本的な依存関係が記載される
- 各種ツールのための設定ファイル。上記の依存関係が記載される
- テストセットアップのスケルトン。必要に応じてMocha BDDパッケージと一緒に使うこともできる
- 基本的なドキュメントファイル。通常の優先ライセンスが含まれる
プロジェクト向けのREADME.mdには、ここで収集した多数の標準の情報を記載します。
ここでご紹介する標準はそのほとんどが、Liskエコシステムのさまざまなプロジェクトで私たちが従ってきた慣例から導かれたものです。Lisk Commander(かつてのLisky)やLisk Elements(かつてのLisk JS)はコードベースが比較的小さいので、新たに作ったコード標準や検討中のツールのテスト環境として使われることがよくあります。
一旦このようにテストして新たな標準が気に入れば、Liskテンプレートに追加して、適切な時期に他のLiskプロジェクトにも新たなコード標準を展開できるようになります(プロジェクト固有の独自性があることは避けられないため、与えられた標準が各プロジェクトには意味を成さない可能性があります)。
私たちは標準についての議論を促したいと考えており、Liskのコード標準を改良するアイディアや、使うべきツールを持っている人がLiskテンプレートリポジトリに関する課題を挙げるよう働きかけていきます。
新たなプロジェクトを自力で立ち上げる
Liskテンプレートの主要な事例としては他に、新たなプロジェクトを自力で立ち上げるというものがあります。Liskテンプレートのリポジトリには既に依存関係や設定の一覧が含まれているので、新たなプロジェクトを始めるには理想的です。新たなプロジェクトを初期化するのに役立つ便利なスクリプトを掲載します。完全な説明はこちらにありますが、以下のコマンドのようにご自分のGithubのユーザ名と新しく作るプロジェクトの名前を指定して、必要最小限のスケルトンをカスタマイズして作ることもできます。
curl --silent --user my-github-username "https://raw.githubusercontent.com/LiskHQ/lisk-template/master/bin/bootstrap.sh" | bash -ls my-fresh-lisk-project
新しいLiskプロジェクトをブートしましょう!
私たちは既にLisk HQでこのスクリプトを使ってMocha BDDリポジトリを作成しており、まっさらなプロジェクトを開始するのに使う予定です(言うまでもないことですが、パッケージ情報やライセンスの細目はご自分のプロジェクトに合わせて書き換える必要があります)。
深く関わる
誰もがブロックチェーン技術にアクセスできるようにする、というLiskの使命の一環として、私たちは開発者ができるだけ容易に分散型アプリケーションを作れるようにしたいと考えています。そのため、そのようなアプリケーションを構築するプラットフォームだけでなく開発時に利用できるツールも提供していきます。
コミュニティのメンバーがLiskテンプレートのブートストラップスクリプトを使って新たなプロジェクトを始めるのは私たちの喜びでもあります。人々が後々サイドチェーンを作成するのに役立つという点で、どのようなご意見も非常に有益なものになります。
Lisk標準を改良するアイディアがあれば、課題として挙げるか、Liskテンプレートリポジトリに関する議論に参加してみてください。
あなたも是非ブートストラップしてみましょう!