Introduce LSP Support

.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.py]
+indent_style = space
+indent_size = 4

.github/workflows/tests.yml

@@ -10,6 +10,11 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
+      - name: Lint markdown files
+        uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          globs: '**/*.md'
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:

.gitignore

@@ -33,3 +33,5 @@ venv/
 /test/test_json/test-data.xml
 /test/test_xsd/*.xsd
 /test/test_*/out/
+# created by vscode specific scripts:
+.env

.markdownlint.json

@@ -0,0 +1,45 @@
+{
+  "code-fence-style": {
+    "style": "backtick"
+  },
+  "fenced-code-language": {
+    "allowed_languages": [
+      "sh",
+      "json",
+      "lisp",
+      "ini",
+      "text"
+    ],
+    "language_only": true
+  },
+  "heading-style": {
+    "style": "atx"
+  },
+  "hr-style": {
+    "style": "---"
+  },
+  "line-length": {
+    "strict": true,
+    "code_blocks": false
+  },
+  "link-image-style": {
+    "collapsed": false,
+    "shortcut": false,
+    "url_inline": false
+  },
+  "no-duplicate-heading": {
+    "siblings_only": true
+  },
+  "ol-prefix": {
+    "style": "ordered"
+  },
+  "reference-links-images": {
+    "shortcut_syntax": true
+  },
+  "strong-style": {
+    "style": "asterisk"
+  },
+  "MD013": {
+    "line_length": 160
+  }
+}

.vscode/create_env.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+# This script creates .env file at the root of the repository corresponding to
+# the environment created when sourcing env.sh at the root of the repository
+# It is expected that this script is run from the root of the repository
+
+#shellcheck source=../env.sh
+. ./env.sh
+
+{
+  echo "PATH=\"$PATH\""
+  echo "MANPATH=\"$MANPATH\""
+  echo "PYTHONPATH=\"$PYTHONPATH\""
+  echo "YANG_MODPATH=\"$YANG_MODPATH\""
+  echo "PYANG_XSLT_DIR=\"$PYANG_XSLT_DIR\""
+  echo "PYANG_RNG_LIBDIR=\"$PYANG_RNG_LIBDIR\""
+  echo "W=\"$W\""
+} > ./.env

.vscode/extensions.json

@@ -0,0 +1,21 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+	// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+	// List of extensions which should be recommended for users of this workspace.
+	"recommendations": [
+		"editorconfig.editorconfig",
+		"ms-python.python",
+		"ms-python.debugpy",
+		"ms-python.vscode-pylance",
+		"kevinrose.vsc-python-indent",
+		"mads-hartmann.bash-ide-vscode",
+		"github.vscode-pull-request-github",
+		"github.vscode-github-actions",
+		"bierner.github-markdown-preview",
+		"davidanson.vscode-markdownlint"
+	],
+	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+	"unwantedRecommendations": [
+	]
+}

.vscode/launch.json

@@ -0,0 +1,55 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Python Debugger: lsp server",
+			"type": "debugpy",
+			"request": "launch",
+			"program": "${workspaceFolder}/bin/pyang",
+			"console": "integratedTerminal",
+			"preLaunchTask": "create_env",
+			"justMyCode": false,
+			"args": [
+				"--lsp",
+				"--lsp-mode=tcp",
+				"--lint",
+				"--strict",
+				"--canonical",
+				"--max-line-length=80",
+				"--max-identifier-length=32",
+				"--verbose",
+				"--no-env-path",
+				"--path=${workspaceFolder}/modules",
+			]
+		},
+		{
+			"name": "Python Debugger: lsp client",
+			"type": "debugpy",
+			"request": "launch",
+			"cwd": "${workspaceFolder}/test/test_lsp",
+			"program": "client.py",
+			"console": "integratedTerminal",
+			"preLaunchTask": "create_env",
+			"justMyCode": false,
+			"args": []
+		},
+		{
+			"name": "Python Debugger: Remote Attach",
+			"type": "debugpy",
+			"request": "attach",
+			"connect": {
+				"host": "localhost",
+				"port": 5678
+			},
+			"pathMappings": [
+				{
+					"localRoot": "${workspaceFolder}",
+					"remoteRoot": "."
+				}
+			]
+		}
+	]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+	"python.analysis.typeCheckingMode": "basic"
+}

.vscode/tasks.json

@@ -0,0 +1,27 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=733558
+	// for the documentation about the tasks.json format
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"label": "create_env",
+			"type": "shell",
+			"command": "${workspaceFolder}/.vscode/create_env.sh"
+		},
+		{
+			"label": "test",
+			"type": "shell",
+			"command": ". ./env.sh && make test"
+		},
+		{
+			"label": "test lsp",
+			"type": "shell",
+			"command": ". ./env.sh && make -C test/test_lsp test",
+			"problemMatcher": [],
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		}
+	]
+}