feat(eslint-config-react-native): define rules

fix: add ignore

chore: add ts plugin and parser

fix: update files

chore: bump version

docs: update docs

chore: deps align

feat: extend by typescript config

fix: use singlequote

fix: format

docs: add links to rules

Author: pchalupa

package-lock.json

@@ -17,6 +17,9 @@ import reactNative from '@strv/eslint-config-react-native'
 export default reactNative
 ```
 
+### Tips
+1. Use caching, see https://eslint.org/docs/latest/use/command-line-interface#caching
+
 ## License
 
 See the [LICENSE](LICENSE) file for information.

packages/eslint-config-react-native/README.md

@@ -1,49 +1,83 @@
+import typeScriptConfig from '@strv/eslint-config-typescript'
 import expoConfig from 'eslint-config-expo/flat.js'
 import { defineConfig, globalIgnores } from 'eslint/config'
 
 /** Globally ignored */
-const ignores = globalIgnores(['.expo/'])
+const ignores = globalIgnores(['.expo/', 'expo-env.d.ts'])
 
 /** @type {import("eslint").Linter.Config} */
 const common = {
   rules: {
-    // Very expensive check
+    // Very expensive check, see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/namespace.md
     'import/namespace': 'off',
-    // Very expensive check
+    // Very expensive check, see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-duplicates.md
     'import/no-duplicates': 'off',
+    // Handled by TypeScript, see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unresolved.md
+    'import/no-unresolved': 'off',
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default.md
+    'import/no-named-as-default': 'off',
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default-member.md
+    'import/no-named-as-default-member': 'off',
+    // Handled by TypeScript. Enable noUnusedLocals in your tsconfig.json, see https://www.typescriptlang.org/tsconfig/#noUnusedLocals
+    // https://eslint.org/docs/latest/rules/no-unused-vars
+    'no-unused-vars': 'off',
   },
 }
 
 /** @type {import("eslint").Linter.Config} */
 const react = {
+  files: ['**/*.jsx', '**/*.tsx'],
   rules: {
+    // Enforce alphabetical sorting of props for better readability, see https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-sort-props.md
     'react/jsx-sort-props': [
-      'warn',
+      'error',
       {
         multiline: 'first',
         reservedFirst: ['key'],
         callbacksLast: true,
         shorthandLast: true,
       },
     ],
+    // DisplayName is not required for React Native components, see https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/display-name.md
     'react/display-name': 'off',
   },
 }
 
 /** @type {import("eslint").Linter.Config} */
-const typescript = {
+const typescript = defineConfig([typeScriptConfig, {
+  files: ['**/*.ts', '**/*.tsx'],
   rules: {
-    // Handled by TypeScript, see https://www.typescriptlang.org/tsconfig/#noUnusedLocals
+    // Handled by TypeScript. Enable noUnusedLocals in your tsconfig.json, see https://www.typescriptlang.org/tsconfig/#noUnusedLocals
+    // https://typescript-eslint.io/rules/no-unused-vars/
     '@typescript-eslint/no-unused-vars': 'off',
     // Its common in React Native to import types using require syntax, see https://reactnative.dev/docs/images#static-image-resources
+    // https://typescript-eslint.io/rules/no-require-imports/
     '@typescript-eslint/no-require-imports': 'off',
+    // Very expensive check, see https://typescript-eslint.io/rules/promise-function-async/
+    '@typescript-eslint/promise-function-async': 'off',
 
-    // '@typescript-eslint/consistent-type-imports': [
-    //   'warn',
-    //   { prefer: 'type-imports', fixStyle: 'inline-type-imports' },
-    // ],
+    // Allows variable shadowing in TypeScript contexts, see https://typescript-eslint.io/rules/no-shadow/
+    '@typescript-eslint/no-shadow': 'off',
+    // Allows both interface and type definitions, see https://typescript-eslint.io/rules/consistent-type-definitions/
+    '@typescript-eslint/consistent-type-definitions': 'off',
+    // Allows Promises in places where they might not be handled properly, see https://typescript-eslint.io/rules/no-misused-promises/
+    '@typescript-eslint/no-misused-promises': 'off',
+    // Allows assignments of any typed values, see https://typescript-eslint.io/rules/no-unsafe-assignment/
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    // Allows returning any typed values from functions, see https://typescript-eslint.io/rules/no-unsafe-return/
+    '@typescript-eslint/no-unsafe-return': 'off',
+    // Allows unbound method references that may lose 'this' context, see https://typescript-eslint.io/rules/unbound-method/
+    '@typescript-eslint/unbound-method': 'off',
+    // Allows member access on any typed values, see https://typescript-eslint.io/rules/no-unsafe-member-access/
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+
+    // Enforce consistent type imports with inline style, see https://typescript-eslint.io/rules/consistent-type-imports/
+    '@typescript-eslint/consistent-type-imports': [
+      'error',
+      { prefer: 'type-imports', fixStyle: 'inline-type-imports' },
+    ],
   },
-}
+}])
 
 export default defineConfig([
   expoConfig,

packages/eslint-config-react-native/index.mjs

@@ -1,7 +1,7 @@
 {
   "name": "@strv/eslint-config-react-native",
   "description": "STRV's ESLint config for React Native projects",
-  "version": "1.0.0",
+  "version": "4.0.0",
   "author": "Petr Chalupa <[email protected]>",
   "keywords": ["eslint", "react-native", "config", "strv"],
   "repository": {
@@ -16,7 +16,8 @@
   "main": "index.mjs",
   "type": "module",
   "dependencies": {
-    "eslint-config-expo": "~10.0.0"
+    "@strv/eslint-config-typescript": "^6.0.0",
+    "eslint-config-expo": "^10.0.0"
   },
   "peerDependencies": {
     "eslint": "^9"