@4mbl/lint 0.0.0-beta.00cfefd

package/CHANGELOG.md

@@ -0,0 +1,45 @@
+# @4mbl/lint
+
+## 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,58 @@
+# @4mbl/lint
+
+> Linting configuration for various environments.
+
+* [Usage](#usage)
+* [Available templates](#available-templates)
+* [Versioning](#versioning)
+
+---
+
+## Usage
+
+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.
+
+```js
+import defaultConfig, { type Config } from '@4mbl/lint/next'; // <-- change `next` to the desired template
+
+export default [...defaultConfig] satisfies Config[];
+```
+
+Set a script that uses the linting package.
+
+```shell
+npm pkg set scripts.lint="eslint 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` for ESLint.
+
+```yaml
+publicHoistPattern:
+  - eslint
+```
+
+## Available templates
+
+There is currently one config template.
+
+- **Next** - Extending the Next.js linting config.
+- **Node** - Linting configuration for Node.js.
+- **React** - Extending the Vite-React linting config.
+
+## Versioning
+
+_Until v1.0.0 is released, breaking changes may be introduced in minor releases without prior warnings._
+
+The package follows the following versioning scheme: `X.Y.Z`.
+
+- `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/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@4mbl/lint",
+  "version": "0.0.0-beta.00cfefd",
+  "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",
+    "./node": "./src/node.ts",
+    "./react": "./src/react.ts"
+  },
+  "files": [
+    "src",
+    "package.json",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/4mbl/config.git",
+    "directory": "packages/lint"
+  },
+  "keywords": [
+    "lint"
+  ],
+  "dependencies": {
+    "@eslint/js": "^9.39.1",
+    "eslint": "^9.39.1",
+    "eslint-config-next": "^16.0.3",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-react-compiler": "19.1.0-rc.2",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "globals": "^16.5.0",
+    "jiti": "^2.6.1",
+    "typescript-eslint": "^8.47.0"
+  },
+  "scripts": {}
+}

package/src/next.ts

@@ -0,0 +1,34 @@
+// @ts-nocheck
+import js from '@eslint/js';
+import nextVitals from 'eslint-config-next/core-web-vitals';
+import nextTs from 'eslint-config-next/typescript';
+import prettier from 'eslint-config-prettier/flat';
+import * as reactCompiler from 'eslint-plugin-react-compiler';
+import reactHooks from 'eslint-plugin-react-hooks';
+import { Config, defineConfig, globalIgnores } 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,
+  reactHooks.configs.flat.recommended,
+  reactCompiler.configs.recommended,
+  {
+    rules: {
+      'react-compiler/react-compiler': 'error',
+    },
+  },
+  prettier,
+  globalIgnores(['.next/**', 'out/**', 'build/**', 'next-env.d.ts']),
+]) satisfies Config[];

package/src/node.ts

@@ -0,0 +1,14 @@
+import js from '@eslint/js';
+import { defineConfig, globalIgnores, type Config } from 'eslint/config';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export { Config };
+
+export default defineConfig([
+  globalIgnores(['dist/**']),
+  { files: ['**/*.{js,mjs,cjs,ts}'] },
+  { languageOptions: { globals: globals.node } },
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+]);

package/src/react.ts

@@ -0,0 +1,34 @@
+import js from '@eslint/js';
+import prettier from 'eslint-config-prettier/flat';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import { defineConfig, globalIgnores, type Config } from 'eslint/config';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export { Config };
+
+export default defineConfig([
+  js.configs.recommended,
+  tseslint.configs.recommended,
+
+  reactHooks.configs.flat.recommended,
+  reactRefresh.configs.recommended,
+
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    rules: {
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+
+  prettier,
+]);