@commencis/eslint-config 2.5.0 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @commencis/eslint-config
 
+## 3.0.1
+
+### Patch Changes
+
+- fix: export paths ([#416](https://github.com/Commencis/js-toolkit/pull/416))
+
+## 3.0.0
+
+### Major Changes
+
+- [BreakingChange]: Introducing v3 - With cleaner dependencies and structure. Check readme files for implementations. ([#414](https://github.com/Commencis/js-toolkit/pull/414))
+
 ## 2.5.0
 
 ### Minor Changes

package/README.md

@@ -29,74 +29,72 @@ pnpm add --save-dev eslint @commencis/eslint-config
 > [!IMPORTANT]
 > All the configs provided by this package is for the new [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) that supported with `ESLint >= v9`
 
-This package provides `defineConfig` function and includes config sets and can be found in package exports as following,
+Access the `defineConfig` function directly from this package, or import it from `eslint/config` as needed.
 
-- Commencis Base: `commencisBaseConfig`
-- Typescript: `commencisTypescriptConfig`
-- React: `commencisReactConfig`
-- NextJs: `commencisNextConfig`
-- Vue: `commencisVueConfig`
-- Prettier: `commencisPrettierConfig`
+## Configs & Helper Exports
 
-Firstly create your `eslint.config.js` and use the desired config by your project.
+This package includes pre-configured configs for:
 
-### Example Usage for React/Typescript Project:
+- **Javascript**
+- **Typescript**
+- **React**
+- **NextJs**
+- **ReactNative**
 
-```javascript
-// eslint.config.js
-import { commencisReactConfig, defineConfig } from '@commencis/eslint-config';
-
-export default defineConfig(...commencisReactConfig, {
-  /* ... */
-});
-```
+To use the default rules without additional customization, export the base configuration as shown below:
 
-### Example Usage for React-Native/Typescript Project:
+### Basic Usage without Overrides
 
 ```javascript
-// eslint.config.js
-import {
-  commencisReactNativeConfig,
-  defineConfig,
-} from '@commencis/eslint-config';
-
-export default defineConfig(...commencisReactNativeConfig, {
-  /* ... */
-});
+// eslint.config.mjs
+export { default } from '@commencis/eslint-config/react';
 ```
 
-### Example Usage for NextJs/Typescript Project:
+Default export is available on:
 
-```javascript
-// eslint.config.js
-import { commencisNextConfig, defineConfig } from '@commencis/eslint-config';
+- `@commencis/eslint-config/javascript`;
+- `@commencis/eslint-config/typescript`;
+- `@commencis/eslint-config/react`;
+- `@commencis/eslint-config/next`;
+- `@commencis/eslint-config/native`;
 
-export default defineConfig(...commencisNextConfig, {
-  ignores: ['.next/', 'next.config.js', 'next-env.d.ts'],
-});
-```
+### Flexible Usage with Overrides
 
-### Example Usage for Vue/Typescript Project:
+Alternatively, to use overrides:
 
-```javascript
-// eslint.config.js
-import { commencisVueConfig, defineConfig } from '@commencis/eslint-config';
+Find desired named exports:
 
-export default defineConfig(...commencisVueConfig);
-```
+- `javascriptConfig`
+- `typescriptConfig`
+- `reactConfig`
+- `nextConfig`
+- `reactNativeConfig`
 
-`React, NextJs, Vue` configs include `base, typescript, prettier` configs as bundle. You dont have to add them seperately. But also override any rules by your needs.
+```javascript
+// eslint.config.mjs
+export { nextConfig, defineConfig } from '@commencis/eslint-config';
 
-### Partial Imports
+export default defineConfig(next, {
+  // overrides
+});
+```
 
-You can also import the configs seperately and merge them if needed on specific cases.
+### New `configFactory` Usage with Overrides:
 
 ```javascript
-// eslint.config.js
-import baseConfig from '@commencis/eslint-config/base';
-import typescriptConfig from '@commencis/eslint-config/typescript';
+// eslint.config.mjs
+export { configFactory, defineConfig } from '@commencis/eslint-config';
+
+const config = configFactory({
+  react: true,
+  next: true,
+  jsxA11y: true,
+  reactCompiler: true,
+});
 
-export default [...baseConfig, ...typescriptConfig];
+export default defineConfig(config, {
+  // overrides
+});
 ```
 
 ## References

package/dist/{flatConfig-Cm6wkwA_.d.ts → config.types-M1gOzpFJ.d.mts}

@@ -1,4 +1,6 @@
-import { Linter } from 'eslint';
+import { Linter } from "eslint";
+
+//#region src/types/config.types.d.ts
 
 /**
  * Relax plugins type limitation,
@@ -10,9 +12,13 @@ import { Linter } from 'eslint';
  * @see Using plugins in your configuration]
  * (https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
  */
-type FlatConfig = Omit<Linter.Config, 'plugins'> & {
-    plugins?: Record<string, unknown>;
+/**
+ * Plugin relaxation reverted temporarily,
+ * which causes type errors in the config files.
+ */
+type Ruleset = Linter.Config & {
+  name: string;
 };
-type FlatConfigArray = FlatConfig[];
-
-export type { FlatConfig as F, FlatConfigArray as a };
+type FlatConfig = Ruleset[];
+//#endregion
+export { FlatConfig as t };