Merge branch 'eslint/update-config' into develop

Author: iamWing

.eslintignore

@@ -3,5 +3,3 @@ dist
 coverage
 out
 public
-jest.config.js
-webpack.config.js

.eslintrc

@@ -0,0 +1,103 @@
+const baseConfig = {
+  env: { node: true },
+  plugins: ['import'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: ['./tsconfig.eslint.json'],
+  },
+  extends: [
+    'airbnb',
+    'airbnb/hooks',
+    'plugin:import/recommended',
+  ],
+  rules: {
+    'max-len': [
+      'warn',
+      {
+        code: 80,
+        tabWidth: 2,
+        ignoreComments: true,
+      },
+    ],
+    'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+    'import/order': [
+      'error',
+      { alphabetize: { order: 'asc' } },
+    ],
+  },
+};
+
+const tsConfig = {
+  files: ['*.ts', '*.tsx'],
+  excludedFiles: ['*.spec.ts', '*.spec.tsx', '*.test.ts', '*.test.tsx'],
+  plugins: [
+    ...baseConfig.plugins,
+    '@typescript-eslint',
+  ],
+  extends: [
+    ...baseConfig.extends,
+    'airbnb-typescript',
+    'plugin:import/typescript',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+  ],
+  rules: {
+    ...baseConfig.rules,
+    // disable rules covered by TypesScript compiler
+    'import/default': 'off',
+    'import/named': 'off',
+    'import/namespace': 'off',
+    'import/no-named-as-default-member': 'off',
+    // disable rules for better local performance
+    'import/no-cycle': 'off',
+    'import/no-deprecated': 'off',
+    'import/no-named-as-default': 'off',
+    'import/no-unused-modules': 'off',
+  },
+  settings: {
+    'import/parsers': { '@typescript-eslint/parser': ['.ts', '.tsx'] },
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true,
+        project: ['./tsconfig.eslint.json'],
+      },
+    },
+  },
+};
+
+const jestConfig = {
+  files: ['*.spec.ts', '*.spec.tsx', '*.test.ts', '*.test.tsx'],
+  env: { node: true, 'jest/globals': true },
+  plugins: [
+    ...tsConfig.plugins,
+    'jest',
+  ],
+  extends: [
+    ...tsConfig.extends,
+    'plugin:jest/recommended',
+    'plugin:jest/style',
+  ],
+  rules: {
+    ...tsConfig.rules,
+    '@typescript-eslint/no-non-null-assertion': 'off',
+  },
+  settings: tsConfig.settings,
+};
+
+const specialConfig = {
+  files: ['**/*.config.js', '**/*.config.*.js'],
+  rules: {
+    ...baseConfig.rules,
+    'import/no-extraneous-dependencies': 'off',
+  },
+};
+
+module.exports = {
+  root: true,
+  ...baseConfig,
+  overrides: [
+    tsConfig,
+    jestConfig,
+    specialConfig,
+  ],
+};

.eslintrc.cjs

@@ -5,6 +5,36 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- `tsconfig.eslint.json` to avoid ESLint complains for file not being included
+  in project provided.
+
+### Changed
+- Migrated from deprecated `.eslintrc` (ESLint config with no file extension) to
+  `CommonJS` file - `.eslintrc.cjs`, with the following changes on the
+  configurations:
+  - Different rules and plugins are now applied based on file types, allowing
+    JavaScript files to be linted properly and only using plugins & rules needed
+    on the targeted files.
+  - Separated config to 4 objects -  naming as `baseConfig`, `tsConfig`,
+    `jestConfig`, and `specialConfig` respectively to maintain the readability
+    on the pervious `.eslintrc`.
+  - `eslint-plugin-import` is now properly configured for both JavaScript and
+    TypeScript files.
+  - `jest.config.js` & `webpack.config.js` are no longer ignored by ESLint.
+
+### Fixed
+- Module import order warnings in most modules.
+- ESLint warnings & errors on `jest.config.js` & `webpack.config.js`.
+
+### Updates on package dependencies
+### Added
+- `eslint-import-resolver-typescript` *- Better TypeScript support for ESLint
+  `import` plugin*
+
+### Removed
+- `eslint-import-resolver-webpack` *- Not being used in any part of the
+  boilerplate*
 
 ## [v4.0.0] - 2022-07-22
 ### Added

CHANGELOG_V4+.md

@@ -1,8 +1,8 @@
-const { pathsToModuleNameMapper } = require('ts-jest')
-const { compilerOptions } = require('./tsconfig.json')
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('./tsconfig.json');
 
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
-module.exports = config = {
+module.exports = {
   testEnvironment: 'node',
   globals: {
     'ts-jest': {