chore(eslint): add some ESlint configuration (#1178)

Based on bpmn-visualization configuration:
- Add `eslint-plugin-import` and `eslint-import-resolver-typescript`.
- Update TS configuration
- Add some `@typescript-eslint` rules

.eslintrc.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 module.exports = {
-  plugins: ['notice'],
+  plugins: ['notice', 'import'],
   extends: [
     'plugin:prettier/recommended', // Enables eslint-plugin-prettier and eslint-config-prettier. This will display prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
   ],
@@ -44,7 +44,22 @@ module.exports = {
       extends: [
         'plugin:@typescript-eslint/recommended', // Uses the recommended rules from the @typescript-eslint/eslint-plugin
         'plugin:prettier/recommended', // Enables eslint-plugin-prettier and eslint-config-prettier. This will display prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
+        'plugin:import/recommended',
+        'plugin:import/typescript',
       ],
+      settings: {
+        'import/resolver': {
+          typescript: {
+            alwaysTryTypes: true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
+            project: './tsconfig.json',
+          },
+        },
+      },
+      parserOptions: {
+        // This setting is required if you want to use rules which require type information
+        // https://typescript-eslint.io/packages/parser/#project
+        project: ['./tsconfig.json'],
+      },
       rules: {
         // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
         '@typescript-eslint/explicit-function-return-type': [
@@ -54,6 +69,24 @@ module.exports = {
             allowTypedFunctionExpressions: true,
           },
         ],
+        '@typescript-eslint/explicit-member-accessibility': [
+          'error',
+          {
+            accessibility: 'no-public',
+          },
+        ],
+        '@typescript-eslint/consistent-type-exports': [
+          'error',
+          {
+            fixMixedExportsWithInlineTypeSpecifier: true,
+          },
+        ],
+        '@typescript-eslint/consistent-type-imports': ['error'],
+        '@typescript-eslint/dot-notation': 'error',
+        '@typescript-eslint/require-await': 'error',
+        '@typescript-eslint/no-floating-promises': 'error',
+        '@typescript-eslint/no-misused-promises': 'error',
+        '@typescript-eslint/restrict-plus-operands': 'error',
       },
     },
     // markdown

package.json

@@ -43,7 +43,9 @@
     "babel-plugin-styled-components": "^2.1.4",
     "eslint": "^8.50.0",
     "eslint-config-prettier": "^9.0.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-mdx": "^2.2.0",
+    "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-mdx": "^2.2.0",
     "eslint-plugin-notice": "^0.9.10",
     "eslint-plugin-prettier": "^5.0.0",

src/assets/theme/base/breakpoints.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { BreakpointsOptions } from '@mui/material';
+import type { BreakpointsOptions } from '@mui/material';
 
 /**
  * To customize the breakpoints: https://mui.com/material-ui/customization/breakpoints/

src/assets/theme/base/colors.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { PaletteOptions, SocialPaletteOptions } from '@mui/material';
+import type { PaletteOptions, SocialPaletteOptions } from '@mui/material';
 
 /**
  * The base colors for the Material Kit 2 React.

src/assets/theme/base/typography.ts

@@ -20,7 +20,7 @@
  * You can customize the typography styles for the entire Material Kit 2 React using this file.
  */
 
-import { TypographyOptions } from '@mui/material/styles/createTypography';
+import type { TypographyOptions } from '@mui/material/styles/createTypography';
 
 import { fontSize, fontWeight } from '../helpers/font-utils';
 

src/assets/theme/components/card/muiCard.ts

@@ -29,7 +29,7 @@ Coded by www.creative-tim.com
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders, boxShadows, rgba } from '../..';
 

src/assets/theme/components/card/muiCardContent.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 /**
  =========================================================

src/assets/theme/components/card/muiCardMedia.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders } from '../..';
 

src/assets/theme/components/dialog/muiDialog.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders, boxShadows } from '../..';
 

src/assets/theme/components/dialog/muiDialogActions.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 /**
  =========================================================

src/assets/theme/components/dialog/muiDialogContent.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { fontSize, borders } from '../..';
 

src/assets/theme/components/dialog/muiDialogContentText.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { fontSize } from '../..';
 

src/assets/theme/components/dialog/muiDialogTitle.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { fontSize } from '../..';
 

src/assets/theme/components/form/muiAutocomplete.ts

@@ -29,11 +29,9 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
-import { borders, boxShadows, dark, darker } from '../..';
-
-import { fontSize } from '../..';
+import { borders, boxShadows, dark, darker, fontSize } from '../..';
 
 export const MuiAutocomplete: Components<Theme>['MuiAutocomplete'] = {
   styleOverrides: {

src/assets/theme/components/form/muiCheckbox.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders, linearGradient } from '../..';
 

src/assets/theme/components/form/muiFormControlLabel.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { dark, fontSize, fontWeight } from '../..';
 

src/assets/theme/components/form/muiFormLabel.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { fontSize } from '../..';
 

src/assets/theme/components/form/muiInput.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { dark, fontSize } from '../..';
 

src/assets/theme/components/form/muiInputBase.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { fontSize } from '../..';
 

src/assets/theme/components/form/muiInputLabel.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Palette, PaletteColor, Theme } from '@mui/material';
+import type { Components, Palette, PaletteColor, Theme } from '@mui/material';
 
 import { fontSize } from '../..';
 

src/assets/theme/components/form/muiOutlinedInput.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { fontSize } from '../..';
 

src/assets/theme/components/form/muiRadio.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders, linearGradient } from '../..';
 

src/assets/theme/components/form/muiSelect.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 export const MuiSelect: Components<Theme>['MuiSelect'] = {
   styleOverrides: {

src/assets/theme/components/form/muiSwitch.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders, boxShadows, darker, linearGradient } from '../..';
 

src/assets/theme/components/form/muiTextField.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 export const MuiTextField: Components<Theme>['MuiTextField'] = {
   styleOverrides: {

src/assets/theme/components/list/muiList.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 export const MuiList: Components<Theme>['MuiList'] = {
   styleOverrides: {

src/assets/theme/components/list/muiListItem.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 export const MuiListItem: Components<Theme>['MuiListItem'] = {
   defaultProps: {

src/assets/theme/components/list/muiListItemText.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 export const MuiListItemText: Components<Theme>['MuiListItemText'] = {
   styleOverrides: {

src/assets/theme/components/menu/muiMenu.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders, boxShadows, fontSize } from '../..';
 

src/assets/theme/components/menu/muiMenuItem.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders, dark, fontSize } from '../..';
 

src/assets/theme/components/muiAppBar.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 /**
 =========================================================

src/assets/theme/components/muiAvatar.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders } from '..';
 

src/assets/theme/components/muiBreadcrumbs.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { fontSize } from '..';
 

src/assets/theme/components/muiButton.ts

@@ -29,7 +29,7 @@ Coded by www.creative-tim.com
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { borders, fontSize, fontWeight } from '..';
 

src/assets/theme/components/muiButtonBase.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 export const MuiButtonBase: Components<Theme>['MuiButtonBase'] = {
   defaultProps: {

src/assets/theme/components/muiContainer.ts

@@ -29,8 +29,8 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Breakpoint, Components, Theme } from '@mui/material';
-import { OverridesStyleRules } from '@mui/material/styles/overrides';
+import type { Breakpoint, Components, Theme } from '@mui/material';
+import type { OverridesStyleRules } from '@mui/material/styles/overrides';
 
 // Material Kit 2 React base styles
 import { breakpoints } from '../base/breakpoints';

src/assets/theme/components/muiCssBaseline.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 export const MuiCssBaseline: Components<Theme>['MuiCssBaseline'] = {
   styleOverrides: ({ palette }) => ({

src/assets/theme/components/muiDivider.ts

@@ -29,7 +29,7 @@
  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  */
 
-import { Components, Theme } from '@mui/material';
+import type { Components, Theme } from '@mui/material';
 
 import { dark, rgba } from '..';