Skip to content

Commit

Permalink
Merge pull request #145 from hatena/update-dts
Browse files Browse the repository at this point in the history
型定義の更新漏れを修正
  • Loading branch information
susisu authored Oct 7, 2024
2 parents b169616 + 956dc72 commit 82149a0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
4 changes: 2 additions & 2 deletions lib/config/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ const rules = require('../rules/index.js');
* @property {boolean | undefined} [react]
* true の場合, React に関連する設定を有効にする.
* デフォルト: false
* @property {boolean | "strict" | undefined} [next]
* @property {boolean | 'strict' | undefined} [next]
* true の場合, React に関する設定と eslint-config-next 相当の設定を有効にする.
* `"strict"` を指定した場合, Core Web Vitals に関するルールを追加で有効にする.
* `'strict'` を指定した場合, Core Web Vitals に関するルールを追加で有効にする.
* デフォルト: false
* @property {boolean | undefined} [prettier]
* Prettier を使用するか. true の場合, eslint-config-prettier を使ってフォーマットに関するルールを無効化する.
Expand Down
16 changes: 11 additions & 5 deletions lib/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,33 @@ import { Config, ConfigWithExtends } from 'typescript-eslint';
type ConfigOptions = Readonly<
Partial<{
/**
* TypeScript の設定ファイル (https://typescript-eslint.io/packages/parser#project)
* TypeScript の設定ファイル (https://typescript-eslint.io/packages/parser#project).
* デフォルト: true (lint 対象のファイルに最も近い tsconfig.json を利用する)
*/
tsProject: ParserOptions['project'];
/**
* TypeScript のプロジェクトの設定 (https://typescript-eslint.io/packages/parser#projectservice)
* TypeScript のプロジェクトの設定 (https://typescript-eslint.io/packages/parser#projectservice).
* デフォルト: false (無効)
*/
tsProjectService: ParserOptions['projectService'];
/**
* tsconfig.json の探索先のルートディレクトリ (https://typescript-eslint.io/packages/parser#tsconfigrootdir)
* tsconfig.json の探索先のルートディレクトリ (https://typescript-eslint.io/packages/parser#tsconfigrootdir).
* デフォルト: undefined
*/
tsconfigRootDir: ParserOptions['tsconfigRootDir'];
/**
* React を使用するか. true の場合, React に関連する設定を有効にする
* React を使用するか. true の場合, React に関連する設定を有効にする.
* デフォルト: false
*/
react: boolean | undefined;
/**
* Prettier を使用するか. true の場合, eslint-config-prettier を使ってフォーマットに関するルールを無効化する
* true の場合, React に関する設定と eslint-config-next 相当の設定を有効にする.
* `'strict'` を指定した場合, Core Web Vitals に関するルールを追加で有効にする.
* デフォルト: false
*/
next: boolean | 'strict' | undefined;
/**
* Prettier を使用するか. true の場合, eslint-config-prettier を使ってフォーマットに関するルールを無効化する.
* デフォルト: true
*/
prettier: boolean | undefined;
Expand Down

0 comments on commit 82149a0

Please sign in to comment.