<h2 id="%E6%A6%82%E8%A6%81" data-line="0" class="code-line">
<a class="header-anchor-link" href="#%E6%A6%82%E8%A6%81" aria-hidden="true"></a> 概要</h2>
調べ物をしているとフレームワークやライブラリのソースコードが手元に欲しくなるときがあります。 
そんなときにリポジトリを丸ごと<code>clone</code>したり<code>checkout</code>するのではなく、特定の部分に絞ることで時間とディスクを節約したいというのが本記事の趣旨です。
<h2 id="%E9%83%A8%E5%88%86%E7%9A%84%E3%81%ABclone%E3%81%99%E3%82%8B" data-line="5" class="code-line">
<a class="header-anchor-link" href="#%E9%83%A8%E5%88%86%E7%9A%84%E3%81%ABclone%E3%81%99%E3%82%8B" aria-hidden="true"></a> 部分的にcloneする</h2>
<code>git clone</code>や<code>git fetch</code>は<code>--depth</code>オプションで取得するコミット数を指定できます。
<a href="git@github.com:spring-projects/spring-framework.git">Spring</a>で試してみましょう。
まず<code>--depth</code>を設定せずに取得します。<a href="#fn-7fba-1" id="fnref-7fba-1">[1]</a>
<div class="code-block-container"><pre class="language-shell"><code class="language-shell code-line" data-line="15">$ time git clone --no-checkout git@github.com:spring-projects/spring-framework.git
Cloning into 'spring-framework'...
remote: Enumerating objects: 609218, done.
remote: Counting objects: 100% (38/38), done.
remote: Compressing objects: 100% (29/29), done.
remote: Total 609218 (delta 7), reused 21 (delta 4), pack-reused 609180
Receiving objects: 100% (609218/609218), 163.78 MiB | 6.27 MiB/s, done.
Resolving deltas: 100% (297615/297615), done.
git clone --no-checkout git@github.com:spring-projects/spring-framework.git 13.09s user 2.49s system 49% cpu 31.448 total
$ du -sh spring-framework/.git
193M spring-framework/.git
$
</code></pre></div><code>git clone</code>に31秒かかり、<code>.git</code>のサイズは193MBでした。
次に<code>--depth=1</code>を設定して取得します。
<div class="code-block-container"><pre class="language-shell"><code class="language-shell code-line" data-line="34">$ time git clone --no-checkout --depth=1 git@github.com:spring-projects/spring-framework.git
Cloning into 'spring-framework'...
remote: Enumerating objects: 10774, done.
remote: Counting objects: 100% (10774/10774), done.
remote: Compressing objects: 100% (7299/7299), done.
remote: Total 10774 (delta 3038), reused 8527 (delta 2780), pack-reused 0
Receiving objects: 100% (10774/10774), 12.45 MiB | 5.86 MiB/s, done.
Resolving deltas: 100% (3038/3038), done.
git clone --no-checkout --depth=1 0.70s user 0.19s system 14% cpu 6.121 total
$ du -sh spring-framework/.git
 13M spring-framework/.git
$
</code></pre></div><code>git clone</code>は6秒になり、<code>.git</code>のサイズは13MBになりました。
すべてのコミットを取得したくなった場合は<code>git fetch --unshallow</code>を実行してください。
<h2 id="%E9%83%A8%E5%88%86%E7%9A%84%E3%81%ABcheckout%E3%81%99%E3%82%8B" data-line="53" class="code-line">
<a class="header-anchor-link" href="#%E9%83%A8%E5%88%86%E7%9A%84%E3%81%ABcheckout%E3%81%99%E3%82%8B" aria-hidden="true"></a> 部分的にcheckoutする</h2>
前セクションで<code>git clone</code>するときに<code>--no-checkout</code>というオプションを設定していました。 
これを付けていると<code>clone</code>後に<code>HEAD</code>を<code>checkout</code>しなくなる、つまり<code>.git</code>ディレクトリのみが作成されることになります。
この状態から特定のディレクトリだけを<code>checkout</code>するために<code>git sparse-checkout</code>を使います。
<ul data-line="60" class="code-line">
<li data-line="60" class="code-line"><a href="https://git-scm.com/docs/git-sparse-checkout" target="_blank" rel="nofollow noopener noreferrer">Git - git-sparse-checkout Documentation</a></li>
</ul>
<code>--depth=1</code>を設定して<code>clone</code>したSpringのリポジトリを使って試してみます。
<div class="code-block-container"><pre class="language-shell"><code class="language-shell code-line" data-line="64">$ cd spring-framework
$ ls -a
. .. .git
$ git sparse-checkout init
$ git checkout
Your branch is up to date with 'origin/main'.
$ ls -a
. .git .mailmap LICENSE.txt build.gradle gradlew.bat settings.gradle
.. .gitattributes CODE_OF_CONDUCT.adoc README.md gradle.properties import-into-eclipse.md
.editorconfig .gitignore CONTRIBUTING.md SECURITY.md gradlew import-into-idea.md
$
</code></pre></div>まず<code>ls -a</code>で<code>.git</code>しかないことを確認しています。
次に<code>git sparse-checkout init</code>で<code>sparse-checkout</code>を有効化しています。
最後にもう一度<code>ls -a</code>でリポジトリのルートディレクトリにあるファイルだけが<code>checkout</code>されていることを確認しています。
<h3 id="sparse-checkout%E3%81%AE%E8%A8%AD%E5%AE%9A" data-line="84" class="code-line">
<a class="header-anchor-link" href="#sparse-checkout%E3%81%AE%E8%A8%AD%E5%AE%9A" aria-hidden="true"></a> sparse-checkoutの設定</h3>
<code>sparse-checkout</code>でどのファイルが<code>checkout</code>の対象になるのかは<code>list</code>サブコマンドで確認できます。
デフォルトの設定は次のようになっています。
<div class="code-block-container"><pre class="language-shell"><code class="language-shell code-line" data-line="90">$ git sparse-checkout list
/*
!/*/
$
</code></pre></div>これはルートディレクトリ内のすべてのファイルを対象とし(<code>/*</code>)、ルートディレクトリの1つ下のディレクトリ内は対象外とします(<code>!/*/</code>)。
<code>checkout</code>の対象を増やしたいときは<code>add</code>サブコマンドを使います。
試しに<code>spring-webmvc</code>ディレクトリを対象に加えましょう。
<div class="code-block-container"><pre class="language-shell"><code class="language-shell code-line" data-line="103">$ git sparse-checkout list
/*
!/*/
$ ls
CODE_OF_CONDUCT.adoc LICENSE.txt SECURITY.md gradle.properties gradlew.bat import-into-idea.md
CONTRIBUTING.md README.md build.gradle gradlew import-into-eclipse.md settings.gradle
$ git sparse-checkout add spring-webmvc
$ git sparse-checkout list
/*
!/*/
spring-webmvc
$ ls
CODE_OF_CONDUCT.adoc LICENSE.txt SECURITY.md gradle.properties gradlew.bat import-into-idea.md spring-webmvc
CONTRIBUTING.md README.md build.gradle gradlew import-into-eclipse.md settings.gradle
$
</code></pre></div><code>sparse-checkout</code>の設定とファイル一覧を確認してから<code>add</code>サブコマンドで<code>spring-webmvc</code>を追加しました。 
それから再度<code>sparse-checkout</code>の設定とファイル一覧を確認しています。 
<code>spring-webmvc</code>ディレクトリが<code>checkout</code>できていることがわかります。
<code>sparse-checkout</code>をやめたい、つまりすべてのファイルを<code>checkout</code>したくなった場合は<code>disable</code>サブコマンドを使用してください。
<section class="footnotes">
脚注
<ol class="footnotes-list">
<li id="fn-7fba-1" class="footnote-item">
<code>git clone</code>の時間を計測するために<code>time</code>コマンドを使用しています。作業環境はmacOSです。 <a href="#fnref-7fba-1" class="footnote-backref">↩︎</a>
</li>
</ol>
</section>

部分的にgit cloneしたりgit checkoutする

Discussion