Upgrade to Pro — share decks privately, control downloads, hide ads and more …
Sign up for free

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
スマート反転とウェブアクセシビリティ
Avatar for KAMIHARA Takumi camiha
0
210
モバイル交通系ICへのチャージ実例から考える、クロスプラットフォーム開発におけるiOS実機テスト設計とCI運用
Avatar for Yu Sugawara yusuga
1
460
AI × TiDD / 2026.09.05 Redmine 大阪
Avatar for tokudiro tokudiro
1
160
Kiroで創り、AgentCoreで繋ぐ！AWSで実践する「AI-DLC」から「AIエージェント統合」までの最新地図
Avatar for matsukada licux
4
680
Omarchy Tokyo やると聞いて UMPC 買ってセットアップしてきた
Avatar for Fumiaki MATSUSHIMA mtsmfm
0
140
技術的負債の返済は、AI時代の複利で効く投資 — 経営としての意思決定とその遂行
Avatar for curekoshimizu curekoshimizu
0
1.2k
【DroidKaigi 2026】「アクセシビリティを利用するとき、 アクセシビリティもまたこちらを利用している」 〜マルウェアによる攻撃と防衛について〜
Avatar for HalunoYo. halunoyo
0
460
Jetpack Compose メカニズム
Avatar for Jaewoong skydoves
0
410
MVNOの申込からeSIM開通までをiOSアプリでつなぐ- 本人確認・MNP・通信事業者基盤をまたぐ実装
Avatar for Sato Takeshi satotakeshi
0
350
速く作れる。その次は、速く確かめられる開発へ 〜AIネイティブ開発を支える、Shift Down〜 / Can build fast. Next, moving to development where we can verify fast.
Avatar for r-kagaya rkaga
2
1.2k
更なる可用性を求めて、5年間運用したKotlinのアプリケーションをGoでリプレイスする話
Avatar for Kensuke Taguchi ken_tunc
0
180
ゲームコントローラやキーボードのファームウェアをSwiftで書く
Avatar for Kishikawa Katsumi kishikawakatsumi
1
230

Featured

See All Featured
The Invisible Side of Design
Avatar for Vitaly Friedman smashingmag
301
52k
[SF Ruby Conf 2025] Rails X
Avatar for Vladimir Dementyev palkan
3
1.4k
Scaling GitHub
Avatar for Zach Holman holman
464
140k
Site-Speed That Sticks
Avatar for Harry Roberts csswizardry
13
1.5k
Neural Spatial Audio Processing for Sound Field Analysis and Control
Avatar for NII S. Koyama's Lab skoyamalab
0
500
GitHub's CSS Performance
Avatar for Jon Rohan jonrohan
1033
470k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
Avatar for Eileen M. Uchitelle eileencodes
28
3.6k
Have SEOs Ruined the Internet? - User Awareness of SEO in 2025
Avatar for Akash Hashmi akashhashmi
0
500
Speed Design
Avatar for Sergey Chernyshev sergeychernyshev
33
2.1k
Digital Projects Gone Horribly Wrong (And the UX Pros Who Still Save the Day) - Dean Schuster
Avatar for UX Y'all uxyall
1
2.9k
RailsConf 2023
Avatar for Aaron Patterson tenderlove
30
1.5k
Visualization
Avatar for Eitan Lees eitanlees
152
17k

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