@paratco/eslint-config 3.4.0 → 4.0.0

package/README.md

@@ -16,6 +16,11 @@ Yarn:
 # prettier is optional, just use it if you want to use prettier formatting
 yarn add -D @paratco/eslint-config eslint prettier
 ```
+Bun:
+```bash
+# prettier is optional, just use it if you want to use prettier formatting
+bun add -d @paratco/eslint-config eslint prettier
+```
 ## Usage (ESLint Flat Config)
 Create an `eslint.config.{js,mjs,ts}` file in your project root:
 ```javascript
@@ -124,68 +129,5 @@ export default [
 ];
 ```
 > **Note:** When `files` is used and multiple `createConfig` calls are combined, spread each result (`...createConfig(...)`) into the top-level array instead of returning a single `createConfig` call directly.
-## Using oxlint alongside ESLint
-[oxlint](https://oxc-project.github.io/) is a fast JavaScript/TypeScript linter written in Rust that can be used alongside ESLint to improve performance and catch additional issues. This package supports using both linters together.
-### Installation
-Install oxlint alongside ESLint:
-NPM:
-```bash
-npm install --save-dev --save-exact oxlint@1.7.0 eslint-plugin-oxlint@1.7.0
-```
-Yarn:
-```bash
-yarn add -D -E oxlint@1.7.0 eslint-plugin-oxlint@1.7.0
-```
-note: Ensure you have the latest and exact version of oxlint and eslint-plugin-oxlint installed.
-### Configuration
-1. Create an `.oxlintrc.json` file with @oxlint/migrate:
-```bash
-# version match with oxlint installed before
-npx @oxlint/migrate@1.7.0
-```
-This will generate or update your `.oxlintrc.json` file based on your ESLint configuration. The tool analyzes your ESLint config and converts compatible rules to their oxlint equivalents.
-2. Update your `package.json` scripts to run both linters (run oxlint first for performance):
-```json
-{
-  "scripts": {
-    "lint": "oxlint --max-warnings=0 && eslint --max-warnings=0",
-    "lint:fix": "oxlint --fix && eslint --fix"
-  }
-}
-```
-3. integrate oxlint with ESLint by adding the ESLint plugin to your configuration:
-```javascript
-import { createConfig } from "@paratco/eslint-config";
-import oxlintPlugin from "eslint-plugin-oxlint";
-export default createConfig({
-  platform: "node", // or "react"
-  style: "prettier", // or "stylistic"
-  // Add oxlint plugin as the LAST item in your overrides
-  // This ensures ESLint rules that are handled by oxlint are turned off
-  overrides: [
-    // Your other overrides go here
-    // eslint-plugin-oxlint must be the last config
-    ...oxlintPlugin.configs["flat/all"]
-  ]
-});
-```
-### Running Linters
-Run both linters with a single command:
-```bash
-npm run lint
-# or
-yarn lint
-```
-Fix issues automatically when possible:
-```bash
-npm run lint:fix
-# or
-yarn lint:fix
-```
-### Benefits of Using Both Linters
-- **Performance**: oxlint is significantly faster than ESLint, especially on large codebases
-- **Complementary Rules**: Each linter has unique rules that can catch different issues
-- **Gradual Migration**: You can gradually migrate from ESLint to oxlint or use both permanently
-- **Modern JavaScript Support**: oxlint has excellent support for modern JavaScript and TypeScript features
 ## License
 Licensed under [MIT License](./LICENSE)

package/dist/configs/base.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from "eslint";
+declare const _default: Linter.Config[];
+export default _default;

package/dist/configs/import.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from "eslint";
+import type { TypescriptOptions } from "../types";
+export default function importConfig(typescript?: TypescriptOptions): Linter.Config[];

package/dist/configs/node.d.ts

@@ -0,0 +1 @@
+export { default } from "./base";

package/dist/configs/prettierFormatter.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from "eslint";
+declare const _default: Linter.Config[];
+export default _default;

package/dist/configs/react.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from "eslint";
+declare const _default: Linter.Config[];
+export default _default;

package/dist/configs/stylisticFormatter.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from "eslint";
+declare const _default: Linter.Config[];
+export default _default;

package/dist/index.d.ts

@@ -1,21 +1,3 @@
-import { Linter } from "eslint";
-
-//#region src/types.d.ts
-interface TypescriptOptions {
-  tsconfigRootDir?: string;
-  project?: string | string[];
-}
-interface Options {
-  platform: "node" | "react";
-  style: "stylistic" | "prettier";
-  useImport?: boolean;
-  files?: string[];
-  overrides?: Linter.Config[];
-  ignores?: string[];
-  typescript?: TypescriptOptions;
-}
-//#endregion
-//#region src/index.d.ts
-declare function createConfig(opt: Options): Linter.Config[];
-//#endregion
-export { createConfig };
+import type { Linter } from "eslint";
+import type { Options } from "./types";
+export declare function createConfig(opt: Options): Linter.Config[];