ルール
パッケージ `@tai-kun/vp-lint-plugins` が提供する Oxlint ルールの一覧です。
@tai-kun/vp-lint-plugins は、Vite+(Oxlint)向けの独自ルールをまとめたプラグインです。vite.config.ts の lint.jsPlugins に追加すると、tai-kun/ プレフィックスのルールを有効にできます。
セットアップ
import { defineConfig } from "vite-plus";
export default defineConfig({
lint: {
jsPlugins: [
{
name: "tai-kun",
specifier: "@tai-kun/vp-lint-plugins",
},
],
rules: {
"tai-kun/spaced-comment": "error",
},
},
});
各ルールは tai-kun/<ルール名> で指定します。ルールの多くはレイアウト用で、最小限の空白や改行を挿入したあと、最終的な整形は Oxfmt に任せます。
コメント
| ルール | 内容 | 自動修正 |
|---|---|---|
spaced-comment |
コメントの開始記号の直後と終了記号の直前に空白を要求します。 | あり |
comment-one-sentence-per-line |
コメントを 1 行 1 文にし、単純なブロックコメントを 1 行化します。 | 一部(行の結合と 1 行化) |
comment-japanese-spacing |
日本語と半角文字の間に半角スペースを 1 つ要求します。 | あり |
JSDoc
| ルール | 内容 | 自動修正 |
|---|---|---|
jsdoc-tag-lines |
JSDoc の description とタグ、タググループの間の空行を揃えます。 | あり |
jsdoc-tag-order |
JSDoc タグの順序を統一します。 | なし |
jsdoc-param-order |
@param タグが関数の引数の順序に従うことを要求します。 |
なし |
空行
| ルール | 内容 | 自動修正 |
|---|---|---|
blank-line |
文・クラスメンバー・switch の case の境界に空行を要求します。 | あり |
レイアウト
| ルール | 内容 | 自動修正 |
|---|---|---|
object-properties-newline |
2 つ以上のプロパティーを持つオブジェクトリテラルを複数行にします。 | あり |
type-literal-properties-newline |
2 つ以上のメンバーを持つ型リテラルを複数行にします。 | あり |
インポート
| ルール | 内容 | 自動修正 |
|---|---|---|
merge-imports |
同じモジュールを指す連続した import 宣言を 1 つにまとめます。 | あり |
並び替え
| ルール | 内容 | 自動修正 |
|---|---|---|
sort-object-properties |
オブジェクトのプロパティーを名前の長さ順、次に名前順に並べます。 | あり |
sort-type-members |
型リテラルのメンバーを名前の長さ順、次に名前順に並べます。 | あり |
sort-jsx-props |
JSX の props をグループ順、名前の長さ順、名前順に並べます。 | あり |
sort-import-export-specifiers |
import/export の specifier をグループ順、名前の長さ順、名前順に並べます。 | あり |
クラス・関数
| ルール | 内容 | 自動修正 |
|---|---|---|
overload-signatures-adjacent |
オーバーロード署名と実装の間の空行を禁止します。 | あり |
member-ordering |
クラスメンバーの順序を統一します。 | なし |
explicit-member-accessibility |
# 以外のクラスメンバーにアクセス修飾子を要求します。 |
なし |
テスト
| ルール | 内容 | 自動修正 |
|---|---|---|
no-await-in-expect |
expect(await ...) の代わりに await expect(...).resolves / .rejects を要求します。 |
あり |
命名
| ルール | 内容 | 自動修正 |
|---|---|---|
catch-param-name |
catch の引数名に e / err / error / reason を禁止します。 |
なし(サジェストあり) |