ci: Set up problem matchers

.github/workflows/ci.yml

@@ -27,6 +27,8 @@ jobs:
         with:
           node-version: '12.x'
         if: "matrix.testenv == 'eslint'"
+      - name: Set up problem matchers
+        run: "python3 scripts/dev/ci/problemmatchers.py ${{ matrix.testenv }}"
       - name: Install dependencies
         run: "bash scripts/dev/ci/install.sh ${{ matrix.testenv }}"
       - name: "Run ${{ matrix.testenv }}"

scripts/dev/ci/problemmatchers.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python3
+# vim: ft=sh fileencoding=utf-8 sts=4 sw=4 et:
+
+# Copyright 2020 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Register problem matchers for GitHub Actions.
+
+Relevant docs:
+https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md
+https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers
+"""
+
+import sys
+import tempfile
+import pathlib
+import json
+
+
+MATCHERS = {
+    "shellcheck": [
+        {
+            "regexp": r"^(.+):(\d+):(\d+):\s(note|warning|error):\s(.*)\s\[(SC\d+)\]$",
+            "file": 1,
+            "line": 2,
+            "column": 3,
+            "severity": 4,
+            "message": 5,
+            "code": 6,
+        },
+    ],
+}
+
+
+def main():
+    testenv = sys.argv[1]
+    if testenv not in MATCHERS:
+        return 0
+
+    # We're not deleting the temporary file because this is only running on CI
+    # anyways, and we're not sure if GitHub has already read the file contents
+    # at the point this script exits.
+    output_dir = pathlib.Path(tempfile.mkdtemp(suffix='-ghmatchers'))
+
+    data = {
+        'problemMatcher': [
+            {
+                'owner': testenv,
+                'pattern': MATCHERS[testenv],
+            },
+        ],
+    }
+
+    output_file = output_dir / '{}.json'.format(testenv)
+    with output_file.open('w', encoding='utf-8') as f:
+        json.dump(data, f)
+
+    print("::add-matcher::{}".format(output_file))
+
+
+if __name__ == '__main__':
+    sys.exit(main())