eslint-config-decent 1.6.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

@@ -9,40 +9,67 @@ A decent ESLint configuration for TypeScript projects.
 ```mjs
 // eslint.config.mjs
 
-import { defaultConfig } from 'eslint-config-decent';
-import tsEslint from 'typescript-eslint';
+import { config } from 'eslint-config-decent';
 
-export default tsEslint.config(...defaultConfig());
+export default config();
 ```
 
 ## Override parserOptions
 
-````mjs
+```mjs
 // eslint.config.mjs
 
-import { defaultConfig } from 'eslint-config-decent';
-import tsEslint from 'typescript-eslint';
+import { config } from 'eslint-config-decent';
 
-export default tsEslint.config(...defaultConfig({
+export default config({
   projectService: {
     allowDefaultProject: ['./*.{js,cjs,mjs}'],
     defaultProject: 'tsconfig.json',
   },
   tsconfigRootDir: import.meta.dirname,
-}));
+});
+```
 
 ## Disable require-extensions rules
 
 ```mjs
 // eslint.config.mjs
 
-import { defaultConfig } from 'eslint-config-decent';
-import tsEslint from 'typescript-eslint';
+import { config } from 'eslint-config-decent';
 
-export default tsEslint.config(...defaultConfig({
+export default config({
   enableRequireExtensions: false,
-}));
-````
+});
+```
+
+## Override a rule
+
+```mjs
+// eslint.config.mjs
+
+import { config } from 'eslint-config-decent';
+
+export default [
+  ...config(),
+  {
+    files: ['**/*.ts'],
+    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: {
@@ -765,7 +766,11 @@ function defaultConfig(options) {
     prettier__default
   ];
 }
+function config(options) {
+  return tsEslint__default.config(...tsEslintConfig(options));
+}
 
+exports.config = config;
 exports.defaultConfig = defaultConfig;
 exports.eslintConfigs = configs$9;
 exports.importConfigs = configs$7;
@@ -773,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

@@ -1,5 +1,5 @@
-import { ConfigWithExtends } from 'typescript-eslint';
 import { TSESLint } from '@typescript-eslint/utils';
+import { ConfigWithExtends } from 'typescript-eslint';
 
 declare const configs$7: {
     base: TSESLint.FlatConfig.Config;
@@ -39,6 +39,21 @@ interface DefaultConfigOptions {
     parserOptions?: NonNullable<ConfigWithExtends['languageOptions']>['parserOptions'];
     enableRequireExtensionRule?: boolean;
 }
-declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
-
-export { type DefaultConfigOptions, 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 };
+/**
+ * @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 tsEslintConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
+/**
+ * Exports eslint configurations. Use this if you do not need to explicitly import typescript-eslint in your project.
+ * @param options
+ * @returns An array of eslint configurations
+ */
+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, tsEslintConfig, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { ConfigWithExtends } from 'typescript-eslint';
 import { TSESLint } from '@typescript-eslint/utils';
+import { ConfigWithExtends } from 'typescript-eslint';
 
 declare const configs$7: {
     base: TSESLint.FlatConfig.Config;
@@ -39,6 +39,21 @@ interface DefaultConfigOptions {
     parserOptions?: NonNullable<ConfigWithExtends['languageOptions']>['parserOptions'];
     enableRequireExtensionRule?: boolean;
 }
-declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
-
-export { type DefaultConfigOptions, 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 };
+/**
+ * @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 tsEslintConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
+/**
+ * Exports eslint configurations. Use this if you do not need to explicitly import typescript-eslint in your project.
+ * @param options
+ * @returns An array of eslint configurations
+ */
+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, tsEslintConfig, configs$1 as typescriptEslintConfigs, configs as unicornConfigs };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { ConfigWithExtends } from 'typescript-eslint';
 import { TSESLint } from '@typescript-eslint/utils';
+import { ConfigWithExtends } from 'typescript-eslint';
 
 declare const configs$7: {
     base: TSESLint.FlatConfig.Config;
@@ -39,6 +39,21 @@ interface DefaultConfigOptions {
     parserOptions?: NonNullable<ConfigWithExtends['languageOptions']>['parserOptions'];
     enableRequireExtensionRule?: boolean;
 }
-declare function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
-
-export { type DefaultConfigOptions, 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 };
+/**
+ * @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 tsEslintConfig(options?: DefaultConfigOptions): ConfigWithExtends[];
+/**
+ * Exports eslint configurations. Use this if you do not need to explicitly import typescript-eslint in your project.
+ * @param options
+ * @returns An array of eslint configurations
+ */
+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, 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: {
@@ -746,5 +747,8 @@ function defaultConfig(options) {
     prettier
   ];
 }
+function config(options) {
+  return tsEslint.config(...tsEslintConfig(options));
+}
 
-export { 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": "1.6.0",
+  "version": "2.0.1",
   "description": "A decent ESLint configuration",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/index.ts

@@ -1,4 +1,5 @@
 import eslint from '@eslint/js';
+import type { TSESLint } from '@typescript-eslint/utils';
 import prettier from 'eslint-plugin-prettier/recommended';
 import globals from 'globals';
 import tsEslint, { type ConfigWithExtends } from 'typescript-eslint';
@@ -30,7 +31,17 @@ export interface DefaultConfigOptions {
   enableRequireExtensionRule?: boolean;
 }
 
-export function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends[] {
+/**
+ * @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 tsEslintConfig(options?: DefaultConfigOptions): ConfigWithExtends[] {
   const enableRequireExtensionRule = options?.enableRequireExtensionRule ?? true;
   const languageOptions: ConfigWithExtends['languageOptions'] = {
     globals: {
@@ -127,3 +138,12 @@ export function defaultConfig(options?: DefaultConfigOptions): ConfigWithExtends
     prettier,
   ];
 }
+
+/**
+ * Exports eslint configurations. Use this if you do not need to explicitly import typescript-eslint in your project.
+ * @param options
+ * @returns An array of eslint configurations
+ */
+export function config(options?: DefaultConfigOptions): TSESLint.FlatConfig.ConfigArray {
+  return tsEslint.config(...tsEslintConfig(options));
+}