Upgrade to Pro — share decks privately, control downloads, hide ads and more …

ESLintプラグインを使用してCDKのセオリーを適用する

Avatar for Ren Yamanashi Ren Yamanashi
January 16, 2025
Programming
890
2

 ESLintプラグインを使用してCDKのセオリーを適用する

クラスメソッドのAWS CDK事情大公開スペシャル#2 で発表したLTのスライドになります
https://classmethod.connpass.com/event/337711/

Avatar for Ren Yamanashi

Ren Yamanashi

January 16, 2025

More Decks by Ren Yamanashi

See All by Ren Yamanashi
保守性を高める AWS CDK のセオリー・ベストプラクティス
Avatar for Ren Yamanashi yamanashi_ren01
6
1.5k
CDK開発におけるコーディング規約の運用
Avatar for Ren Yamanashi yamanashi_ren01
3
740
AWS初心者ってどうやってAWSを学ぶ？〜アプリエンジニアがやってよかったアーキテクチャ学習方法〜
Avatar for Ren Yamanashi yamanashi_ren01
0
720

Other Decks in Programming

See All in Programming
go-spidermonkeyでAIエージェントのCode Modeを実装する
Avatar for syumai syumai
3
1.3k
自動化したのに回らない テスト運用の壁 ―AI時代の品質責任と生産性
Avatar for Masahiko Funaki(舟木 将彦) mfunaki
0
530
夏だ！祭りだ！祭りとはドメインモデリングでは？
Avatar for ryugen04 ryugen04
0
440
高専、大学編入、そして未踏へ〜プロダクト開発とキャリアの歩み - Technical College, University Transfer, and On to “Mitou” / My Journey in Product Development and Career
Avatar for __pkmiya pkmiya
0
100
【QA Test Talk Vol.8】AI-DLC による Whole Team Approach の加速
Avatar for PKSHA Technology（パークシャテクノロジー） pkshadeck
PRO
0
250
freee が目指す データ マネジメント戦略 AI-Ready 時代を支える 攻めのガバナンスとは
Avatar for freee freee
PRO
0
520
関東Kaggler会_NVIDIA_Nemotron_コンペ_振り返り
Avatar for rick rick_ds
0
730
Oxlintはいいぞ（続）
Avatar for Yuji Yamaguchi yug1224
1
480
書籍「プロフェッショナルAI駆動開発」紹介スライド
Avatar for Juntaro Matsumoto juntaromatsumoto
0
780
Go 1.27からのGODEBUG / Go 1.27 リリースパーティ #go127party
Avatar for mazrean mazrean
0
250
Hello, Hiroshima Geospatial Data! — Exploring DoboX with Python
Avatar for ぴっかりん ra0kley
0
110
複数の Claude Code が"放置"されてしまう問題をCLI ダッシュボードを自作して解決した話
Avatar for sumihiro3 sumihiro3
1
740

Featured

See All Featured
A designer walks into a library…
Avatar for Paul Jervis Heath pauljervisheath
211
24k
No one is an island. Learnings from fostering a developers community.
Avatar for Antonio thoeni
21
3.8k
Art, The Web, and Tiny UX
Avatar for Lynn Fisher lynnandtonic
304
22k
Leading Effective Engineering Teams in the AI Era
Avatar for Addy Osmani addyosmani
9
2.4k
Amusing Abliteration
Avatar for ianozsvald ianozsvald
1
270
The Organizational Zoo: Understanding Human Behavior Agility Through Metaphoric Constructive Conversations (based on the works of Arthur Shelley, Ph.D)
Avatar for Dr. Kim W Petersen kimpetersen
PRO
0
430
Product Roadmaps are Hard
Avatar for C. Todd Lombardo iamctodd
55
12k
Visual Storytelling: How to be a Superhuman Communicator
Avatar for David Neal reverentgeek
2
630
The innovator’s Mindset - 
Leading Through an Era of Exponential Change - McGill University 2025
Avatar for Jean-Marc De Jonghe jdejongh
PRO
1
300
Building Applications with DynamoDB
Avatar for Matt Wood mza
96
7.2k
SEO in 2025: How to Prepare for the Future of Search
Avatar for Michael King ipullrank
3
3.8k
Are puppies a ranking factor?
Avatar for Jono Alderson jonoalderson
2
3.8k

Transcript

  1. 2025/01/17 山梨 蓮 クラスメソッドのAWS CDK事情大公開スペシャル#2 　

  2. 自己紹介 @ren_yamanashi ・job 󰞵: web engineer (backend) ・lang 📝: TypeScript

    ・hobby 🚀: CDK Contribute

  3. ・TypeScriptを使用した開発を想定しています 前提

  4. 自己紹 介 CDKにおける「セオリー」とは？

  5. ・construct ID は PascalCaseで書く ・propsのプロパティはreadonlyに CDKのセオリー ・props/Constructで公開するリソースのプロパティはClassではなくInterfaceに 　など

  6. ・特にCDK / TypeScript になれていない場合 CDKコーディングにおける課題 ・セオリーを意識しながらのコーディングが大変 ・メンバー間で認識のレベルに差がある

  7. ・特にCDK / TypeScript になれていない場合 CDKコーディングにおける課題 レビューで毎回同じ指摘をする(される) ・セオリーを意識しながらのコーディングが大変 ・メンバー間で認識のレベルに差がある

  8. ・特にCDK / TypeScript になれていない場合 CDKコーディングにおける課題 レビューで毎回同じ指摘をする(される) ・セオリーを意識しながらのコーディングが大変 ・メンバー間で認識のレベルに差がある （レビュー漏れも・・・）

  9. 自己紹 介 この課題を　 ESLintを使って解決する

  10. ・JS / TS コードを解析し、構文エラーやルール違反コードを検出するツール ESLintとは？ ・基本的なルールはESLintから提供される ・ルールはユースケースに応じて自前で作成可能

  11. 課題 ESLintを使用した課題の解決 ・セオリーを一つ一つ意識するのが大変なこと 解決方法 ・毎回同じ指摘をすること / レビュー漏れが起きること ・ESLintを使用した機械的な解析によって自動検知する ・意識しなくても /

    レビューしなくても 勝手にエラーになる

  12. 自己紹 介 課題を解決するために

  13. 自己紹 介 CDKに特化した ESLintルールを作りました

  14. 自己紹 介

  15. サポートしているルール(一部) eslint-cdk-pluginの紹介 ① construct ID は PascalCase で書く ② construct

    には必ず this を渡す ③ construct ID に変数を使用しない ④ propsやconstructで公開するリソースのプロパティはinterfaceにする ⑤ propsやconstructで公開するリソースのプロパティはreadonlyにする CDKのセオリー / ベストプラクティス強制するESLintルール

  16. 自己紹 介 ① construct ID は PascalCase で書く

  17. こちらの記事で紹介されているもの ① construct ID は PascalCase で書く

  18. ① construct ID は PascalCase で書く

  19. 自己紹 介 ② construct には必ず this を渡す

  20. CDKのメンテナである Rico Hermans (@rrix0rr) 氏から提案いただいたもの ② construct には必ず this を渡す

  21. ② construct には必ず this を渡す

  22. construct に this を渡すことは正しいリソース階層を維持するために重要 scope のような値を使用すると・・・ ② construct には必ず this

    を渡す ・生成されるCFnテンプレートのリソース階層が正しくない ・予期しないリソースの命名 のような問題が起こる

  23. 自己紹 介 ③ construct ID に変数を使用しない

  24. こちらもrrix0rr氏から提案いただいたもの ③ construct ID に変数を使用しない

  25. ③ construct ID に変数を使用しない

  26. construct ID に変数を使用すると・・・ ③ construct ID に変数を使用しない ・不要な重複 ・パラメータ変更時のリソース再作成 のような問題が起こり得る

    ・IDの一意性を重視するあまり、不要な文字列を混在させてしまう

  27. 自己紹 介 ④ propsやconstructで公開する リソースのプロパティはinterfaceにする

  28. こちらのスライドで紹介されているもの ④ propsやconstructで公開するリソースのプロパティは interfaceにする

  29. ④ propsやconstructで公開するリソースのプロパティは interfaceにする

  30. ④ propsやconstructで公開するリソースのプロパティは interfaceにする

  31. 自己紹 介 ⑤ propsやconstructで公開する リソースのプロパティはreadonlyにする

  32. 同じく、こちらのスライドで紹介されているもの ⑤ propsやconstructで公開するリソースのプロパティは readonlyにする

  33. ⑤ propsやconstructで公開するリソースのプロパティは readonlyにする

  34. ⑤ propsやconstructで公開するリソースのプロパティは readonlyにする

  35. まとめ ・セオリーを自動適用するプラグインを紹介 ・導入方法などはドキュメントをご覧ください 🙏 　https://eslint-cdk-plugin.dev/ ・「こんなルールが欲しい」という要望もお待ちしております！！ ・Twitter(X): @ren_yamanashi ・Github: @ren-yamanashi