Merge branch 'release/4.1.0'

Author: iamWing

.eslintignore

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

.eslintrc

@@ -0,0 +1,108 @@
+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.cjs',
+    '**/*.config.*.js',
+    '**/*.config.*.cjs',
+  ],
+  rules: {
+    ...baseConfig.rules,
+    'import/no-extraneous-dependencies': 'off',
+  },
+};
+
+module.exports = {
+  root: true,
+  ...baseConfig,
+  overrides: [
+    tsConfig,
+    jestConfig,
+    specialConfig,
+  ],
+};

.eslintrc.cjs

@@ -6,6 +6,58 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v4.1.0] - 2022-08-07
+### 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.
+- Improved the readability of `webpack.config.js` by migrating to `webpack-merge`
+  from using `lodash.deepClone()` for merging configuration objects.
+- Configured Node to resolve JavaScript files as ES modules (`"type": "module"`
+  in `package.json`).
+- Refactored Jest and Webpack config files as ES modules.
+
+### 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` *- Enhanced TypeScript support for ESLint
+  `import` plugin*
+- `webpack-merge` *- Replaced the sections using `lodash.deepClone()` in
+  `webpack.config.js`*
+
+### Updated
+- Major version updates:
+  - `electron` - `19.0.9` -> `20.0.1`
+  - `tsconfig-paths-webpack-plugin` - `3.5.2` -> `4.0.0`
+- Minor & patch version updates:
+  - `@typescript-eslint/eslint-plugin` & `@typescript-eslint/parser` -
+    `5.30.7` -> `5.32.0`
+  - `eslint` - `8.20.0` -> `8.21.0`
+  - `eslint-plugin-jest` - `26.6.0` -> `26.7.0`
+  - `electron-builder` - `23.1.0` -> `23.3.3`
+  - `tsconfig-paths` - `4.0.0` -> `4.1.0`
+
+### Removed
+- `eslint-import-resolver-webpack` *- Not being used in any part of the
+  boilerplate*
+- `lodash` *- Replaced by `webpack-merge` for its' usage in `webpack.config.js`*
+
 ## [v4.0.0] - 2022-07-22
 ### Added
 - Jest as default unit testing framework, with sample test suite for `main`.
@@ -87,5 +139,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `ts-jest`*
 - `spectron` *- Deprecated package; No replacement*
 
-[Unreleased]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/compare/v4.0.0...HEAD
+[Unreleased]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/compare/v4.1.0...HEAD
 [v4.0.0]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/compare/v3.0.0...v4.0.0
+[v4.1.0]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/compare/v4.0.0...v4.1.0

CHANGELOG_V4+.md

@@ -1,6 +1,6 @@
-# Electron-React-TypeScript-Webpack-Boilerplate
+# Electron-React-TypeScript-Webpack (ERTW) Boilerplate
 A boilerplate that let you instantly start working on your next [Electron] app 
-in [TypeScript] with no time wasted messing with the config files.
+project in [TypeScript] with no time wasted messing with the config files.
 
 - Ready to use [Electron] project template with [React], [Webpack] and
   [TypeScript] seamlessly integrated.
@@ -16,8 +16,8 @@ in [TypeScript] with no time wasted messing with the config files.
 doesn't work, please [file an issue].*
 
 ### Maintenance schedule
-Starting from `v4.0.0`, the project maintenance will become much more regular.
-A new release will be published on a monthly basis to keep the package
+Starting from [`v4.0.0`], this project is set to receive regular maintenances.
+New releases will be published on monthly basis to keep the package
 dependencies, package configurations and APIs / syntax up to date.
 
 Maintenance work will begin on 1st of each month, and expect the new version to
@@ -27,9 +27,10 @@ especially on experimental features. If you want any particular feature to be
 implemented, please [file an issue], or consider make a [new pull request].
 
 ### Development plan
-- [ ] Create a `create-react-app`-like package initialiser __!!!__
+- [ ] Develop a `create-react-app`-like NPX tool __!!!__
+  __*([working on it](https://github.com/Devtography/create-ertw-app))*__
 - [ ] Integrate another end-to-end testing framework to replace [Spectron]
-- [ ] Migrate to Webpack 5 `Asset Modules`
+- [ ] Migrate to Webpack 5 `Asset Modules` __*(pending for `v4.2.0`)*__
 
 ---
 
@@ -48,6 +49,11 @@ implemented, please [file an issue], or consider make a [new pull request].
   `mocha` as your unit testing framework, please reference to `package.json`
   from [`v3.0.0`].
 
+- [ESLint] config file `.eslintrc.cjs` introduced in [`v4.1.0`] is written in
+  CommonJS syntax on purpose. As of the release of [`v4.1.0`], ESLint has yet
+  to support ES module for its' config file. __Converting the config file to
+  ES module will result in ESLint not working.__
+
 ---
 
 ## Getting started
@@ -123,7 +129,7 @@ To package your Electron app, run `npm run prod` to get your code compiled in
   meant to improve performance of reading files if bundler like Webpack is not
   being used. The app packaging workflow defined in this boilerplate already
   uses Webpack to minify your code in `production` builds, so there shouldn't
-  be any significant performance different with `asar` archiving disabled.
+  be any significant performance difference with `asar` archiving disabled.
 
 ## Project folders & files
 - `dist/` - [Webpack] output location
@@ -210,7 +216,7 @@ To package your Electron app, run `npm run prod` to get your code compiled in
   - `main/main.spec.ts` - Sample test file for `src/main/main`
   - `tsconfig.json` - TypeScript config file for `tests` module
 - `.eslintignore` - [ESLint] ignore file
-- `.eslintrc` - [ESLint] config file
+- `.eslintrc.cjs` - [ESLint] config file
 
   Configured to use Airbnb's rules with [TypeScript] supported, and rules for
   [Jest] applied.
@@ -229,6 +235,7 @@ To package your Electron app, run `npm run prod` to get your code compiled in
   build config setup guides.
 
 - `README.md`
+- `tsconfig.eslint.json` - [TypeScript] config file consume by [ESLint].
 - `tsconfig.json` - [TypeScript] config file
 
   Module path aliases are configured here. [Jest] & [Webpack] will pick up the
@@ -240,13 +247,14 @@ To package your Electron app, run `npm run prod` to get your code compiled in
   Includes configurations targetting `electron-main`, `electron-preload`, and
   `electron-renderer` respectively.
 
-## Author
-[Wing Chau](https://github.com/iamWing) [@Devtography](https://github.com/Devtography)
-
 ## Donation
 Maintaining this project takes time, lots of cups of coffee, and I do it for
-free. Consider buy me coffee via [donations]. 100% of donation will fund my
-coffee buying budget for quality coffee beans from great roasters I know 😉 ☕️️
+free. Consider buy me some coffee via [GitHub Sponsors] or [PayPal]. 100% of
+your donation will fund my coffee buying budget for quality coffee beans from
+great roasters I know 😉 ☕️️
+
+## Author
+[Wing Chau](https://github.com/iamWing) [@Devtography](https://github.com/Devtography)
 
 ## License
 Electron React TypeScript Webpack Boilerplate is open source software 
@@ -265,11 +273,15 @@ Electron React TypeScript Webpack Boilerplate is open source software
 [Playwright]: https://playwright.dev
 [WebdriverIO]: https://webdriver.io
 [Spectron Deprecation Notice]: https://www.electronjs.org/blog/spectron-deprecation-notice
-[`v3.0.0`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/releases/tag/v3.0.0
 [`Use this template`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/generate
 [`tsconfig-paths`]: https://github.com/dividab/tsconfig-paths
 [`tsconfig-paths-webpack-plugin`]: https://github.com/dividab/tsconfig-paths-webpack-plugin
 [Electron quick start guide]: https://www.electronjs.org/docs/latest/tutorial/quick-start
 [Electron Forge]: https://github.com/electron-userland/electron-forge
 [`electron-builder`'s document]: https://www.electron.build
-[donations]: https://github.com/sponsors/iamWing
+[GitHub Sponsors]: https://github.com/sponsors/iamWing
+[PayPal]: https://paypal.me/iamWing0w0
+
+[`v3.0.0`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/releases/tag/v3.0.0
+[`v4.0.0`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/releases/tag/v4.0.0
+[`v4.1.0`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/releases/tag/v4.1.0

README.md

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