GitHubのgistについてまとめています。
目次
Gistは、コードの共有サービス 便利なスニペットが多数公開されている
GithubのGistではユーザが共有している便利にスニペット（コードの断片）を検索して調べることができるんですね。検索もスニペットコードの公開も無料で可能です。
例えば、検索ワードを「while loop」、言語をPython、C++、bash、Javaで検索してみましょう。
使い回しに便利そうなスニペットコードが大量に見つかります。以下は、PythonのWhileループスニペットです。nに指定した数だけループし、ループごとにnの値を表示、ループが終了したら「Blastoff!」と表示するシンプルなものです。
n = 5
while n > 0:
print(n)
n = n - 1
print('Blastoff!')
引用：[while] statement #while #loops
「Pythonのwhileって、文法どうだったかな…」というときに使えば、ネットで検索するよりも簡単にサンプルコードが入手できそうですね。なお、共有されたスニペットには「Star」（いいね、のようなもの）による評価ができるので、なるべくStar評価が多いものを探すと良いでしょう。
以下は、C++のWhileループスニペットです。
#include <iostream>
#include <string>
using namespace std;
int main () {
//Good
string input;
do {
cout << "Enter foo: ";
cin >> input;
} while (input.compare("foo"));
//Okay
cout << "Enter bar: ";
cin >> input;
while (input.compare("bar")) {
cout << "Enter bar: ";
cin >> input;
}
//Bad
while (true) {
cout << "Enter baz: ";
cin >> input;
if (!input.compare("bar")) { break; }
}
}
引用：While loop type comparisons
do～whileとwhileループのサンプルです。そのままコンパイル・実行できるコードなので、C++初心者の学習に役立ちそうです。
以下は、bashのWhileループスニペットです。
#!/bin/bash X=0 while [ $X -le 20 ] do echo $X X=$((X+1)) done
引用：[while loop] while loop in bash #shell #while
bashは、初見だと文法エラーの位置が見つけにくい言語です。スペースが入っているだけでもエラーになるケースもあります。そんなときにgistでサンプルコードを探し出し、そのまま実行してみたり、少し変更して実行してみたりすれば、文法エラーの原因究明にも役立つかも知れません。
以下は、JavaのWhileループスニペットです。
//1
int number = 0;
while (number != 5) {
number++
}
//2
int anotherNumber = 0;
do {
number++;
} while (number !=5)
System.out.println(number == anotherNumber); //true
// 1 and 2 are equal at the end and in this case both loops have exactly the same behaviour
whileとdo whileが同じ動きをするように記述されたサンプルです。
なお、公開されたスニペットは開発物にコピペして使ったりしても良いのでしょうか？数行のサンプルコードならまだしも、長めのコードだと後からライセンス違反などの問題が出てくると困ってしまいますよね。
基本的には、gistでライセンスを主張しているコードはあまり見かけないのですがLICENSEに関する記述があるかどうかはチェックしておいた方が無難でしょう。
関連）Gistのコードのライセンスはどう扱えば良いのか考えてみました
gistをgit cloneで複製する
gistはリポジトリ形式なので、git cloneやforkなどのリポジトリ操作が可能です。
【関連記事】
▶GitHubのforkはリポジトリの複製 フォークの手順と、クローン、ブランチとの違い
以下は、git cloneで公開されたスニペットのURLを指定してローカルに複製した例です。
$ git clone https://gist.github.com/wrfOxobz/77580358be7a61e2f557340a846a416f
Cloning into '77580358be7a61e2f557340a846a416f'...
remote: Enumerating objects: 3, done.
remote: Total 3 (delta 0), reused 0 (delta 0), pack-reused 3
Unpacking objects: 100% (3/3), done.
kabuki@ubuntu:~/work/github$ ls
77580358be7a61e2f557340a846a416f
$ cd 77580358be7a61e2f557340a846a416f/
$ ls
whileloop.py
$ cat whileloop.py
j = 0 #nilai awal j =0
while j<6: #ketika j kurang dari 6 lakukan perulangan, jika tidak stop perulangan
print("Ini adalah perulangan ke -",j) #lakukan perintah ini ketika perulangan
j=j+1 #setiap kali diakhir perulangan update nilai dengan ditambah 1
生成されるディレクトリがハッシュ値のような文字列なのでわかりにくいのですが、スニペットがローカルにコピーされました。
gistのコードをブログなどで共有する
gistには、ブログなどへのコード埋め込み機能があります。gistでコードを表示し、Embedの欄に表示されるコードを貼り付ければ良いんですね。
しかし、実際にはscriptタグ貼り付けがOKなブログはほとんどなく、あまり使われていないのが現状のようです。embedの文字列は以下のような形式になります。
<script src="https://gist.github.com/username1/404c3dff7bb54b11e5ef1d3ca257858e.js"></script>
GitHubのGistのまとめ
- GitHubのGistはスニペットコードを共有するサービス
- Gistはリポジトリ形式のためcloneやforkなどのリポジトリ操作が可能
- Gistにはブログ埋め込み機能があるが、scriptタグ形式のためかあまり利用されていない
