chore: add documentation for import/no-unresolved rule (#285)

Author: iamturns

README.md

@@ -116,6 +116,18 @@ module.exports = {
 
 My personal ESLint config file with support for Jest, Promises, and Prettier can be found in [create-exposed-app](https://github.com/iamturns/create-exposed-app/blob/master/.eslintrc.js).
 
+### Why is `import/no-unresolved` disabled?
+
+Two reasons:
+
+1. It requires additional configuration, which may be different for monorepo's, webpack usage, etc
+2. The rule offers little value in a TypeScript world, as the TypeScript compiler will catch these errors
+
+If you would like to enable this rule, then:
+
+- Enable the rule within your config: `'import/no-unresolved': 'error'`
+- Install and configure the TypeScript import resolver: [eslint-import-resolver-typescript](https://www.npmjs.com/package/eslint-import-resolver-typescript)
+
 ## Additional Documentation
 
 - [CHANGELOG.md](CHANGELOG.md)

index.js

@@ -3,15 +3,17 @@ module.exports = {
   extends: ['./lib/shared'].map(require.resolve),
   settings: {
     // Append 'ts' extensions to Airbnb 'import/resolver' setting
+    // Prepend 'mjs' to match shared config
+    // Original: ['.js', '.jsx', '.json']
     'import/resolver': {
       node: {
-        extensions: ['.js', '.jsx', '.json', '.ts', '.tsx', '.d.ts'],
+        extensions: ['.mjs', '.js', '.jsx', '.json', '.ts', '.tsx', '.d.ts'],
       },
     },
   },
   rules: {
     // Append 'tsx' to Airbnb 'react/jsx-filename-extension' rule
-    // https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md
+    // Original: ['.jsx']
     'react/jsx-filename-extension': ['error', { extensions: ['.jsx', '.tsx'] }],
   },
 };

lib/shared.js

@@ -16,12 +16,14 @@ module.exports = {
       '@typescript-eslint/parser': ['.ts', '.tsx', '.d.ts'],
     },
     // Append 'ts' extensions to Airbnb 'import/resolver' setting
+    // Original: ['.mjs', '.js', '.json']
     'import/resolver': {
       node: {
         extensions: ['.mjs', '.js', '.json', '.ts', '.d.ts'],
       },
     },
     // Append 'ts' extensions to Airbnb 'import/extensions' setting
+    // Original: ['.js', '.mjs', '.jsx']
     'import/extensions': ['.js', '.mjs', '.jsx', '.ts', '.tsx', '.d.ts'],
     // Resolve type definition packages
     'import/external-module-folders': ['node_modules', 'node_modules/@types'],
@@ -279,7 +281,7 @@ module.exports = {
         // See: https://github.com/typescript-eslint/typescript-eslint/blob/13583e65f5973da2a7ae8384493c5e00014db51b/docs/linting/TROUBLESHOOTING.md#eslint-plugin-import
         'import/named': 'off',
         'import/no-named-as-default-member': 'off',
-        // The following rule has likely been incorrectly disabled. This will be fixed in a separate PR.
+        // Disable `import/no-unresolved`, see README.md for details
         'import/no-unresolved': 'off',
       },
     },