feat(designer): support Qt designer features

Author: seanwu1105

README.md

@@ -27,14 +27,14 @@
   - [x] `qmldir`
   - [ ] `qss`
   - [x] `qrc`
-  - [ ] `ui`
+  - [x] `ui`
   - [ ] ~~`qt.ts`~~
   - [ ] ~~`pro.user`~~
   - [ ] ~~qmake `pro`~~
 - [ ] Simple tools integration
   - [x] pyside6-rcc
   - [x] pyside6-uic
-  - [ ] pyside6-designer
+  - [x] pyside6-designer
   - [ ] pyside6-project
   - [ ] ~~i18n tools~~
 - [ ] Continuous compilation

package.json

@@ -53,7 +53,9 @@
   "activationEvents": [
     "onLanguage:qml",
     "onCommand:qtForPython.compileResource",
-    "onCommand:qtForPython.compileUi"
+    "onCommand:qtForPython.compileUi",
+    "onCommand:qtForPython.createUi",
+    "onCommand:qtForPython.editUi"
   ],
   "contributes": {
     "languages": [
@@ -98,6 +100,16 @@
         "command": "qtForPython.compileUi",
         "title": "Compile Qt UI File",
         "category": "Qt for Python"
+      },
+      {
+        "command": "qtForPython.createUi",
+        "title": "Create Qt UI File",
+        "category": "Qt for Python"
+      },
+      {
+        "command": "qtForPython.editUi",
+        "title": "Edit Qt UI File",
+        "category": "Qt for Python"
       }
     ],
     "menus": {
@@ -111,6 +123,16 @@
           "command": "qtForPython.compileUi",
           "when": "resourceExtname == .ui && resourceLangId == xml",
           "group": "qtForPython"
+        },
+        {
+          "command": "qtForPython.createUi",
+          "when": "explorerResourceIsFolder == true",
+          "group": "qtForPython"
+        },
+        {
+          "command": "qtForPython.editUi",
+          "when": "resourceExtname == .ui && resourceLangId == xml",
+          "group": "qtForPython"
         }
       ],
       "explorer/context": [
@@ -123,6 +145,16 @@
           "command": "qtForPython.compileUi",
           "when": "resourceExtname == .ui && resourceLangId == xml",
           "group": "qtForPython"
+        },
+        {
+          "command": "qtForPython.createUi",
+          "when": "explorerResourceIsFolder == true",
+          "group": "qtForPython"
+        },
+        {
+          "command": "qtForPython.editUi",
+          "when": "resourceExtname == .ui && resourceLangId == xml",
+          "group": "qtForPython"
         }
       ],
       "editor/title": [
@@ -135,6 +167,16 @@
           "command": "qtForPython.compileUi",
           "when": "resourceExtname == .ui && resourceLangId == xml",
           "group": "qtForPython"
+        },
+        {
+          "command": "qtForPython.createUi",
+          "when": "explorerResourceIsFolder == true",
+          "group": "qtForPython"
+        },
+        {
+          "command": "qtForPython.editUi",
+          "when": "resourceExtname == .ui && resourceLangId == xml",
+          "group": "qtForPython"
         }
       ],
       "editor/context": [
@@ -147,6 +189,16 @@
           "command": "qtForPython.compileUi",
           "when": "resourceExtname == .ui && resourceLangId == xml",
           "group": "qtForPython"
+        },
+        {
+          "command": "qtForPython.createUi",
+          "when": "explorerResourceIsFolder == true",
+          "group": "qtForPython"
+        },
+        {
+          "command": "qtForPython.editUi",
+          "when": "resourceExtname == .ui && resourceLangId == xml",
+          "group": "qtForPython"
         }
       ]
     },
@@ -156,13 +208,13 @@
         "qtForPython.qmllint.enabled": {
           "type": "boolean",
           "default": true,
-          "markdownDescription": "Enable the qmllint integration.",
+          "markdownDescription": "Enable the Qt `qmllint` integration.",
           "scope": "resource"
         },
         "qtForPython.qmllint.path": {
           "type": "string",
           "default": "",
-          "markdownDescription": "The path to `qmllint` executable. Set to empty string to automatically resolve from the installed Python package. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
+          "markdownDescription": "The path to Qt `qmllint` executable. Set to empty string to automatically resolve from the installed Python package. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
           "scope": "resource"
         },
         "qtForPython.qmllint.options": {
@@ -171,13 +223,13 @@
             "type": "string"
           },
           "default": [],
-          "markdownDescription": "The options passed to `qmllint` executable. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
+          "markdownDescription": "The options passed to Qt `qmllint` executable. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
           "scope": "resource"
         },
         "qtForPython.rcc.path": {
           "type": "string",
           "default": "",
-          "markdownDescription": "The path to `rcc` executable. Set to empty string to automatically resolve from the installed Python package. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
+          "markdownDescription": "The path to Qt `rcc` executable. Set to empty string to automatically resolve from the installed Python package. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
           "scope": "resource"
         },
         "qtForPython.rcc.options": {
@@ -189,13 +241,13 @@
             "-o",
             "${resourceDirname}${pathSeparator}rc_${resourceBasenameNoExtension}.py"
           ],
-          "markdownDescription": "The options passed to `rcc` executable. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
+          "markdownDescription": "The options passed to Qt `rcc` executable. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
           "scope": "resource"
         },
         "qtForPython.uic.path": {
           "type": "string",
           "default": "",
-          "markdownDescription": "The path to `uic` executable. Set to empty string to automatically resolve from the installed Python package. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
+          "markdownDescription": "The path to Qt `uic` executable. Set to empty string to automatically resolve from the installed Python package. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
           "scope": "resource"
         },
         "qtForPython.uic.options": {
@@ -207,7 +259,22 @@
             "-o",
             "${resourceDirname}${pathSeparator}ui_${resourceBasenameNoExtension}.py"
           ],
-          "markdownDescription": "The options passed to `uic` executable. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
+          "markdownDescription": "The options passed to Qt `uic` executable. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
+          "scope": "resource"
+        },
+        "qtForPython.designer.path": {
+          "type": "string",
+          "default": "",
+          "markdownDescription": "The path to Qt `designer` executable. Set to empty string to automatically resolve from the installed Python package. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
+          "scope": "resource"
+        },
+        "qtForPython.designer.options": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": [],
+          "markdownDescription": "The options passed to Qt `designer` executable. See [here](https://github.com/seanwu1105/vscode-qt-for-python#predefined-variables) for a detailed list of predefined variables.",
           "scope": "resource"
         }
       }

python/.coveragerc

@@ -4,6 +4,7 @@ omit =
     scripts/qmllint.py
     scripts/rcc.py
     scripts/uic.py
+    scripts/designer.py
 
 [report]
 fail_under = 100

python/scripts/designer.py

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

python/tests/test_designer.py

@@ -0,0 +1,26 @@
+import os
+import subprocess
+
+import pytest
+
+from tests import ASSETS_DIR, SCRIPTS_DIR
+
+
+@pytest.mark.skip(reason="a GUI app cannot be closed gracefully")
+def test_designer_sample_ui():
+    filename = "sample.ui"
+    result = invoke_designer_py([get_assets_path(filename)])
+    assert result.returncode == 0
+    assert len(result.stdout.decode("utf-8")) > 0
+
+
+def invoke_designer_py(args: list[str]):
+    return subprocess.run(
+        ["poetry", "run", "python", "designer.py", *args],
+        cwd=SCRIPTS_DIR,
+        capture_output=True,
+    )
+
+
+def get_assets_path(filename: str) -> str:
+    return os.path.join(ASSETS_DIR, "ui", filename)

src/commands.ts

@@ -1,9 +1,11 @@
 import type { ExtensionContext, Uri } from 'vscode'
 import { window } from 'vscode'
 import { URI } from 'vscode-uri'
-import { compileResource } from './rcc/compile'
+import { createUi } from './designer/create-ui'
+import { editUi } from './designer/edit-ui'
+import { compileResource } from './rcc/compile-resource'
 import type { ErrorResult, SuccessResult } from './types'
-import { compileUi } from './uic/compile'
+import { compileUi } from './uic/compile-ui'
 import { isNil } from './utils'
 
 export const COMMANDS = [
@@ -15,6 +17,14 @@ export const COMMANDS = [
     name: 'compileUi',
     callback: compileUi,
   },
+  {
+    name: 'createUi',
+    callback: createUi,
+  },
+  {
+    name: 'editUi',
+    callback: editUi,
+  },
 ] as const
 
 export type CommandDeps = Pick<ExtensionContext, 'extensionPath'>

src/designer/create-ui.ts

@@ -0,0 +1,63 @@
+import * as fs from 'node:fs'
+import * as path from 'node:path'
+import type { URI } from 'vscode-uri'
+import type { CommandDeps } from '../commands'
+import { getTargetDocumentUri } from '../commands'
+import type { ExecError, StdErrError } from '../run'
+import { run } from '../run'
+import { getToolCommand } from '../tool-utils'
+import type { ErrorResult, SuccessResult } from '../types'
+import { notNil } from '../utils'
+
+export async function createUi(
+  { extensionPath }: CommandDeps,
+  ...args: any[]
+): Promise<CreateUiResult> {
+  const targetDocumentUriResult = getTargetDocumentUri(...args)
+
+  if (targetDocumentUriResult.kind !== 'Success') return targetDocumentUriResult
+
+  const uri = targetDocumentUriResult.value
+
+  const getToolCommandResult = await getToolCommand({
+    tool: 'designer',
+    extensionPath,
+    resource: uri.toString(),
+  })
+
+  if (getToolCommandResult.kind !== 'Success') return getToolCommandResult
+
+  const getDirectoryPathResult = await getDirectoryPath(uri)
+
+  if (getDirectoryPathResult.kind !== 'Success') return getDirectoryPathResult
+
+  return run({
+    command: [
+      ...getToolCommandResult.value.command,
+      ...getToolCommandResult.value.options,
+    ],
+    cwd: getDirectoryPathResult.value,
+  })
+}
+
+type CreateUiResult =
+  | SuccessResult<string>
+  | ExecError
+  | StdErrError
+  | ErrorResult<'NotFound'>
+  | ErrorResult<'Type'>
+  | ErrorResult<'IO'>
+
+async function getDirectoryPath(uri: URI): Promise<GetDirectoryPathResult> {
+  return new Promise<GetDirectoryPathResult>(resolve => {
+    fs.lstat(uri.fsPath, (err, stats) => {
+      if (notNil(err))
+        resolve({ kind: 'IOError', message: `${JSON.stringify(err)}` })
+      else if (stats.isDirectory())
+        resolve({ kind: 'Success', value: uri.fsPath })
+      else resolve({ kind: 'Success', value: path.dirname(uri.fsPath) })
+    })
+  })
+}
+
+type GetDirectoryPathResult = SuccessResult<string> | ErrorResult<'IO'>

src/designer/edit-ui.ts

@@ -0,0 +1,40 @@
+import type { CommandDeps } from '../commands'
+import { getTargetDocumentUri } from '../commands'
+import type { ExecError, StdErrError } from '../run'
+import { run } from '../run'
+import { getToolCommand } from '../tool-utils'
+import type { ErrorResult, SuccessResult } from '../types'
+
+export async function editUi(
+  { extensionPath }: CommandDeps,
+  ...args: any[]
+): Promise<EditUiResult> {
+  const targetDocumentUriResult = getTargetDocumentUri(...args)
+
+  if (targetDocumentUriResult.kind !== 'Success') return targetDocumentUriResult
+
+  const uiFile = targetDocumentUriResult.value
+
+  const getToolCommandResult = await getToolCommand({
+    tool: 'designer',
+    extensionPath,
+    resource: uiFile.toString(),
+  })
+
+  if (getToolCommandResult.kind !== 'Success') return getToolCommandResult
+
+  return run({
+    command: [
+      ...getToolCommandResult.value.command,
+      ...getToolCommandResult.value.options,
+      uiFile.fsPath,
+    ],
+  })
+}
+
+type EditUiResult =
+  | SuccessResult<string>
+  | ExecError
+  | StdErrError
+  | ErrorResult<'NotFound'>
+  | ErrorResult<'Type'>

src/extension.ts

@@ -72,7 +72,8 @@ function onResultReceived(
     | ErrorResult<'Unexpected'>
     | ErrorResult<'NotFound'>
     | ErrorResult<'Type'>
-    | ErrorResult<'Parse'>,
+    | ErrorResult<'Parse'>
+    | ErrorResult<'IO'>,
 ) {
   const indent = 2
   switch (result.kind) {