API
@plumeria/next-plugin
★★★★☆ StableNext.js の設定を withPlumeria で包み、コンパイラのオプションを指定します。
@plumeria/next-plugin は Next.js 用のプラグインです。Turbopack と Webpack の両方で、ビルド時にスタイルを変換し、開発時は HMR で変更を反映します。
インストール
pnpm i -D @plumeria/next-plugin使い方
next.config.ts または next.config.js の設定を withPlumeria で囲みます。
import type { NextConfig } from "next";
import { withPlumeria } from "@plumeria/next-plugin";
const nextConfig: NextConfig = {
// Existing configuration
};
export default withPlumeria(nextConfig);API
withPlumeria(nextConfig, options)
Next.js の設定を受け取り、Plumeria に必要な Turbopack または Webpack の設定を加えて返します。
nextConfigは Next.js の設定オブジェクトです。optionsにはローダーに渡すコンパイラ設定とlintを指定します。
function withPlumeria(nextConfig: NextConfig, options?: PlumeriaOptions): NextConfig;オプション
export default withPlumeria(nextConfig, {
include: ['./src/**/*.{ts,tsx}'],
exclude: ['**/node_modules/**', '**/.next/**'],
styleProp: 'classStyle',
});includeは CSS の生成元を指定する glob です。標準ではすべての js、jsx、ts、tsx ファイルが対象です。excludeは対象から外す glob です。標準ではnode_modules、dist、.nextを除きます。stylePropは JSX のスタイル用 prop 名です。標準は'sx'です。withoutLogicalPropertiesは物理名もあるプロパティの論理名を禁止します。初期値はfalseです。withoutPhysicalPropertiesは論理名もあるプロパティの物理名を禁止します。初期値はfalseです。lintはnext build時に @plumeria/eslint-plugin でチェックします。初期値はtrueです。
interface PlumeriaOptions {
include?: string[];
exclude?: string[];
styleProp?: string;
withoutLogicalProperties?: boolean | { sizes?: boolean };
withoutPhysicalProperties?: boolean | { sizes?: boolean };
lint?: boolean;
}styleProp
prop 名を変えるには、次の二か所の名前をそろえます。まずプラグインに指定します。
export default withPlumeria(nextConfig, { styleProp: 'classStyle' });次に TypeScript に同じ名前を宣言します。prop の型宣言
名前が違うと型チェックは通っても prop が変換されません。@plumeria/eslint-plugin は settings.plumeria.styleProp から名前を読みます。
withoutLogicalProperties と withoutPhysicalProperties
論理名と物理名があるプロパティを一方の書き方にそろえます。挙動は @plumeria/unplugin と同じです。
export default withPlumeria(nextConfig, { withoutPhysicalProperties: true });export default withPlumeria(nextConfig, {
withoutPhysicalProperties: { sizes: true },
});lint
本番ビルドでは設定なしで lint が動きます。next build と並行して oxlint が @plumeria/eslint-plugin を実行し、警告やエラーがあれば失敗します。コンパイルのほうが先に終わっても lint の完了を待ちます。next dev では実行しません。
推奨ルールを実行し、withoutLogicalProperties または withoutPhysicalProperties に対応する名前のルールも追加します。{ sizes } と styleProp の設定も引き継ぎます。eslint.config.* は読みません。
oxlint は .gitignore の対象を除外し、Plumeria のルールだけを実行します。
plumeria-lint -- next build でも lint は一回だけです。無効にするには次のように設定します。
export default withPlumeria(nextConfig, { lint: false });