@nelsonlaidev/oxlint-config 0.1.4 → 0.2.1

package/README.md

@@ -2,6 +2,8 @@
 
 Personal Oxlint configurations for Nelson Lai projects.
 
+This package is synced from `eslint-config` and aims to enable every supported Oxlint rule that is also enabled in `eslint-config`.
+
 ## Installation
 
 ```bash
@@ -14,13 +16,22 @@ Create an `oxlint.config.ts` file with the following content:
 import { defineConfig } from '@nelsonlaidev/oxlint-config'
 
 export default defineConfig({
-  // Custom OxLint configuration options
+  config: {
+    // Custom OxLint configuration options
+  },
+  custom: {
+    react: true,
+  },
 })
 ```
 
 ### Notes
 
-If you are using pnpm/bun, add the following to your `.npmrc` to hoist ESLint plugin dependencies so the Oxlint can resolve them:
+This package follows `eslint-config` as the source of truth. When a rule is enabled there, we enable the corresponding Oxlint rule here when Oxlint supports it.
+
+`unused-imports` is intentionally not included. That plugin requires type information, and Oxlint `jsPlugins` does not support that currently.
+
+If you are using pnpm, add the following to your `.npmrc` to hoist ESLint plugin dependencies so the Oxlint can resolve them:
 
 ```ini
 public-hoist-pattern[]=*eslint-plugin*

package/dist/index.d.mts

@@ -129,9 +129,16 @@ type CustomConfig = {
   vitest?: VitestConfig;
   playwright?: PlaywrightConfig;
 };
+type DefineConfigOptions = {
+  config?: OxlintConfig$1;
+  custom?: CustomConfig;
+};
 //#endregion
 //#region src/base.d.ts
-declare const defineConfig: (config?: OxlintConfig$1, userConfig?: CustomConfig) => OxlintConfig$1;
+declare const defineConfig: ({
+  config,
+  custom: userConfig
+}?: DefineConfigOptions) => OxlintConfig$1;
 //#endregion
 //#region src/globs.d.ts
 declare const GLOB_SRC_EXT = "{js,jsx,ts,tsx,cjs,cts,mjs,mts}";
@@ -141,5 +148,5 @@ declare const GLOB_JSX = "**/*.{jsx,cjsx,mjsx}";
 declare const GLOB_TS = "**/*.{ts,cts,mts}";
 declare const GLOB_TSX = "**/*.{tsx,ctsx,mtsx}";
 //#endregion
-export { CustomConfig, GLOB_JS, GLOB_JSX, GLOB_SRC, GLOB_SRC_EXT, GLOB_TS, GLOB_TSX, type OxlintConfig, TailwindCSSConfig, defineConfig };
+export { CustomConfig, DefineConfigOptions, GLOB_JS, GLOB_JSX, GLOB_SRC, GLOB_SRC_EXT, GLOB_TS, GLOB_TSX, type OxlintConfig, TailwindCSSConfig, defineConfig };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types/playwright.ts","../src/types/tailwindcss.ts","../src/types/vitest.ts","../src/types/config.ts","../src/base.ts","../src/globs.ts"],"mappings":";;;;KAEY,gBAAA;;;AAAZ;EAIE,KAAA,EAAO,cAAA;;;;;EAKP,mBAAA;EAKA;;;;EAAA,sBAAA;AAAA;;;KCdU,iBAAA;;;ADAZ;ECIE,UAAA;;;;EAIA,cAAA;EDCA;;;ECGA,QAAA;;;;AAZF;EAiBE,sBAAA;;;;;EAKA,YAAA;EALA;;;EASA,YAAA;EAIY;;;EAAZ,SAAA,GAAY,SAAA;EAEZ,SAAA;IAkBE;;;;IAbA,QAAA;IAwCF;;;;IAnCE,OAAA;EAAA;EAGF,UAAA;IA6CE;;;;IAxCA,KAAA;;AClDJ;;;IDuDI,cAAA;ICnDmB;;;;IDwDnB,iBAAA;IE1DoB;;;;IF+DpB,YAAA;IE1D2B;;;;IF+D3B,eAAA;EAAA;EEhEF;;;;EFuEA,QAAA,cAAsB,KAAA;IAAQ,OAAA;IAAiB,OAAA;IAAkB,GAAA;EAAA;EGjCtD;;;;EHuCX,MAAA;EAEA,UAAA;IGwDD;;;;IHnDG,cAAA;EAAA;AAAA;;;KC1FQ,YAAA;;;AFAZ;EEIE,KAAA,EAAO,cAAA;AAAA;;;KCFG,YAAA;EACV,MAAA;EACA,KAAA;EACA,WAAA,GAAc,iBAAA;EACd,MAAA,GAAS,YAAA;EACT,UAAA,GAAa,gBAAA;AAAA;;;cCqCF,YAAA,GAAgB,MAAA,GAAQ,cAAA,EAAmB,UAAA,GAAY,YAAA,KAAoB,cAAA;;;cC9C3E,YAAA;AAAA,cACA,QAAA;AAAA,cAEA,OAAA;AAAA,cACA,QAAA;AAAA,cAEA,OAAA;AAAA,cACA,QAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types/playwright.ts","../src/types/tailwindcss.ts","../src/types/vitest.ts","../src/types/config.ts","../src/base.ts","../src/globs.ts"],"mappings":";;;;KAEY,gBAAA;;;AAAZ;EAIE,KAAA,EAAO,cAAA;;;;;EAKP,mBAAA;EAKA;;;;EAAA,sBAAA;AAAA;;;KCdU,iBAAA;;;ADAZ;ECIE,UAAA;;;;EAIA,cAAA;EDCA;;;ECGA,QAAA;;;;AAZF;EAiBE,sBAAA;;;;;EAKA,YAAA;EALA;;;EASA,YAAA;EAIY;;;EAAZ,SAAA,GAAY,SAAA;EAEZ,SAAA;IAkBE;;;;IAbA,QAAA;IAwCF;;;;IAnCE,OAAA;EAAA;EAGF,UAAA;IA6CE;;;;IAxCA,KAAA;;AClDJ;;;IDuDI,cAAA;ICnDmB;;;;IDwDnB,iBAAA;IEzDoB;;;;IF8DpB,YAAA;IEzD2B;;;;IF8D3B,eAAA;EAAA;EE/DF;;;;EFsEA,QAAA,cAAsB,KAAA;IAAQ,OAAA;IAAiB,OAAA;IAAkB,GAAA;EAAA;EEhE5C;;;;EFsErB,MAAA;EAEA,UAAA;IExEqB;;;;IF6EnB,cAAA;EAAA;AAAA;;;KC1FQ,YAAA;;;AFAZ;EEIE,KAAA,EAAO,cAAA;AAAA;;;KCDG,YAAA;EACV,MAAA;EACA,KAAA;EACA,WAAA,GAAc,iBAAA;EACd,MAAA,GAAS,YAAA;EACT,UAAA,GAAa,gBAAA;AAAA;AAAA,KAGH,mBAAA;EACV,MAAA,GAAS,cAAA;EACT,MAAA,GAAS,YAAA;AAAA;;;cC+BE,YAAA;EAAgB,MAAA;EAAA,MAAA,EAAA;AAAA,IAA0C,mBAAA,KAA2B,cAAA;;;cC9CrF,YAAA;AAAA,cACA,QAAA;AAAA,cAEA,OAAA;AAAA,cACA,QAAA;AAAA,cAEA,OAAA;AAAA,cACA,QAAA"}