@nelsonlaidev/oxlint-config 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nelson Lai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+# @nelsonlaidev/oxlint-config
+
+Personal Oxlint configurations for Nelson Lai projects.
+
+## Installation
+
+```bash
+npm i -D @nelsonlaidev/oxlint-config oxlint
+```
+
+Create an `oxlint.config.ts` file with the following content:
+
+```ts
+import { defineConfig } from '@nelsonlaidev/oxlint-config'
+
+export default defineConfig({
+  // Custom OxLint configuration options
+})
+```
+
+### Notes
+
+If you are using pnpm, add the following to your `.npmrc` to hoist ESLint plugin dependencies so the Oxc VS Code extension can resolve them:
+
+```ini
+public-hoist-pattern[]=*eslint-plugin*
+```
+
+### What's Included
+
+This config includes opinionated rules from the following plugins:
+
+#### Always enabled
+
+- `oxc`
+- `eslint`
+- `typescript`
+- `unicorn`
+- `promise`
+- `node`
+- `jsx-a11y`
+- `import` / `import-sort`
+- `jsdoc`
+- `stylistic`
+- `de-morgan`
+- `zod`
+- `regexp`
+- `sonarjs`
+
+#### Conditionally enabled
+
+- `react` — auto-detected or via `react` option
+- `nextjs` — auto-detected or via `nextjs` option
+- `vitest` — via `vitest` option
+- `playwright` — via `playwright` option
+- `tailwindcss` — via `tailwindcss` option

package/dist/index.d.mts

@@ -0,0 +1,145 @@
+import { Selectors } from "eslint-plugin-better-tailwindcss/types";
+import { OxlintConfig, OxlintOverride } from "oxlint";
+
+//#region src/types/playwright.d.ts
+type PlaywrightConfig = {
+  /**
+   * A list of glob patterns for your Playwright test files.
+   */
+  files: OxlintOverride['files'];
+  /**
+   * See [official docs](https://github.com/mskelton/eslint-plugin-playwright/blob/main/docs/rules/expect-expect.md#assertfunctionnames) for more details.
+   * @default []
+   */
+  assertFunctionNames?: string[];
+  /**
+   * See [official docs](https://github.com/mskelton/eslint-plugin-playwright/blob/main/docs/rules/expect-expect.md#assertfunctionpatterns) for more details.
+   * @default []
+   */
+  assertFunctionPatterns?: string[];
+};
+//#endregion
+//#region src/types/tailwindcss.d.ts
+type TailwindCSSConfig = {
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#entrypoint) for more details.
+   */
+  entryPoint?: string;
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#tailwindconfig) for more details.
+   */
+  tailwindConfig?: string;
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#tsconfig) for more details.
+   */
+  tsconfig?: string;
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#detectcomponentclasses) for more details.
+   * @default false
+   */
+  detectComponentClasses?: boolean;
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#rootfontsize) for more details.
+   * @default 16
+   */
+  rootFontSize?: number;
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#messagestyle) for more details.
+   */
+  messageStyle?: 'visual' | 'compact' | 'raw';
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md#selectors) for more details.
+   */
+  selectors?: Selectors;
+  canonical?: {
+    /**
+     * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-canonical-classes.md#collapse) for more details.
+     * @default true
+     */
+    collapse?: boolean;
+    /**
+     * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-canonical-classes.md#logical) for more details.
+     * @default true
+     */
+    logical?: boolean;
+  };
+  classOrder?: {
+    /**
+     * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-class-order.md#order) for more details.
+     * @default 'official'
+     */
+    order?: 'asc' | 'desc' | 'official' | 'strict';
+    /**
+     * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-class-order.md#componentClassOrder) for more details.
+     * @default 'preserve'
+     */
+    componentOrder?: 'asc' | 'desc' | 'preserve';
+    /**
+     * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-class-order.md#componentClassPosition) for more details.
+     * @default 'start'
+     */
+    componentPosition?: 'start' | 'end';
+    /**
+     * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-class-order.md#unknownClassOrder) for more details.
+     * @default 'preserve'
+     */
+    unknownOrder?: 'asc' | 'desc' | 'preserve';
+    /**
+     * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/enforce-consistent-class-order.md#unknownClassPosition) for more details.
+     * @default 'start'
+     */
+    unknownPosition?: 'start' | 'end';
+  };
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-restricted-classes.md#restrict) for more details.
+   * @default []
+   */
+  restrict?: string[] | Array<{
+    pattern: string;
+    message?: string;
+    fix?: string;
+  }>;
+  /**
+   * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-unknown-classes.md#ignore) for more details.
+   * @default []
+   */
+  ignore?: string[];
+  whitespace?: {
+    /**
+     * See [official docs](https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-unnecessary-whitespace.md#allowMultiline) for more details.
+     * @default true
+     */
+    allowMultiline?: boolean;
+  };
+};
+//#endregion
+//#region src/types/vitest.d.ts
+type VitestConfig = {
+  /**
+   * A list of glob patterns for your Vitest test files.
+   */
+  files: OxlintOverride['files'];
+};
+//#endregion
+//#region src/types/config.d.ts
+type CustomConfig = {
+  nextjs?: boolean;
+  react?: boolean;
+  tailwindcss?: TailwindCSSConfig;
+  vitest?: VitestConfig;
+  playwright?: PlaywrightConfig;
+};
+//#endregion
+//#region src/base.d.ts
+declare const defineConfig: (config?: OxlintConfig, userConfig?: CustomConfig) => OxlintConfig;
+//#endregion
+//#region src/globs.d.ts
+declare const GLOB_SRC_EXT = "{js,jsx,ts,tsx,cjs,cts,mjs,mts}";
+declare const GLOB_SRC = "**/*.{js,jsx,ts,tsx,cjs,cts,mjs,mts}";
+declare const GLOB_JS = "**/*.{js,cjs,mjs}";
+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, TailwindCSSConfig, defineConfig };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +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,YAAA,EAAmB,UAAA,GAAY,YAAA,KAAoB,YAAA;;;cC9C3E,YAAA;AAAA,cACA,QAAA;AAAA,cAEA,OAAA;AAAA,cACA,QAAA;AAAA,cAEA,OAAA;AAAA,cACA,QAAA"}