fix(ignore): Migrate to eslint 9 (#23800)

* Eslint 9

* Automatic changes

* Manual changes

* Process feedback

* u

Author: Koenkk

.eslintignore

@@ -23,8 +23,7 @@ jobs:
                   node-version: 20
                   cache: npm
             # [email protected] requires Node 20 >=
-            # eslint: https://github.com/typescript-eslint/typescript-eslint/issues/8211
-            - run: npx npm-check-updates -u -x connect-gzip-static -x eslint
+            - run: npx npm-check-updates -u -x connect-gzip-static
             - run: rm -f package-lock.json
             - run: npm install
             - uses: peter-evans/create-pull-request@v7

.eslintrc.js

@@ -5,5 +5,23 @@
     "printWidth": 150,
     "bracketSpacing": false,
     "endOfLine": "lf",
-    "tabWidth": 4
+    "tabWidth": 4,
+    "importOrder": [
+        "",
+        "<TYPES>^(node:)",
+        "",
+        "<TYPES>",
+        "",
+        "<TYPES>^[.]",
+        "",
+        "<BUILTIN_MODULES>",
+        "",
+        "<THIRD_PARTY_MODULES>",
+        "",
+        "^zigbee",
+        "",
+        "^[.]"
+    ],
+    "importOrderParserPlugins": ["typescript", "decorators"],
+    "plugins": ["@ianvs/prettier-plugin-sort-imports"]
 }

.github/workflows/update_deps.yml

@@ -0,0 +1,32 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+    eslint.configs.recommended,
+    ...tseslint.configs.recommended,
+    {
+        languageOptions: {
+            parserOptions: {
+                project: true,
+            },
+        },
+        rules: {
+            '@typescript-eslint/await-thenable': 'error',
+            '@typescript-eslint/ban-ts-comment': 'error',
+            '@typescript-eslint/explicit-function-return-type': 'error',
+            '@typescript-eslint/no-explicit-any': 'error',
+            '@typescript-eslint/no-unused-vars': 'error',
+            'array-bracket-spacing': ['error', 'never'],
+            'no-return-await': 'error',
+            'object-curly-spacing': ['error', 'never'],
+            '@typescript-eslint/no-floating-promises': 'error',
+        },
+    },
+    {
+        ignores: ['dist/', '**/*.js', '**/*.mjs'],
+    },
+    eslintConfigPrettier,
+);

.prettierrc

@@ -1,6 +1,10 @@
+import type * as SdNotify from 'sd-notify';
+
 import assert from 'assert';
+
 import bind from 'bind-decorator';
 import stringify from 'json-stable-stringify-without-jsonify';
+
 import {setLogger as zhSetLogger} from 'zigbee-herdsman';
 import {setLogger as zhcSetLogger} from 'zigbee-herdsman-converters';
 
@@ -31,6 +35,8 @@ import * as settings from './util/settings';
 import utils from './util/utils';
 import Zigbee from './zigbee';
 
+type SdNotifyType = typeof SdNotify;
+
 const AllExtensions = [
     ExtensionPublish,
     ExtensionReceive,
@@ -63,15 +69,6 @@ type ExtensionArgs = [
     addExtension: (extension: Extension) => Promise<void>,
 ];
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-let sdNotify: any = null;
-try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    sdNotify = process.env.NOTIFY_SOCKET ? require('sd-notify') : null;
-} catch {
-    // sd-notify is optional
-}
-
 export class Controller {
     private eventBus: EventBus;
     private zigbee: Zigbee;
@@ -81,6 +78,7 @@ export class Controller {
     private exitCallback: (code: number, restart: boolean) => Promise<void>;
     private extensions: Extension[];
     private extensionArgs: ExtensionArgs;
+    private sdNotify: SdNotifyType | undefined;
 
     constructor(restartCallback: () => Promise<void>, exitCallback: (code: number, restart: boolean) => Promise<void>) {
         logger.init();
@@ -149,6 +147,14 @@ export class Controller {
         const info = await utils.getZigbee2MQTTVersion();
         logger.info(`Starting Zigbee2MQTT version ${info.version} (commit #${info.commitHash})`);
 
+        try {
+            this.sdNotify = process.env.NOTIFY_SOCKET ? await import('sd-notify') : undefined;
+            logger.debug('sd-notify loaded');
+        } catch {
+            // istanbul ignore next
+            logger.debug('sd-notify is not installed');
+        }
+
         // Start zigbee
         let startResult;
         try {
@@ -224,11 +230,11 @@ export class Controller {
 
         logger.info(`Zigbee2MQTT started!`);
 
-        const watchdogInterval = sdNotify?.watchdogInterval() || 0;
+        const watchdogInterval = this.sdNotify?.watchdogInterval() || 0;
         if (watchdogInterval > 0) {
-            sdNotify.startWatchdogMode(Math.floor(watchdogInterval / 2));
+            this.sdNotify?.startWatchdogMode(Math.floor(watchdogInterval / 2));
         }
-        sdNotify?.ready();
+        this.sdNotify?.ready();
     }
 
     @bind async enableDisableExtension(enable: boolean, name: string): Promise<void> {
@@ -253,7 +259,7 @@ export class Controller {
     }
 
     async stop(restart = false): Promise<void> {
-        sdNotify?.stopping();
+        this.sdNotify?.stopping(process.pid);
 
         // Call extensions
         await this.callExtensions('stop', this.extensions);
@@ -272,7 +278,7 @@ export class Controller {
             code = 1;
         }
 
-        sdNotify?.stopWatchdogMode();
+        this.sdNotify?.stopWatchdogMode();
         return this.exit(code, restart);
     }
 

eslint.config.mjs

@@ -2,7 +2,6 @@ import events from 'events';
 
 import logger from './util/logger';
 
-// eslint-disable-next-line
 type ListenerKey = object;
 
 interface EventBusMap {

lib/controller.ts

@@ -1,6 +1,8 @@
 import assert from 'assert';
+
 import bind from 'bind-decorator';
 import debounce from 'debounce';
+
 import * as zhc from 'zigbee-herdsman-converters';
 
 import logger from '../util/logger';

lib/eventBus.ts

@@ -1,7 +1,9 @@
 import assert from 'assert';
+
 import bind from 'bind-decorator';
 import debounce from 'debounce';
 import stringify from 'json-stable-stringify-without-jsonify';
+
 import {Zcl} from 'zigbee-herdsman';
 import {ClusterName} from 'zigbee-herdsman/dist/zspec/zcl/definition/tstype';