Use NLS strings for extension settings (#60)

The extension settings defined in the package.json can support
translation if a package.nls.json is defined. VSCode determines
the locale and looks up the appropriate strings.

Signed-off-by: Eric Brown <[email protected]>

Author: ericwb

package.json

@@ -79,7 +79,7 @@
             "properties": {
                 "bandit.args": {
                     "default": [],
-                    "description": "Arguments passed in. Each argument is a separate item in the array.",
+                    "markdownDescription": "%settings.args.description%",
                     "items": {
                         "type": "string"
                     },
@@ -88,13 +88,13 @@
                 },
                 "bandit.enabled": {
                     "default": true,
-                    "markdownDescription": "Enable/disable linting Python files with Bandit.",
+                    "markdownDescription": "%settings.enabled.description%",
                     "scope": "resource",
                     "type": "boolean"
                 },
                 "bandit.path": {
                     "default": [],
-                    "description": "When set to a path to bandit binary, extension will use that. NOTE: Using this option may slowdown server response time.",
+                    "markdownDescription": "%settings.path.description%",
                     "scope": "resource",
                     "items": {
                         "type": "string"
@@ -103,21 +103,21 @@
                 },
                 "bandit.importStrategy": {
                     "default": "useBundled",
-                    "description": "Defines where `bandit` is imported from. This setting may be ignored if `bandit.path` is set.",
+                    "markdownDescription": "%settings.importStrategy.description%",
                     "enum": [
                         "useBundled",
                         "fromEnvironment"
                     ],
                     "enumDescriptions": [
-                        "Always use the bundled version of `bandit`.",
-                        "Use `bandit` from environment, fallback to bundled version only if `bandit` not available in the environment."
+                        "%settings.importStrategy.useBundled.description%",
+                        "%settings.importStrategy.fromEnvironment.description%"
                     ],
                     "scope": "window",
                     "type": "string"
                 },
                 "bandit.interpreter": {
                     "default": [],
-                    "description": "When set to a path to python executable, extension will use that to launch the server and any subprocess.",
+                    "markdownDescription": "%settings.interpreter.description%",
                     "scope": "resource",
                     "items": {
                         "type": "string"
@@ -126,18 +126,18 @@
                 },
                 "bandit.showNotifications": {
                     "default": "off",
-                    "description": "Controls when notifications are shown by this extension.",
+                    "markdownDescription": "%settings.showNotifications.description%",
                     "enum": [
                         "off",
                         "onError",
                         "onWarning",
                         "always"
                     ],
                     "enumDescriptions": [
-                        "All notifications are turned off, any errors or warning are still available in the logs.",
-                        "Notifications are shown only in the case of an error.",
-                        "Notifications are shown for errors and warnings.",
-                        "Notifications are show for anything that the server chooses to show."
+                        "%settings.showNotifications.off.description%",
+                        "%settings.showNotifications.onError.description%",
+                        "%settings.showNotifications.onWarning.description%",
+                        "%settings.showNotifications.always.description%"
                     ],
                     "scope": "machine",
                     "type": "string"
@@ -146,7 +146,7 @@
         },
         "commands": [
             {
-                "title": "Restart Server",
+                "title": "%command.restartServer%",
                 "category": "Bandit",
                 "command": "bandit.restart"
             }

package.nls.json

@@ -0,0 +1,16 @@
+{
+    "command.restartServer": "Restart Server",
+    "extension.description": "Linting support for Python files using Pylint.",
+    "settings.args.description": "Arguments passed in. Each argument is a separate item in the array.",
+    "settings.enabled.description": "Enable/disable linting Python files with Bandit.",
+    "settings.path.description": "When set to a path to bandit binary, extension will use that. NOTE: Using this option may slowdown server response time.",
+    "settings.importStrategy.description": "Defines where `bandit` is imported from. This setting may be ignored if `bandit.path` is set.",
+    "settings.importStrategy.useBundled.description": "Always use the bundled version of `bandit`.",
+    "settings.importStrategy.fromEnvironment.description": "Use `bandit` from environment, fallback to bundled version only if `bandit` not available in the environment.",
+    "settings.interpreter.description": "When set to a path to python executable, extension will use that to launch the server and any subprocess.",
+    "settings.showNotifications.description": "Controls when notifications are shown by this extension.",
+    "settings.showNotifications.off.description": "All notifications are turned off, any errors or warning are still available in the logs.",
+    "settings.showNotifications.onError.description": "Notifications are shown only in the case of an error.",
+    "settings.showNotifications.onWarning.description": "Notifications are shown for errors and warnings.",
+    "settings.showNotifications.always.description": "Notifications are show for anything that the server chooses to show."
+}

requirements.txt

@@ -16,9 +16,9 @@ bandit[sarif]==1.8.3 \
     --hash=sha256:28f04dc0d258e1dd0f99dee8eefa13d1cb5e3fde1a5ab0c523971f97b289bcd8 \
     --hash=sha256:f5847beb654d309422985c36644649924e0ea4425c76dec2e89110b87506193a
     # via -r ./requirements.in
-cattrs==24.1.2 \
-    --hash=sha256:67c7495b760168d931a10233f979b28dc04daf853b30752246f4f8471c6d68d0 \
-    --hash=sha256:8028cfe1ff5382df59dd36474a86e02d817b06eaf8af84555441bac915d2ef85
+cattrs==24.1.3 \
+    --hash=sha256:981a6ef05875b5bb0c7fb68885546186d306f10f0f6718fe9b96c226e68821ff \
+    --hash=sha256:adf957dddd26840f27ffbd060a6c4dd3b2192c5b7c2c0525ef1bd8131d8a83f5
     # via
     #   lsprotocol
     #   pygls
@@ -30,9 +30,9 @@ jschema-to-python==1.2.3 \
     --hash=sha256:76ff14fe5d304708ccad1284e4b11f96a658949a31ee7faed9e0995279549b91 \
     --hash=sha256:8a703ca7604d42d74b2815eecf99a33359a8dccbb80806cce386d5e2dd992b05
     # via bandit
-jsonpickle==4.0.2 \
-    --hash=sha256:3e650b9853adcdab9d9d62a88412b6d36e9a59ba423b01cacf0cd4ee80733aca \
-    --hash=sha256:cd3c90d32a68dcaa7f0e4b918bda7d4bb61f3c03b182d82dae2caf9ded0ab6b3
+jsonpickle==4.0.5 \
+    --hash=sha256:b4ac7d0a75ddcdfd93445737f1d36ff28768690d43e54bf5d0ddb1d915e580df \
+    --hash=sha256:f299818b39367c361b3f26bdba827d4249ab5d383cd93144d0f94b5417aacb35
     # via jschema-to-python
 lsprotocol==2023.0.1 \
     --hash=sha256:c75223c9e4af2f24272b14c6375787438279369236cd568f596d4951052a60f2 \
@@ -120,9 +120,9 @@ pyyaml==6.0.2 \
     --hash=sha256:f753120cb8181e736c57ef7636e83f31b9c0d1722c516f7e86cf15b7aa57ff12 \
     --hash=sha256:ff3824dc5261f50c9b0dfb3be22b4567a6f938ccce4587b38952d85fd9e9afe4
     # via bandit
-rich==13.9.4 \
-    --hash=sha256:439594978a49a09530cff7ebc4b5c7103ef57baf48d5ea3184f21d9a2befa098 \
-    --hash=sha256:6049d5e6ec054bf2779ab3358186963bac2ea89175919d699e378b99738c2a90
+rich==14.0.0 \
+    --hash=sha256:1c9491e1951aac09caffd42f448ee3d04e58923ffe14993f6e83068dc395d7e0 \
+    --hash=sha256:82f1bc23a6a21ebca4ae0c45af9bdbc492ed20231dcb63f297d6d1021a9d5725
     # via bandit
 sarif-om==1.0.4 \
     --hash=sha256:539ef47a662329b1c8502388ad92457425e95dc0aaaf995fe46f4984c4771911 \
@@ -132,9 +132,9 @@ stevedore==5.4.1 \
     --hash=sha256:3135b5ae50fe12816ef291baff420acb727fcd356106e3e9cbfa9e5985cd6f4b \
     --hash=sha256:d10a31c7b86cba16c1f6e8d15416955fc797052351a56af15e608ad20811fcfe
     # via bandit
-typing-extensions==4.12.2 \
-    --hash=sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d \
-    --hash=sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8
+typing-extensions==4.13.0 \
+    --hash=sha256:0a4ac55a5820789d87e297727d229866c9650f6521b64206413c4fbada24d95b \
+    --hash=sha256:c8dd92cc0d6425a97c18fbb9d1954e5ff92c1ca881a309c45f06ebc0b79058e5
     # via
     #   cattrs
     #   rich

src/test/python_tests/requirements.txt

@@ -5,9 +5,9 @@
 #    pip-compile --generate-hashes ./src/test/python_tests/requirements.in
 #
 colorama==0.4.6 \
-    --hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6 \
-    --hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44
-    # via pytest
+    --hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44 \
+    --hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6
+    # via -r ./src/test/python_tests/requirements.in
 exceptiongroup==1.2.2 \
     --hash=sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b \
     --hash=sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc