zsh on blog.kyu08.com

forkしたrepositoryのremoteを最新化しつつローカルにpullするスクリプトを書いた

Mon, 02 Sep 2024 15:54:12 +0000

前提

ghコマンドがインストールされていること
デフォルトブランチにいること

tl;dr

# forkしたrepositoryのremoteを更新しつつpullする
function git-sync() {
    REPO=$(git remote get-url origin | sed -E 's%.+github.com/(.*).git$%\1%')
    echo "🔄 Syncing ${REPO}...\\n"
    gh repo sync ${REPO} && git pull
}
alias gsy=git-sync

嬉しさ

もともとは以下の2ステップだったが前述のスクリプトを使うと1ステップにまとめることができる。

ブラウザでSync fork > Update branchをクリック
ローカルでgit pullを実行

ブラウザからforkすると遅いのでCLIからfork & cloneするスクリプトを書いた

Sun, 18 Aug 2024 06:52:01 +0000

モチベーション

GitHubにホストされているOSSにPRを出す時にforkしてからローカルにcloneするが、ブラウザのforkボタンを使ってforkすると時間がかかることが多くストレスに感じていた。

そのためCLI上でforkとcloneを行うスクリプトを書いた。

これまでの手順は以下のような手順が必要だった。

ブラウザでforkボタンを押す
forkの完了を待つ
ブラウザに表示されるcloneコマンドをコピー(gh repo clone owner/repoみたいなやつ)
ターミナルでコマンドを実行してforkしたリポジトリをcloneする

これを以下のステップでできるようにした。

リポジトリのURLまたはOWNER/REPO形式の文字列をコピー
コマンドに1. で取得した文字列を渡して実行

つくったスクリプト

以下を.zshrcなどに追加すると使えるようになる。aliasの部分はお好みで。¹

function git-fork-clone() {
    # 入力からowner/repoを取り出す。owner/repoのような形式でもURLでもOK
    REPO=$(echo $1 | sed -E 's@.+github.com/([^/]+)/([^/]+).*@\1/\2@')
    echo "🐙 ${REPO} will be forked and cloned.\\n"
    # -- 以降のオプションはgit cloneに渡される
    # See: https://cli.github.com/manual/gh_repo_fork
    gh repo fork ${REPO} --default-branch-only --clone=true -- --filter=blob:none
}
alias gf=git-fork-clone

前提

ghコマンドがインストールされていること。

使い方

$ git-fork-clone https://github.com/cli/cli

上記を実行すると以下のような出力が表示され、リポジトリのforkとcloneが行われる。

🐙 cli/cli will be forked and cloned.

✓ Created fork kyu08/cli
Cloning into 'cli'...
remote: Enumerating objects: 31, done.
remote: Counting objects: 100% (31/31), done.
remote: Compressing objects: 100% (30/30), done.
remote: Total 31 (delta 0), reused 10 (delta 0), pack-reused 0 (from 0)
Receiving objects: 100% (31/31), 20.41 KiB | 10.20 MiB/s, done.
From github.com:cli/cli
 * [new branch]      main       -> upstream/main
 * [new tag]         v1.0.1     -> v1.0.1
✓ Cloned fork

以下のような形式でも動く。

git-fork-clone https://github.com/cli/cli/pulls
git-fork-clone cli/cli

まとめ

また人類のOSS貢献力を加速させてしまいました。

完全に余談だがスクリプトのREPO=...の部分は https://www.tutorialspoint.com/execute_bash_online.php を使って出先で書いた。スマホでもシェルスクリプトが書けて便利。 ↩︎

Tmux+NeovimでJetBrains IDEのScratchみたいな機能を実現している話

Sat, 04 Feb 2023 16:15:48 +0000

任意の構成のSandbox的な環境をTmuxのwindowとして用意するようにしたところターミナルから出ずにサクっと動作検証とかが行えてハッピーになったよ、という記事。ここではvanillaなGoのプロジェクトの例を紹介しますが、お好みの構成でSandbox環境を作ってみてください。

全然大したことをやっているわけではないですがTmux, Neovimやそれらのプラグインの普及活動になれば嬉しいので書いてみます。

動作イメージ

こんな感じでvanillaのGoプロジェクトをTmuxのwindowに開いておいて、確認したくなったときにすぐwindowを切り替えてコードを書いて実行結果を確認できるようにしている。(Gifの例はGoの書式指定子%+vの動作を忘れて試してみているところ)

Gifでやっていることは以下

GoのSandbox環境を開いたNeovimが起動しているwindowに切り替え
コードを書く
Neovim上でターミナルを表示
make runを実行してコード実行
結果を確認
元いたwindowに戻る

tmux-fzfなど筆者のターミナル環境については以下参照

開発の効率化のためにやっていることターミナル編

筆者はGoの動作を確認したいことがほとんどなのでこういった構成にしているが、必要に応じてよく使うFWをセットアップした環境を作っておくと便利そう。

プロジェクトの内容

Go固有の内容もあるので参考程度で。

├── .git
├── .gitignore
├── go.mod
├── go.sum
├── main.go
├── main.go.sample
├── main_test.go
└── Makefile

基本的にmain.goの中身を編集して、go run .で実行して実行結果を確認するということをしている。

Makefileの中身は以下のような感じになっていて、make runでコード実行、make clearでmain.goをまっさらにできるようにしているだけである。

.PHONY: run clear

run:
  @go run .

clear:
  @cp ./main.go.sample ./main.go

main.go.sampleの内容は以下。

package main

func main() {
}

あとはよく見返したくなるコードはmain.go以外のファイル名で保存したり、commitしておくと後からでもさっと確認できてよさそう。(筆者はそこまでやってない)

感想

ターミナルから出ずに作業が完結できてうれしい。

同様のことはGoの場合はブラウザからThe Go Playground(※)を開いても行えるが筆者は何でもターミナルでできると嬉しい人なのでできるようにしてみた。

※ブラウザ上で実行できるGoのエディタ + 実行環境がセットになったやつ。

Go Playground - The Go Programming Language

https://go.dev/play/

あとやるとしたらThe Go PlaygroundにあるURL発行機能とかを実現できると他の人への共有も楽になっていいのかもしれない。(今のところあんまり他の人に共有する機会がないので困っていない)

補足

最後に補足としてGif内で使っているNeovimのプラグインを紹介します。

ターミナル表示

voldikss/vim-floaterm

GoのSandbox環境のmain.goに書いたスクリプトを実行するために、Neovimからターミナルを表示するシーンで使っている。

コード編集してサクっと動作確認したいときなどに便利。(といいつつ最近動作の重さが目立ってきたので<C-z>でNeovimの起動元に戻ってターミナルを操作することが多い)

カーソル移動

yuki-yano/fuzzy-motion.vim

fmt.Printf("u: %v\n", u)のuから%vの位置にカーソル移動する際に使っているプラグイン。

動作のイメージはこんな感じ。

起動すると文字がグレーアウトするのでジャンプしたい文字列を入力するとその文字にジャンプするためのキーワードを表示してくれるというプラグイン。

同様の機能をもつプラグインとしてはeasy-motionなどのプラグインが有名だが、fuzzy-motionはジャンプしたい文字列をfuzzy-finder形式で絞り込んでくれるのが大きな特徴。(詳しくはリポジトリのREADME参照)

筆者はノーマルモードでfキーを押下するとプラグインが起動するように設定している。

カーソル移動の効率がよすぎて正直もうこれなしでは開発したくない。

LSP Server

neoclide/coc.nvim

Language Serverをホストするためのプラグイン。

すごく簡単にいうと補完や関数定義を表示したり定義ジャンプできるようにしたりしてくれる。

以上です。ここまで読んでくれてありがとうございました。

開発の効率化のためにやっていることターミナル編

Wed, 14 Dec 2022 16:15:48 +0000

【この記事はUnipos Advent Calendar 2022の記事です】

この記事では筆者が開発の効率化のために行っている工夫や使っているツールなどについて紹介します。「他にもこんなツールあるよ！」「こんな設定おすすめだよ！」などなどありましたらtwitterとかで教えてもらえると助かります。

今回はターミナル編です！

シェル

シェルはzshを使っています。一時期fishも使っていましたが、環境移行のコストが低かったりPOSIX準拠だったりするメリットに旨味を感じてzshに乗り換えました。

よく使うalias

zshではalias hoge='echo hoge'のように記述することでaliasを定義できます。

ここでは筆者がよく使うaliasをいくつか紹介します。

alias m='MEMODIR=~/code/memo; cd $MEMODIR; FILE=$MEMODIR/$(date +%Y%m%d).md; if [ ! -e $FILE ]; then echo "# todo \n\n# done\n" >> $FILE; fi; nvim $FILE'

日毎にyyyymmdd.md形式の名前のファイルを作成してvimで開く。ファイルが存在していなければ

# todo

# done

をファイルに書き込んだうえでvimで開く、という内容のワンライナーです。

実際に呼び出すとこんな感じです。

ちなみに筆者は

# todo
- タスクA
  - 子タスクa
  - 子タスクb
- タスクB

# done

のような感じでタスクを書いていき、完了したら以下のようにdoneに移すという素朴な方法でタスク管理をしています。

# todo
- タスクB

# done
- タスクA
  - 子タスクa
  - 子タスクb

alias ghw='gh repo view -w'

ghコマンドを利用して現在いるリポジトリをブラウザでGitHubで開くコマンド

alias pbc='pbcopy && pbpaste'

make test | pbcのように出力をパイプでpbcに渡すとクリップボードにコピーしつつ標準出力に出力してくれる。

コマンドの出力をコピーしたいけど出力内容もその場で確認したいときに便利。

こちらの記事で紹介されていた。

pbcopy で標準出力の内容をecho表示を維持しつつコピーしたい - それマグで！

pbcopy コマンドはクリップボードのコピーが出来て便利。 pbcopy コマンドを使うと、ターミナルの出力内容をコピーが出来る。便利なコマンドでも困ったことが有る。クリップボードにコピーされた内容を見れない。 takuya@~$ ls / Applications Network Users bin dev home lost+found net private tmp var Library System Volumes cores etc installer.failurerequests mnt opt sbin usr takuya@~$ ls / | pbcopy コピーされる…

https://takuya-1st.hatenablog.jp/entry/2017/05/30/093000

alias finder='open -a Finder ./'

現在いるディレクトをfinderで開くコマンド

ごく稀に使う。

ディレクトリ移動

zshにはcdrという、移動したことがあるディレクトリを自動的に保持してくれる機能があります。

これをいい感じにファジーファインダーから呼び出すスクリプトを公開して下さっている方がいたのでありがたく使わせてもらっています。

fzfで捗る自作コマンド一覧(zsh) - ハイパーマッスルエンジニア

みんな大好きfzf fzfは結果をインタラクティブに絞り込むだけのコマンドだが、組み合わせ次第でかなり使えるコマンドだ。日本ではpecoの方が有名だが海外ではfzfの方が人気らしい。 github.com 筆者が思うpecoと比較したときのfzfのメリットを述べる。画面クリアがなく目に優しい fuzzy search(曖昧検索)が可能絞り込んだものをパイプつなぎでコマンドを適用でき、結果をpreviewとして画面に表示できるカスタマイズが豊富特にfuzzy searchとpreviewできる点が素晴らしい。またfzfの絞り込み結果の画面サイズを指定できたりとカスタマイズ性が高いのもGO…

https://www.rasukarusan.com/entry/2018/08/14/083000

fzfをインストールした上で以下のスクリプトを.zshrcに記述するとcで呼び出すことができます。

# fzf-cdr 
alias c='fzf-cdr'
function fzf-cdr() {
    target_dir=`cdr -l | sed 's/^[^ ][^ ]*  *//' | fzf`
    target_dir=`echo ${target_dir/\~/$HOME}`
    if [ -n "$target_dir" ]; then
        cd $target_dir
    fi
}

# cdrの設定
autoload -Uz is-at-least
if is-at-least 4.3.11
then
  autoload -Uz chpwd_recent_dirs cdr add-zsh-hook
  add-zsh-hook chpwd chpwd_recent_dirs
  zstyle ':chpwd:*'      recent-dirs-max 500
  zstyle ':chpwd:*'      recent-dirs-default yes
  zstyle ':completion:*' recent-dirs-insert both
fi

# fzfの設定
export FZF_DEFAULT_OPTS='--color=fg+:11 --height 70% --reverse --exit-0 --multi'

これを実際に使うとこんな感じになります。ファジーファインダーを利用して効率的にディレクトリ移動できます。

やっていることは以下です。

.zshrcに定義したfzf-cdrを実行
移動したいディレクトリのパスの一部を入力
候補から移動したいディレクトリを選択する

コマンド履歴検索

実行したコマンドの履歴についてもfzfを使って絞り込みを行うようにしています。

これもスクリプトを公開して下さっている方がいたのでありがたく使わせてもらっています。

fzfを使ってzshのコマンド履歴検索をスマートに

https://techblog.sgr-ksmt.dev/2016/12/10/smart_fzf_history/

以下のスクリプトを.zshrcに記述すると、ctrl + rでコマンド履歴を呼び出すことができます。

function select-history() {
  BUFFER=$(history -n -r 1 | fzf --no-sort +m --query "$LBUFFER" --prompt="History > ")
  CURSOR=$#BUFFER
}
zle -N select-history
bindkey '^r' select-history