update eslint dependencies and lint whole project

.github/ISSUE_TEMPLATE/config.yml

@@ -2,4 +2,4 @@
 # contact_links:
 #   - name: Homebridge Discord Community
 #     url: https://discord.gg/kqNCe2D
-#     about: Ask your questions in the #YOUR_CHANNEL_HERE channel
+#     about: Ask your questions in the #YOUR_CHANNEL_HERE channel

.github/ISSUE_TEMPLATE/feature-request.md

@@ -19,5 +19,4 @@ assignees: ''
 **Additional context:**
 <!-- Add any other context or screenshots about the feature request here. -->
 
-
 <!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->

.github/workflows/build.yml

@@ -9,14 +9,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # the Node.js versions to build on
-        node-version: [18.x, 20.x]
+        node-version: [18.x, 20.x, 22.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Use Node.js ${{ matrix.node-version }} 
-        uses: actions/setup-node@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 

.npmignore

@@ -7,7 +7,7 @@ src
 .github
 
 # eslint
-.eslintrc
+eslint.config.js
 
 # typescript
 tsconfig.json

.vscode/extensions.json

@@ -2,4 +2,4 @@
   "recommendations": [
     "dbaeumer.vscode-eslint"
   ]
-}
+}

.vscode/settings.json

@@ -3,6 +3,6 @@
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": true
   },
-  "editor.rulers": [ 140 ],
+  "editor.rulers": [140],
   "eslint.enable": true
-}
+}

README.md

@@ -10,18 +10,18 @@
 
 </span>
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 > **Homebridge v2.0 Information**
-> 
+>
 > This template currently has a
 > - `package.json -> engines.homebridge` value of `"^1.8.0 || ^2.0.0-beta.0"`
 > - `package.json -> devDependencies.homebridge` value of `"^2.0.0-beta.0"`
 >
 > This is to ensure that your plugin will build and run on both Homebridge v1 and v2.
-> 
+>
 > Once Homebridge v2.0 has been released, you can remove the `-beta.0` in both places.
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 > **Node v22 Information**
 >
 > This template currently has a
@@ -65,8 +65,9 @@ Open the [`package.json`](./package.json) and change the following attributes:
 
 - `name` - this should be prefixed with `homebridge-` or `@username/homebridge-`, is case-sensitive, and contains no spaces nor special characters apart from a dash `-`
 - `displayName` - this is the "nice" name displayed in the Homebridge UI
-- `repository.url` - Link to your GitHub repo
-- `bugs.url` - Link to your GitHub repo issues page
+- `homepage` - link to your GitHub repo's `README.md`
+- `repository.url` - link to your GitHub repo
+- `bugs.url` - link to your GitHub repo issues page
 
 When you are ready to publish the plugin you should set `private` to false, or remove the attribute entirely.
 
@@ -75,7 +76,7 @@ When you are ready to publish the plugin you should set `private` to false, or r
 Open the [`src/settings.ts`](./src/settings.ts) file and change the default values:
 
 - `PLATFORM_NAME` - Set this to be the name of your platform. This is the name of the platform that users will use to register the plugin in the Homebridge `config.json`.
-- `PLUGIN_NAME` - Set this to be the same name you set in the [`package.json`](./package.json) file. 
+- `PLUGIN_NAME` - Set this to be the same name you set in the [`package.json`](./package.json) file.
 
 Open the [`config.schema.json`](./config.schema.json) file and change the following attribute:
 
@@ -190,6 +191,7 @@ sudo npm install -g homebridge-example-plugin@beta
 ```
 
 ### Best Practices
+
 Consider creating your plugin with the [Homebridge Verified](https://github.com/homebridge/verified) criteria in mind. This will help you to create a plugin that is easy to use and works well with Homebridge.
 You can then submit your plugin to the Homebridge Verified list for review.
 The most up-to-date criteria can be found [here](https://github.com/homebridge/verified#requirements).
@@ -208,5 +210,7 @@ For reference, the current criteria are:
 - If the plugin needs to write files to disk (cache, keys, etc.), it must store them inside the Homebridge storage directory.
 
 ### Useful Links
+
 Note these links are here for help but are not supported/verified by the Homebridge team
+
 - [Custom Characteristics](https://github.com/homebridge/homebridge-plugin-template/issues/20)

config.schema.json

@@ -13,4 +13,4 @@
       }
     }
   }
-}
+}

eslint.config.js

@@ -0,0 +1,35 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['dist/**'],
+  },
+  {
+    rules: {
+      'quotes': ['error', 'single'],
+      'indent': ['error', 2, { 'SwitchCase': 0 }],
+      'linebreak-style': ['error', 'unix'],
+      'semi': ['error', 'always'],
+      'comma-dangle': ['error', 'always-multiline'],
+      'dot-notation': 'error',
+      'eqeqeq': ['error', 'smart'],
+      'curly': ['error', 'all'],
+      'brace-style': ['error'],
+      'prefer-arrow-callback': 'warn',
+      'max-len': ['warn', 160],
+      'object-curly-spacing': ['error', 'always'],
+      'no-use-before-define': 'off',
+      '@typescript-eslint/no-use-before-define': ['error', { 'classes': false, 'enums': false }],
+      '@typescript-eslint/no-unused-vars': ['error', { 'caughtErrors': 'none' }],
+    },
+  },
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+    },
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+);

nodemon.json

@@ -9,4 +9,4 @@
   "env": {
     "NODE_OPTIONS": "--trace-warnings"
   }
-}
+}