🍃

tailwind.config.jsで型補完を効かせる

2021/04/19に公開

2022/10/05 追記

知らない間に以下で補完効くようになってました。下記のように@types/tailwindcssのインストールは必要ありません。
めでたいですね。

tailwind.config.js
/** @type {import('tailwindcss').Config} */

module.exports = {
 ...
}

1. @types/tailwindcssをインストール

https://www.npmjs.com/package/@types/tailwindcss

# npm
$ npm i -D @types/tailwindcss

# yarn
$ yarn add -D @types/tailwindcss

2. tailwind.config.jsにJSDocコメントを書く

ファイルの先頭に以下を加えます。

tailwind.config.js
/**
 * @type {import('@types/tailwindcss/tailwind-config').TailwindConfig}
 */

module.exports = {
 ...
}

結果

エディタで補完が効いてめでたい!
僕はVSCodeを使っています。

所感

そこまで頻繁に更新するものでもないし、編集するときはたいてい公式ドキュメントを見ながらなので、正直そこまで必要ない。

参考

https://nju33.com/notes/tailwindcss/articles/型付きで tailwind.config.js を書く

Discussion