@4mbl/lint 0.0.0-beta.2a064a7 → 0.0.0-beta.2b77e08

package/CHANGELOG.md

@@ -1,5 +1,140 @@
 # @4mbl/lint
 
+## 1.0.0-beta.1
+
+### Patch Changes
+
+- 2c338b1: fix(lint): re-export `OxlintConfig` to make config portable
+
+## 1.0.0-beta.0
+
+### Major Changes
+
+- c65e34e: Add CLI to allow default arguments and easier tool migration in the future
+- c65e34e: Migrate from eslint to oxlint
+
+## 0.16.0
+
+### Minor Changes
+
+- 6878a35: Upgrade config dependencies
+
+## 0.15.0
+
+### Minor Changes
+
+- 5040323: Upgrade config dependencies
+
+## 0.14.0
+
+### Minor Changes
+
+- 794dbfb: Upgrade config dependencies
+- e6a08fd: Upgrade to ESLint 10
+
+## 0.13.0
+
+### Minor Changes
+
+- ac23f1d: Upgrade config dependencies
+
+## 0.12.0
+
+### Minor Changes
+
+- dd16619: Upgrade config dependencies
+
+## 0.11.0
+
+### Minor Changes
+
+- e011cd6: Upgrade config dependencies
+
+## 0.10.0
+
+### Minor Changes
+
+- 774cb2a: Upgrade config dependencies
+
+## 0.9.0
+
+### Minor Changes
+
+- aee78b7: Upgrade config dependencies
+
+## 0.8.0
+
+### Minor Changes
+
+- 152396b: Upgrade config dependencies
+
+## 0.7.0
+
+### Minor Changes
+
+- 8e46d6b: Upgrade config dependencies
+
+### Patch Changes
+
+- 8e46d6b: Re-export types with type-keyword to fix verbatimModuleSyntax
+
+## 0.6.0
+
+### Minor Changes
+
+- 46d0443: Upgrade config dependencies
+
+## 0.5.0
+
+### Minor Changes
+
+- 55c3db6: Export `defineConfig` from eslint
+- f7d30bb: Upgrade config dependencies
+
+## 0.4.0
+
+### Minor Changes
+
+- 00cfefd: Add node template
+
+## 0.3.2
+
+### Patch Changes
+
+- df1c48b: Re-export eslint Config type from react template
+
+## 0.3.1
+
+### Patch Changes
+
+- d17fc69: Fix react template export
+
+## 0.3.0
+
+### Minor Changes
+
+- 6d969e6: Add react template
+- 6d969e6: Upgrade eslint and config dependencies
+
+## 0.2.1
+
+### Patch Changes
+
+- 3a223fe: Use flat config version of eslint-plugin-react-hooks
+
+## 0.2.0
+
+### Minor Changes
+
+- c4e49f3: Add eslint-plugin-react-hooks
+- c4e49f3: Add eslint-config-prettier
+
+## 0.1.1
+
+### Patch Changes
+
+- 2c91355: Move dependencies not to be dev-only
+
 ## 0.1.0
 
 ### Minor Changes

package/README.md

@@ -2,40 +2,77 @@
 
 > Linting configuration for various environments.
 
-* [Usage](#usage)
-* [Available templates](#available-templates)
-* [Versioning](#versioning)
+- [Usage](#usage)
+  - [Running `lint` CLI wrapper](#running-lint-cli-wrapper)
+  - [Running `oxlint` directly](#running-oxlint-directly)
+- [Available templates](#available-templates)
+- [Versioning](#versioning)
 
 ---
 
+> [!NOTE]
+> This package currently uses [oxlint](https://www.npmjs.com/package/oxlint) as the underlying linting tool. That may change in a future major release.
+
 ## Usage
 
-Install the [`@4mbl/lint`](https://www.npmjs.com/package/@4mbl/lint) npm package.
+Install the [`@4mbl/lint`](https://www.npmjs.com/package/@4mbl/lint) package.
 
 ```shell
 npm install -D @4mbl/lint
 ```
 
-Create a `eslint.config.ts` file in the root of your project with the desired configuration. This package currently uses eslint. That might change in a future major release.
+Create a `oxlint.config.ts` file for your package. If you are using a monorepo, create a `oxlint.config.ts` for each package in the monorepo.
 
 ```js
-import defaultConfig, { type Config } from '@4mbl/lint/next'; // <-- change `next` to the desired template
+import defineConfig from '@4mbl/lint/next'; // <-- change `next` to the desired template
+
+export default defineConfig();
+```
+
+### Running `lint` CLI wrapper
+
+This is the recommended way as it abstracts away the underlying linting package and allows us to change it in the future. While we try to keep the CLI wrapper interface stable between possible tooling changes, it is inevitable to have breaking changes if the underlying tooling changes.
 
-export default [...defaultConfig] satisfies Config[];
+Set a script that uses the linting CLI wrapper in your `package.json`. While it may be tempting to just call `lint` directly in CI or locally, it is recommended to use a script as it allows additional arguments to be passed to the CLI wrapper.
+
+```shell
+npm pkg set scripts.lint="lint"
+```
+
+The CLI wrapper uses the `src` directory by default and the following arguments:
+
+- `--max-warnings=0`
+- `--report-unused-disable-directives`
+
+These arguments can be overridden by passing them explicitly to the CLI wrapper.
+
+### Running `oxlint` directly
+
+```shell
+npm pkg set scripts.lint="oxlint src"
+```
+
+You may need to explicitly allow the underlying linting packages to be used by your scripts.
+
+For example, when using pnpm, you need to set `publicHoistPattern` in your `pnpm-workspace.yaml`.
+
+```yaml
+publicHoistPattern:
+  - oxlint
 ```
 
 ## Available templates
 
-There is currently one config template.
+These are the currently available config templates.
 
-- **Next** - Linting configuration extending the Next.js default config.
+- **Next** - Extending the Next.js linting config.
+- **Node** - Linting configuration for Node.js.
+- **React** - Extending the Vite-React linting config.
 
 ## Versioning
 
-As of version 4.0.0, the package migrated to a single template per type. The package version is now used to determine the template version. This simplifies both the maintenance and usage of the package.
-
-The package follows the following versioning scheme: `X.Y.Z`
+The package follows the following versioning scheme: `X.Y.Z`.
 
-- `X` - Reserved for linting provider changes as those might cause wider backwards compat issues.
+- `X` - Reserved for linting provider changes as those might cause wider backwards compatibility issues.
 - `Y` - New linting rules. New rules are first added as warnings, and if error is preferred, the rule is promoted to produce errors in the next minor release.
 - `Z` - Minor fixes that make the previous release unusable.

package/bin/cli.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+import { spawnSync } from 'node:child_process';
+
+const args = process.argv.slice(2);
+
+const hasPath = args.some((a) => !a.startsWith('-'));
+const hasMaxWarn = args.some((a) => a.startsWith('--max-warnings'));
+const hasReportUnused = args.some((a) =>
+  a.startsWith('--report-unused-disable-directives'),
+);
+
+const finalArgs = [
+  ...(hasPath ? [] : ['src']),
+  ...(hasMaxWarn ? [] : ['--max-warnings=0']),
+  ...(hasReportUnused ? [] : ['--report-unused-disable-directives']),
+  ...args,
+];
+
+const result = spawnSync('oxlint', finalArgs, {
+  stdio: 'inherit',
+  shell: true,
+});
+
+process.exit(result.status ?? 1);

package/package.json

@@ -1,16 +1,23 @@
 {
   "name": "@4mbl/lint",
-  "version": "0.0.0-beta.2a064a7",
+  "version": "0.0.0-beta.2b77e08",
   "description": "Linting configuration for various environments.",
   "type": "module",
   "author": "4mbl",
   "license": "MIT",
   "homepage": "https://github.com/4mbl/config/tree/main/packages/lint#readme",
   "exports": {
-    "./next": "./src/next.ts"
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "development": "./src/*.ts",
+      "default": "./dist/*.js"
+    }
+  },
+  "bin": {
+    "lint": "./bin/cli.js"
   },
   "files": [
-    "src",
+    "dist",
     "package.json",
     "README.md",
     "CHANGELOG.md"
@@ -24,12 +31,18 @@
     "lint"
   ],
   "dependencies": {
-    "@eslint/js": "^9.38.0",
-    "eslint": "^9.38.0",
-    "eslint-config-next": "^16.0.1",
     "eslint-plugin-react-compiler": "19.1.0-rc.2",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.5.2",
+    "globals": "^17.4.0",
     "jiti": "^2.6.1",
-    "typescript-eslint": "^8.46.2"
+    "oxlint": "^1.56.0",
+    "oxlint-tsgolint": "^0.17.0"
+  },
+  "devDependencies": {
+    "@4mbl/tsconfig": "0.0.0-beta.2b77e08"
   },
-  "scripts": {}
+  "scripts": {
+    "build": "tsc"
+  }
 }

package/src/next.ts

@@ -1,30 +0,0 @@
-// @ts-nocheck
-import js from '@eslint/js';
-import nextVitals from 'eslint-config-next/core-web-vitals';
-import nextTs from 'eslint-config-next/typescript';
-import * as reactCompiler from 'eslint-plugin-react-compiler';
-import { defineConfig, globalIgnores, Config } from 'eslint/config';
-import tseslint from 'typescript-eslint';
-
-export { Config };
-
-export default defineConfig([
-  js.configs.recommended,
-  ...tseslint.configs.recommended,
-  {
-    languageOptions: {
-      parserOptions: {
-        tsconfigRootDir: (import.meta as any).dirname,
-      },
-    },
-  },
-  ...nextVitals,
-  ...nextTs,
-  globalIgnores(['.next/**', 'out/**', 'build/**', 'next-env.d.ts']),
-  reactCompiler.configs.recommended,
-  {
-    rules: {
-      'react-compiler/react-compiler': 'error',
-    },
-  },
-]) satisfies Config[];