chore: improve external converter issue bot

Author: Koenkk

.github/workflows/external_converter_issue.yml

@@ -2,7 +2,7 @@ name: External Converter Issue
 
 on:
   issues:
-    types: [opened]
+    types: [opened, edited]
 
 permissions:
   issues: write
@@ -23,6 +23,25 @@ jobs:
               return;
             }
 
+            // Hide previous bot comments
+            const comments = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: issue.number,
+            });
+
+            for (const comment of comments.data) {
+              if (comment.user.type === 'Bot' && comment.user.login === 'github-actions[bot]') {
+                await github.graphql(`
+                  mutation {
+                    minimizeComment(input: {subjectId: "${comment.node_id}", classifier: OUTDATED}) {
+                      clientMutationId
+                    }
+                  }
+                `);
+              }
+            }
+
             // Check for placeholder text
             const placeholderText = '<!-- REPLACE THIS LINE WITH YOUR EXTERNAL CONVERTER\'S CODE -->';
             if (issue.body && issue.body.includes(placeholderText)) {
@@ -46,31 +65,22 @@ jobs:
             }
 
             // Check if Tuya manufacturer name is already supported.
-            const regex = /['"](_T\w+_\w+)['"]/g;
-            let tuyaManufacturerNames = [];
-            let match;
-            while ((match = regex.exec(issue.body)) !== null) {
-                tuyaManufacturerNames.push(match[1]);
-            }
+            const tuyaManufacturerNameRe = /['"](_T\w+_(\w+))['"]/g;
+            const tuyaManufacturerNames = Array.from(issue.body.matchAll(tuyaManufacturerNameRe), m => [m[1], m[2]]);
             if (tuyaManufacturerNames.length > 0) {
                 // Checkout the repo and grep for the manufacturer name
                 const execSync = require('child_process').execSync;
-                execSync(`git clone https://github.com/${context.repo.owner}/${context.repo.repo}.git zhc`, {stdio: 'ignore'});
+                execSync(`git clone https://github.com/Koenkk/zigbee-herdsman-converters.git zhc`, {stdio: 'ignore'});
 
-                for (const name of tuyaManufacturerNames) {
-                    // Grep for the manufacturer name
-                    let grepResult = '';
-                    try {
-                      grepResult = execSync(`grep -r "${name}" zhc`, {encoding: 'utf8'});
-                    } catch (err) {}
-
-                    if (grepResult) {
+                for (const [fullName, partialName] of tuyaManufacturerNames) {
+                    const fullMatch = (() => { try { return execSync(`grep -r --include="*.ts" "${fullName}" zhc`, {encoding: 'utf8'}); } catch { return undefined; } })();
+                    if (fullMatch) {
                       await github.rest.issues.createComment({
                         owner: context.repo.owner,
                         repo: context.repo.repo,
                         issue_number: issue.number,
                         body: [
-                          `👋 Hi there! The Tuya device with manufacturer name \`${name}\` is already supported in the latest dev branch.`,
+                          `👋 Hi there! The Tuya device with manufacturer name \`${fullName}\` is already supported in the latest dev branch.`,
                           "See this [guide](https://www.zigbee2mqtt.io/advanced/more/switch-to-dev-branch.html) on how to update, after updating you can remove your external converter.",
                           "",
                           "In case you created the external converter with the goal to extend or fix an issue with the out-of-the-box support, please submit a pull request.",
@@ -86,6 +96,25 @@ jobs:
                       });
                       return;
                     }
+
+                    const partialMatch = (() => { try { return execSync(`grep -r --include="*.ts" "${partialName}" zhc`, {encoding: 'utf8'}); } catch { return undefined; } })();
+                    if (partialMatch) {
+                      const candidates = Array.from(partialMatch.matchAll(tuyaManufacturerNameRe), m => m[1]);
+                      await github.rest.issues.createComment({
+                        owner: context.repo.owner,
+                        repo: context.repo.repo,
+                        issue_number: issue.number,
+                        body: [
+                          `👋 Hi there! A similar Tuya device of which the manufacturer name also ends with \`_${partialName}\` is already supported.`,
+                          "This means the device can probably be easily be supported by re-using the existing converter.",
+                          "",
+                          "I found the following matches: " + candidates.map((c) => `\`${c}\``).join(', '),
+                          `Try to stop Z2M, change all occurrences of \`${fullName}\` in the \`data/database.db\` to one of the matches above and start Z2M.`,
+                          "Let us know if it works so we can support this device out-of-the-box!",
+                        ].join('\n')
+                      });
+                      return;
+                    }
                 }
             }
 
@@ -97,9 +126,12 @@ jobs:
               body: [
               "🙏 Thank you for creating this issue and sharing your external converter!",
               "",
-              "Please submit a pull request on this repository so the device can be supported out-of-the-box with the next release.",
+              "In case all features work, please submit a pull request on this repository so the device can be supported out-of-the-box with the next release.",
               "For instructions on how to create a pull request, see the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).",
               "",
+              "If **NOT** all features work, please follow the [How To Support new devices](https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html)",
+              tuyaManufacturerNames.length > 0 ? "Since this is a Tuya also consider [How To Support new Tuya devices](https://www.zigbee2mqtt.io/advanced/support-new-devices/02_support_new_tuya_devices.html)" : "",
+              "",
               "If you need help with the process, feel free to ask here and we'll be happy to assist."
               ].join('\n')
             });