@4mbl/lint 0.0.0-alpha.007a287

package/CHANGELOG.md

@@ -0,0 +1,202 @@
+# @4mbl/lint
+
+## 1.0.0-beta.9
+
+### Minor Changes
+
+- 491164e: Add --help flag to cli
+- 491164e: Fallback to Oxlint config lookup if no preset is passed to CLI and Oxlint config exists within working directory.
+
+## 1.0.0-beta.8
+
+### Minor Changes
+
+- a78f42b: Configure rules to reduce noise
+
+## 1.0.0-beta.7
+
+### Minor Changes
+
+- 7c82f22: Upgrade dependencies
+
+## 1.0.0-beta.6
+
+### Minor Changes
+
+- 0422e86: Upgrade dependencies
+
+## 1.0.0-beta.5
+
+### Minor Changes
+
+- 125b851: Enable most rule categories
+- 473bad0: Upgrade dependencies
+
+## 1.0.0-beta.4
+
+### Minor Changes
+
+- 10abc93: Upgrade dependencies
+
+## 1.0.0-beta.3
+
+### Minor Changes
+
+- dd91a0d: Allow direct preset usage with default exports
+- dd91a0d: Add `--preset` argument to use any preset directly from the CLI
+
+### Patch Changes
+
+- 51c5a6a: Resolve uiPath from cwd in next preset
+
+## 1.0.0-beta.2
+
+### Minor Changes
+
+- ba4500a: Use named exports for config templates
+- ba4500a: Re-export oxlint defineConfig
+
+### Patch Changes
+
+- 2b77e08: Transpile configs to support usage from node_modules
+
+## 1.0.0-beta.1
+
+### Patch Changes
+
+- 2c338b1: 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
+
+- 66bbf26: Initial release

package/README.md

@@ -0,0 +1,132 @@
+# @4mbl/lint
+
+> Linting configuration for various environments.
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Using `lint` CLI](#using-lint-cli)
+    - [Setting up the `lint` CLI](#setting-up-the-lint-cli)
+    - [Choosing presets](#choosing-presets)
+    - [Beyond presets](#beyond-presets)
+    - [CLI default arguments](#cli-default-arguments)
+  - [Using `oxlint` directly](#using-oxlint-directly)
+    - [Oxlint CLI](#oxlint-cli)
+    - [Configuring oxlint](#configuring-oxlint)
+- [Available presets](#available-presets)
+- [Versioning](#versioning)
+
+---
+
+> [!NOTE]
+> This package currently uses [oxlint](https://www.npmjs.com/package/oxlint) as the underlying linting tool. This may change in a future major release.
+
+## Installation
+
+Install the [`@4mbl/lint`](https://www.npmjs.com/package/@4mbl/lint) package.
+
+```shell
+npm install -D @4mbl/lint
+```
+
+## Usage
+
+This package supports two ways of running the linting tool.
+
+### Using `lint` CLI
+
+Using the provided `lint` CLI is the recommended approach, as it abstracts away the underlying linting tool and allows it to be changed in the future with minimal impact on consumers.
+
+While we aim to keep the CLI stable across tooling changes, some breaking changes may be unavoidable if the underlying tool changes.
+
+#### Setting up the `lint` CLI
+
+To use the provided CLI, simply call `lint` in your scripts.
+
+```shell
+npm pkg set scripts.lint="lint"
+```
+
+#### Choosing presets
+
+The CLI uses the environment-agnostic `base` preset by default. To use a different preset, pass the `--preset` argument with the preset name.
+
+```shell
+npm pkg set scripts.lint="lint --preset node"
+```
+
+_See the [available presets](#available-presets) section for a list of available presets._
+
+#### Beyond presets
+
+In some cases, the provided presets may not be sufficient for your use case. You can create an `oxlint.config.ts` file and pass it to the oxlint CLI directly.
+
+```shell
+npm pkg set scripts.lint="lint -- --config oxlint.config.ts"
+```
+
+You can use the provided presets as a base for your custom configuration, as shown in the [Configuring oxlint](#configuring-oxlint) section.
+
+#### CLI default arguments
+
+By default, the CLI targets the `src` directory and uses the following oxlint arguments:
+
+- `--max-warnings=0`
+- `--report-unused-disable-directives`
+
+You can override these arguments or pass additional arguments to the underlying oxlint tool.
+
+```shell
+npm pkg set scripts.lint="lint -- --max-warnings=10 --fix"
+```
+
+### Using `oxlint` directly
+
+For full control over the linting setup, you can use oxlint directly.
+
+#### Oxlint CLI
+
+Set the `lint` script in your `package.json` to use the `oxlint` binary.
+
+```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, set `publicHoistPattern` in your `pnpm-workspace.yaml`.
+
+#### Configuring oxlint
+
+Create an `oxlint.config.ts` file in your package with the desired preset.
+
+```js
+import nodeConfig from '@4mbl/lint/node';
+
+export default nodeConfig();
+```
+
+Some presets may accept additional options. For example, the `next` preset accepts a `uiPath` option.
+
+_See the [available presets](#available-presets) section for a list of available presets._
+
+```yaml
+publicHoistPattern:
+  - oxlint
+```
+
+## Available presets
+
+The following presets are currently available:
+
+- **Base** – Environment-agnostic linting rules.
+- **Next** – Additional linting rules for Next.js.
+- **Node** – Additional linting rules for Node.js.
+- **React** – Additional linting rules for React.
+
+## Versioning
+
+The package follows the versioning scheme `X.Y.Z`:
+
+- `X` – Reserved for linting provider changes, as these may introduce broader compatibility issues.
+- `Y` – New linting rules. Rules are initially introduced as warnings and may be promoted to errors in a subsequent minor release.
+- `Z` – Fixes for issues that made the previous release unusable.

package/bin/cli.js

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+
+import { spawnSync } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const rawArgs = process.argv.slice(2);
+
+const separatorIndex = rawArgs.indexOf('--');
+
+const wrapperArgs =
+  separatorIndex === -1 ? rawArgs : rawArgs.slice(0, separatorIndex);
+const toolArgs = separatorIndex === -1 ? [] : rawArgs.slice(separatorIndex + 1);
+
+if (wrapperArgs.includes('--help') || rawArgs.includes('-h')) {
+  console.log(`
+Usage:
+  lint [options] -- [oxlint options]
+
+Options:
+  --preset <name>     Use a preset config (default: base if no config within cwd)
+
+Examples:
+  lint
+  lint --preset node
+  lint -- src --fix
+
+Notes:
+  Everything after "--" is passed directly to oxlint.
+`);
+
+  process.exit(0);
+}
+
+const presetArgIndex = wrapperArgs.findIndex((a) => a === '--preset');
+
+const presetName =
+  presetArgIndex !== -1
+    ? wrapperArgs[presetArgIndex + 1]
+    : !existsSync('./oxlint.config.ts') && !existsSync('./.oxlintrc.json')
+      ? 'base'
+      : undefined;
+
+const configPath = presetName
+  ? path.resolve(__dirname, `../dist/${presetName}.js`)
+  : undefined;
+
+const hasPath = toolArgs.some((a) => !a.startsWith('-'));
+const hasMaxWarn = toolArgs.some((a) => a.startsWith('--max-warnings'));
+const hasReportUnused = toolArgs.some((a) =>
+  a.startsWith('--report-unused-disable-directives'),
+);
+
+const finalArgs = [
+  configPath ? '--config' : undefined,
+  configPath,
+  hasPath ? undefined : 'src',
+  hasMaxWarn ? undefined : '--max-warnings=0',
+  hasReportUnused ? undefined : '--report-unused-disable-directives',
+  ...toolArgs,
+].filter((a) => a !== undefined);
+
+const result = spawnSync('oxlint', finalArgs, {
+  stdio: 'inherit',
+  shell: true,
+});
+
+process.exit(result.status ?? 1);