🌟

そうだ。Neovim使おう。

2024/01/22に公開

この記事は全ての個人メモをNeovimで書いて管理する上で行った事をまとめた記事です。

現状

そもそも私自身、必要なこと以外あまりメモを取らずに生きてきた。
だが、こちらの記事を拝見し今年の継続リストに「作業メモをとる」ことを追加することとした。
https://zenn.dev/akase244/articles/e448e7562ec190

普段はVSCodeをちょこっとVim仕様にしてVSCodeでメモをとったり、個人的なメモはInkdropに残している。
そのため、各所にメモが散在しており、かつこれからの作業メモも増えていくと想定される。
これをどこか一箇所にまとめたい。

メモに対する要件

これは完全に個人的なメモに対する要件だが、ざっくりこんな感じだ

Mustな要件

  • Vimで操作できること
  • 検索ができること
  • Mac, Windows, iPhone, ブラウザに対応していること

Betterな要件

  • デザインがかっこいい
  • 書いていて心地いいこと
  • メモが管理しやすい(探しやすい)こと

Mustな要件でブラウザに対応していることと書いたが、社用PCだと勝手にアプリをインストールできないという問題がある。
そのため、社用PCからはアプリ以外から操作する必要がある。(iPhoneでもいいが作業効率落ちるので、できれば作業しているPCからメモを残したい)

という事を踏まえて、色々探したあげく「Vimが一番いいのでは?」となった。
要はVimで書いて、githubにリポジトリとして置いておくことで、どこからでもメモを見る・書くことができると考えたのだ。
じゃぁついでにNeovim使ってみよ〜というわけだ。

Neovimインストール 〜 セットアップ

こちらは多くの記事が挙げられているのでここでは省略します。
プラグインなどはこのあたりを参考にさせていただきました。
https://note.com/histone/n/na8ebb8a5909f
ターミナルもちょっといじりました
https://zenn.dev/yushin_hirano/articles/28e7ea8cd11bc1

nippouコマンドを作成

メモを取る際にアプリケーションを開いて、フォルダ開いて、.mdを作成して...
みたいな面倒な事をしていると、私の場合絶対にメモを取らなくなる。(手間が増えると嫌になる)
そんな未来が容易に想像できたので、コマンド一発で解決できないかな〜...
ということでnipppouコマンドを作った。

私はMacなので以下を.zshrcに追加する

.zshrc
# 日付.mdをnvimで開くコマンド
NIPPOU_DATE=`date '+%Y-%m-%d'` # 当日の日付
alias nippou="nvim ~/Documents/note/nippou/$NIPPOU_DATE.md"

追加したら、source ~/.zshrcで設定の反映を忘れずに。

nippouコマンドを叩くと、Neovimで日付.mdが開かれる。

これでよし。

フォルダをgitと連携してどこでもnippou

あとはgitのリポジトリ作成して、どの環境でも作業メモを書けるようにしておく必要がある。

init_nippouコマンドを作成

全ての作業メモはリモートリポジトリに置いておくため、必ずpullしてから日報を書くようにしなければならない。
だが、この前作業すらめんどくさいので、これもコマンド一発でできるようにしておく

以下を.zshrcに追加する

.zshrc
# メモを書く前にリモートに置いてあるメモとローカルのメモを同期
# リモートリポジトリが作成済みかつ、git remote add してあることが前提
function init_nippou () {
	git -C ~/Documents/note pull origin main
	echo -e "\e[32mLet's get started\e[m👍"
}

最後の一文は余興だ

コマンドを打つとこんな感じ

作業開始前には必ずinit_nippouを打ってから作業を始める。

done_nippouコマンドを作成

あとは作業完了時にリポジトリに差分をあげておかないと次の時に困るので、ここもコマンド一発でできるようにする
以下を追加

.zshrc
# git add, commit, pushまでを行うコマンド
function done_nippou () {
	git -C ~/Documents/note add . &&
	git -C ~/Documents/note commit -m "nippou done $NIPPOU_DATE" &&
	git -C ~/Documents/note push origin main
	echo -e "\e[32mIt's Done!!!!!  Greate Job\e[m🍺🍺🍺"
}

ちゃんと労いの言葉を入れておくのがミソだ

これでどこからでもメモを取れるようになったので、自分としては大変満足だ。
まだこの環境で1〜2週間だが9割型満足している😗。

補足

Must要件で検索を挙げていたが、grepで検索をかけるつもりだった。
だが実際やってみると、なかなか検索しづらいので検索かける時だけはVSCodeからフォルダを開いて検索かけている。(ここだけちょっと悔しい)

またgithubに挙げているため、パスワード等のメモは残さないようにしている。(そのあたりは引き続きローカルメモに残してある)
あと、commitをしていくので余計なgithub contributions(草のこと)が増える前提だ。
余計なcontributionsが増えるのが嫌な場合はメモ専用のアカウントを追加するのがいいかもしれない。

GitHubで編集を提案

Discussion