@todesktop/dev-config 1.0.1 → 1.0.28

package/README.md

@@ -1,20 +1,86 @@
 # dev-config
 
 This package provides reusable development configuration files used across the
-repository: ESLint, Prettier, and a base `tsconfig`.
+repository: oxlint, oxfmt, and a base `tsconfig`.
 
-## ESLint
+## Oxlint
 
-The ESLint configuration is based on
-[eslint-config-airbnb-extended](https://github.com/NishargShah/eslint-config-airbnb-extended),
-which modernizes and replaces parts of
-[eslint-config-airbnb](https://github.com/airbnb/javascript) and
-[eslint-config-airbnb-typescript](https://github.com/iamturns/eslint-config-airbnb-typescript).
+[Oxlint](https://oxc.rs/docs/guide/usage/linter) is the primary linting tool.
+Shared configs are in `oxlint/` and consumed via each package's
+`oxlint.config.ts`.
+
+A typical project config looks like this:
+
+```ts
+import { configs, defineConfig } from '@todesktop/dev-config/oxlint';
+
+export default defineConfig({
+  overrides: [
+    configs.base,
+    configs.ts,
+    configs.react,
+    configs.node,
+
+    {
+      rules: {
+        'no-console': 'off',
+      },
+    },
+  ],
+});
+```
+
+Configs are passed as items in `overrides`. Each item applies to all JS/TS file
+extensions by default. You can also spread a config inline to narrow it to
+specific files:
+
+```ts
+{ files: ['**/*.mjs'], ...configs.node }
+```
+
+Available configs:
+
+| Config        | Strict variant | Description                                          |
+| ------------- | -------------- | ---------------------------------------------------- |
+| base          | strict         | Airbnb-based JS rules; lenient defaults              |
+| ts            | tsStrict       | TypeScript rules via `@typescript-eslint`            |
+| react         | reactStrict    | React + React Hooks rules                            |
+| node          | -              | Node.js best practices + globals                     |
+| nodeCommonJs  | -              | CommonJS `.js`/`.cjs` files (configs, scripts)       |
+| browser       | -              | Browser globals                                      |
+| esm           | -              | ESM-specific rules                                   |
+| unicorn       | -              | Rules from `eslint-plugin-unicorn`                   |
+| perfectionist | -              | Sorts imports, objects, and types                    |
+| jest          | -              | Jest globals (auto-scoped to `**/*.test.ts`)         |
+| vitest        | -              | Vitest globals (auto-scoped to `**/*.test.{ts,tsx}`) |
+
+Strict variants tighten rules from their base — for example `tsStrict` turns
+`@typescript-eslint/no-explicit-any` into an error and bans non-null assertions.
+Include the base config alongside its strict variant, as strict does not inherit
+from base automatically.
+
+## tsconfig
+
+A shared TypeScript base config is available. To reuse it, extend it from your
+package's `tsconfig.json`:
+
+```json
+{
+  "extends": "@todesktop/dev-config/tsconfig.json",
+  "include": ["src/**/*.ts"]
+}
+```
+
+---
+
+## Legacy: ESLint (deprecated)
 
-All projects extend the root config at
-[eslint.config.mjs](../../eslint.config.mjs). If a project needs a different
-configuration, add or override rules in that project's `eslint.config.mjs` (for
-example, [tdutils](../tdutils/eslint.config.mjs)).
+> **ESLint support is legacy.** New projects should use oxlint instead.
+
+The ESLint configuration is based on
+[eslint-config-airbnb-extended](https://github.com/NishargShah/eslint-config-airbnb-extended).
+ESLint and all related plugins are optional peer dependencies and will not be
+installed automatically.
 
 A typical project config that reuses these shared configs looks like this:
 
@@ -36,14 +102,7 @@ export default defineConfig(
 );
 ```
 
-Predefined configs from this package are applied first, then any
-project-specific rules are merged on top.
-
-See `eslint/index.js` in this package for a list of available configs and short
-descriptions.
-
-Some configs come in multiple strictness levels. When you choose a strict
-variant, also include the base config, since it's not inherited.
+Available configs:
 
 | Base         | Strict      | Description                                                         |
 | ------------ | ----------- | ------------------------------------------------------------------- |
@@ -56,20 +115,30 @@ variant, also include the base config, since it's not inherited.
 | esm          | -           | ESM-specific rules                                                  |
 | unicorn      | -           | Rules from `eslint-plugin-unicorn`                                  |
 
-## Prettier
-
-A shared Prettier configuration is provided and applied from the repository
-root, so you usually do not need to add a separate Prettier config inside each
-subpackage.
+Since all eslint-related dependencies are removed, you need to install them
+manually:
+
+```sh
+pnpm add -D \
+  @eslint/js@^9.37.0 \
+  eslint@^9.39.1 \
+  eslint-config-airbnb-extended@^2.3.2 \
+  eslint-config-prettier@^10.1.8 \
+  eslint-import-resolver-typescript@^4.4.4 \
+  eslint-plugin-import-x@^4.16.1 \
+  eslint-plugin-n@^17.23.1 \
+  eslint-plugin-perfectionist@^4.15.1 \
+  eslint-plugin-prettier@^5.5.4 \
+  eslint-plugin-react@^7.37.5 \
+  eslint-plugin-react-hooks@^7.0.0 \
+  eslint-plugin-unicorn@^61.0.2 \
+  prettier@^3.6.2 \
+  typescript-eslint@^8.46.1
+```
 
-## tsconfig
+## Legacy: Prettier (deprecated)
 
-A shared TypeScript base config is available. To reuse it, extend it from your
-package's `tsconfig.json`:
+> **Prettier support is legacy.** New projects should use oxfmt instead.
 
-```json
-{
-  "extends": "@todesktop/dev-config/tsconfig.json",
-  "include": ["src/**/*.ts"]
-}
-```
+A shared Prettier configuration is provided for existing projects. Prettier is
+an optional peer dependency and will not be installed automatically.

package/eslint/configs/base.js

@@ -1,4 +1,5 @@
 import airbnb from 'eslint-config-airbnb-extended';
+import { getConsoleMethods } from './data/console.js';
 
 /** @type {import('eslint').Linter.Config} */
 export default {
@@ -25,15 +26,27 @@ export default {
     // https://github.com/NishargShah/eslint-config-airbnb-extended/blob/master/packages/eslint-config-airbnb-extended/rules/variables.ts
     ...airbnb.rules.base.variables.rules,
 
-    // Together with enabling for..of
-    // https://eslint.org/docs/latest/rules/no-restricted-syntax
+    // Warn in base, error in strict
+    // https://eslint.org/docs/latest/rules/no-await-in-loop
+    'no-await-in-loop': 'warn',
+
+    // Warn in base, error in strict. console.log should be used only in development mode
+    // https://eslint.org/docs/latest/rules/no-console
+    'no-console': ['warn', { allow: getConsoleMethods() }],
+
+    // Widely used in for..of
+    // https://eslint.org/docs/latest/rules/no-continue
     'no-continue': 'off',
 
-    // Re-enabled in strict
+    // Warn in base, error in strict
     // https://eslint.org/docs/latest/rules/no-nested-ternary
-    'no-nested-ternary': 'off',
+    'no-nested-ternary': 'warn',
 
-    // Re-enabled in strict, keep `Promise((r) => setTimeout(r, 10))` syntax
+    // Allow ++ in for loops
+    // https://eslint.org/docs/latest/rules/no-plusplus
+    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+
+    // Off in base, error in strict, keep `Promise((r) => setTimeout(r, 10))` syntax
     // https://eslint.org/docs/rules/no-promise-executor-return
     'no-promise-executor-return': 'off',
 
@@ -58,6 +71,27 @@ export default {
       },
     ],
 
+    // Warn in base, error in strict
+    // https://eslint.org/docs/latest/rules/no-shadow
+    'no-shadow': 'warn',
+
+    // Allow underscore in some cases, like destructing third-party objects
+    // https://eslint.org/docs/latest/rules/no-underscore-dangle
+    'no-underscore-dangle': [
+      'error',
+      {
+        allow: ['__mock', '__root'],
+        allowAfterSuper: false,
+        allowAfterThis: false,
+        allowAfterThisConstructor: false,
+        allowFunctionParams: true,
+        allowInArrayDestructuring: true,
+        allowInObjectDestructuring: true,
+        enforceInClassFields: false,
+        enforceInMethodNames: true,
+      },
+    ],
+
     // Using before definition allows placing the primary code on the top
     // https://eslint.org/docs/latest/rules/no-use-before-define
     'no-use-before-define': 'off',

package/eslint/configs/data/console.js

@@ -0,0 +1,47 @@
+export function getConsoleMethods({ excludeDev = true } = {}) {
+  const allMethods = [
+    'assert',
+    'clear',
+    'context',
+    'count',
+    'countReset',
+    'createTask',
+    'debug',
+    'dir',
+    'dirxml',
+    'error',
+    'group',
+    'groupCollapsed',
+    'groupEnd',
+    'info',
+    'log',
+    'profile',
+    'profileEnd',
+    'table',
+    'time',
+    'timeEnd',
+    'timeLog',
+    'timeStamp',
+    'trace',
+    'warn',
+  ];
+
+  const devMethods = [
+    'clear',
+    'count',
+    'countReset',
+    'debug',
+    'log',
+    'profile',
+    'profileEnd',
+    'time',
+    'timeEnd',
+    'timeLog',
+    'timeStamp',
+    'trace',
+  ];
+
+  return excludeDev
+    ? allMethods.filter((m) => !devMethods.includes(m))
+    : allMethods;
+}

package/eslint/configs/react.js

@@ -13,6 +13,12 @@ export default {
     ...airbnb.plugins.reactHooks.plugins,
   },
 
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+
   rules: {
     // https://github.com/NishargShah/eslint-config-airbnb-extended/blob/master/packages/eslint-config-airbnb-extended/rules/react/react.ts
     ...airbnb.rules.react.base.rules,
@@ -20,26 +26,29 @@ export default {
     // https://github.com/NishargShah/eslint-config-airbnb-extended/blob/master/packages/eslint-config-airbnb-extended/rules/react/reactHooks.ts
     ...airbnb.rules.react.hooks.rules,
 
+    // Warn in base, error in strict
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/destructuring-assignment.md
+    'react/destructuring-assignment': 'warn',
+
+    // Off in base, error in strict, since it's widely used
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/function-component-definition.md
+    'react/function-component-definition': 'off',
+
     // Add tsx extension
     // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md
-    'react/jsx-filename-extension': [
-      'error',
-      {
-        extensions: ['.jsx', '.tsx'],
-      },
-    ],
-
-    // Re-enabled in reactStrict
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/destructuring-assignment.md
-    'react/destructuring-assignment': 'off',
+    'react/jsx-filename-extension': ['error', { extensions: ['.jsx', '.tsx'] }],
+
+    // Not always useful
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-no-bind.md
+    'react/jsx-no-bind': 'off',
 
     // There are a lot of existed cases that would look worse after applying
     // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-one-expression-per-line.md
     'react/jsx-one-expression-per-line': 'off',
 
-    // We already have a lot of components defined as arrow functions
-    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/function-component-definition.md
-    'react/function-component-definition': 'off',
+    // Warn in base, error in strict
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-unescaped-entities.md
+    'react/no-unescaped-entities': 'warn',
 
     // I think only web-app doesn't use react-jsx runtime
     // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/react-in-jsx-scope.md
@@ -48,5 +57,9 @@ export default {
     // It's better handled by TSC
     // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/prop-types.md
     'react/require-default-props': 'off',
+
+    // Warn in base, error in strict
+    // https://react.dev/reference/eslint-plugin-react-hooks/lints/exhaustive-deps
+    'react-hooks/exhaustive-deps': 'warn',
   },
 };

package/eslint/configs/reactStrict.js

@@ -8,11 +8,11 @@ export default {
     // https://github.com/NishargShah/eslint-config-airbnb-extended/blob/master/packages/eslint-config-airbnb-extended/rules/react/reactStrict.ts
     ...airbnb.rules.react.strict.rules,
 
-    // Re-enabling
+    // Warn in base, error in strict
     // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/destructuring-assignment.md
     'react/destructuring-assignment': 'error',
 
-    // Re-enabling
+    // Off in base, error in strict
     // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/function-component-definition.md
     'react/function-component-definition': [
       'error',
@@ -21,5 +21,13 @@ export default {
         unnamedComponents: 'function-expression',
       },
     ],
+
+    // Warn in base, error in strict
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-unescaped-entities.md
+    'react/no-unescaped-entities': 'error',
+
+    // Warn in base, error in strict
+    // https://react.dev/reference/eslint-plugin-react-hooks/lints/exhaustive-deps
+    'react-hooks/exhaustive-deps': 'error',
   },
 };

package/eslint/configs/strict.js

@@ -1,5 +1,6 @@
 import airbnb from 'eslint-config-airbnb-extended';
 import perfectionist from 'eslint-plugin-perfectionist';
+import { getConsoleMethods } from './data/console.js';
 
 /** @type {import('eslint').Linter.Config} */
 export default {
@@ -36,6 +37,18 @@ export default {
       },
     ],
 
+    // Configure whitelist
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-extraneous-dependencies.md
+    'import-x/no-extraneous-dependencies': [
+      'error',
+      {
+        ...airbnb.rules.base.imports.rules[
+          'import-x/no-extraneous-dependencies'
+        ][1],
+        whitelist: ['@todesktop/dev-config'],
+      },
+    ],
+
     // It's often useful to rename default exports
     // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-rename-default.md
     'import-x/no-rename-default': 'off',
@@ -52,14 +65,26 @@ export default {
     // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/prefer-default-export.md
     'import-x/prefer-default-export': 'off',
 
-    // Re-enabling
+    // Warn in base, error in strict
+    // https://eslint.org/docs/latest/rules/no-await-in-loop
+    'no-await-in-loop': 'error',
+
+    // Warn in base, error in strict. console.log should be used only in development mode
+    // https://eslint.org/docs/latest/rules/no-console
+    'no-console': ['error', { allow: getConsoleMethods() }],
+
+    // Warn in base, error in strict
     // https://eslint.org/docs/latest/rules/no-nested-ternary
     'no-nested-ternary': 'error',
 
-    // Re-enabling
+    // Off in base, error in strict
     // https://eslint.org/docs/rules/no-promise-executor-return
     'no-promise-executor-return': 'error',
 
+    // Warn in base, error in strict
+    // https://eslint.org/docs/latest/rules/no-shadow
+    'no-shadow': 'error',
+
     // https://perfectionist.dev/rules/sort-array-includes
     'perfectionist/sort-array-includes': [
       'error',

package/eslint/configs/ts.js

@@ -17,5 +17,20 @@ export default {
     // Re-enabled in tsStrict
     // https://typescript-eslint.io/rules/no-explicit-any/
     '@typescript-eslint/no-explicit-any': 'off',
+
+    // Tune some options
+    // https://typescript-eslint.io/rules/no-unused-vars/
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        args: 'all',
+        argsIgnorePattern: '^_',
+        caughtErrors: 'all',
+        caughtErrorsIgnorePattern: '^_',
+        destructuredArrayIgnorePattern: '^_',
+        ignoreRestSiblings: true,
+        varsIgnorePattern: '^_',
+      },
+    ],
   },
 };

package/eslint/index.js

@@ -10,7 +10,6 @@ import ts from './configs/ts.js';
 import tsStrict from './configs/tsStrict.js';
 import unicorn from './configs/unicorn.js';
 
-// eslint-disable-next-line import-x/no-extraneous-dependencies
 export { defineConfig } from 'eslint/config';
 
 export const configs = {