@imranbarbhuiya/oxc-config 0.0.1 → 0.1.0

package/README.md

@@ -1,190 +1,153 @@
-# Mahir ESLint Config
+# Mahir Oxc Config
 
-The ultimate ESLint shareable config. This config includes all of the ESLint rules that I use in my projects.
+Opinionated shared Oxlint and Oxfmt configuration for JavaScript and TypeScript projects.
 
-> [!Important]
-> This is a highly opinionated config. It's based on my personal preferences and the way I write code.
-> I don't recommend using this config as is as I'll update it based on my preferences without any notice.
+> [!IMPORTANT]
+> This config follows my personal preferences and may change without notice.
 
-<div align="center">
- <br />
- <p>
-  <a href="https://www.npmjs.com/package/eslint-config-mahir"><img src="https://img.shields.io/npm/v/eslint-config-mahir.svg?maxAge=3600" alt="npm version" /></a>
-  <a href="https://www.npmjs.com/package/eslint-config-mahir"><img src="https://img.shields.io/npm/dw/eslint-config-mahir.svg?maxAge=3600" alt="npm downloads" /></a>
- </p>
-</div>
+## Requirements
 
-## Installation
+- Node.js 24
 
-```bash
-npm install --save-dev eslint eslint-config-mahir
-```
+## Quick setup
 
-## Quick Setup (CLI)
-
-The easiest way to set up ESLint with this config is using the CLI:
+Run the interactive CLI:
 
 ```bash
-npx eslint-config-mahir
+npx @imranbarbhuiya/oxc-config
 ```
 
-This will interactively guide you through selecting a preset and options. You can also use flags:
+It detects the package manager and project type, creates `oxlint.config.ts` and `oxfmt.config.ts`, adds lint and format scripts, and installs:
+
+- `@imranbarbhuiya/oxc-config`
+- `oxlint`
+- `oxlint-tsgolint`
+- `oxfmt`
+- Any selected optional JavaScript plugins
+
+Examples:
 
 ```bash
-npx eslint-config-mahir --preset nextjs --tailwind
-npx eslint-config-mahir -p react -y
+npx @imranbarbhuiya/oxc-config --preset nextjs --tailwind
+npx @imranbarbhuiya/oxc-config -p react -y
 ```
 
 Available options:
 
-- `-p, --preset <name>` - Preset to use (nextjs, react, node, native, library)
-- `-t, --tailwind` - Include Tailwind CSS support
-- `--no-tailwind` - Exclude Tailwind CSS support
-- `--i18n` / `--no-i18n` - Include/exclude next-intl i18n rules (Next.js)
-- `--native-tailwind` / `--no-native-tailwind` - Include/exclude React Native Tailwind className rules
-- `--central-icons` / `--no-central-icons` - Include/exclude central-icons barrel-import rules
-- `--api-error` / `--no-api-error` - Include/exclude ApiError rules for queryFn/mutationFn
-- `--query` / `--no-query` - Include/exclude TanStack Query ESLint rules (`@tanstack/eslint-plugin-query`)
-- `-y, --yes` - Skip prompts and use defaults
-- `--cwd <path>` - Working directory
-- `-h, --help` - Show help
-
-The CLI offers the `i18n`, `native-tailwind`, `central-icons`, `query`, and `api-error` options only when they are relevant to your project (for example, `i18n` for Next.js, and `query` when `@tanstack/react-query` is detected).
-
-## Manual Usage
-
-Add in your eslint.config.js (for esm projects) or eslint.config.mjs
-
-```js
-import common from 'eslint-config-mahir/common';
-import node from 'eslint-config-mahir/node';
-import module from 'eslint-config-mahir/module';
-import typescript from 'eslint-config-mahir/typescript';
-import jsx from 'eslint-config-mahir/jsx';
-import react from 'eslint-config-mahir/react';
-import next from 'eslint-config-mahir/next';
-import mdx from 'eslint-config-mahir/mdx';
-import edge from 'eslint-config-mahir/edge';
-import jsdoc from 'eslint-config-mahir/jsdoc';
-import tsdoc from 'eslint-config-mahir/tsdoc';
-import native from 'eslint-config-mahir/native';
-import tailwind from 'eslint-config-mahir/tailwind';
-import i18n from 'eslint-config-mahir/i18n';
-import nativeTailwind from 'eslint-config-mahir/native-tailwind';
-import centralIcons from 'eslint-config-mahir/central-icons';
-import apiError from 'eslint-config-mahir/api-error';
-
-export default [
-	...common,
-	...node,
-	...module,
-	...typescript,
-	...jsx,
-	...react, // when using react, you can omit jsx as it's already included with react
-	...next,
-	...mdx,
-	...edge,
-	...jsdoc,
-	...tsdoc, // when using tsdoc, you can omit jsdoc as it's already included with tsdoc
-	...native, // when using native, you can omit react as it's already included with native
-	...tailwind, // for projects using Tailwind CSS (requires eslint-plugin-better-tailwindcss)
-	...i18n, // for Next.js projects using next-intl
-	...nativeTailwind, // for React Native projects using Tailwind (use with native + tailwind)
-	...centralIcons, // for React/React Native projects using @central-icons-react* packages
-	...apiError, // for projects using TanStack Query — require ApiError in queryFn/mutationFn
-];
-```
+- `-p, --preset <name>` selects `nextjs`, `react`, `node`, `native`, `library`, or `nest`
+- `-t, --tailwind` / `--no-tailwind`
+- `--i18n` / `--no-i18n`
+- `--native-tailwind` / `--no-native-tailwind`
+- `--central-icons` / `--no-central-icons`
+- `--api-error` / `--no-api-error`
+- `--query` / `--no-query`
+- `-y, --yes` skips prompts and uses detected defaults
+- `--cwd <path>` changes the target directory
+- `-h, --help` shows help
 
-You can remove any of the configs you don't need.
+The CLI offers optional features only where they apply. For example, i18n is available for Next.js, while TanStack Query support is available for React-based presets.
 
-`api-error` accepts `allowedErrors` (default `['ApiError', 'FormValidationError']`). That list is what you may `throw new Class(...)` or `throw Class.from(...)` inside `queryFn` / `mutationFn`. Other constructors (`new Error`) and other factories (`Other.from(...)`) are reported:
+## Manual setup
 
-```js
-{
-	rules: {
-		'mahir-api-error/require-api-error': [
-			'error',
-			{ allowedErrors: ['ApiError', 'FormValidationError'] },
-		],
-	},
-}
+Install the config and Oxc tools:
+
+```bash
+npm install --save-dev @imranbarbhuiya/oxc-config oxlint oxlint-tsgolint oxfmt
 ```
 
-> **Note**:
-
-For typescript users, typed linting is done via `projectService`. You can learn more about it from https://typescript-eslint.io/getting-started/typed-linting/#faqs and customize it as per your need.
-
-```js
-/**
- * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
- */
-export default [
-	...
-	{
-	languageOptions: {
-		parserOptions: {
-			projectService: {
-				allowDefaultProject: [
-					'files-outside-tsconfig.json',
-				],
-				defaultProject: 'tsconfig.json',
-			},
-			tsconfigRootDir: process.cwd(),
-		},
+Create `oxlint.config.ts`:
+
+```ts
+import { defineConfig } from 'oxlint';
+
+import common from '@imranbarbhuiya/oxc-config/common';
+import module from '@imranbarbhuiya/oxc-config/module';
+import node from '@imranbarbhuiya/oxc-config/node';
+import typescript from '@imranbarbhuiya/oxc-config/typescript';
+
+export default defineConfig({
+	extends: [common, node, typescript, module],
+	options: {
+		typeAware: true,
 	},
-]
+});
 ```
 
-> **Warning**:
-> If you are using both `mdx` and `typescript` config, make sure add files to avoid conflicts
-
-```js
-/**
- * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray}
- */
-export default [
-	// ... other configs
-	...mdx.map((config) => ({
-		files: ['**/*.mdx'],
-		...config,
-	})),
-	...typescript.map((config) => ({
-		files: ['**/*.tsx', '**/*.ts', '**/*.cjs', '**/*.jsx', '**/*.js'],
-		...config,
-	})),
-	// ... other configs
-];
+`options.typeAware` belongs at the root of the Oxlint config. It enables type-aware linting through `oxlint-tsgolint`.
+
+Create `oxfmt.config.ts`:
+
+```ts
+import { defineConfig } from 'oxfmt';
+
+import config from '@imranbarbhuiya/oxc-config/oxfmt';
+
+export default defineConfig({
+	...config,
+});
 ```
 
-## Configs
+Add scripts to `package.json`:
 
-This package contains eslint config for
+```json
+{
+	"scripts": {
+		"lint": "oxlint --fix .",
+		"lint:check": "oxlint .",
+		"format": "oxfmt",
+		"format:check": "oxfmt --check"
+	}
+}
+```
 
-- `common` rules common for all configs
-- `node` rules for nodejs projects
-- `module` rules for esm projects
-- `typescript` rules for typescript projects
-- `jsx` rules for jsx/tsx projects
-- `react` rules for react projects (this config contains all the `jsx` rules too)
-- `native` rules for react native projects (this config contains all the `react` rules too)
-- `next` rules for nextjs projects
-- `mdx` rules for mdx projects
-- `edge` rules for projects running in edge
-- `jsdoc` jsdoc related config
-- `tsdoc` tsdoc related config (this config contains all the `jsdoc` rules too)
-- `tailwind` rules for Tailwind CSS projects (requires `eslint-plugin-better-tailwindcss`)
+## Config fragments
+
+- `common` contains rules shared by all projects
+- `node` contains Node.js rules
+- `module` contains ECMAScript module rules
+- `typescript` contains TypeScript and type-aware rules
+- `jsx` contains JSX rules
+- `react` contains React rules and includes JSX
+- `native` contains React Native rules and includes React
+- `next` contains Next.js rules
+- `edge` contains edge-runtime rules
+- `jsdoc` contains JSDoc rules
+- `tsdoc` contains TSDoc rules and includes JSDoc
+- `tailwind` contains Tailwind CSS rules and requires `eslint-plugin-better-tailwindcss`
+- `i18n` contains next-intl rules
+- `native-tailwind` contains React Native Tailwind class-name rules
+- `central-icons` prevents barrel imports from `@central-icons-react*` packages
+- `api-error` requires allowed error classes in TanStack Query functions
+
+Fragments can be combined through `defineConfig({ extends: [...] })`. Install any JavaScript plugin required by an optional fragment or third-party config.
+
+TanStack Query can be added directly:
+
+```ts
+import { defineConfig } from 'oxlint';
+
+import common from '@imranbarbhuiya/oxc-config/common';
+import react from '@imranbarbhuiya/oxc-config/react';
+
+export default defineConfig({
+	extends: [common, react],
+	jsPlugins: [{ name: 'query', specifier: '@tanstack/eslint-plugin-query' }],
+	rules: {
+		'query/exhaustive-deps': 'error',
+		'query/no-rest-destructuring': 'error',
+		'query/stable-query-client': 'error',
+	},
+});
+```
 
-The following configs are opt-in and are offered by the CLI only when relevant to your project. They are intentionally not bundled into `next` or `native`:
+## MDX
 
-- `i18n` rules for Next.js projects using [`next-intl`](https://next-intl.dev) (enforces static `t()` keys and disallows passing `t` around). Use alongside `next`.
-- `native-tailwind` rules for React Native projects using Tailwind (forbids `flex`/`flex-col`). Use alongside `native` and `tailwind`.
-- `central-icons` rules for React or React Native projects using `@central-icons-react*` packages (forbids barrel imports and autofixes to direct subpath imports). Use alongside `react`, `native`, or `next`.
-- `api-error` rules for TanStack Query projects (requires an allowed error class instead of `Error` inside `queryFn`/`mutationFn`, including extracted handlers). Allows `new ApiError(...)` and `ApiError.from(...)`; reports other constructors and factories. Override `allowedErrors` in your ESLint config if your class names differ. Use alongside `react`, `native`, or `next`.
+Oxfmt formats MDX files with the shared formatter config. Oxlint does not lint MDX, so this package does not provide an MDX lint fragment.
 
-## Contributors ✨
+## Contributors
 
-Thanks goes to these wonderful people:
+Thanks to all contributors.
 
-<a href="https://github.com/imranbarbhuiya/eslint-config-mahir/graphs/contributors">
-    <img src="https://contrib.rocks/image?repo=imranbarbhuiya/eslint-config-mahir" />
+<a href="https://github.com/imranbarbhuiya/oxc-config/graphs/contributors">
+	<img src="https://contrib.rocks/image?repo=imranbarbhuiya/oxc-config" alt="Contributors" />
 </a>

package/dist/api-error.d.ts

@@ -1,6 +1,11 @@
-import { TSESLint } from "@typescript-eslint/utils";
 //#region src/api-error.d.ts
-declare const config: TSESLint.FlatConfig.ConfigArray;
+declare const config: {
+  plugins: ("eslint" | "react" | "unicorn" | "typescript" | "oxc" | "import" | "jsdoc" | "jest" | "vitest" | "jsx-a11y" | "nextjs" | "react-perf" | "promise" | "node" | "vue")[];
+  jsPlugins: import("oxlint").ExternalPluginEntry[];
+  rules: {
+    'mahir-api-error/require-api-error': number;
+  };
+};
 //#endregion
 export { config as default };
 //# sourceMappingURL=api-error.d.ts.map

package/dist/api-error.js

@@ -1,11 +1,12 @@
-import plugin from "./plugins/api-error.js";
+import { localPlugin, nativePlugins } from "./config.js";
+import { defineConfig } from "oxlint";
 
 //#region src/api-error.ts
-const config = [{
-	name: "mahir/api-error",
-	plugins: { "mahir-api-error": plugin },
+const config = defineConfig({
+	plugins: nativePlugins,
+	jsPlugins: [localPlugin("mahir-api-error", "./plugins/api-error.js")],
 	rules: { "mahir-api-error/require-api-error": 2 }
-}];
+});
 
 //#endregion
 export { config as default };

package/dist/api-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-error.js","names":["pluginApiError"],"sources":["../src/api-error.ts"],"sourcesContent":["import pluginApiError from './plugins/api-error.js';\n\nimport type { TSESLint } from '@typescript-eslint/utils';\n\nconst config: TSESLint.FlatConfig.ConfigArray = [\n\t{\n\t\tname: 'mahir/api-error',\n\t\tplugins: {\n\t\t\t'mahir-api-error': pluginApiError,\n\t\t},\n\t\trules: {\n\t\t\t'mahir-api-error/require-api-error': 2,\n\t\t},\n\t},\n];\n\nexport default config;\n"],"mappings":";;;AAIA,MAAM,SAA0C,CAC/C;CACC,MAAM;CACN,SAAS,EACR,mBAAmBA,OACpB;CACA,OAAO,EACN,qCAAqC,EACtC;AACD,CACD"}
+{"version":3,"file":"api-error.js","names":[],"sources":["../src/api-error.ts"],"sourcesContent":["import { defineConfig } from 'oxlint';\n\nimport { localPlugin, nativePlugins } from './config.js';\n\nconst config = defineConfig({\n\tplugins: nativePlugins,\n\tjsPlugins: [localPlugin('mahir-api-error', './plugins/api-error.js')],\n\trules: {\n\t\t'mahir-api-error/require-api-error': 2,\n\t},\n});\n\nexport default config;\n"],"mappings":";;;;AAIA,MAAM,SAAS,aAAa;CAC3B,SAAS;CACT,WAAW,CAAC,YAAY,mBAAmB,wBAAwB,CAAC;CACpE,OAAO,EACN,qCAAqC,EACtC;AACD,CAAC"}

package/dist/central-icons.d.ts

@@ -1,6 +1,11 @@
-import { TSESLint } from "@typescript-eslint/utils";
 //#region src/central-icons.d.ts
-declare const config: TSESLint.FlatConfig.ConfigArray;
+declare const config: {
+  plugins: ("eslint" | "react" | "unicorn" | "typescript" | "oxc" | "import" | "jsdoc" | "jest" | "vitest" | "jsx-a11y" | "nextjs" | "react-perf" | "promise" | "node" | "vue")[];
+  jsPlugins: import("oxlint").ExternalPluginEntry[];
+  rules: {
+    'mahir-central-icons/no-central-icons-barrel-import': number;
+  };
+};
 //#endregion
 export { config as default };
 //# sourceMappingURL=central-icons.d.ts.map

package/dist/central-icons.js

@@ -1,11 +1,12 @@
-import plugin from "./plugins/central-icons.js";
+import { localPlugin, nativePlugins } from "./config.js";
+import { defineConfig } from "oxlint";
 
 //#region src/central-icons.ts
-const config = [{
-	name: "mahir/central-icons",
-	plugins: { "mahir-central-icons": plugin },
+const config = defineConfig({
+	plugins: nativePlugins,
+	jsPlugins: [localPlugin("mahir-central-icons", "./plugins/central-icons.js")],
 	rules: { "mahir-central-icons/no-central-icons-barrel-import": 2 }
-}];
+});
 
 //#endregion
 export { config as default };

package/dist/central-icons.js.map

@@ -1 +1 @@
-{"version":3,"file":"central-icons.js","names":["pluginCentralIcons"],"sources":["../src/central-icons.ts"],"sourcesContent":["import pluginCentralIcons from './plugins/central-icons.js';\n\nimport type { TSESLint } from '@typescript-eslint/utils';\n\nconst config: TSESLint.FlatConfig.ConfigArray = [\n\t{\n\t\tname: 'mahir/central-icons',\n\t\tplugins: {\n\t\t\t'mahir-central-icons': pluginCentralIcons,\n\t\t},\n\t\trules: {\n\t\t\t'mahir-central-icons/no-central-icons-barrel-import': 2,\n\t\t},\n\t},\n];\n\nexport default config;\n"],"mappings":";;;AAIA,MAAM,SAA0C,CAC/C;CACC,MAAM;CACN,SAAS,EACR,uBAAuBA,OACxB;CACA,OAAO,EACN,sDAAsD,EACvD;AACD,CACD"}
+{"version":3,"file":"central-icons.js","names":[],"sources":["../src/central-icons.ts"],"sourcesContent":["import { defineConfig } from 'oxlint';\n\nimport { localPlugin, nativePlugins } from './config.js';\n\nconst config = defineConfig({\n\tplugins: nativePlugins,\n\tjsPlugins: [localPlugin('mahir-central-icons', './plugins/central-icons.js')],\n\trules: {\n\t\t'mahir-central-icons/no-central-icons-barrel-import': 2,\n\t},\n});\n\nexport default config;\n"],"mappings":";;;;AAIA,MAAM,SAAS,aAAa;CAC3B,SAAS;CACT,WAAW,CAAC,YAAY,uBAAuB,4BAA4B,CAAC;CAC5E,OAAO,EACN,sDAAsD,EACvD;AACD,CAAC"}

package/dist/cli/index.d.ts

@@ -0,0 +1 @@
+export { };