[UIE-77] add airbnb eslint and prettier (#3902)

Co-authored-by: Tristan Garwood <[email protected]>

Author: trock-broadinst

.eslintignore

@@ -1,5 +1,13 @@
-.yarn
-node_modules
+*.json
+*.yaml
+*.yml
+*.md
 *.min.js
 .pnp.*js
 build
+public
+.eslintrc.js
+.hooks
+.yarn
+node_modules
+.vscode

.eslintrc.js

@@ -1,139 +1,113 @@
-/* eslint-disable quote-props */
 module.exports = {
-  'plugins': ['lodash-fp', 'simple-import-sort'],
-  'extends': 'react-app',
-  'settings': {
+  extends: ['airbnb-typescript-prettier'],
+  parserOptions: {
+    project: './tsconfig.json',
+  },
+  settings: {
     'import/resolver': {
       'eslint-import-resolver-custom-alias': {
-        'alias': {
-          'src': './src',
-          'types': './types'
+        alias: {
+          src: './src',
+          types: './types',
         },
-        'extensions': ['.js', '.ts']
-      }
-    }
+        extensions: ['.js', '.ts'],
+      },
+    },
   },
-  'rules': {
-    // Best Practices
-    'no-multi-spaces': 'warn',
-    'require-await': 'warn',
-    // Stylistic Issues
-    'array-bracket-newline': ['warn', 'consistent'],
-    'array-bracket-spacing': 'warn',
-    'block-spacing': 'warn',
-    'brace-style': ['warn', '1tbs', { 'allowSingleLine': true }],
-    'camelcase': ['warn', { 'properties': 'never' }],
-    'comma-dangle': ['warn', 'only-multiline'],
-    'comma-spacing': 'warn',
-    'comma-style': 'warn',
-    'computed-property-spacing': 'warn',
-    'eol-last': 'warn',
-    'func-call-spacing': 'warn',
-    'implicit-arrow-linebreak': 'warn',
-    'indent': ['warn', 2, { 'SwitchCase': 1, 'CallExpression': { 'arguments': 1 } }],
-    'key-spacing': 'warn',
-    'keyword-spacing': 'warn',
-    'lines-between-class-members': 'warn',
-    '@typescript-eslint/member-delimiter-style': ['warn', { 'multiline': { 'delimiter': 'none' } }],
-    'no-floating-decimal': 'warn',
-    'no-lonely-if': 'warn',
-    'no-multi-assign': 'warn',
-    'no-multiple-empty-lines': 'warn',
-    'no-trailing-spaces': 'warn',
-    'no-unneeded-ternary': 'warn',
-    'no-unused-vars': 'off', // prefer @typescript-eslint/no-unused-vars
-    '@typescript-eslint/no-unused-vars': [
-      'warn', {
-        'vars': 'all',
-        'args': 'all',
-        'argsIgnorePattern': '^_|^props',
-        'ignoreRestSiblings': true,
-      }
-    ],
-    'no-whitespace-before-property': 'warn',
-    'nonblock-statement-body-position': 'warn',
-    'object-curly-newline': ['warn', { 'multiline': true, 'consistent': true }],
-    'object-curly-spacing': ['warn', 'always'],
-    'one-var': ['warn', 'never'],
-    'operator-linebreak': ['warn', 'after'],
-    'padded-blocks': ['warn', 'never'],
-    'quote-props': ['warn', 'as-needed'],
-    'quotes': ['warn', 'single', { 'avoidEscape': true }],
-    'semi': ['warn', 'never'],
-    'space-before-blocks': 'warn',
-    'space-before-function-paren': ['warn', { 'anonymous': 'never', 'named': 'never', 'asyncArrow': 'always' }],
-    'space-in-parens': 'warn',
-    'space-infix-ops': 'warn',
-
-    // ES6
-    'arrow-parens': ['warn', 'as-needed'],
-    'arrow-spacing': 'warn',
-    'no-duplicate-imports': 'warn',
-    'no-restricted-syntax': [
-      'warn',
-      { 'selector': 'TSEnumDeclaration', 'message': 'Use a union of literals instead of an enum' },
-      { 'selector': 'JSXElement', 'message': 'Use react-hyperscript-helpers instead of JSX' }
-    ],
-    // TODO: Set 'variables' to 'true' after fixing the existing issues
-    'no-use-before-define': ['warn', { 'functions': true, 'classes': true, 'variables': false }],
-    'no-useless-rename': 'warn',
-    'no-var': 'warn',
-    'object-shorthand': 'warn',
-    'prefer-arrow-callback': 'warn',
-    'prefer-const': 'warn',
-    'prefer-template': 'warn',
-    'prefer-rest-params': 'warn',
-    'prefer-spread': 'warn',
-    'rest-spread-spacing': 'warn',
-    'template-curly-spacing': 'warn',
-    'vars-on-top': 'warn',
-
-
-    'lodash-fp/consistent-name': ['warn', '_'],
-    'lodash-fp/no-argumentless-calls': 'warn',
-    'lodash-fp/no-chain': 'warn',
-    'lodash-fp/no-extraneous-args': 'warn',
-    'lodash-fp/no-extraneous-function-wrapping': 'warn',
-    'lodash-fp/no-extraneous-iteratee-args': 'warn',
-    // 'lodash-fp/no-extraneous-partials': 'warn', // available in eslint-plugin-lodash-fp 2.2.0+
-    'lodash-fp/no-partial-of-curried': 'warn',
-    'lodash-fp/no-single-composition': 'warn',
-    'lodash-fp/no-submodule-destructuring': 'warn',
-    'lodash-fp/no-unused-result': 'warn',
-    'lodash-fp/prefer-compact': 'warn',
-    'lodash-fp/prefer-composition-grouping': 'warn',
-    'lodash-fp/prefer-flat-map': 'warn',
-    'lodash-fp/prefer-get': 'warn',
-    'lodash-fp/prefer-identity': ['warn', { 'arrowFunctions': false }],
-    'lodash-fp/preferred-alias': 'warn',
-    'lodash-fp/use-fp': 'warn',
-
+  rules: {
+    'import/prefer-default-export': 'off',
+    'simple-import-sort/imports': 'warn',
+    quotes: [2, 'single', { avoidEscape: true }],
+    'prettier/prettier': ['error', { singleQuote: true }],
 
-    'react/default-props-match-prop-types': 'warn',
-    'react/no-children-prop': 'warn',
-    'react/no-unused-state': 'warn',
+    // TODO: ticket all of these to be enabled or explain why they are disabled
+    'react/destructuring-assignment': 'off',
+    'react/forbid-prop-types': 'off',
+    'react/hooks/exhaustive-deps': 'off',
+    'react/prop-types': 'off',
+    'react/require-default-props': 'off',
+    'react/sort-comp': 'off',
+    'react/static-property-placement': 'off',
 
-    'react-hooks/rules-of-hooks': 'warn',
-    'react-hooks/exhaustive-deps': 'warn',
+    'import/extensions': 'off',
+    'import/named': 'off',
+    'import/no-cycle': 'off',
+    'import/no-extraneous-dependencies': 'off',
+    'import/no-named-as-default': 'off',
+    'import/no-named-as-default-member': 'off',
+    'import/no-relative-parent-imports': 'off',
 
-    'simple-import-sort/imports': 'warn',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/ban-types': 'off',
+    '@typescript-eslint/default-param-last': 'off',
+    '@typescript-eslint/naming-convention': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-explicit-any': ['off'],
+    '@typescript-eslint/no-implied-eval': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-shadow': 'off',
+    '@typescript-eslint/no-throw-literal': 'off',
+    '@typescript-eslint/no-unused-expressions': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/return-await': 'off',
+    '@typescript-eslint/strict-boolean-expressions': 'off', // TODO: should be 'warn',
 
-    'import/named': 'warn',
-    'import/newline-after-import': ['warn', { 'count': 2 }],
-    'import/no-anonymous-default-export': ['warn', { 'allowObject': true }],
-    'import/no-internal-modules': ['warn', {
-      'forbid': ['src/components/common/*']
-    }],
-    'import/no-unresolved': 'warn',
+    'class-methods-use-this': 'off',
+    'consistent-return': 'off',
+    'default-param-last': 'off',
+    'func-names': 'off',
+    'implicit-arrow-linebreak': 'off',
+    'max-len': 'off', // TODO: should be: ['warn', { code: 120 }],
+    'no-await-in-loop': 'off',
+    'no-case-declarations': 'off',
+    'no-constant-condition': 'off',
+    'no-console': 'off',
+    'no-dupe-keys': 'off',
+    'no-empty': 'off',
+    'no-continue': 'off',
+    'no-nested-ternary': 'off',
+    'no-param-reassign': 'off',
+    'no-plusplus': 'off',
+    'no-promise-executor-return': 'off',
+    'no-restricted-syntax': 'off',
+    'no-return-await': 'off',
+    'no-undef': 'off',
+    'no-underscore-dangle': 'off',
+    'no-unused-expressions': 'off',
+    'no-void': 'off',
+    'operator-linebreak': 'off',
+    'prefer-destructuring': 'off',
+    'prefer-promise-reject-errors': 'off',
+    'prefer-regex-literals': 'off',
+    radix: 'off',
+    'symbol-description': 'off',
+    //
 
-    'no-debugger': 'warn'
+    'no-unsafe-optional-chaining': 'warn',
+    '@typescript-eslint/no-unused-vars': [
+      'warn',
+      {
+        vars: 'all',
+        args: 'all',
+        argsIgnorePattern: '_|^_|^props',
+        ignoreRestSiblings: true,
+      },
+    ],
   },
-  'overrides': [
+  overrides: [
+    {
+      files: ['**/*.test.ts', '**/*.test.js'],
+      env: {
+        jest: true,
+      },
+    },
     {
-      'files': 'src/**/*.{js,ts}',
-      'rules': {
-        'no-console': ['warn', { 'allow': ['assert', 'error'] }]
-      }
-    }
-  ]
-}
+      files: 'src/**/*.{js,ts}',
+      rules: {
+        // 'no-console': ['warn', { allow: ['assert', 'error'] }],//TODO: should be enabled
+      },
+    },
+  ],
+  plugins: ['lodash-fp', 'simple-import-sort'],
+};