Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Documentation testsの恩恵 / Documentation testing benefits
Search
TOMIKAWA Sotaro
May 11, 2024
Programming
2
650
Documentation testsの恩恵 / Documentation testing benefits
TSKaigi 2024
の発表資料です
TOMIKAWA Sotaro
May 11, 2024
Tweet
Share
More Decks by TOMIKAWA Sotaro
See All by TOMIKAWA Sotaro
脱法Svelte / Evasion of svelte rules
ssssota
1
50
TypeScriptとDocumentaion tests / Documentation tests with TypeScript
ssssota
7
3k
Svelteでライブラリを作る / Make your library with Svelte
ssssota
0
68
現代のReactivityとSvelteの魔法
ssssota
0
1.5k
型付きdotenv
ssssota
0
180
Other Decks in Programming
See All in Programming
ruby.wasm 最前線 2024 - wasmでMockServerをつくる #rubykaigi
lnit
2
430
"統合ERP"とアプリケーションアーキテクチャ
keitatomozawa
0
390
multipart/form-dataの省メモリパース / Go Conference 2024 Pre Party #gocon24_preparty
mazrean
0
270
「ソフトウェア設計」のドメイン - 「データモデリングでドメインを駆動する」を読んで
hidenorigoto
7
2.2k
Streaming I/O
macdice
0
230
バリデーション付きフォームを宣言的に実装する / Declaratively Implementing a Form with Validation
studio_rookery
0
250
GoのWasmでWebRTC P2Pで通信する
ponyo877
0
270
Why Spring Matters to Jakarta EE - And Vice Versa
ivargrimstad
0
1.1k
#kaigieffect LT 2024 - rexml-css_selector: A REXML extension for supporting CSS selector
makenowjust
1
230
You may not need XXX in Node.js
masashi
5
720
Datadogのmonitorを Terraform管理に爆速で 移行する
kuro_kurorrr
4
370
『改訂新版前処理大全』の話と Apache Parquet の話 #TokyoR
bob3bob3
0
160
Featured
See All Featured
BBQ
matthewcrist
80
8.8k
Pencils Down: Stop Designing & Start Developing
hursman
117
11k
Code Review Best Practice
trishagee
57
16k
What the flash - Photography Introduction
edds
64
11k
Building Better People: How to give real-time feedback that sticks.
wjessup
356
18k
Building a Modern Day E-commerce SEO Strategy
aleyda
22
6.5k
Embracing the Ebb and Flow
colly
80
4.2k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
359
22k
The Illustrated Children's Guide to Kubernetes
chrisshort
34
47k
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
22
2k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
71
15k
Clear Off the Table
cherdarchuk
87
310k
Transcript
Documentation testsの恩恵 ssssota
自己紹介 冨川宗太郎 Tomikawa Sotaro (ssssota) { GitHub: "ssssota", X: "ssssotaro"}
フロントエンドエンジニア sは合計4つ
突然ですがこちらのコードをご覧ください
/// ``` /// use biome_unicode_table::is_js_ident; /// /// assert!(is_js_ident("id0")); /// assert!(is_js_ident("$id$"));
/// assert!(is_js_ident("_id_")); /// assert!(is_js_ident("𐊧")); /// /// assert!(!is_js_ident("")); /// assert!(!is_js_ident("@")); /// assert!(!is_js_ident("custom-id")); /// assert!(!is_js_ident("0")); /// ``` pub fn is_js_ident(s: &str) -> bool { if s.is_empty() { return false; Rust製Linter/Formatterである Biomeのコードを一部抜粋 ソースコード中のドキュメント に 関数の入出力が記載されている Rust(Cargo)にはデフォルトで 搭載されている機能で実際に利 用されている https://github.com/biomejs/biome/blob/7 245146125fa76c19780f68653092ed24fcdb717/ crates/biome_unicode_table/src/lib.rs#L4 2-L57
TypeScriptでは次のようなもの(vite-plugin-doctestの例) JSDocとして記載されたコメント内でassert関数を用い関数をテストしている それだけ /** * @example * ```ts @import.meta.vitest *
assert(add(1, 2) === 3); * ``` */ export const add = (a: number, b: number) => a + b; Documentation testsとは?
1. ソースコードのすぐそばに、テストコードが記載できる。 index.test.ts など別途ファイルを作成することなく、すぐにテストを書 き始めることができる。 2. ドキュメントに記載したコードを実行してその動作が保証できる。 ライブラリ等で、動かないサンプルコードを見たことが...。 3. 関数利用時にIDE(LSP)を介して「動作保証されたサンプルが閲覧できる」。
Documentation testsの恩恵
Documentation testsの恩恵 こんなシーンを見たことが... • ドキュメントにサンプルコードを書いても廃れる • そもそもJSDoc誰も読み書きしない... →実装のすぐとなりにテストコード(=JSDoc)を書くことで、 そもそもJSDocに触れる機会が増え、 それがサンプルコードとなり、生きたドキュメントになる。
ドキュメンテーションテストとの向き合い方 ドキュメンテーションテストは銀の弾丸(万能)ではない。 次のようなテストは向かない(書けない)。 • ライフサイクル関数が必要 • モックが必要 • UIテスト カジュアルにドキュメントおよびテストを書き始める手段の一つ。
いま型をカジュアルに書くように、 よりドキュメント/テストをカジュアルに書く世界。
npm i -D vitest vite-plugin-doctest import { defineConfig } from
'vitest/config'; import { doctest } from 'vite-plugin-doctest'; export default defineConfig({ plugins: [doctest()], // markdownファイルもサポートしている test: { includeSource: ['./src/**/*.[jt]s?(x)', './**/*.md'] }, }); npx vitest 導入方法(vite-plugin-doctest)
TypeScriptでは次のようなもの(vite-plugin-doctestの例) JSDocとして記載されたコメント内でassert関数を用い関数をテストしている それだけ /** * @example * ```ts @import.meta.vitest *
assert(add(1, 2) === 3); * ``` */ export const add = (a: number, b: number) => a + b; Documentation testsとは?
Documentation testsで 生きてるドキュメントとテストを書こう!