eslint-stylistic-airbnb 3.0.0-rc.1 → 3.0.0-rc.2

package/README.md

@@ -61,13 +61,13 @@ Install the core packages:
 
 ```bash
 # npm
-npm install -D eslint @stylistic/eslint-plugin eslint-stylistic-airbnb
+npm install -D eslint @stylistic/eslint-plugin eslint-stylistic-airbnb globals
 
 # pnpm
-pnpm add -D eslint @stylistic/eslint-plugin eslint-stylistic-airbnb
+pnpm add -D eslint @stylistic/eslint-plugin eslint-stylistic-airbnb globals
 
 # yarn
-yarn add -D eslint @stylistic/eslint-plugin eslint-stylistic-airbnb
+yarn add -D eslint @stylistic/eslint-plugin eslint-stylistic-airbnb globals
 ```
 
 ## Quickstart
@@ -84,9 +84,16 @@ You can either use flat `eslint.config.js` (recommended) or legacy `.eslintrc` (
 ```javascript
 // eslint.config.js
 import airbnb from 'eslint-stylistic-airbnb';
+import globals from 'globals';
 
 export default [
   airbnb.configs['flat/recommended'],
+  
+  {
+    languageOptions: {
+      globals: globals.browser,
+    },
+  },
 ];
 ```
 
@@ -95,10 +102,19 @@ export default [
 // eslint.config.js
 import airbnb from 'eslint-stylistic-airbnb';
 import tseslint from 'typescript-eslint';
+import globals from 'globals';
 
 export default [
   ...tseslint.configs.recommended,
+
   airbnb.configs['flat/recommended'],
+  airbnb.configs['flat/addon-typescript'],
+
+  {
+    languageOptions: {
+      globals: globals.browser,
+    },
+  },
 ];
 ```
 
@@ -108,13 +124,21 @@ export default [
 import airbnb from 'eslint-stylistic-airbnb';
 import react from 'eslint-plugin-react';
 import reactHooks from 'eslint-plugin-react-hooks';
+import globals from 'globals';
 
 export default [
-  airbnb.configs['flat/recommended'],
   react.configs.flat.recommended,
   reactHooks.configs.recommended,
-  airbnb.configs['flat/jsx'],
-  airbnb.configs['flat/react'],
+
+  airbnb.configs['flat/recommended'],
+  airbnb.configs['flat/addon-jsx'],
+  airbnb.configs['flat/addon-react'],
+
+  {
+    languageOptions: {
+      globals: globals.browser,
+    },
+  },
 ];
 ```
 
@@ -125,14 +149,23 @@ import airbnb from 'eslint-stylistic-airbnb';
 import react from 'eslint-plugin-react';
 import reactHooks from 'eslint-plugin-react-hooks';
 import tseslint from 'typescript-eslint';
+import globals from 'globals';
 
 export default [
   ...tseslint.configs.recommended,
-  airbnb.configs['flat/recommended'],
   react.configs.flat.recommended,
   reactHooks.configs.recommended,
-  airbnb.configs['flat/jsx'],
-  airbnb.configs['flat/react'],
+
+  airbnb.configs['flat/recommended'],
+  airbnb.configs['flat/addon-typescript'],
+  airbnb.configs['flat/addon-jsx'],
+  airbnb.configs['flat/addon-react'],
+  
+  {
+    languageOptions: {
+      globals: globals.browser,
+    },
+  },
 ];
 ```
 
@@ -141,11 +174,19 @@ export default [
 // eslint.config.js
 import airbnb from 'eslint-stylistic-airbnb';
 import pluginVue from 'eslint-plugin-vue';
+import globals from 'globals';
 
 export default [
   ...pluginVue.configs['flat/recommended'],
+
   airbnb.configs['flat/recommended'],
-  airbnb.configs['flat/vue'],
+  airbnb.configs['flat/addon-vue'],
+
+  {
+    languageOptions: {
+      globals: globals.browser,
+    },
+  }
 ];
 ```
 
@@ -155,12 +196,21 @@ export default [
 import airbnb from 'eslint-stylistic-airbnb';
 import pluginVue from 'eslint-plugin-vue';
 import tseslint from 'typescript-eslint';
+import globals from 'globals';
 
 export default [
   ...tseslint.configs.recommended,
   ...pluginVue.configs['flat/recommended'],
+
   airbnb.configs['flat/recommended'],
-  airbnb.configs['flat/vue'],
+  airbnb.configs['flat/addon-vue'],
+  airbnb.configs['flat/addon-typescript'],
+
+  {
+    languageOptions: {
+      globals: globals.browser,
+    },
+  },
 ];
 ```
 
@@ -204,6 +254,7 @@ Add **any combination** of these to extend base configs:
 
 |Config|Dependencies|Description|
 |-|-|-|
+|`flat/addon-typescript` | `typescript-eslint` | TypeScript-specific rule replacements: replaces base ESLint rules with TypeScript-aware versions for `no-shadow`, `no-unused-vars`, `no-use-before-define`, `no-useless-constructor`, `no-unused-expressions`, `prefer-destructuring`, and `prefer-promise-reject-errors` to prevent incorrect errors. |
 |`flat/addon-jsx`| None | JSX/TSX formatting for React/Preact/Solid: PascalCase components, double quotes, 2-space indentation, self-closing tags, multiline wrapped in parens, one prop per line (multiline). |
 |`flat/addoniterators`| None | Relaxes iterator restrictions: allows `for...of` loops. Still disallows `for...in`, `with` statements, and labeled statements. |
 |`flat/addon-react` | `eslint-plugin-react` | React component rules: prop types validation, no deprecated APIs, component method ordering, lifecycle conventions, no array index keys, destructured props, function component style. |
@@ -259,9 +310,12 @@ import tseslint from 'typescript-eslint';
 export default [
   ...tseslint.configs.recommended,
   airbnb.configs['flat/recommended'],
+  airbnb.configs['flat/addon-typescript'],
 ];
 ```
 
+Make sure to include `addon-typescript` to prevent incorrect errors in TypeScript files.
+
 ## Migration Guide
 
 ### From `eslint-config-airbnb`
@@ -366,6 +420,32 @@ Yes! See the [Customizing Rules](#customizing-rules) section for examples.
 
 Yes, ESLint 9 is fully supported using the flat config format.
 
+### Do I need to use a `recommended` config from `@eslint/js`?
+
+No, all recommended rules are already included in the base airbnb config. You don't need to add `@eslint/js` recommended preset separately.
+
+### Why do I have `no-undef` errors?
+
+Make sure to specify globals via the `languageOptions.globals` property in your flat config. For example, to enable browser globals:
+
+```javascript
+// eslint.config.js
+import airbnb from 'eslint-stylistic-airbnb';
+import globals from 'globals';
+
+export default [
+  airbnb.configs['flat/recommended'],
+  
+  {
+    languageOptions: {
+      globals: globals.browser,
+    },
+  },
+];
+```
+
+You can also combine multiple environments: `{ ...globals.browser, ...globals.node }`. See the [globals package](https://www.npmjs.com/package/globals) for available options.
+
 ### How do I migrate from `eslint-config-airbnb`?
 
 See the [Migration Guide](#migration-guide) for step-by-step instructions.

package/configs/flat/addon-typescript.js

@@ -0,0 +1,54 @@
+'use strict';
+
+module.exports = {
+  name: 'airbnb:addon-typescript',
+  rules: {
+    'no-shadow': 'off',
+    '@typescript-eslint/no-shadow': 'error',
+
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': ['error', { vars: 'all', args: 'after-used', ignoreRestSiblings: true }],
+
+    'no-use-before-define': 'off',
+    '@typescript-eslint/no-use-before-define': ['error', {
+      functions: false,
+      classes: false,
+      variables: true,
+      enums: true,
+      typedefs: true,
+      ignoreTypeReferences: false,
+    }],
+
+    'no-useless-constructor': 'off',
+    '@typescript-eslint/no-useless-constructor': 'error',
+
+    'no-unused-expressions': 'off',
+    '@typescript-eslint/no-unused-expressions': ['error', {
+      allowShortCircuit: false,
+      allowTernary: false,
+      allowTaggedTemplates: false,
+    }],
+
+    'prefer-destructuring': 'off',
+    '@typescript-eslint/prefer-destructuring': ['error', {
+      VariableDeclarator: {
+        array: false,
+        object: true,
+      },
+      AssignmentExpression: {
+        array: true,
+        object: false,
+      },
+    }, {
+        enforceForRenamedProperties: false,
+        enforceForDeclarationWithTypeAnnotation: false,
+      }],
+
+    'prefer-promise-reject-errors': 'off',
+    '@typescript-eslint/prefer-promise-reject-errors': ['error', {
+      allowEmptyReject: true,
+      allowThrowingAny: false,
+      allowThrowingUnknown: false,
+    }],
+  },
+};

package/index.d.ts

@@ -14,6 +14,7 @@ declare const airbnb: {
     'flat/addon-vue': Linter.Config;
     'flat/addon-vue-ts': Linter.Config;
     'flat/addon-import': Linter.Config;
+    'flat/addon-typescript': Linter.Config;
   };
 };
 

package/index.js

@@ -14,5 +14,6 @@ module.exports = {
     'flat/addon-vue': require('./configs/flat/addon-vue'),
     'flat/addon-vue-ts': require('./configs/flat/addon-vue-ts'),
     'flat/addon-import': require('./configs/flat/addon-import'),
+    'flat/addon-typescript': require('./configs/flat/addon-typescript'),
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-stylistic-airbnb",
-  "version": "3.0.0-rc.1",
+  "version": "3.0.0-rc.2",
   "description": "Airbnb config for eslint using stylistic plugin",
   "main": "index.js",
   "types": "./index.d.ts",