Merge branch 'develop'

Author: seanwu1105

CHANGELOG.md

@@ -1,7 +1,28 @@
 # Change Log
-All notable changes to the "vscode-qt-for-python" extension will be documented in this file.
 
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+## Unreleased
 
-## [Unreleased]
-- Initial release
+### Added
+
+* Python UI compiler (`pyuic5`, `pyside2-uic`)
+* Python Resource Compiler (`pyrcc5`, `pyside2-rcc`)
+* Python `lupdate` (`pylupdate5`, `pyside2-lupdate`)
+* CI/CD
+
+## 0.0.1
+
+### Added
+
+* Qt Markup Language (`*.qml`) highlighting and snippets support
+* QML Module Definition Files (`*.qmldir`) highlighting and snippets support
+* Qt Style Sheets (`*.qss`) highlighting and snippets support
+* Qt Linguist Translation (`*.qt.ts`) highlighting support (XML)
+* Resource Collection Files (`*.qrc`) highlighting support (XML)
+* Qt Designer Form (`*.ui`) highlighting support (XML)
+* Qt Creator User Settings (`*.pro.user`) highlighting support (XML)
+* `qmake` highlighting support
+* New form (Qt Designer `*.ui` file) command
+* Edit form (Qt Designer `*.ui` file) command
+* Edit translation (Qt Linguist `*.qt.ts` file)
+* Release translation (Qt Linguist `*.qt.ts` file) to `*.qm` file
+* Preview QML

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Sean Wu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,65 +1,79 @@
-# vscode-qt-for-python README
+# Visual Studio Code Extension Qt for Python
 
-This is the README for your extension "vscode-qt-for-python". After writing up a brief description, we recommend including the following sections.
+A Visual Studio Code extension provides some common functionalities for PyQt5 and PySide2 with Qt Creator.
 
-## Features
+|        Qt Markup Language (`qml`)       |         Qt Style Sheets (`qss`)         |    Resource Collection Files (`qrc`)    |
+|:---------------------------------------:|:---------------------------------------:|:---------------------------------------:|
+| ![qml](https://i.imgur.com/YDWuDDJ.png) | ![qss](https://i.imgur.com/N1w3vs9.png) | ![qrc](https://i.imgur.com/6qW1YTI.png) |
 
-Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
+|          `qmake` Files (`pro`)          |     Qt Linguist Translation (`qt.ts`)    |   QML Module Definition Files (`qmldir`)   |
+|:---------------------------------------:|:----------------------------------------:|:------------------------------------------:|
+| ![pro](https://i.imgur.com/kI3m5c4.png) | ![qtts](https://i.imgur.com/TnizAQd.png) | ![qmldir](https://i.imgur.com/F6NH69h.png) |
 
-For example if there is an image subfolder under your extension project workspace:
+|         Qt Markup Language (`*.qml`)        |          Qt Designer Form (`*.ui`)          | Qt Linguist Translation (`*.qt.ts`)         |
+|:-------------------------------------------:|:-------------------------------------------:|---------------------------------------------|
+| ![preview](https://i.imgur.com/fSwBIjL.png) | ![preview](https://i.imgur.com/1MMSV2b.png) | ![preview](https://i.imgur.com/Wjf2PkO.png) |
 
-\!\[feature X\]\(images/feature-x.png\)
+## Features
 
-> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
+* [x] Qt Markup Language (`*.qml`) highlighting and snippets support
+* [x] QML Module Definition Files (`*.qmldir`) highlighting and snippets support
+* [x] Qt Style Sheets (`*.qss`) highlighting and snippets support
+* [x] Qt Linguist Translation (`*.qt.ts`) highlighting support (XML)
+* [x] Resource Collection Files (`*.qrc`) highlighting support (XML)
+* [x] Qt Designer Form (`*.ui`) highlighting support (XML)
+* [x] Qt Creator User Settings (`*.pro.user`) highlighting support (XML)
+* [x] `qmake` highlighting support
+* [x] New form (Qt Designer `*.ui` file) command
+* [x] Edit form (Qt Designer `*.ui` file) command
+* [x] Edit translation (Qt Linguist `*.qt.ts` file)
+* [x] Release translation (Qt Linguist `*.qt.ts` file) to `*.qm` file
+* [x] Preview QML
 
 ## Requirements
 
-If you have any requirements or dependencies, add a section describing those and how to install and configure them.
-
-## Extension Settings
-
-Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
-
-For example:
+This extension requires Qt Designer, Qt Linguist, Qt `lrelease` and Qt `qmlscene` for different features. You could install these tools by installing [Qt Creator](https://www.qt.io/download).
 
-This extension contributes the following settings:
-
-* `myExtension.enable`: enable/disable this extension
-* `myExtension.thing`: set to `blah` to do something
+After the installation, you could find the tools within the installing folder of Qt Creator in your computer. For example, if you install Qt Creator 5.12.0 in `/opt/Qt` in Linux, you could find out the binary of these tools in `/opt/Qt/5.12.0/gcc_64/bin`. You have to set the paths of tool in **Qt for Python** section in user settings of Visual Studio Code before using the commands provided by this extension.
 
-## Known Issues
+## Commmand and Explorer Context Menu
 
-Calling out known issues can help limit users opening duplicate issues against your extension.
+> **Note**: All file generated by the following command would overwrite the existing file with the same name **without warning**.
 
-## Release Notes
+### New Form (Qt Designer UI File)
 
-Users appreciate release notes as you update your extension.
+* When: Any condition for command palette or the target in explorer context is a folder.
+* Behavior: Create new UI file in Qt Designer.
 
-### 1.0.0
+### Edit Form (Qt Designer UI File)
 
-Initial release of ...
+* When: The file name extension of the target file in explorer context or the current document in the editor is `*.ui`.
+* Behavior: Edit the UI file in Qt Designer.
 
-### 1.0.1
+### Edit Qt Linguist Translation File
 
-Fixed issue #.
+* When: The file name extension of the target file in explorer context or the current document in the editor is `*.qt.ts` and the language is `xml`.
+* Behavior: Edit the `qt.ts` file in Qt Linguist.
 
-### 1.1.0
+### Release Qt Linguist Translation to QM File
 
-Added features X, Y, and Z.
+* When: The file name extension of the target file in explorer context or the current document in the editor is `*.qt.ts` and the language is `xml`.
+* Behavior: Use `lrelease` to convert the `qt.ts` file into `*.qm` file.
 
------------------------------------------------------------------------------------------------------------
+### Preview QML
 
-## Working with Markdown
+* When: The file name extension of the target file in explorer context or the current document in the editor is `*.qml`.
+* Behavior: Use `qmlscene` to preview the QML file.
 
-**Note:** You can author your README using Visual Studio Code.  Here are some useful editor keyboard shortcuts:
+## Extension Settings
 
-* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
-* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
-* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
+This extension contributes the following settings:
 
-### For more information
+* `qtForPython.path.designer`: The path of Qt Designer with CLI arguments to create and edit form (`*.ui`) files. For example, `/opt/Qt/5.12.0/gcc_64/bin/designer`.
+* `qtForPython.path.linguist`: The path of Qt Linguist with CLI arguments to edit translation (`*.qt.ts`) files. For example, `/opt/Qt/5.12.0/gcc_64/bin/linguist`.
+* `qtForPython.path.lrelease`: The path of Qt lrelease with CLI arguments to edit translation (`*.qt.ts`) files. For example, `/opt/Qt/5.12.0/gcc_64/bin/lrelease -qm ./out.qm`.
+* `qtForPython.path.qmlscene`: The path of Qt QML Scene (`qmlscene`) with CLI arguments to preview QML (`*.qml`) files. For example, `/opt/Qt/5.12.0/gcc_64/bin/qmlscene --verbose`.
 
-* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
-* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
+## Release Notes
 
-**Enjoy!**
+Please see the release notes in [CHANGELOG](CHANGELOG.md).

images/icon.png

@@ -0,0 +1,27 @@
+{
+	"brackets": [
+		["{", "}"],
+		["[", "]"],
+		["(", ")"]
+	],
+	"autoClosingPairs": [
+		{ "open": "{", "close": "}", "notIn": ["string", "comment"] },
+		{ "open": "[", "close": "]", "notIn": ["string", "comment"] },
+		{ "open": "(", "close": ")", "notIn": ["string", "comment"] },
+		{ "open": "\"", "close": "\"", "notIn": ["string", "comment"] },
+		{ "open": "'", "close": "'", "notIn": ["string", "comment"] }
+	],
+	"surroundingPairs": [
+		["{", "}"],
+		["[", "]"],
+		["(", ")"],
+		["\"", "\""],
+		["'", "'"]
+	],
+	"folding": {
+		"markers": {
+			"start": "^\\s*#region\\b",
+			"end": "^\\s*#endregion\\b"
+		}
+	}
+}

languages/qmake-language-configuration.json

@@ -0,0 +1,37 @@
+{
+  "comments": {
+    "lineComment": "//",
+    "blockComment": [ "/*", "*/" ]
+  },
+  "brackets": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"]
+  ],
+  "autoClosingPairs": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"],
+    { "open": "'", "close": "'", "notIn": ["string", "comment"] },
+    { "open": "\"", "close": "\"", "notIn": ["string"] },
+    { "open": "`", "close": "`", "notIn": ["string", "comment"] },
+    { "open": "/**", "close": " */", "notIn": ["string"] }
+  ],
+  "surroundingPairs": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"],
+    ["<", ">"],
+    ["'", "'"],
+    ["\"", "\""],
+    ["`", "`"]
+  ],
+  "folding": {
+    "offSide": true,
+    "markers": {
+      "start": "^\\s*//#region",
+      "end": "^\\s*//#endregion"
+    }
+  },
+  "wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\`\\~\\!\\@\\#\\%\\^\\&\\*\\(\\)\\-\\=\\+\\[\\{\\]\\}\\\\\\|\\;\\:\\'\\\"\\,\\.\\<\\>\\/\\?\\s]+)"
+}

languages/qml-language-configuration.json

@@ -0,0 +1,8 @@
+{
+	"folding": {
+		"markers": {
+			"start": "^\\s*#region\\b",
+			"end": "^\\s*#endregion\\b"
+		}
+	}
+}

languages/qmldir-language-configuration.json

@@ -0,0 +1,31 @@
+{
+	"comments": {
+		"blockComment": ["/*", "*/"]
+	},
+	"brackets": [
+		["{", "}"],
+		["[", "]"],
+		["(", ")"]
+	],
+	"autoClosingPairs": [
+		{ "open": "{", "close": "}", "notIn": ["string", "comment"] },
+		{ "open": "[", "close": "]", "notIn": ["string", "comment"] },
+		{ "open": "(", "close": ")", "notIn": ["string", "comment"] },
+		{ "open": "\"", "close": "\"", "notIn": ["string", "comment"] },
+		{ "open": "'", "close": "'", "notIn": ["string", "comment"] },
+		{ "open": "/**", "close": " */", "notIn": ["string"] }
+	],
+	"surroundingPairs": [
+		["{", "}"],
+		["[", "]"],
+		["(", ")"],
+		["\"", "\""],
+		["'", "'"]
+	],
+	"folding": {
+		"markers": {
+			"start": "^\\s*\\/\\*\\s*#region\\b\\s*(.*?)\\s*\\*\\/",
+			"end": "^\\s*\\/\\*\\s*#endregion\\b.*\\*\\/"
+		}
+	}
+}