feat: show error notifications generated from Python scripts

README.md

@@ -6,7 +6,9 @@
   - [x] `qmllint` language server
   - [ ] Support ini file
 - [x] Show errors on notification
-- [ ] Handle exceptions from Python scripts
+- [x] Handle exceptions from Python scripts
+  - [x] Drop support to install Python dependencies
+- [ ] Auto bump Python project version
 - [ ] Support multi-root projects
 - [ ] Support spaces in paths
 - [ ] Unit tests for ALL TypeScript scripts

python/.coveragerc

@@ -1,5 +1,7 @@
 [run]
-omit = **/test_*.py
+omit =
+    **/test_*.py
+    scripts/qmllint.py
 
 [report]
 fail_under = 100

python/scripts/qmllint.py

@@ -1,8 +1,12 @@
 import re
 import sys
 
-from PySide6.scripts.pyside_tool import qmllint
+from utils import is_installed
 
 if __name__ == "__main__":
+    if is_installed("PySide6"):
+        from PySide6.scripts.pyside_tool import qmllint
+    else:
+        sys.exit("No qmllint can be found in current Python environment.")
     sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0])
     sys.exit(qmllint())

python/scripts/utils/__init__.py

@@ -0,0 +1,6 @@
+import importlib.util
+import sys
+
+
+def is_installed(name: str) -> bool:
+    return name in sys.modules or importlib.util.find_spec(name) is not None

python/tests/test_qmllint.py

@@ -4,15 +4,9 @@
 import subprocess
 import typing
 
-import scripts.qmllint
-
 from tests import ASSETS_DIR, SCRIPTS_DIR
 
 
-def test_qmllint_is_callable():
-    assert callable(scripts.qmllint.qmllint)
-
-
 def test_qmllint_version():
     result = invoke_qmllint_py(["-v"])
     assert result.returncode == 0

python/tests/test_utils.py

@@ -0,0 +1,6 @@
+from scripts.utils import is_installed
+
+
+def test_is_installed():
+    assert is_installed("not_exist_module") == False
+    assert is_installed("PySide6") == True

src/extension.ts

@@ -1,7 +1,3 @@
-// TODO: 1. odd behavior when checking is QmlLintType!!!
-// TODO: 2. it seems that qmllint does not support whole file content
-// TODO: 3. make onNotification work
-
 import type { ExtensionContext } from 'vscode'
 import { window } from 'vscode'
 import type { LanguageClient } from 'vscode-languageclient/node'
@@ -37,8 +33,14 @@ export async function activate({
 
 function onNotification(n: QmlLintNotification) {
   switch (n.kind) {
-    case 'Error':
-      window.showErrorMessage(n.message)
+    case 'ParseError':
+      return window.showErrorMessage(n.message)
+    case 'ExecError':
+      return window.showErrorMessage(
+        `${n.stderr}\n${n.stdout}\n${n.error.message ?? ''}`,
+      )
+    case 'StdErrError':
+      return window.showErrorMessage(`${n.stderr}\n${n.stdout}`)
   }
 }
 

src/qmllint/server/server.ts

@@ -7,6 +7,8 @@ import {
 
 import { fileURLToPath, pathToFileURL } from 'node:url'
 import { TextDocument } from 'vscode-languageserver-textdocument'
+import type { ErrorResult } from '../../result-types'
+import type { ExecError, StdErrError } from '../../run'
 import { toDiagnostic } from '../converters'
 import { lint } from '../lint'
 
@@ -32,28 +34,16 @@ export function startServer() {
       options: ['--json'],
     })
 
-    if (result.kind === 'StdErrError') {
-      const n: QmlLintNotification = { kind: 'Error', message: result.stderr }
-      return connection.sendNotification(QmlLintNotification, n)
-    }
-    if (result.kind === 'ParseError') {
-      const n: QmlLintNotification = { kind: 'Error', message: result.message }
-      return connection.sendNotification(QmlLintNotification, n)
-    }
-    if (result.kind === 'ExecError') {
-      const n: QmlLintNotification = {
-        kind: 'Error',
-        message: result.error.message,
-      }
-      return connection.sendNotification(QmlLintNotification, n)
-    }
+    if (result.kind === 'Success')
+      return result.value.files.forEach(file =>
+        connection.sendDiagnostics({
+          uri: pathToFileURL(file.filename).href,
+          diagnostics: file.warnings.map(w => toDiagnostic(w)),
+        }),
+      )
 
-    return result.value.files.forEach(file =>
-      connection.sendDiagnostics({
-        uri: pathToFileURL(file.filename).href,
-        diagnostics: file.warnings.map(w => toDiagnostic(w)),
-      }),
-    )
+    const notification: QmlLintNotification = result
+    return connection.sendNotification(QmlLintNotification, notification)
   }
 
   documents.listen(connection)
@@ -64,9 +54,4 @@ export function startServer() {
 export type InitializationOptions = { readonly qmlLintCommand: string[] }
 
 export const QmlLintNotification = 'QmlLintNotification'
-export type QmlLintNotification = ErrorNotification
-
-type ErrorNotification = {
-  readonly kind: 'Error'
-  readonly message: string
-}
+export type QmlLintNotification = ErrorResult<'Parse'> | ExecError | StdErrError

src/run.ts

@@ -21,7 +21,7 @@ type RunResult = SuccessResult<string> | ExecError | StdErrError
 
 export type ExecError = {
   readonly kind: 'ExecError'
-  readonly error: ExecException
+  readonly error: Partial<ExecException>
   readonly stdout: string
   readonly stderr: string
 }