diff --git a/README.md b/README.md index d58ee36..0fe9a61 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,7 @@ 2026 年の記事 - 2026-10-27 [ [:memo:](articles/2026-10-27_tfstylus_01.md) ] [その1 なぜ tfstylus を作ったのか](https://zenn.dev/terraform_jp/articles/2026-10-27_tfstylus_01) +- 2026-10-27 [ [:memo:](articles/2026-10-27_tfstylus_02.md) ] [その2 tfstylus を作り始めた時にわかっていなかったこと](https://zenn.dev/terraform_jp/articles/2026-10-27_tfstylus_02) - 2026-10-26 [ [:memo:](articles/2026-10-26_tfstylus.md) ] [terraform のコードを少し整える tfstylus を作ってみた](https://zenn.dev/terraform_jp/articles/2026-10-26_tfstylus) - 2026-07-07 [ [:memo:](articles/2026-07-07_terraform_graph_format_mermaid.md) ] [terraform graph -format mermaid が来るっぽいので試してみた](https://zenn.dev/terraform_jp/articles/2026-07-07_terraform_graph_format_mermaid) - 2026-06-26 [ [:memo:](articles/2026-06-26_terraform.md) ] [tflint と terraform-docs のバッティングを回避](https://zenn.dev/terraform_jp/articles/2026-06-26_terraform) diff --git a/articles/2026-10-27_tfstylus_02.md b/articles/2026-10-27_tfstylus_02.md new file mode 100644 index 0000000..441d334 --- /dev/null +++ b/articles/2026-10-27_tfstylus_02.md @@ -0,0 +1,96 @@ +--- +title: "その2 tfstylus を作り始めた時にわかっていなかったこと" +emoji: "☠️" +type: "tech" +topics: ["terraform", "AI", "tfstylus"] +published: true +publication_name: "terraform_jp" +--- + +# tl;dr + +- [terraform のコードを少し整える tfstylus を作ってみた](https://zenn.dev/terraform_jp/articles/2026-10-26_tfstylus) の続きの +- [その1 なぜ tfstylus を作ったのか](https://zenn.dev/terraform_jp/articles/2026-10-27_tfstylus_01) の続き +- 作り始めてから IT なんもわからんになっていたことを整理した + +# わかってなかったこと + +## terraform + +- 長い付き合いではあるんだけれども +- 未使用の機能や設定がたくさんある +- 公式ドキュメントを眺め直していて、増えてる function とか、記事は書いたけど活用してない list リソースとか +- 大雑把にはリソースブロックの中身(引数と呼ばれているところ)の並び替えをするツール、と位置づけていたけど、使ってないリソースががが + +## tfstylusとしての仕様 + +- なにをどうするかの言語化 +- 公式ドキュメントで強く言及されていない部分について、どうあるべきか +- AI と壁打ちを繰り返して、狙った機能に落とし込むことの大変さ +- 似て非なるものの名前に引っかかって発生する諸問題(IDとかtagとかラベルとか) + +## AIとの付き合い方 + +- バイブコーディング(笑)にはしたくなかったので、詰められるだけ詰めたつもりだけど、それでも期待どおりのアウトプットを出してもらえないケースが何度もあった +- 必要なプロンプト。どういう文面であれば期待した動作をしてくれるか +- ヌケモレに対してどう改善していくか(`AGENTS.md`すら自動で読まなかった時は心が折れるかと思ったw) +- 実際の作業の進め方、積み上げ方も `design.md` に積んで欲しいことと `issue` にして欲しいことを区別させるのも難しかった +- どれを使うか、どこからどうやるか。モデル選択やエージェントチーム(具体的には Copilot の Squad)をちょっとずつ試してみていた。どのタイミングでどれを使うのがいいかとかは完全に手探りだった + +## CLI ツールとして + +- ドキュメントの整理のしかた。今回はリポジトリ中に設計を残す感じなわけだけどコードのためのドキュメントと、人が読むためのドキュメントに区別をつけてもらうことが難しく、そんな何度も同じことを書かなくていいだろってなった +- 依存関係。Golang の勉強不足が悪いんだけど、外部に依存すると(ライブラリを使いすぎると)セキュリティ面でめんどうなことになる、と思っている。できる限り標準的な機能で書くように指示していたのでコードが何度も冗長になっていた +- セキュリティ。これも勉強不足すぎて諦めた。入力はテキストファイル(*.tf)を期待しているわけだけど、拡張子で読み込んでいるので、ハッキング目的のバイナリファイルを食わされたら壊れるかもしれない。食わせた人のマシンでw +- オプション類。サブコマンドやオプションについて、こうあるべき、こうしたらいいだろうの判断が遅いうえに薄かった。サブコマンドなんか最初は `check` と `run` だったからね。変更点の diff を出力したりしているうちに terraform と同じにしたほうがわかりやすいんじゃね?って気づいた +- バージョン。セマンティックバージョニングはもちろん理解しているけど、ツールとしてのバージョンの採番としてどう振っていくか、は今も具体的に決められていない(なので今でも数日置きに feat を打ったら 0.0.1 ずつ上げている) + +## Go言語 + +- 言語仕様がまだ理解できてない。コード自体は読めるし、AIに書いてもらっているけど、自力で書き直せって言われると無理。。。 +- リポジトリ(やソースコードの)構造のお作法。フレームワークを使うとある程度固定されるし、ライブラリ的に公開する部分を作る場合もある程度構造化されると思うけど、気がついたらフルフラットになっていて、言語の理解が足りてないなぁって +- フレームワークは使わないことにしたわけだけど、なくてももちろん読めるんだけど、あんまり綺麗じゃないなって。やっぱりフレームワークがあってそれを理解していれば、人が読みやすいコードになるよなって +- テストコードの良し悪しが全然わかってない。以前 Golang のツールを作った時はテストを書かなかった(ダメ)ので、このテストの書き方があってるのかどうか、の判断からしないといけなくてつらかった +- コードの良し悪しも同じで、フラットなファイル構造になっているんだけど、似たような関数がばんばん作られていた。名前は似てるし同じでいいんじゃないかとか流用は可能なんじゃないかと思っても後回しになった。コードの見直しタスクを定期的に実施したのでだいぶ改善してると思うけど +- ツール類の知見がゼロで始めるとつらい。バージョンが上がって仕様変更があったばかりだと情報が少ないとか、それに必要な知見がないとか +- goreleaser で brew 対応をするところがまさにそんな感じだった +- golangci-lint も prek でつい先日までうまく動いていたのに GitHub Actions Runner の Ubuntu が 24.04 から 26.04 になったタイミングから Go のバージョンが違うとか暴れ出してとてもつらかった(個人的には珍しく2桁コミットになった) +- ツールの取捨選択できる知見がなくて、AIと壁打ちして決めたけど、使えるようになるまでも遠くて、世の中のバイブコーダーってマジどうしてんの?!ってなってた + +## brew + +- brew install でインストールできるツールをしゅっと作れるようになるとエンジニアっぽいよねw +- まぁ今まで一度もそこまでやったことなかったので、今回始めてやってみてやっぱ大変だったんですけれども +- 個人開発ツールの登録方法なども全然知らなくて、前述の goreleaser を使えばできるって書いてあるのに、brew じゃなくて homebrew-cask を使えとか、なんのこっちゃパンナコッタ +- 最初に koki 先生の [GoReleaser で Go 製 CLI のリリースを自動化& Homebrew でインストールできるようにする](https://zenn.dev/kou_pg_0131/articles/goreleaser-usage) にあたっていればいらん苦労しないで済んだのにw +- homebrew-tap リポジトリがいるとか知らんがな + +## GitHub + +- 長く使ってれば知ってるってもんでもないしね(2009年から GitHub ユーザーやで) +- リポジトリのセキュリティ設定もいろいろある +- 新規パブリックリポジトリにちゃんと再設定できるか、と。普段プライベートリポジトリでセキュリティも甘々なのに +- 毎度ぽちぽちするのやめないといかんとちゃう? +- GitHub Pages 最近全然やってなくて、ドキュメントがちゃんとできたらやろうかなと思ってまだやってない +- シェルについてもまだまだわかってないことががが +- PATH の順序の設定の仕方をやり直しちゃったからね。今は `~/.local/bin`->`aqua/bin`->`/home/homebrew/.bin` にして、開発時とテスト時とリリース後の使い分けをしている +- PATH がキャッシュされて、`rm ~/.local/bin/tfstylus` しても切り替わらない時に `hash -d tfstylus` みたいにするといけるってことを知った時、linux なんもわからんになったw +- おかげで、ビルド時に .local/bin/、クリーンにしたら brew のパスを使用するがスムーズになった + +## prek(pre-commit) + +- ユーザーとして使う分には充分な知見を持っているつもりだったけど、本当につもりだった。。。 +- フックを提供するにあたって、system と go build と docker を提供しているけど、python 渡し(language: python)で提供するのがユーザー負担少ないんだ、とか +- 普段 Dockerfile 書かない(terraformばっかり触ってるから)んだけど、hadolint と dockerfmt 導入したり +- tfstylus 自体のフックをそれぞれテストするのに右往左往したり + +# まとめと次回予告 + +- わかってなかったこと多すぎ。完全に勉強不足だなって +- もちろん誰だってはじめてのことはわからないことだらけだと思うけど +- 30年もITのお仕事してて、守備範囲が違う、とか言い訳でしかないよね +- それ自体は知ってる、けど作り方は知らない、だからやってみて覚える。ITのお仕事の醍醐味だなとか +- つまり、なんでも手を動かしてやってみるのが一番なんだなってことを再確認した +- まだ手を動かしてない同志に届くといいな +- 次回「複数のAIと一緒に開発をする羽目になったオールドエンジニアは本来の目的である何か作って残そうとするのだが途中のCIでいきなりバグと戦闘になり思いがけない方法でどうにか切り抜けたと思ったら今度はGitHub Statusの罠にはまってしまうなどAパートだけでさんざん苦労する上に開発もまだ途中なのでVS Codeと離れるわけにもいかないし今後のさらなる苦労がしみじみ思いやられるそれにしてもこの長い長いサブタイトルは実は次回予告も兼ねているのだけれどちゃんと全部読んでくれている人がどれだけいるのかいささかならず気がかりでもある。そんな第三話」 +- めんどくさい苦労話をする予定w