@danielwaltz/eslint-config 0.0.13 → 0.0.14

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +24 -3
  3. package/dist/index.d.mts +3 -3
  4. package/dist/index.d.ts +3 -3
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,6 +1,23 @@
1
1
  # Changelog
2
2
 
3
3
 
4
+ ## v0.0.14
5
+
6
+ [compare changes](https://github.com/danielwaltz/eslint-config/compare/v0.0.13...v0.0.14)
7
+
8
+ ### 🚀 Enhancements
9
+
10
+ - Use const type params for generics ([a9e8b05](https://github.com/danielwaltz/eslint-config/commit/a9e8b05))
11
+
12
+ ### 🏡 Chore
13
+
14
+ - Update readme usage examples ([001ec31](https://github.com/danielwaltz/eslint-config/commit/001ec31))
15
+ - Add npm version badge to readme ([cac09a1](https://github.com/danielwaltz/eslint-config/commit/cac09a1))
16
+
17
+ ### ❤️ Contributors
18
+
19
+ - Daniel Waltz ([@danielwaltz](http://github.com/danielwaltz))
20
+
4
21
  ## v0.0.13
5
22
 
6
23
  [compare changes](https://github.com/danielwaltz/eslint-config/compare/v0.0.12...v0.0.13)
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @danielwaltz/eslint-config
1
+ # @danielwaltz/eslint-config [![npm](https://img.shields.io/npm/v/@danielwaltz/eslint-config.svg)](https://npmjs.com/package/@danielwaltz/eslint-config)
2
2
 
3
3
  My personal ESLint configuration. Extends from [@sxzz/eslint-config](https://github.com/sxzz/eslint-config).
4
4
 
@@ -10,7 +10,9 @@ npx -y nypm@latest i -D eslint prettier @danielwaltz/eslint-config
10
10
 
11
11
  ## Usage
12
12
 
13
- ```mjs
13
+ Using a TypeScript `eslint.config.ts` config file is ideal.
14
+
15
+ ```ts
14
16
  import { danielwaltz } from "@danielwaltz/eslint-config";
15
17
 
16
18
  export default danielwaltz();
@@ -18,10 +20,29 @@ export default danielwaltz();
18
20
 
19
21
  ## Customization
20
22
 
21
- ```mjs
23
+ Refer to [eslint-flat-config-utils](https://github.com/antfu/eslint-flat-config-utils) for all available options.
24
+
25
+ ```ts
22
26
  import { danielwaltz } from "@danielwaltz/eslint-config";
23
27
 
24
28
  export default danielwaltz([...customConfigs])
25
29
  .prepend([...prependConfigs])
26
30
  .append([...appendConfigs]);
27
31
  ```
32
+
33
+ ## Nuxt
34
+
35
+ Install the official [Nuxt ESLint](https://eslint.nuxt.com/) module.
36
+
37
+ ```shell
38
+ npx nuxi module add eslint
39
+ ```
40
+
41
+ Update the generated config.
42
+
43
+ ```ts
44
+ import { danielwaltz } from "@danielwaltz/eslint-config";
45
+ import { withNuxt } from "./.nuxt/eslint.config.mjs";
46
+
47
+ export default withNuxt(danielwaltz());
48
+ ```
package/dist/index.d.mts CHANGED
@@ -4,11 +4,11 @@ import * as eslint from 'eslint';
4
4
  import { Linter } from 'eslint';
5
5
  export * from '@sxzz/eslint-config';
6
6
 
7
- type BaseConfig = Linter.Config<Linter.RulesRecord>;
7
+ type BaseConfig = Linter.Config;
8
8
  type BaseConfigNames = keyof DefaultConfigNamesMap;
9
9
 
10
- declare function defineFlatConfigs<TConfig extends BaseConfig = BaseConfig, TConfigNames extends string = BaseConfigNames>(...configs: ResolvableFlatConfig<TConfig>[]): eslint_flat_config_utils.FlatConfigComposer<eslint.Linter.Config<eslint.Linter.RulesRecord> extends TConfig ? TConfig : eslint.Linter.Config<eslint.Linter.RulesRecord>, TConfigNames>;
10
+ declare function defineFlatConfigs<const TConfig extends BaseConfig = BaseConfig, const TConfigNames extends string = BaseConfigNames>(...configs: ResolvableFlatConfig<TConfig>[]): eslint_flat_config_utils.FlatConfigComposer<eslint.Linter.Config<eslint.Linter.RulesRecord> extends TConfig ? TConfig : eslint.Linter.Config<eslint.Linter.RulesRecord>, TConfigNames>;
11
11
 
12
- declare function danielwaltz<TConfig extends BaseConfig = BaseConfig, TConfigNames extends string = BaseConfigNames>(...userConfigs: ResolvableFlatConfig<TConfig>[]): eslint_flat_config_utils.FlatConfigComposer<eslint.Linter.Config<eslint.Linter.RulesRecord> extends TConfig ? TConfig : eslint.Linter.Config<eslint.Linter.RulesRecord>, TConfigNames>;
12
+ declare function danielwaltz<const TConfig extends BaseConfig = BaseConfig, const TConfigNames extends string = BaseConfigNames>(...userConfigs: ResolvableFlatConfig<TConfig>[]): eslint_flat_config_utils.FlatConfigComposer<eslint.Linter.Config<eslint.Linter.RulesRecord> extends TConfig ? TConfig : eslint.Linter.Config<eslint.Linter.RulesRecord>, TConfigNames>;
13
13
 
14
14
  export { danielwaltz, defineFlatConfigs };
package/dist/index.d.ts CHANGED
@@ -4,11 +4,11 @@ import * as eslint from 'eslint';
4
4
  import { Linter } from 'eslint';
5
5
  export * from '@sxzz/eslint-config';
6
6
 
7
- type BaseConfig = Linter.Config<Linter.RulesRecord>;
7
+ type BaseConfig = Linter.Config;
8
8
  type BaseConfigNames = keyof DefaultConfigNamesMap;
9
9
 
10
- declare function defineFlatConfigs<TConfig extends BaseConfig = BaseConfig, TConfigNames extends string = BaseConfigNames>(...configs: ResolvableFlatConfig<TConfig>[]): eslint_flat_config_utils.FlatConfigComposer<eslint.Linter.Config<eslint.Linter.RulesRecord> extends TConfig ? TConfig : eslint.Linter.Config<eslint.Linter.RulesRecord>, TConfigNames>;
10
+ declare function defineFlatConfigs<const TConfig extends BaseConfig = BaseConfig, const TConfigNames extends string = BaseConfigNames>(...configs: ResolvableFlatConfig<TConfig>[]): eslint_flat_config_utils.FlatConfigComposer<eslint.Linter.Config<eslint.Linter.RulesRecord> extends TConfig ? TConfig : eslint.Linter.Config<eslint.Linter.RulesRecord>, TConfigNames>;
11
11
 
12
- declare function danielwaltz<TConfig extends BaseConfig = BaseConfig, TConfigNames extends string = BaseConfigNames>(...userConfigs: ResolvableFlatConfig<TConfig>[]): eslint_flat_config_utils.FlatConfigComposer<eslint.Linter.Config<eslint.Linter.RulesRecord> extends TConfig ? TConfig : eslint.Linter.Config<eslint.Linter.RulesRecord>, TConfigNames>;
12
+ declare function danielwaltz<const TConfig extends BaseConfig = BaseConfig, const TConfigNames extends string = BaseConfigNames>(...userConfigs: ResolvableFlatConfig<TConfig>[]): eslint_flat_config_utils.FlatConfigComposer<eslint.Linter.Config<eslint.Linter.RulesRecord> extends TConfig ? TConfig : eslint.Linter.Config<eslint.Linter.RulesRecord>, TConfigNames>;
13
13
 
14
14
  export { danielwaltz, defineFlatConfigs };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@danielwaltz/eslint-config",
3
- "version": "0.0.13",
3
+ "version": "0.0.14",
4
4
  "packageManager": "pnpm@9.15.4",
5
5
  "type": "module",
6
6
  "keywords": [