chore: document reasons for disabling rules (#284)

Author: iamturns

lib/shared.js

@@ -257,6 +257,7 @@ module.exports = {
       rules: {
         // The following rules are enabled in Airbnb config, but are already checked (more thoroughly) by the TypeScript compiler
         // Some of the rules also fail in TypeScript files, for example: https://github.com/typescript-eslint/typescript-eslint/issues/662#issuecomment-507081586
+        // Rules are inspired by: https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslint-recommended.ts
         'constructor-super': 'off',
         'getter-return': 'off',
         'no-const-assign': 'off',
@@ -274,8 +275,11 @@ module.exports = {
         'no-unreachable': 'off',
         'no-unsafe-negation': 'off',
         'valid-typeof': 'off',
+        // The following rules are enabled in Airbnb config, but are recommended to be disabled within TypeScript projects
+        // 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.
         'import/no-unresolved': 'off',
       },
     },