@kazupon/eslint-config 0.33.1 → 0.33.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +39 -70
- package/dist/index.js +51 -72
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ import { StylisticCustomizeOptions } from "@stylistic/eslint-plugin";
|
|
|
9
9
|
/**
|
|
10
10
|
* define eslint configurations
|
|
11
11
|
*
|
|
12
|
-
* @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations
|
|
12
|
+
* @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs - eslint flat configurations
|
|
13
13
|
* @returns {FlatConfigComposer} eslint flat configuration composer
|
|
14
14
|
*/
|
|
15
15
|
declare function defineConfig(...configs: Awaitable<Linter.Config | Linter.Config[]>[]): FlatConfigComposer;
|
|
@@ -15688,9 +15688,10 @@ interface CommentsOptions {
|
|
|
15688
15688
|
}
|
|
15689
15689
|
/**
|
|
15690
15690
|
* configure comments preset for the below plugins
|
|
15691
|
+
*
|
|
15691
15692
|
* - `@eslint-community/eslint-plugin-eslint-comments`
|
|
15692
15693
|
*
|
|
15693
|
-
* @param {CommentsOptions} options {@link CommentsOptions | comments preset options}
|
|
15694
|
+
* @param {CommentsOptions} options - {@link CommentsOptions | comments preset options}
|
|
15694
15695
|
* @returns {Promise<Linter.Config[]>} resolved eslint flat configurations
|
|
15695
15696
|
*/
|
|
15696
15697
|
declare function comments(options?: CommentsOptions): Promise<Linter.Config[]>;
|
|
@@ -15724,7 +15725,7 @@ interface CssOptions {
|
|
|
15724
15725
|
* `@eslint/css` and overrides configuration options
|
|
15725
15726
|
*
|
|
15726
15727
|
* @param {CssOptions & OverridesOptions} options
|
|
15727
|
-
* eslint css configuration options
|
|
15728
|
+
* - eslint css configuration options
|
|
15728
15729
|
* @returns {Promise<Linter.Config[]>}
|
|
15729
15730
|
* eslint flat configurations with `@eslint/css` and overrides
|
|
15730
15731
|
*/
|
|
@@ -15760,9 +15761,8 @@ interface HtmlOptions {
|
|
|
15760
15761
|
/**
|
|
15761
15762
|
* `@html-eslint/eslint-plugin` and overrides configuration options
|
|
15762
15763
|
*
|
|
15763
|
-
* @param {HtmlOptions & OverridesOptions} options eslint configuration options for HTML
|
|
15764
|
-
* @returns {Promise<Linter.Config[]>}
|
|
15765
|
-
* eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
|
|
15764
|
+
* @param {HtmlOptions & OverridesOptions} options - eslint configuration options for HTML
|
|
15765
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
|
|
15766
15766
|
*/
|
|
15767
15767
|
declare function html(options?: HtmlOptions & OverridesOptions<HtmlRules>): Promise<Linter.Config[]>;
|
|
15768
15768
|
//#endregion
|
|
@@ -15788,10 +15788,9 @@ interface ImportsOptions {
|
|
|
15788
15788
|
* `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides configuration options
|
|
15789
15789
|
*
|
|
15790
15790
|
* @description if you want to use this preset, you need to put after `javascript` and `typescript` presets**
|
|
15791
|
-
*
|
|
15792
|
-
*
|
|
15793
|
-
* @returns {Promise<Linter.Config[]>}
|
|
15794
|
-
* eslint flat configurations with `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides
|
|
15791
|
+
*
|
|
15792
|
+
* @param {ImportsOptions & OverridesOptions} options - import configuration options
|
|
15793
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides
|
|
15795
15794
|
*/
|
|
15796
15795
|
declare function imports(options?: ImportsOptions & OverridesOptions<ImportsRules>): Promise<Linter.Config[]>;
|
|
15797
15796
|
//#endregion
|
|
@@ -15804,7 +15803,7 @@ interface JavaScriptOptions {}
|
|
|
15804
15803
|
/**
|
|
15805
15804
|
* `@eslint/js` and overrides configuration options
|
|
15806
15805
|
*
|
|
15807
|
-
* @param {JavaScriptOptions & OverridesOptions} options eslint configuration options for JavaScript
|
|
15806
|
+
* @param {JavaScriptOptions & OverridesOptions} options - eslint configuration options for JavaScript
|
|
15808
15807
|
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/js` and overrides
|
|
15809
15808
|
*/
|
|
15810
15809
|
declare function javascript(options?: JavaScriptOptions & OverridesOptions<JavascriptRules>): Promise<Linter.Config[]>;
|
|
@@ -15834,11 +15833,8 @@ interface JsDocumentOptions {
|
|
|
15834
15833
|
/**
|
|
15835
15834
|
* `eslint-plugin-jsdoc` and overrides configuration options
|
|
15836
15835
|
*
|
|
15837
|
-
* @param {JsDocOptions & OverridesOptions} options
|
|
15838
|
-
* eslint
|
|
15839
|
-
*
|
|
15840
|
-
* @returns {Promise<Linter.Config[]>}
|
|
15841
|
-
* eslint flat configurations with `eslint-plugin-jsdoc` and overrides
|
|
15836
|
+
* @param {JsDocOptions & OverridesOptions} options - eslint configuration options for JavaScript
|
|
15837
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-jsdoc` and overrides
|
|
15842
15838
|
*/
|
|
15843
15839
|
declare function jsdoc(options?: JsDocumentOptions & OverridesOptions<JsdocRules>): Promise<Linter.Config[]>;
|
|
15844
15840
|
//#endregion
|
|
@@ -15879,10 +15875,8 @@ interface JsoncOptions {
|
|
|
15879
15875
|
/**
|
|
15880
15876
|
* `eslint-plugin-jsonc` and overrides configuration options
|
|
15881
15877
|
*
|
|
15882
|
-
* @param {JsoncOptions & OverridesOptions} options
|
|
15883
|
-
*
|
|
15884
|
-
* @returns {Promise<Linter.Config[]>}
|
|
15885
|
-
* eslint flat configurations with `eslint-plugin-jsonc` and overrides
|
|
15878
|
+
* @param {JsoncOptions & OverridesOptions} options - eslint jsonc configuration options for json, jsonc, json5
|
|
15879
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-jsonc` and overrides
|
|
15886
15880
|
*/
|
|
15887
15881
|
declare function jsonc(options?: JsoncOptions & OverridesOptions<JsoncRules>): Promise<Linter.Config[]>;
|
|
15888
15882
|
//#endregion
|
|
@@ -15933,10 +15927,8 @@ interface MarkdownOptions {
|
|
|
15933
15927
|
/**
|
|
15934
15928
|
* `@eslint/markdown` and overrides configuration options
|
|
15935
15929
|
*
|
|
15936
|
-
* @param {MarkdownOptions & OverridesOptions} options
|
|
15937
|
-
*
|
|
15938
|
-
* @returns {Promise<Linter.Config[]>}
|
|
15939
|
-
* eslint flat configurations with `@eslint/markdown` and overrides
|
|
15930
|
+
* @param {MarkdownOptions & OverridesOptions} options - eslint unicorn configuration options
|
|
15931
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/markdown` and overrides
|
|
15940
15932
|
*/
|
|
15941
15933
|
declare function markdown(options?: MarkdownOptions & OverridesOptions): Promise<Linter.Config[]>;
|
|
15942
15934
|
// alias
|
|
@@ -15951,10 +15943,8 @@ interface PrettierOptions {}
|
|
|
15951
15943
|
/**
|
|
15952
15944
|
* `eslint-config-prettier` and overrides configuration options
|
|
15953
15945
|
*
|
|
15954
|
-
* @param {PrettierOptions & OverridesOptions} options
|
|
15955
|
-
* eslint
|
|
15956
|
-
* @returns {Promise<Linter.Config[]>}
|
|
15957
|
-
* eslint flat configurations with `eslint-config-prettier` and overrides
|
|
15946
|
+
* @param {PrettierOptions & OverridesOptions} options - eslint configuration options for Prettier
|
|
15947
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-config-prettier` and overrides
|
|
15958
15948
|
*/
|
|
15959
15949
|
declare function prettier(options?: PrettierOptions & OverridesOptions<PrettierRules>): Promise<Linter.Config[]>;
|
|
15960
15950
|
//#endregion
|
|
@@ -15967,10 +15957,8 @@ interface PromiseOptions {}
|
|
|
15967
15957
|
/**
|
|
15968
15958
|
* `eslint-plugin-promise` and overrides configuration options
|
|
15969
15959
|
*
|
|
15970
|
-
* @param {PromiseOptions & OverridesOptions} options
|
|
15971
|
-
*
|
|
15972
|
-
* @returns {Promise<Linter.Config[]>}
|
|
15973
|
-
* eslint flat configurations with `eslint-plugin-promise` and overrides
|
|
15960
|
+
* @param {PromiseOptions & OverridesOptions} options - eslint promise configuration options
|
|
15961
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-promise` and overrides
|
|
15974
15962
|
*/
|
|
15975
15963
|
declare function promise(options?: PromiseOptions & OverridesOptions<PromiseRules>): Promise<Linter.Config[]>;
|
|
15976
15964
|
//#endregion
|
|
@@ -16034,10 +16022,8 @@ interface TypeScriptProjectServiceOptions {
|
|
|
16034
16022
|
/**
|
|
16035
16023
|
* `typescript-eslint` and overrides configuration options
|
|
16036
16024
|
*
|
|
16037
|
-
* @param {TypeScriptOptions & OverridesOptions} options
|
|
16038
|
-
* eslint
|
|
16039
|
-
* @returns {Promise<Linter.FlatConfig[]>}
|
|
16040
|
-
* eslint flat configurations with `typescript-eslint` and overrides
|
|
16025
|
+
* @param {TypeScriptOptions & OverridesOptions} options - eslint configuration options for TypeScript
|
|
16026
|
+
* @returns {Promise<Linter.FlatConfig[]>} eslint flat configurations with `typescript-eslint` and overrides
|
|
16041
16027
|
*/
|
|
16042
16028
|
declare function typescript(options?: TypeScriptOptions & OverridesOptions<TypescriptRules>): Promise<Linter.Config[]>;
|
|
16043
16029
|
//#endregion
|
|
@@ -16062,10 +16048,8 @@ interface ReactOptions {
|
|
|
16062
16048
|
/**
|
|
16063
16049
|
* `eslint-plugin-react` and overrides configuration options
|
|
16064
16050
|
*
|
|
16065
|
-
* @param {ReactOptions & OverridesOptions} options
|
|
16066
|
-
*
|
|
16067
|
-
* @returns {Promise<Linter.Config[]>}
|
|
16068
|
-
* eslint flat configurations with `eslint-plugin-react` and overrides
|
|
16051
|
+
* @param {ReactOptions & OverridesOptions} options - eslint react configuration options for regular expressions
|
|
16052
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-react` and overrides
|
|
16069
16053
|
*/
|
|
16070
16054
|
declare function react(options?: ReactOptions & TypeScriptOptions & OverridesOptions<ReactRules>): Promise<Linter.Config[]>;
|
|
16071
16055
|
//#endregion
|
|
@@ -16078,10 +16062,8 @@ interface RegexpOptions {}
|
|
|
16078
16062
|
/**
|
|
16079
16063
|
* `eslint-plugin-regexp` and overrides configuration options
|
|
16080
16064
|
*
|
|
16081
|
-
* @param {RegexpOptions & OverridesOptions} options
|
|
16082
|
-
*
|
|
16083
|
-
* @returns {Promise<Linter.Config[]>}
|
|
16084
|
-
* eslint flat configurations with `eslint-plugin-regexp` and overrides
|
|
16065
|
+
* @param {RegexpOptions & OverridesOptions} options - eslint regexp configuration options for regular expressions
|
|
16066
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-regexp` and overrides
|
|
16085
16067
|
*/
|
|
16086
16068
|
declare function regexp(options?: RegexpOptions & OverridesOptions<RegexpRules>): Promise<Linter.Config[]>;
|
|
16087
16069
|
//#endregion
|
|
@@ -16100,10 +16082,8 @@ interface StylisticOptions {
|
|
|
16100
16082
|
/**
|
|
16101
16083
|
* `@stylistic/eslint-plugin` and overrides configuration options
|
|
16102
16084
|
*
|
|
16103
|
-
* @param {StylisticOptions & OverridesOptions} options
|
|
16104
|
-
* stylistic
|
|
16105
|
-
* @returns {Promise<Linter.Config[]>}
|
|
16106
|
-
* eslint flat configurations with `@stylistic/eslint-plugin` and overrides
|
|
16085
|
+
* @param {StylisticOptions & OverridesOptions} options - stylistic eslint plugin configuration options
|
|
16086
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@stylistic/eslint-plugin` and overrides
|
|
16107
16087
|
*/
|
|
16108
16088
|
declare function stylistic(options?: StylisticOptions & OverridesOptions<StylisticRules>): Promise<Linter.Config[]>;
|
|
16109
16089
|
//#endregion
|
|
@@ -16128,10 +16108,8 @@ interface SvelteScriptOptions {
|
|
|
16128
16108
|
/**
|
|
16129
16109
|
* `eslint-plugin-svelte` and overrides configuration options
|
|
16130
16110
|
*
|
|
16131
|
-
* @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options
|
|
16132
|
-
* eslint
|
|
16133
|
-
* @returns {Promise<Linter.Config[]>}
|
|
16134
|
-
* eslint flat configurations with `eslint-plugin-svelte` and overrides
|
|
16111
|
+
* @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options - eslint configuration options for Vue
|
|
16112
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-svelte` and overrides
|
|
16135
16113
|
*/
|
|
16136
16114
|
declare function svelte(options?: SvelteScriptOptions & TypeScriptOptions & OverridesOptions<SvelteRules>): Promise<Linter.Config[]>;
|
|
16137
16115
|
//#endregion
|
|
@@ -16144,10 +16122,8 @@ interface TomlOptions {}
|
|
|
16144
16122
|
/**
|
|
16145
16123
|
* `eslint-plugin-yml` and overrides configuration options
|
|
16146
16124
|
*
|
|
16147
|
-
* @param {YmlOptions & OverridesOptions} options
|
|
16148
|
-
*
|
|
16149
|
-
* @returns {Promise<Linter.Config[]>}
|
|
16150
|
-
* eslint flat configurations with `eslint-plugin-yml` and overrides
|
|
16125
|
+
* @param {YmlOptions & OverridesOptions} options - eslint yml configuration options for yml, yaml
|
|
16126
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-yml` and overrides
|
|
16151
16127
|
*/
|
|
16152
16128
|
declare function toml(options?: TomlOptions & OverridesOptions<TomlRules>): Promise<Linter.Config[]>;
|
|
16153
16129
|
//#endregion
|
|
@@ -16166,8 +16142,7 @@ interface UnicornOptions {
|
|
|
16166
16142
|
/**
|
|
16167
16143
|
* `eslint-plugin-unicorn` and overrides configuration options
|
|
16168
16144
|
*
|
|
16169
|
-
* @param {UnicornOptions & OverridesOptions} options
|
|
16170
|
-
* eslint unicorn configuration options
|
|
16145
|
+
* @param {UnicornOptions & OverridesOptions} options - eslint unicorn configuration options
|
|
16171
16146
|
* @returns {Promise<Linter.Config[]>}
|
|
16172
16147
|
* eslint flat configurations with `eslint-plugin-unicorn` and overrides
|
|
16173
16148
|
*/
|
|
@@ -16190,10 +16165,8 @@ interface VitestOptions {
|
|
|
16190
16165
|
/**
|
|
16191
16166
|
* `@vitest/eslint-plugin` and overrides configuration options
|
|
16192
16167
|
*
|
|
16193
|
-
* @param {VitestOptions & OverridesOptions} options
|
|
16194
|
-
*
|
|
16195
|
-
* @returns {Promise<Linter.Config[]>}
|
|
16196
|
-
* eslint flat configurations with `@vitest/eslint-plugin` and overrides
|
|
16168
|
+
* @param {VitestOptions & OverridesOptions} options - eslint vitest configuration options
|
|
16169
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@vitest/eslint-plugin` and overrides
|
|
16197
16170
|
*/
|
|
16198
16171
|
declare function vitest(options?: VitestOptions & OverridesOptions<VitestRules>): Promise<Linter.Config[]>;
|
|
16199
16172
|
//#endregion
|
|
@@ -16251,10 +16224,8 @@ interface VueI18nOptions {
|
|
|
16251
16224
|
/**
|
|
16252
16225
|
* `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides configuration options
|
|
16253
16226
|
*
|
|
16254
|
-
* @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
|
|
16255
|
-
* eslint
|
|
16256
|
-
* @returns {Promise<Linter.Config[]>}
|
|
16257
|
-
* eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
|
|
16227
|
+
* @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options - eslint configuration options for Vue
|
|
16228
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
|
|
16258
16229
|
*/
|
|
16259
16230
|
declare function vue(options?: VueScriptOptions & TypeScriptOptions & OverridesOptions<VueRules>): Promise<Linter.Config[]>;
|
|
16260
16231
|
//#endregion
|
|
@@ -16274,10 +16245,8 @@ interface YmlOptions {
|
|
|
16274
16245
|
/**
|
|
16275
16246
|
* `eslint-plugin-yml` and overrides configuration options
|
|
16276
16247
|
*
|
|
16277
|
-
* @param {YmlOptions & OverridesOptions} options
|
|
16278
|
-
*
|
|
16279
|
-
* @returns {Promise<Linter.Config[]>}
|
|
16280
|
-
* eslint flat configurations with `eslint-plugin-yml` and overrides
|
|
16248
|
+
* @param {YmlOptions & OverridesOptions} options - eslint yml configuration options for yml, yaml
|
|
16249
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-yml` and overrides
|
|
16281
16250
|
*/
|
|
16282
16251
|
declare function yml(options?: YmlOptions & OverridesOptions<YmlRules>): Promise<Linter.Config[]>;
|
|
16283
16252
|
// alias
|
package/dist/index.js
CHANGED
|
@@ -8,7 +8,7 @@ import { mergeProcessors, processorPassThrough } from "eslint-merge-processors";
|
|
|
8
8
|
/**
|
|
9
9
|
* define eslint configurations
|
|
10
10
|
*
|
|
11
|
-
* @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs eslint flat configurations
|
|
11
|
+
* @param {Awaitable<Linter.Config | Linter.Config[]>[]} configs - eslint flat configurations
|
|
12
12
|
* @returns {FlatConfigComposer} eslint flat configuration composer
|
|
13
13
|
*/
|
|
14
14
|
function defineConfig(...configs) {
|
|
@@ -60,7 +60,9 @@ const GLOB_TESTS_TYPE = [`**/*.test-d.${GLOB_SRC_EXT}`, `**/*.spec-d.${GLOB_SRC_
|
|
|
60
60
|
/**
|
|
61
61
|
* load eslint plugin
|
|
62
62
|
*
|
|
63
|
-
* @
|
|
63
|
+
* @typeParam T - plugin type
|
|
64
|
+
*
|
|
65
|
+
* @param {string} name - plugin name
|
|
64
66
|
* @returns {Promise<T>} loaded plugin
|
|
65
67
|
*/
|
|
66
68
|
async function loadPlugin(name) {
|
|
@@ -84,7 +86,7 @@ async function getTypeScriptParser() {
|
|
|
84
86
|
/**
|
|
85
87
|
* get glob source files
|
|
86
88
|
*
|
|
87
|
-
* @param {boolean} useTypeScript use TypeScript, default `false`
|
|
89
|
+
* @param {boolean} useTypeScript - use TypeScript, default `false`
|
|
88
90
|
* @returns {string[]} files
|
|
89
91
|
*/
|
|
90
92
|
function getGlobSourceFiles(useTypeScript = false) {
|
|
@@ -99,9 +101,10 @@ function getGlobSourceFiles(useTypeScript = false) {
|
|
|
99
101
|
//#region src/configs/comments.ts
|
|
100
102
|
/**
|
|
101
103
|
* configure comments preset for the below plugins
|
|
104
|
+
*
|
|
102
105
|
* - `@eslint-community/eslint-plugin-eslint-comments`
|
|
103
106
|
*
|
|
104
|
-
* @param {CommentsOptions} options {@link CommentsOptions | comments preset options}
|
|
107
|
+
* @param {CommentsOptions} options - {@link CommentsOptions | comments preset options}
|
|
105
108
|
* @returns {Promise<Linter.Config[]>} resolved eslint flat configurations
|
|
106
109
|
*/
|
|
107
110
|
async function comments(options = {}) {
|
|
@@ -134,7 +137,7 @@ async function comments(options = {}) {
|
|
|
134
137
|
* `@eslint/css` and overrides configuration options
|
|
135
138
|
*
|
|
136
139
|
* @param {CssOptions & OverridesOptions} options
|
|
137
|
-
* eslint css configuration options
|
|
140
|
+
* - eslint css configuration options
|
|
138
141
|
* @returns {Promise<Linter.Config[]>}
|
|
139
142
|
* eslint flat configurations with `@eslint/css` and overrides
|
|
140
143
|
*/
|
|
@@ -169,9 +172,8 @@ async function css(options = {}) {
|
|
|
169
172
|
/**
|
|
170
173
|
* `@html-eslint/eslint-plugin` and overrides configuration options
|
|
171
174
|
*
|
|
172
|
-
* @param {HtmlOptions & OverridesOptions} options eslint configuration options for HTML
|
|
173
|
-
* @returns {Promise<Linter.Config[]>}
|
|
174
|
-
* eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
|
|
175
|
+
* @param {HtmlOptions & OverridesOptions} options - eslint configuration options for HTML
|
|
176
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@html-eslint/eslint-plugin` and overrides
|
|
175
177
|
*/
|
|
176
178
|
async function html(options = {}) {
|
|
177
179
|
const { rules: overrideRules = {}, prettier: prettier$1 = false, frontmatter = false, templateEngineSyntax } = options;
|
|
@@ -241,10 +243,9 @@ const IMPORTS_FILES = [
|
|
|
241
243
|
* `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides configuration options
|
|
242
244
|
*
|
|
243
245
|
* @description if you want to use this preset, you need to put after `javascript` and `typescript` presets**
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
* @returns {Promise<Linter.Config[]>}
|
|
247
|
-
* eslint flat configurations with `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides
|
|
246
|
+
*
|
|
247
|
+
* @param {ImportsOptions & OverridesOptions} options - import configuration options
|
|
248
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-import-x`, `eslint-plugin-unused-imports` and overrides
|
|
248
249
|
*/
|
|
249
250
|
async function imports(options = {}) {
|
|
250
251
|
const { rules: overrideRules = {}, interop = true } = options;
|
|
@@ -304,7 +305,7 @@ async function imports(options = {}) {
|
|
|
304
305
|
/**
|
|
305
306
|
* `@eslint/js` and overrides configuration options
|
|
306
307
|
*
|
|
307
|
-
* @param {JavaScriptOptions & OverridesOptions} options eslint configuration options for JavaScript
|
|
308
|
+
* @param {JavaScriptOptions & OverridesOptions} options - eslint configuration options for JavaScript
|
|
308
309
|
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/js` and overrides
|
|
309
310
|
*/
|
|
310
311
|
async function javascript(options = {}) {
|
|
@@ -343,11 +344,8 @@ async function javascript(options = {}) {
|
|
|
343
344
|
/**
|
|
344
345
|
* `eslint-plugin-jsdoc` and overrides configuration options
|
|
345
346
|
*
|
|
346
|
-
* @param {JsDocOptions & OverridesOptions} options
|
|
347
|
-
* eslint
|
|
348
|
-
*
|
|
349
|
-
* @returns {Promise<Linter.Config[]>}
|
|
350
|
-
* eslint flat configurations with `eslint-plugin-jsdoc` and overrides
|
|
347
|
+
* @param {JsDocOptions & OverridesOptions} options - eslint configuration options for JavaScript
|
|
348
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-jsdoc` and overrides
|
|
351
349
|
*/
|
|
352
350
|
async function jsdoc(options = {}) {
|
|
353
351
|
const { rules: overrideRules = {}, ignores: overrideIgnores = [], typescript: typescript$1, error = false } = options;
|
|
@@ -408,6 +406,14 @@ async function jsdoc(options = {}) {
|
|
|
408
406
|
applyToEndTag: false
|
|
409
407
|
}
|
|
410
408
|
],
|
|
409
|
+
"jsdoc/require-param": ["error", { checkDestructuredRoots: false }],
|
|
410
|
+
"jsdoc/check-param-names": ["error", { checkDestructured: false }],
|
|
411
|
+
"jsdoc/check-tag-names": ["error", { definedTags: ["typeParam"] }],
|
|
412
|
+
"jsdoc/require-hyphen-before-param-description": [
|
|
413
|
+
"error",
|
|
414
|
+
"always",
|
|
415
|
+
{ tags: { typeParam: "always" } }
|
|
416
|
+
],
|
|
411
417
|
...overrideRules
|
|
412
418
|
}
|
|
413
419
|
}];
|
|
@@ -418,10 +424,8 @@ async function jsdoc(options = {}) {
|
|
|
418
424
|
/**
|
|
419
425
|
* `eslint-plugin-jsonc` and overrides configuration options
|
|
420
426
|
*
|
|
421
|
-
* @param {JsoncOptions & OverridesOptions} options
|
|
422
|
-
*
|
|
423
|
-
* @returns {Promise<Linter.Config[]>}
|
|
424
|
-
* eslint flat configurations with `eslint-plugin-jsonc` and overrides
|
|
427
|
+
* @param {JsoncOptions & OverridesOptions} options - eslint jsonc configuration options for json, jsonc, json5
|
|
428
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-jsonc` and overrides
|
|
425
429
|
*/
|
|
426
430
|
async function jsonc(options = {}) {
|
|
427
431
|
const { rules: overrideRules = {} } = options;
|
|
@@ -547,10 +551,8 @@ function jsoncSort() {
|
|
|
547
551
|
/**
|
|
548
552
|
* `@eslint/markdown` and overrides configuration options
|
|
549
553
|
*
|
|
550
|
-
* @param {MarkdownOptions & OverridesOptions} options
|
|
551
|
-
*
|
|
552
|
-
* @returns {Promise<Linter.Config[]>}
|
|
553
|
-
* eslint flat configurations with `@eslint/markdown` and overrides
|
|
554
|
+
* @param {MarkdownOptions & OverridesOptions} options - eslint unicorn configuration options
|
|
555
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@eslint/markdown` and overrides
|
|
554
556
|
*/
|
|
555
557
|
async function markdown(options = {}) {
|
|
556
558
|
const { rules: overrideRules = {}, files = [GLOB_MARKDOWN], blockExtensions = [] } = options;
|
|
@@ -598,10 +600,8 @@ const md = markdown;
|
|
|
598
600
|
/**
|
|
599
601
|
* `eslint-config-prettier` and overrides configuration options
|
|
600
602
|
*
|
|
601
|
-
* @param {PrettierOptions & OverridesOptions} options
|
|
602
|
-
* eslint
|
|
603
|
-
* @returns {Promise<Linter.Config[]>}
|
|
604
|
-
* eslint flat configurations with `eslint-config-prettier` and overrides
|
|
603
|
+
* @param {PrettierOptions & OverridesOptions} options - eslint configuration options for Prettier
|
|
604
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-config-prettier` and overrides
|
|
605
605
|
*/
|
|
606
606
|
async function prettier(options = {}) {
|
|
607
607
|
const { rules: overrideRules = {} } = options;
|
|
@@ -620,10 +620,8 @@ async function prettier(options = {}) {
|
|
|
620
620
|
/**
|
|
621
621
|
* `eslint-plugin-promise` and overrides configuration options
|
|
622
622
|
*
|
|
623
|
-
* @param {PromiseOptions & OverridesOptions} options
|
|
624
|
-
*
|
|
625
|
-
* @returns {Promise<Linter.Config[]>}
|
|
626
|
-
* eslint flat configurations with `eslint-plugin-promise` and overrides
|
|
623
|
+
* @param {PromiseOptions & OverridesOptions} options - eslint promise configuration options
|
|
624
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-promise` and overrides
|
|
627
625
|
*/
|
|
628
626
|
async function promise(options = {}) {
|
|
629
627
|
const { rules: overrideRules = {} } = options;
|
|
@@ -642,10 +640,8 @@ async function promise(options = {}) {
|
|
|
642
640
|
/**
|
|
643
641
|
* `eslint-plugin-react` and overrides configuration options
|
|
644
642
|
*
|
|
645
|
-
* @param {ReactOptions & OverridesOptions} options
|
|
646
|
-
*
|
|
647
|
-
* @returns {Promise<Linter.Config[]>}
|
|
648
|
-
* eslint flat configurations with `eslint-plugin-react` and overrides
|
|
643
|
+
* @param {ReactOptions & OverridesOptions} options - eslint react configuration options for regular expressions
|
|
644
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-react` and overrides
|
|
649
645
|
*/
|
|
650
646
|
async function react(options = {}) {
|
|
651
647
|
const { rules: overrideRules = {}, settings = {} } = options;
|
|
@@ -691,10 +687,8 @@ async function react(options = {}) {
|
|
|
691
687
|
/**
|
|
692
688
|
* `eslint-plugin-regexp` and overrides configuration options
|
|
693
689
|
*
|
|
694
|
-
* @param {RegexpOptions & OverridesOptions} options
|
|
695
|
-
*
|
|
696
|
-
* @returns {Promise<Linter.Config[]>}
|
|
697
|
-
* eslint flat configurations with `eslint-plugin-regexp` and overrides
|
|
690
|
+
* @param {RegexpOptions & OverridesOptions} options - eslint regexp configuration options for regular expressions
|
|
691
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-regexp` and overrides
|
|
698
692
|
*/
|
|
699
693
|
async function regexp(options = {}) {
|
|
700
694
|
const { rules: overrideRules = {} } = options;
|
|
@@ -714,10 +708,8 @@ async function regexp(options = {}) {
|
|
|
714
708
|
/**
|
|
715
709
|
* `@stylistic/eslint-plugin` and overrides configuration options
|
|
716
710
|
*
|
|
717
|
-
* @param {StylisticOptions & OverridesOptions} options
|
|
718
|
-
* stylistic
|
|
719
|
-
* @returns {Promise<Linter.Config[]>}
|
|
720
|
-
* eslint flat configurations with `@stylistic/eslint-plugin` and overrides
|
|
711
|
+
* @param {StylisticOptions & OverridesOptions} options - stylistic eslint plugin configuration options
|
|
712
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@stylistic/eslint-plugin` and overrides
|
|
721
713
|
*/
|
|
722
714
|
async function stylistic(options = {}) {
|
|
723
715
|
const { rules: overrideRules = {}, customize = {
|
|
@@ -760,10 +752,8 @@ async function stylistic(options = {}) {
|
|
|
760
752
|
/**
|
|
761
753
|
* `eslint-plugin-svelte` and overrides configuration options
|
|
762
754
|
*
|
|
763
|
-
* @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options
|
|
764
|
-
* eslint
|
|
765
|
-
* @returns {Promise<Linter.Config[]>}
|
|
766
|
-
* eslint flat configurations with `eslint-plugin-svelte` and overrides
|
|
755
|
+
* @param {SvelteScriptOptions & TypeScriptOptions & OverridesOptions} options - eslint configuration options for Vue
|
|
756
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-svelte` and overrides
|
|
767
757
|
*/
|
|
768
758
|
async function svelte(options = {}) {
|
|
769
759
|
const { rules: overrideRules = {}, parserOptions = { projectService: true }, svelteConfig = {} } = options;
|
|
@@ -797,10 +787,8 @@ async function svelte(options = {}) {
|
|
|
797
787
|
/**
|
|
798
788
|
* `eslint-plugin-yml` and overrides configuration options
|
|
799
789
|
*
|
|
800
|
-
* @param {YmlOptions & OverridesOptions} options
|
|
801
|
-
*
|
|
802
|
-
* @returns {Promise<Linter.Config[]>}
|
|
803
|
-
* eslint flat configurations with `eslint-plugin-yml` and overrides
|
|
790
|
+
* @param {YmlOptions & OverridesOptions} options - eslint yml configuration options for yml, yaml
|
|
791
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-yml` and overrides
|
|
804
792
|
*/
|
|
805
793
|
async function toml(options = {}) {
|
|
806
794
|
const { rules: overrideRules = {} } = options;
|
|
@@ -828,10 +816,8 @@ async function toml(options = {}) {
|
|
|
828
816
|
/**
|
|
829
817
|
* `typescript-eslint` and overrides configuration options
|
|
830
818
|
*
|
|
831
|
-
* @param {TypeScriptOptions & OverridesOptions} options
|
|
832
|
-
* eslint
|
|
833
|
-
* @returns {Promise<Linter.FlatConfig[]>}
|
|
834
|
-
* eslint flat configurations with `typescript-eslint` and overrides
|
|
819
|
+
* @param {TypeScriptOptions & OverridesOptions} options - eslint configuration options for TypeScript
|
|
820
|
+
* @returns {Promise<Linter.FlatConfig[]>} eslint flat configurations with `typescript-eslint` and overrides
|
|
835
821
|
*/
|
|
836
822
|
async function typescript(options = {}) {
|
|
837
823
|
const { rules: overrideRules = {}, extraFileExtensions = [], parserOptions = { project: true } } = options;
|
|
@@ -908,8 +894,7 @@ async function typescript(options = {}) {
|
|
|
908
894
|
/**
|
|
909
895
|
* `eslint-plugin-unicorn` and overrides configuration options
|
|
910
896
|
*
|
|
911
|
-
* @param {UnicornOptions & OverridesOptions} options
|
|
912
|
-
* eslint unicorn configuration options
|
|
897
|
+
* @param {UnicornOptions & OverridesOptions} options - eslint unicorn configuration options
|
|
913
898
|
* @returns {Promise<Linter.Config[]>}
|
|
914
899
|
* eslint flat configurations with `eslint-plugin-unicorn` and overrides
|
|
915
900
|
*/
|
|
@@ -932,10 +917,8 @@ async function unicorn(options = {}) {
|
|
|
932
917
|
/**
|
|
933
918
|
* `@vitest/eslint-plugin` and overrides configuration options
|
|
934
919
|
*
|
|
935
|
-
* @param {VitestOptions & OverridesOptions} options
|
|
936
|
-
*
|
|
937
|
-
* @returns {Promise<Linter.Config[]>}
|
|
938
|
-
* eslint flat configurations with `@vitest/eslint-plugin` and overrides
|
|
920
|
+
* @param {VitestOptions & OverridesOptions} options - eslint vitest configuration options
|
|
921
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `@vitest/eslint-plugin` and overrides
|
|
939
922
|
*/
|
|
940
923
|
async function vitest(options = {}) {
|
|
941
924
|
const { rules: overrideRules = {}, files: overrideFiles = [] } = options;
|
|
@@ -967,10 +950,8 @@ async function vitest(options = {}) {
|
|
|
967
950
|
/**
|
|
968
951
|
* `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides configuration options
|
|
969
952
|
*
|
|
970
|
-
* @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options
|
|
971
|
-
* eslint
|
|
972
|
-
* @returns {Promise<Linter.Config[]>}
|
|
973
|
-
* eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
|
|
953
|
+
* @param {VueScriptOptions & TypeScriptOptions & OverridesOptions} options - eslint configuration options for Vue
|
|
954
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-vue`, `eslint-plugin-vue-composable`, `eslint-plugin-vue-eslint-plugin-vuejs-accessibility` and overrides
|
|
974
955
|
*/
|
|
975
956
|
async function vue(options = {}) {
|
|
976
957
|
const { rules: overrideRules = {}, parserOptions = { projectService: true } } = options;
|
|
@@ -1046,10 +1027,8 @@ async function vue(options = {}) {
|
|
|
1046
1027
|
/**
|
|
1047
1028
|
* `eslint-plugin-yml` and overrides configuration options
|
|
1048
1029
|
*
|
|
1049
|
-
* @param {YmlOptions & OverridesOptions} options
|
|
1050
|
-
*
|
|
1051
|
-
* @returns {Promise<Linter.Config[]>}
|
|
1052
|
-
* eslint flat configurations with `eslint-plugin-yml` and overrides
|
|
1030
|
+
* @param {YmlOptions & OverridesOptions} options - eslint yml configuration options for yml, yaml
|
|
1031
|
+
* @returns {Promise<Linter.Config[]>} eslint flat configurations with `eslint-plugin-yml` and overrides
|
|
1053
1032
|
*/
|
|
1054
1033
|
async function yml(options = {}) {
|
|
1055
1034
|
const { rules: overrideRules = {} } = options;
|