Merge pull request #46 from hit9/vscode-syntax-highlighting

hit9 · web-flow · commit e81525482848 · 2022-12-26T21:43:23.000+08:00
Vscode syntax highlighting extension
diff --git a/docs/language.rst b/docs/language.rst
@@ -661,3 +661,9 @@ PyCharm
 
 Syntax highlighting settings for PyCharm is available from
 `bitproto's github repository <https://github.com/hit9/bitproto/tree/master/editors/pycharm>`_.
+
+VSCode
+""""""
+
+Install the extension from marketplace:
+`bitproto vscode extension <https://marketplace.visualstudio.com/items?itemName=hit9.bitproto>`_.
diff --git a/docs/locales/zh/LC_MESSAGES/changelog.po b/docs/locales/zh/LC_MESSAGES/changelog.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: bitproto 0.4.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-12-13 22:41+0800\n"
+"POT-Creation-Date: 2022-12-26 21:32+0800\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -21,55 +21,67 @@ msgstr ""
 msgid "Changelog"
 msgstr "版本历史"
 
-#: ../../../changes.rst:5 9e9740e4c92e4ed595194bd543ebe147
+#: ../../../changes.rst:4 fc5a94d17a314c589b3622ad0c32e5a0
+msgid "Version 1.0.0"
+msgstr ""
+
+#: ../../../changes.rst:8 c894eb85f9834f1b837622fd859c7e98
+msgid "First fully release version"
+msgstr "第一次发布 1.0 版本"
+
+#: ../../../changes.rst:13 30bc2f453f9a4e4daec1f2b082a6ac91
+msgid "Version 0.4.6"
+msgstr ""
+
+#: ../../../changes.rst:15 9e9740e4c92e4ed595194bd543ebe147
 msgid "Support signed integers with arbitrary bits, e.g. int24 PR#45."
 msgstr "支持任意比特数目的有符号整数类型 例如 int24, 见 PR#45"
 
-#: ../../../changes.rst:10 30bc2f453f9a4e4daec1f2b082a6ac91
+#: ../../../changes.rst:20 30bc2f453f9a4e4daec1f2b082a6ac91
 msgid "Version 0.4.5"
 msgstr ""
 
-#: ../../../changes.rst:12 3ba33408fbab4e6e8fa4bd1348e776a9
+#: ../../../changes.rst:22 3ba33408fbab4e6e8fa4bd1348e776a9
 msgid ""
 "Use Python IntEnum for enum generation (respecting backward "
 "compatibility)  PR#41."
 msgstr ""
 
-#: ../../../changes.rst:17 dc7770b7fd674da18fa53f58fea0f06f
+#: ../../../changes.rst:27 dc7770b7fd674da18fa53f58fea0f06f
 msgid "Version 0.4.4"
 msgstr ""
 
-#: ../../../changes.rst:19 ee1e046b6272442181a755b5b744d6ba
+#: ../../../changes.rst:29 ee1e046b6272442181a755b5b744d6ba
 msgid "Minor fix compiler setup.py path issue."
 msgstr ""
 
-#: ../../../changes.rst:24 2cd432670b154c19a01259f94cb33bc3
+#: ../../../changes.rst:34 2cd432670b154c19a01259f94cb33bc3
 msgid "Version 0.4.2"
 msgstr ""
 
-#: ../../../changes.rst:26 a8406cdecd1d4dfc94ad9cebc4c927b5
+#: ../../../changes.rst:36 a8406cdecd1d4dfc94ad9cebc4c927b5
 msgid "Allow using ``type`` as message field name, fixes issue #39."
 msgstr ""
 
-#: ../../../changes.rst:31 fc5a94d17a314c589b3622ad0c32e5a0
+#: ../../../changes.rst:41 fc5a94d17a314c589b3622ad0c32e5a0
 msgid "Version 0.4.0"
 msgstr ""
 
-#: ../../../changes.rst:33 3c499990cd38434f932a3558376617c5
+#: ../../../changes.rst:43 3c499990cd38434f932a3558376617c5
 msgid ""
 "Add support for ``message`` and ``enum`` extensiblity for protocol "
 "backward compatibility."
 msgstr ""
 
-#: ../../../changes.rst:34 ad10bcd6f05a4e5187b2d8ba2f3e5235
+#: ../../../changes.rst:44 ad10bcd6f05a4e5187b2d8ba2f3e5235
 msgid "Cut down the code size of generated language-specific files."
 msgstr ""
 
-#: ../../../changes.rst:35 a2e47a95cb5c4f44ac3a9d965d8d719c
+#: ../../../changes.rst:45 a2e47a95cb5c4f44ac3a9d965d8d719c
 msgid "Refactor the bitproto compiler."
 msgstr ""
 
-#: ../../../changes.rst:36 480040dd74284c97acfb4dcc47354779
+#: ../../../changes.rst:46 480040dd74284c97acfb4dcc47354779
 msgid ""
 "Refactor the bitproto serialization mechanism, using language-specific "
 "libraries instead of pure compiler-generated files."
diff --git a/docs/locales/zh/LC_MESSAGES/language.po b/docs/locales/zh/LC_MESSAGES/language.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: bitproto 0.4.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-12-13 22:41+0800\n"
+"POT-Creation-Date: 2022-12-26 21:32+0800\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -94,11 +94,14 @@ msgid ""
 "integer. For bitproto <= v0.4.5, only ``int8,int16,int32,int64`` are "
 "supported. But since bitproto 0.4.6, signed integers with arbitrary bits "
 "are supported."
-msgstr "有符号的比特级别的整数类型, 其中 ``n`` 是一个从 ``1`` 到 ``64`` 的数字。举例来说，``int24``, ``int32``, ``int64`` 都支持。"
-"一个有符号整数 ``int{n}`` 在编码后将占用 ``n`` 个比特。在代码生成时，``int{n}`` 将会被映射成为最小可以容纳这些数量的比特的对应语言中的整数类型，"
-"例如生成 C 语言时，``int3`` 将映射成 ``int8_t``, ``int13`` 将映射成 ``int16_t``，依此类推。"
-"对于一个有符号类型的整数 ``int{n}`` 而言，第 ``n`` 位比特会被认为是其符号位，比如说 ``int24`` 的符号位是第 ``24`` 个比特。"
-"在 bitproto v0.4.5 之前的版本，只有 ``int8,int16,int32,int64`` 才被支持, 但是自从 v0.4.6 以后，任意比特数目大小的有符号整数都支持了。"
+msgstr ""
+"有符号的比特级别的整数类型, 其中 ``n`` 是一个从 ``1`` 到 ``64`` 的数字。举例来说，``int24``, "
+"``int32``, ``int64`` 都支持。一个有符号整数 ``int{n}`` 在编码后将占用 ``n`` "
+"个比特。在代码生成时，``int{n}`` 将会被映射成为最小可以容纳这些数量的比特的对应语言中的整数类型，例如生成 C 语言时，``int3``"
+" 将映射成 ``int8_t``, ``int13`` 将映射成 ``int16_t``，依此类推。对于一个有符号类型的整数 ``int{n}``"
+" 而言，第 ``n`` 位比特会被认为是其符号位，比如说 ``int24`` 的符号位是第 ``24`` 个比特。在 bitproto "
+"v0.4.5 之前的版本，只有 ``int8,int16,int32,int64`` 才被支持, 但是自从 v0.4.6 "
+"以后，任意比特数目大小的有符号整数都支持了。"
 
 #: ../../language.rst:60 83beae3ea0194637af4e2b8a05064115
 msgid "``byte``"
@@ -660,15 +663,21 @@ msgid "PyCharm"
 msgstr ""
 
 #: ../../language.rst:662 d8243880ab7145a0ad9b686f35e3dbc1
-#, fuzzy
 msgid ""
 "Syntax highlighting settings for PyCharm is available from `bitproto's "
-"github repository "
-"<https://github.com/hit9/bitproto/tree/master/editors/pycharm>`_."
+"github repository <https://github.com/hit9/bitproto/tree/master/editors/pycharm>`_."
 msgstr ""
-"在 `bitproto 的 github 仓库 "
-"<https://github.com/hit9/bitproto/tree/master/editors/vim>`_ 中包含一个 `vim "
-"编辑器 <https://www.vim.org/>`_ 的语法高亮插件。"
+"bitproto 的 PyCharm 语法高亮插件: `<https://github.com/hit9/bitproto/tree/master/editors/pycharm>`_."
+
+#: ../../language.rst:666 867939080c3643a6ad15e3ce30b70e9f
+msgid "VSCode"
+msgstr ""
+
+#: ../../language.rst:668 44ebe8c3d9714e35b3434447f45d400d
+msgid ""
+"Install the extension from marketplace: `bitproto vscode extension "
+"<https://marketplace.visualstudio.com/items?itemName=hit9.bitproto>`_."
+msgstr "VSCode 插件可以直接从市场安装: `<https://marketplace.visualstudio.com/items?itemName=hit9.bitproto>`_."
 
 #~ msgid "``int{8,16,32,64}``"
 #~ msgstr ""
diff --git a/editors/vscode/bitproto/.gitignore b/editors/vscode/bitproto/.gitignore
@@ -0,0 +1 @@
+*.vsix
diff --git a/editors/vscode/bitproto/.vscodeignore b/editors/vscode/bitproto/.vscodeignore
@@ -0,0 +1,4 @@
+.vscode/**
+.vscode-test/**
+.gitignore
+vsc-extension-quickstart.md
diff --git a/editors/vscode/bitproto/LICENSE b/editors/vscode/bitproto/LICENSE
@@ -0,0 +1,28 @@
+
+ Copyright (c) 2021, hit9
+ 
+ All rights reserved.
+ 
+ Redistribution and use in source and binary forms, with or without modification,
+ are permitted provided that the following conditions are met:
+ 
+     * Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.
+     * Redistributions in binary form must reproduce the above copyright notice,
+       this list of conditions and the following disclaimer in the documentation
+       and/or other materials provided with the distribution.
+     * Neither the name of bitproto nor the names of its contributors
+       may be used to endorse or promote products derived from this software
+       without specific prior written permission.
+ 
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/editors/vscode/bitproto/README.md b/editors/vscode/bitproto/README.md
@@ -0,0 +1,28 @@
+VSCode syntax highlighting for bitproto
+========================================
+
+### Install from Marketplace
+
+https://marketplace.visualstudio.com/items?itemName=hit9.bitproto
+
+### Install from local
+
+Firstly, ensure `vsce` is installed:
+
+```
+$ npm install -g @vscode/vsce
+```
+
+Clone this repo, and:
+
+```
+$ cd path/to/bitproto/editors/vscode/bitproto
+$ vsce package
+```
+
+This will generates `bitproto-1.0.0.vsix` in current directory.
+
+Start VSCode editor:
+
+* `View` -> `Extensions` -> `···` -> `Install from VSIX...`
+* Then browse the `bitproto-1.0.0.vsix`.
diff --git a/editors/vscode/bitproto/README.rst b/editors/vscode/bitproto/README.rst
@@ -0,0 +1,4 @@
+VSCode syntax highlighting for bitproto
+========================================
+
+Develop
diff --git a/editors/vscode/bitproto/bitproto-logo.png b/editors/vscode/bitproto/bitproto-logo.png
diff --git a/editors/vscode/bitproto/language-configuration.json b/editors/vscode/bitproto/language-configuration.json
@@ -0,0 +1,25 @@
+{
+    "comments": {
+        "lineComment": "//"
+    },
+    // symbols used as brackets
+    "brackets": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"]
+    ],
+    // symbols that are auto closed when typing
+    "autoClosingPairs": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"],
+        ["\"", "\""]
+    ],
+    // symbols that that can be used to surround a selection
+    "surroundingPairs": [
+        ["{", "}"],
+        ["[", "]"],
+        ["(", ")"],
+        ["\"", "\""]
+    ]
+}
diff --git a/editors/vscode/bitproto/package.json b/editors/vscode/bitproto/package.json
@@ -0,0 +1,31 @@
+{
+    "name": "bitproto",
+    "displayName": "bitproto",
+    "description": "Syntax support for bitproto",
+    "version": "1.0.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/hit9/bitproto.git"
+    },
+    "publisher": "hit9",
+    "icon": "bitproto-logo.png",
+    "engines": {
+        "vscode": "^1.51.0"
+    },
+    "categories": [
+        "Programming Languages"
+    ],
+    "contributes": {
+        "languages": [{
+            "id": "bitproto",
+            "aliases": ["bitproto", "bitproto"],
+            "extensions": [".bitproto"],
+            "configuration": "./language-configuration.json"
+        }],
+        "grammars": [{
+            "language": "bitproto",
+            "scopeName": "source.bitproto",
+            "path": "./syntaxes/bitproto.tmLanguage.json"
+        }]
+    }
+}
diff --git a/editors/vscode/bitproto/syntaxes/bitproto.tmLanguage.json b/editors/vscode/bitproto/syntaxes/bitproto.tmLanguage.json
@@ -0,0 +1,114 @@
+{
+    "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
+    "name": "bitproto",
+    "patterns": [
+        {
+            "include": "#comments"
+        },
+        {
+            "include": "#keywords"
+        },
+        {
+            "include": "#strings"
+        },
+        {
+            "include": "#constants"
+        },
+        {
+            "include": "#types"
+        },
+        {
+            "include": "#defintions"
+        },
+        {
+            "include": "#identifiers"
+        }
+    ],
+    "repository": {
+        "keywords": {
+            "patterns": [
+                {
+                    "name": "keyword.other.bitproto",
+                    "match": "\\b(proto|import|const|option)\\b"
+                },
+                {
+                    "name": "storage.type.bitproto",
+                    "match": "\\b(typedef|type|message|enum|bool|byte)\\b"
+                }
+            ]
+        },
+        "comments": {
+            "name": "comment.line.double-slash.bitproto",
+            "begin": "//",
+            "end": "$"
+        },
+        "strings": {
+            "name": "string.quoted.double.bitproto",
+            "begin": "\"",
+            "end": "\"",
+            "patterns": [
+                {
+                    "name": "constant.character.escape.bitproto",
+                    "match": "\\\\."
+                }
+            ]
+        },
+        "constants": {
+            "patterns": [
+                {
+                    "name": "constant.numeric.integer.bitproto",
+                    "match": "\\b[0-9]+\\b"
+                },
+                {
+                    "name": "constant.numeric.integer.hexadecimal.bitproto",
+                    "match": "\\b0x[0-9A-Fa-f]+\\b"
+                },
+                {
+                    "name": "constant.language.bitproto",
+                    "match": "\\b(true)|(false)|(yes)|(no)\\b"
+                }
+            ]
+        },
+        "types": {
+            "patterns": [
+                {
+                    "name": "storage.type.bitproto",
+                    "match": "\\b(typedef|type|message|enum|bool|byte)\\b"
+                },
+                {
+                    "name": "storage.type.bitproto",
+                    "match": "\\buint\\d+\\b"
+                },
+                {
+                    "name": "storage.type.bitproto",
+                    "match": "\\bint\\d+\\b"
+                }
+            ]
+        },
+        "defintions": {
+            "patterns": [
+                {
+                    "name": "entity.name.type.bitproto",
+                    "match": "(?<=const)\\s\\w+"
+                },
+                {
+                    "name": "entity.name.attribute-name.bitproto",
+                    "match": "(?<=option)\\s\\w+"
+                },
+                {
+                    "name": "entity.name.type.bitproto",
+                    "match": "(?<=message)\\s\\w+"
+                },
+                {
+                    "name": "entity.name.type.bitproto",
+                    "match": "(?<=enum)\\s\\w+"
+                }
+            ]
+        },
+        "identifiers": {
+            "name": "variable.name.bitproto",
+            "match": "\\b([a-zA-Z_][a-zA-Z0-9_]*)\\b"
+        }
+    },
+    "scopeName": "source.bitproto"
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +VSCode syntax highlighting for bitproto
 +========================================
++
 +Develop