fix(ignore): Sync eslint settings from zhc (#23951)

Koenkk · web-flow · commit e642f7c86a25 · 2024-09-12T19:36:57.000Z
* fix(ignore): Sync eslint settings from zhc

* u
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -20,7 +20,7 @@ export default tseslint.config(
             '@typescript-eslint/no-explicit-any': 'error',
             '@typescript-eslint/no-unused-vars': 'error',
             'array-bracket-spacing': ['error', 'never'],
-            'no-return-await': 'error',
+            '@typescript-eslint/return-await': ['error', 'always'],
             'object-curly-spacing': ['error', 'never'],
             '@typescript-eslint/no-floating-promises': 'error',
         },
diff --git a/lib/controller.ts b/lib/controller.ts
@@ -165,7 +165,7 @@ export class Controller {
             logger.error('Check https://www.zigbee2mqtt.io/guide/installation/20_zigbee2mqtt-fails-to-start.html for possible solutions');
             logger.error('Exiting...');
             logger.error((error as Error).stack!);
-            return this.exit(1);
+            return await this.exit(1);
         }
 
         // Disable some legacy options on new network creation
@@ -211,7 +211,7 @@ export class Controller {
         } catch (error) {
             logger.error(`MQTT failed to connect, exiting... (${(error as Error).message})`);
             await this.zigbee.stop();
-            return this.exit(1);
+            return await this.exit(1);
         }
 
         // Call extensions
@@ -279,12 +279,12 @@ export class Controller {
         }
 
         this.sdNotify?.stopWatchdogMode();
-        return this.exit(code, restart);
+        return await this.exit(code, restart);
     }
 
     async exit(code: number, restart = false): Promise<void> {
         await logger.end();
-        return this.exitCallback(code, restart);
+        return await this.exitCallback(code, restart);
     }
 
     @bind async onZigbeeAdapterDisconnected(): Promise<void> {
diff --git a/lib/extension/bridge.ts b/lib/extension/bridge.ts
@@ -141,7 +141,7 @@ export default class Bridge extends Extension {
 
         // Zigbee events
         const publishEvent = async (type: string, data: KeyValue): Promise<void> =>
-            this.mqtt.publish('bridge/event', stringify({type, data}), {retain: false, qos: 0});
+            await this.mqtt.publish('bridge/event', stringify({type, data}), {retain: false, qos: 0});
         this.eventBus.onDeviceJoined(this, async (data) => {
             this.lastJoinedDeviceIeeeAddr = data.device.ieeeAddr;
             await this.publishDevices();
@@ -213,11 +213,11 @@ export default class Bridge extends Extension {
      */
 
     @bind async deviceOptions(message: KeyValue | string): Promise<MQTTResponse> {
-        return this.changeEntityOptions('device', message);
+        return await this.changeEntityOptions('device', message);
     }
 
     @bind async groupOptions(message: KeyValue | string): Promise<MQTTResponse> {
-        return this.changeEntityOptions('group', message);
+        return await this.changeEntityOptions('group', message);
     }
 
     @bind async bridgeOptions(message: KeyValue | string): Promise<MQTTResponse> {
@@ -256,11 +256,11 @@ export default class Bridge extends Extension {
     }
 
     @bind async deviceRemove(message: string | KeyValue): Promise<MQTTResponse> {
-        return this.removeEntity('device', message);
+        return await this.removeEntity('device', message);
     }
 
     @bind async groupRemove(message: string | KeyValue): Promise<MQTTResponse> {
-        return this.removeEntity('group', message);
+        return await this.removeEntity('group', message);
     }
 
     @bind async healthCheck(message: string | KeyValue): Promise<MQTTResponse> {
@@ -289,11 +289,11 @@ export default class Bridge extends Extension {
     }
 
     @bind async deviceRename(message: string | KeyValue): Promise<MQTTResponse> {
-        return this.renameEntity('device', message);
+        return await this.renameEntity('device', message);
     }
 
     @bind async groupRename(message: string | KeyValue): Promise<MQTTResponse> {
-        return this.renameEntity('group', message);
+        return await this.renameEntity('group', message);
     }
 
     @bind async restart(message: string | KeyValue): Promise<MQTTResponse> {
diff --git a/lib/extension/frontend.ts b/lib/extension/frontend.ts
@@ -113,7 +113,7 @@ export default class Frontend extends Extension {
         this.wss?.close();
         /* istanbul ignore else */
         if (this.server) {
-            return new Promise((cb: () => void) => this.server!.close(cb));
+            return await new Promise((cb: () => void) => this.server!.close(cb));
         }
     }
 
diff --git a/lib/extension/homeassistant.ts b/lib/extension/homeassistant.ts
@@ -485,8 +485,8 @@ export default class HomeAssistant extends Extension {
         this.eventBus.onDeviceInterview(this, this.onZigbeeEvent);
         this.eventBus.onDeviceMessage(this, this.onZigbeeEvent);
         this.eventBus.onScenesChanged(this, this.onScenesChanged);
-        this.eventBus.onEntityOptionsChanged(this, async (data) => this.discover(data.entity));
-        this.eventBus.onExposesChanged(this, async (data) => this.discover(data.device));
+        this.eventBus.onEntityOptionsChanged(this, async (data) => await this.discover(data.entity));
+        this.eventBus.onExposesChanged(this, async (data) => await this.discover(data.device));
 
         this.mqtt.subscribe(this.statusTopic);
         this.mqtt.subscribe(DEFAULT_STATUS_TOPIC);
diff --git a/lib/extension/networkMap.ts b/lib/extension/networkMap.ts
@@ -220,7 +220,7 @@ export default class NetworkMap extends Extension {
             } catch {
                 // Network is possibly congested, sleep 5 seconds to let the network settle.
                 await utils.sleep(5);
-                return request();
+                return await request();
             }
         };
 
@@ -233,7 +233,7 @@ export default class NetworkMap extends Extension {
             await utils.sleep(1); // sleep 1 second between each scan to reduce stress on network.
 
             try {
-                const result = await requestWithRetry<zh.LQI>(async () => device.zh.lqi());
+                const result = await requestWithRetry<zh.LQI>(async () => await device.zh.lqi());
                 lqis.set(device, result);
                 logger.debug(`LQI succeeded for '${device.name}'`);
             } catch (error) {
@@ -244,7 +244,7 @@ export default class NetworkMap extends Extension {
 
             if (includeRoutes) {
                 try {
-                    const result = await requestWithRetry<zh.RoutingTable>(async () => device.zh.routingTable());
+                    const result = await requestWithRetry<zh.RoutingTable>(async () => await device.zh.routingTable());
                     routingTables.set(device, result);
                     logger.debug(`Routing table succeeded for '${device.name}'`);
                 } catch (error) {
diff --git a/lib/mqtt.ts b/lib/mqtt.ts
@@ -80,7 +80,7 @@ export default class MQTT {
             options.rejectUnauthorized = false;
         }
 
-        return new Promise((resolve, reject) => {
+        return await new Promise((resolve, reject) => {
             this.client = mqtt.connect(mqttSettings.server, options);
             // https://github.com/Koenkk/zigbee2mqtt/issues/9822
             this.client.stream.setMaxListeners(0);
@@ -206,7 +206,7 @@ export default class MQTT {
             actualOptions.retain = false;
         }
 
-        return new Promise<void>((resolve) => {
+        return await new Promise<void>((resolve) => {
             this.client.publish(topic, payload, actualOptions, () => resolve());
         });
     }
diff --git a/lib/util/utils.ts b/lib/util/utils.ts
@@ -53,7 +53,7 @@ async function getZigbee2MQTTVersion(includeCommitHash = true): Promise<{commitH
         return {version: packageJSON.version, commitHash: undefined};
     }
 
-    return new Promise((resolve) => {
+    return await new Promise((resolve) => {
         const version = packageJSON.version;
 
         git.getLastCommit((err: Error, commit: {shortHash: string}) => {
diff --git a/lib/zigbee.ts b/lib/zigbee.ts
@@ -199,15 +199,15 @@ export default class Zigbee {
     }
 
     async getCoordinatorVersion(): Promise<zh.CoordinatorVersion> {
-        return this.herdsman.getCoordinatorVersion();
+        return await this.herdsman.getCoordinatorVersion();
     }
 
     isStopping(): boolean {
         return this.herdsman.isStopping();
     }
 
     async backup(): Promise<void> {
-        return this.herdsman.backup();
+        return await this.herdsman.backup();
     }
 
     async coordinatorCheck(): Promise<{missingRouters: Device[]}> {
@@ -216,7 +216,7 @@ export default class Zigbee {
     }
 
     async getNetworkParameters(): Promise<zh.NetworkParameters> {
-        return this.herdsman.getNetworkParameters();
+        return await this.herdsman.getNetworkParameters();
     }
 
     async reset(type: 'soft' | 'hard'): Promise<void> {
@@ -386,11 +386,11 @@ export default class Zigbee {
     }
 
     async touchlinkFactoryResetFirst(): Promise<boolean> {
-        return this.herdsman.touchlinkFactoryResetFirst();
+        return await this.herdsman.touchlinkFactoryResetFirst();
     }
 
     async touchlinkFactoryReset(ieeeAddr: string, channel: number): Promise<boolean> {
-        return this.herdsman.touchlinkFactoryReset(ieeeAddr, channel);
+        return await this.herdsman.touchlinkFactoryReset(ieeeAddr, channel);
     }
 
     async addInstallCode(installCode: string): Promise<void> {
@@ -402,7 +402,7 @@ export default class Zigbee {
     }
 
     async touchlinkScan(): Promise<{ieeeAddr: string; channel: number}[]> {
-        return this.herdsman.touchlinkScan();
+        return await this.herdsman.touchlinkScan();
     }
 
     createGroup(ID: number): Group {

Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ export class Controller {`
`165`	`165`	`logger.error('Check https://www.zigbee2mqtt.io/guide/installation/20_zigbee2mqtt-fails-to-start.html for possible solutions');`
`166`	`166`	`logger.error('Exiting...');`
`167`	`167`	`logger.error((error as Error).stack!);`
`168`		`- return this.exit(1);`
	`168`	`+ return await this.exit(1);`
`169`	`169`	`}`
`170`	`170`
`171`	`171`	`// Disable some legacy options on new network creation`
`@@ -211,7 +211,7 @@ export class Controller {`
`211`	`211`	`} catch (error) {`
`212`	`212`	logger.error(`MQTT failed to connect, exiting... (${(error as Error).message})`);
`213`	`213`	`await this.zigbee.stop();`
`214`		`- return this.exit(1);`
	`214`	`+ return await this.exit(1);`
`215`	`215`	`}`
`216`	`216`
`217`	`217`	`// Call extensions`
`@@ -279,12 +279,12 @@ export class Controller {`
`279`	`279`	`}`
`280`	`280`
`281`	`281`	`this.sdNotify?.stopWatchdogMode();`
`282`		`- return this.exit(code, restart);`
	`282`	`+ return await this.exit(code, restart);`
`283`	`283`	`}`
`284`	`284`
`285`	`285`	`async exit(code: number, restart = false): Promise<void> {`
`286`	`286`	`await logger.end();`
`287`		`- return this.exitCallback(code, restart);`
	`287`	`+ return await this.exitCallback(code, restart);`
`288`	`288`	`}`
`289`	`289`
`290`	`290`	`@bind async onZigbeeAdapterDisconnected(): Promise<void> {`
Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ export default class Bridge extends Extension {`
`141`	`141`
`142`	`142`	`// Zigbee events`
`143`	`143`	`const publishEvent = async (type: string, data: KeyValue): Promise<void> =>`
`144`		`- this.mqtt.publish('bridge/event', stringify({type, data}), {retain: false, qos: 0});`
	`144`	`+ await this.mqtt.publish('bridge/event', stringify({type, data}), {retain: false, qos: 0});`
`145`	`145`	`this.eventBus.onDeviceJoined(this, async (data) => {`
`146`	`146`	`this.lastJoinedDeviceIeeeAddr = data.device.ieeeAddr;`
`147`	`147`	`await this.publishDevices();`
`@@ -213,11 +213,11 @@ export default class Bridge extends Extension {`
`213`	`213`	`*/`
`214`	`214`
`215`	`215`	`@bind async deviceOptions(message: KeyValue \| string): Promise<MQTTResponse> {`
`216`		`- return this.changeEntityOptions('device', message);`
	`216`	`+ return await this.changeEntityOptions('device', message);`
`217`	`217`	`}`
`218`	`218`
`219`	`219`	`@bind async groupOptions(message: KeyValue \| string): Promise<MQTTResponse> {`
`220`		`- return this.changeEntityOptions('group', message);`
	`220`	`+ return await this.changeEntityOptions('group', message);`
`221`	`221`	`}`
`222`	`222`
`223`	`223`	`@bind async bridgeOptions(message: KeyValue \| string): Promise<MQTTResponse> {`
`@@ -256,11 +256,11 @@ export default class Bridge extends Extension {`
`256`	`256`	`}`
`257`	`257`
`258`	`258`	`@bind async deviceRemove(message: string \| KeyValue): Promise<MQTTResponse> {`
`259`		`- return this.removeEntity('device', message);`
	`259`	`+ return await this.removeEntity('device', message);`
`260`	`260`	`}`
`261`	`261`
`262`	`262`	`@bind async groupRemove(message: string \| KeyValue): Promise<MQTTResponse> {`
`263`		`- return this.removeEntity('group', message);`
	`263`	`+ return await this.removeEntity('group', message);`
`264`	`264`	`}`
`265`	`265`
`266`	`266`	`@bind async healthCheck(message: string \| KeyValue): Promise<MQTTResponse> {`
`@@ -289,11 +289,11 @@ export default class Bridge extends Extension {`
`289`	`289`	`}`
`290`	`290`
`291`	`291`	`@bind async deviceRename(message: string \| KeyValue): Promise<MQTTResponse> {`
`292`		`- return this.renameEntity('device', message);`
	`292`	`+ return await this.renameEntity('device', message);`
`293`	`293`	`}`
`294`	`294`
`295`	`295`	`@bind async groupRename(message: string \| KeyValue): Promise<MQTTResponse> {`
`296`		`- return this.renameEntity('group', message);`
	`296`	`+ return await this.renameEntity('group', message);`
`297`	`297`	`}`
`298`	`298`
`299`	`299`	`@bind async restart(message: string \| KeyValue): Promise<MQTTResponse> {`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ export default class Frontend extends Extension {`
`113`	`113`	`this.wss?.close();`
`114`	`114`	`/* istanbul ignore else */`
`115`	`115`	`if (this.server) {`
`116`		`- return new Promise((cb: () => void) => this.server!.close(cb));`
	`116`	`+ return await new Promise((cb: () => void) => this.server!.close(cb));`
`117`	`117`	`}`
`118`	`118`	`}`
`119`	`119`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ export default class MQTT {`
`80`	`80`	`options.rejectUnauthorized = false;`
`81`	`81`	`}`
`82`	`82`
`83`		`- return new Promise((resolve, reject) => {`
	`83`	`+ return await new Promise((resolve, reject) => {`
`84`	`84`	`this.client = mqtt.connect(mqttSettings.server, options);`
`85`	`85`	`// https://github.com/Koenkk/zigbee2mqtt/issues/9822`
`86`	`86`	`this.client.stream.setMaxListeners(0);`
`@@ -206,7 +206,7 @@ export default class MQTT {`
`206`	`206`	`actualOptions.retain = false;`
`207`	`207`	`}`
`208`	`208`
`209`		`- return new Promise<void>((resolve) => {`
	`209`	`+ return await new Promise<void>((resolve) => {`
`210`	`210`	`this.client.publish(topic, payload, actualOptions, () => resolve());`
`211`	`211`	`});`
`212`	`212`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ async function getZigbee2MQTTVersion(includeCommitHash = true): Promise<{commitH`
`53`	`53`	`return {version: packageJSON.version, commitHash: undefined};`
`54`	`54`	`}`
`55`	`55`
`56`		`- return new Promise((resolve) => {`
	`56`	`+ return await new Promise((resolve) => {`
`57`	`57`	`const version = packageJSON.version;`
`58`	`58`
`59`	`59`	`git.getLastCommit((err: Error, commit: {shortHash: string}) => {`
Original file line number	Diff line number	Diff line change
`@@ -199,15 +199,15 @@ export default class Zigbee {`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`async getCoordinatorVersion(): Promise<zh.CoordinatorVersion> {`
`202`		`- return this.herdsman.getCoordinatorVersion();`
	`202`	`+ return await this.herdsman.getCoordinatorVersion();`
`203`	`203`	`}`
`204`	`204`
`205`	`205`	`isStopping(): boolean {`
`206`	`206`	`return this.herdsman.isStopping();`
`207`	`207`	`}`
`208`	`208`
`209`	`209`	`async backup(): Promise<void> {`
`210`		`- return this.herdsman.backup();`
	`210`	`+ return await this.herdsman.backup();`
`211`	`211`	`}`
`212`	`212`
`213`	`213`	`async coordinatorCheck(): Promise<{missingRouters: Device[]}> {`
`@@ -216,7 +216,7 @@ export default class Zigbee {`
`216`	`216`	`}`
`217`	`217`
`218`	`218`	`async getNetworkParameters(): Promise<zh.NetworkParameters> {`
`219`		`- return this.herdsman.getNetworkParameters();`
	`219`	`+ return await this.herdsman.getNetworkParameters();`
`220`	`220`	`}`
`221`	`221`
`222`	`222`	`async reset(type: 'soft' \| 'hard'): Promise<void> {`
`@@ -386,11 +386,11 @@ export default class Zigbee {`
`386`	`386`	`}`
`387`	`387`
`388`	`388`	`async touchlinkFactoryResetFirst(): Promise<boolean> {`
`389`		`- return this.herdsman.touchlinkFactoryResetFirst();`
	`389`	`+ return await this.herdsman.touchlinkFactoryResetFirst();`
`390`	`390`	`}`
`391`	`391`
`392`	`392`	`async touchlinkFactoryReset(ieeeAddr: string, channel: number): Promise<boolean> {`
`393`		`- return this.herdsman.touchlinkFactoryReset(ieeeAddr, channel);`
	`393`	`+ return await this.herdsman.touchlinkFactoryReset(ieeeAddr, channel);`
`394`	`394`	`}`
`395`	`395`
`396`	`396`	`async addInstallCode(installCode: string): Promise<void> {`
`@@ -402,7 +402,7 @@ export default class Zigbee {`
`402`	`402`	`}`
`403`	`403`
`404`	`404`	`async touchlinkScan(): Promise<{ieeeAddr: string; channel: number}[]> {`
`405`		`- return this.herdsman.touchlinkScan();`
	`405`	`+ return await this.herdsman.touchlinkScan();`
`406`	`406`	`}`
`407`	`407`
`408`	`408`	`createGroup(ID: number): Group {`