eslint-config-decent 2.0.0 → 2.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 James Geurts
+Copyright (c) James Geurts
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -56,7 +56,19 @@ export default [
     rules: {
       '@typescript-eslint/no-confusing-void-expression': 'off',
     },
-  }
+  },
+];
+```
+
+## Use typescript-eslint config
+
+```mjs
+// eslint.config.mjs
+
+import { tsEslintConfig } from 'eslint-config-decent';
+import tsEslint from 'typescript-eslint';
+
+export default tsEslint(...tsEslintConfig());
 ```
 
 ## License

package/dist/index.cjs

@@ -671,7 +671,8 @@ const configs = {
   base
 };
 
-function defaultConfig(options) {
+const defaultConfig = tsEslintConfig;
+function tsEslintConfig(options) {
   const enableRequireExtensionRule = options?.enableRequireExtensionRule ?? true;
   const languageOptions = {
     globals: {
@@ -766,7 +767,7 @@ function defaultConfig(options) {
   ];
 }
 function config(options) {
-  return tsEslint__default.config(...defaultConfig(options));
+  return tsEslint__default.config(...tsEslintConfig(options));
 }
 
 exports.config = config;
@@ -777,5 +778,6 @@ exports.jsdocConfigs = configs$6;
 exports.promiseConfigs = configs$4;
 exports.reactConfigs = configs$3;
 exports.securityConfigs = configs$2;
+exports.tsEslintConfig = tsEslintConfig;
 exports.typescriptEslintConfigs = configs$1;
 exports.unicornConfigs = configs;

package/dist/index.d.cts

@@ -39,12 +39,16 @@ interface DefaultConfigOptions {
     parserOptions?: NonNullable<ConfigWithExtends['languageOptions']>['parserOptions'];
     enableRequireExtensionRule?: boolean;
 }
+/**
+ * @deprecated Use `tsEslintConfig` instead
+ */
+declare const defaultConfig: typeof tsEslintConfig;
 /**
  * Exports the default configuration to be passed to `tsEslint.config`. Use this if you want more control of typescript-eslint configuration output.
  * @param {DefaultConfigOptions} options
  * @returns Array of typescript-eslint configurations
  */
-declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
+declare function tsEslintConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
 /**
  * Exports eslint configurations. Use this if you do not need to explicitly import typescript-eslint in your project.
  * @param options
@@ -52,4 +56,4 @@ declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtend
  */
 declare function config(options?: DefaultConfigOptions): TSESLint.FlatConfig.ConfigArray;
 
-export { type DefaultConfigOptions, config, defaultConfig, configs$7 as eslintConfigs, configs$6 as importConfigs, configs$5 as jsdocConfigs, configs$4 as promiseConfigs, configs$3 as reactConfigs, configs$2 as securityConfigs, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };
+export { type DefaultConfigOptions, config, defaultConfig, configs$7 as eslintConfigs, configs$6 as importConfigs, configs$5 as jsdocConfigs, configs$4 as promiseConfigs, configs$3 as reactConfigs, configs$2 as securityConfigs, tsEslintConfig, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };

package/dist/index.d.mts

@@ -39,12 +39,16 @@ interface DefaultConfigOptions {
     parserOptions?: NonNullable<ConfigWithExtends['languageOptions']>['parserOptions'];
     enableRequireExtensionRule?: boolean;
 }
+/**
+ * @deprecated Use `tsEslintConfig` instead
+ */
+declare const defaultConfig: typeof tsEslintConfig;
 /**
  * Exports the default configuration to be passed to `tsEslint.config`. Use this if you want more control of typescript-eslint configuration output.
  * @param {DefaultConfigOptions} options
  * @returns Array of typescript-eslint configurations
  */
-declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
+declare function tsEslintConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
 /**
  * Exports eslint configurations. Use this if you do not need to explicitly import typescript-eslint in your project.
  * @param options
@@ -52,4 +56,4 @@ declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtend
  */
 declare function config(options?: DefaultConfigOptions): TSESLint.FlatConfig.ConfigArray;
 
-export { type DefaultConfigOptions, config, defaultConfig, configs$7 as eslintConfigs, configs$6 as importConfigs, configs$5 as jsdocConfigs, configs$4 as promiseConfigs, configs$3 as reactConfigs, configs$2 as securityConfigs, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };
+export { type DefaultConfigOptions, config, defaultConfig, configs$7 as eslintConfigs, configs$6 as importConfigs, configs$5 as jsdocConfigs, configs$4 as promiseConfigs, configs$3 as reactConfigs, configs$2 as securityConfigs, tsEslintConfig, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };

package/dist/index.d.ts

@@ -39,12 +39,16 @@ interface DefaultConfigOptions {
     parserOptions?: NonNullable<ConfigWithExtends['languageOptions']>['parserOptions'];
     enableRequireExtensionRule?: boolean;
 }
+/**
+ * @deprecated Use `tsEslintConfig` instead
+ */
+declare const defaultConfig: typeof tsEslintConfig;
 /**
  * Exports the default configuration to be passed to `tsEslint.config`. Use this if you want more control of typescript-eslint configuration output.
  * @param {DefaultConfigOptions} options
  * @returns Array of typescript-eslint configurations
  */
-declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
+declare function tsEslintConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
 /**
  * Exports eslint configurations. Use this if you do not need to explicitly import typescript-eslint in your project.
  * @param options
@@ -52,4 +56,4 @@ declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtend
  */
 declare function config(options?: DefaultConfigOptions): TSESLint.FlatConfig.ConfigArray;
 
-export { type DefaultConfigOptions, config, defaultConfig, configs$7 as eslintConfigs, configs$6 as importConfigs, configs$5 as jsdocConfigs, configs$4 as promiseConfigs, configs$3 as reactConfigs, configs$2 as securityConfigs, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };
+export { type DefaultConfigOptions, config, defaultConfig, configs$7 as eslintConfigs, configs$6 as importConfigs, configs$5 as jsdocConfigs, configs$4 as promiseConfigs, configs$3 as reactConfigs, configs$2 as securityConfigs, tsEslintConfig, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };

package/dist/index.mjs

@@ -652,7 +652,8 @@ const configs = {
   base
 };
 
-function defaultConfig(options) {
+const defaultConfig = tsEslintConfig;
+function tsEslintConfig(options) {
   const enableRequireExtensionRule = options?.enableRequireExtensionRule ?? true;
   const languageOptions = {
     globals: {
@@ -747,7 +748,7 @@ function defaultConfig(options) {
   ];
 }
 function config(options) {
-  return tsEslint.config(...defaultConfig(options));
+  return tsEslint.config(...tsEslintConfig(options));
 }
 
-export { config, defaultConfig, configs$9 as eslintConfigs, configs$7 as importConfigs, configs$6 as jsdocConfigs, configs$4 as promiseConfigs, configs$3 as reactConfigs, configs$2 as securityConfigs, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };
+export { config, defaultConfig, configs$9 as eslintConfigs, configs$7 as importConfigs, configs$6 as jsdocConfigs, configs$4 as promiseConfigs, configs$3 as reactConfigs, configs$2 as securityConfigs, tsEslintConfig, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-decent",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "A decent ESLint configuration",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/index.ts

@@ -31,12 +31,17 @@ export interface DefaultConfigOptions {
   enableRequireExtensionRule?: boolean;
 }
 
+/**
+ * @deprecated Use `tsEslintConfig` instead
+ */
+export const defaultConfig = tsEslintConfig;
+
 /**
  * Exports the default configuration to be passed to `tsEslint.config`. Use this if you want more control of typescript-eslint configuration output.
  * @param {DefaultConfigOptions} options
  * @returns Array of typescript-eslint configurations
  */
-export function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends[] {
+export function tsEslintConfig(options?: DefaultConfigOptions): ConfigWithExtends[] {
   const enableRequireExtensionRule = options?.enableRequireExtensionRule ?? true;
   const languageOptions: ConfigWithExtends['languageOptions'] = {
     globals: {
@@ -140,5 +145,5 @@ export function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends
  * @returns An array of eslint configurations
  */
 export function config(options?: DefaultConfigOptions): TSESLint.FlatConfig.ConfigArray {
-  return tsEslint.config(...defaultConfig(options));
+  return tsEslint.config(...tsEslintConfig(options));
 }