MORYLAB;

エンジニアの卵がソースコードやライフログを綴るブログ。

GitHubで.solファイルのシンタックスハイライトを有効にする

世の中には2種類のプロジェクトがある。 それは、GitHub上のSolidityファイルがシンタックスハイライトされるプロジェクトと、そうではないプロジェクトだ。
ー Keisuke Mory


...という茶番はさておき。

スマートコントラクトを設計するときに他のプロジェクトのGitHubを見て参考にしたりすることがあるんですが、シンタックスハイライトされない.solファイルをよむのはつらいです。

せめて自分が作るDappsではちゃんとシンタックスハイライトされるようにして、自分を含めてPRなどでコードを読む人がつらい思いをしないようにしたい。ということで、GitHubの.solファイルにシンタックスハイライトを適用する方法を調べてみました。


用意するもの

  • git
  • お好きなターミナル
  • vim
    宗教上の理由でvimを使えない方は他のでも大丈夫です。


やること

該当するプロジェクトに .gitattributes を作成します。

touch .gitattributes

中に以下の構文を記述します

*.sol linguist-language=Solidity

コミットしてプッシュします。

おわり


ひとこと

このあたりを参考にしました。

medium.com

github.com