build(deps): bump vscode-languageclient from 8.1.0 to 9.0.0 in /code

.github/workflows/beta.yml

@@ -0,0 +1,93 @@
+name: Beta
+
+on:
+  push:
+    branches:
+    - beta
+
+jobs:
+  # Simple job the checks to see which parts we actually have to build.
+  trigger:
+    name: Trigger
+    runs-on: ubuntu-latest
+    outputs:
+      vscode: ${{steps.check-vscode.outputs.build}}
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - run: |
+        if [ -z "${BASE_REF}" ]; then
+          echo "BASE=HEAD^" >> $GITHUB_ENV
+        else
+          echo "BASE=origin/${BASE_REF}" >> $GITHUB_ENV
+        fi
+      name: Determine base
+      env:
+        BASE_REF: ${{ github.base_ref }}
+
+    - run: |
+        set -e
+        echo ${BASE}
+        ./scripts/should-build.sh vscode
+      id: check-vscode
+      name: "Build VSCode?"
+
+  vscode:
+    name: VSCode Extension
+    needs: [trigger]
+    if: needs.trigger.outputs.vscode
+    runs-on: ubuntu-latest
+    steps:
+      - uses: 'actions/checkout@v3'
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          cache: 'npm'
+          cache-dependency-path: 'code/package-lock.json'
+
+      # This must be set to the minimum Python version we support
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+
+      - name: Pip cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-vscode-pip-deps-${{ hashFiles('code/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-vscode-pip-deps
+
+      - run: |
+          python --version
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade bump2version towncrier docutils
+        name: Install Build Tools
+
+      - run: |
+          set -e
+          ./scripts/make-release.sh vscode
+        id: info
+        name: Set Version
+
+      - run: |
+          cd code
+          npm ci --prefer-offline
+          make bundle-deps
+        name: Install Dependencies
+
+      - run: |
+          cd code
+          npm run package
+        name: Package Extension
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: 'vsix'
+          path: code/*.vsix
+          if-no-files-found: error
+          retention-days: 7

.github/workflows/docs.yml

@@ -12,6 +12,7 @@ on:
   push:
     branches:
     - release
+    - beta
     - develop
     paths:
     - 'docs/**'

.github/workflows/lsp-pr.yml

@@ -1,9 +1,14 @@
 name: Language Server PR
 on:
+  push:
+    branches:
+    - beta
+    paths:
+    - 'lib/esbonio/**'
+
   pull_request:
     branches:
-    - develop
-    - release
+    - beta
     paths:
     - 'lib/esbonio/**'
 
@@ -12,9 +17,10 @@ jobs:
     name: "Python v${{ matrix.python-version }} -- ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        os: [ubuntu-latest, windows-latest]
 
     steps:
     - uses: actions/checkout@v4
@@ -24,6 +30,12 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: pip cache
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-lsp-pr-pip-deps-${{ matrix.python-version }}
+
     - run: |
         python --version
         python -m pip install --upgrade pip
@@ -43,20 +55,9 @@ jobs:
         cd lib/esbonio
 
         version=$(echo ${{ matrix.python-version }} | tr -d .)
-        python -m tox -e `tox -l | grep $version | tr '\n' ','`
-      name: Run Tests (when not on Windows)
-      if: matrix.os != 'windows-latest'
-
-    - run: |
-        cd lib/esbonio
-
-        $version=$(echo "${{ matrix.python-version }}" | tr -d ".")
-        $envs=$(tox -l | grep $version)
-
-        echo $($envs -join ",")
-        python -m tox -e $($envs -join ",")
-      name: Run Tests (when on Windows)
-      if: matrix.os == 'windows-latest'
+        python -m tox run -e `tox -l | grep $version | tr '\n' ','`
+      shell: bash
+      name: Run Tests
 
     - name: Package
       run: |

.vscode/launch.json

@@ -34,14 +34,15 @@
             "runtimeExecutable": "${execPath}",
             "args": [
                 "--extensionDevelopmentPath=${workspaceRoot}/code",
-                "--folder-uri=${workspaceRoot}/${input:workspace}"
+                "--folder-uri=${workspaceRoot}/docs",
+                "--folder-uri=${workspaceRoot}/lib/esbonio/tests/sphinx-default/workspace"
             ],
             "outFiles": [
                 "${workspaceRoot}/code/dist/node/**/*.js"
             ],
-            "preLaunchTask": "${defaultBuildTask}",
+            // "preLaunchTask": "${defaultBuildTask}",
             "env": {
-                "VSCODE_LSP_DEBUG": "true"
+                // "VSCODE_LSP_DEBUG": "true"
             }
         },
         {

code/.bumpversion.cfg

@@ -1,9 +1,9 @@
 [bumpversion]
-current_version = 0.11.0
+current_version = 0.91.0
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(-dev(?P<dev>\d+))?
-serialize = 
+serialize =
 	{major}.{minor}.{patch}-dev{dev}
 	{major}.{minor}.{patch}
 

code/.gitignore

@@ -0,0 +1,2 @@
+bundled/libs
+node_modules

code/.vscodeignore

@@ -1,12 +1,16 @@
-changes
-node_modules
-src/**
-dist/**/*.map
-dist/test
-syntaxes/tests
 .bumpversion.cfg
 .pytest_cache
+**/__pycache__/**
+**/.pyc
+**/requirements.in
+**/requirements.txt
+changes
 CHANGES.rst
+dist/**/*.map
+dist/test
+node_modules
 pyproject.toml
+src/**
+syntaxes/tests
 tsconfig.json
 webpack.config.js

code/Makefile

@@ -0,0 +1,15 @@
+.PHONY: update-lock bundle-deps
+
+bundle-deps: requirements.txt
+	sed -i /@/d requirements.txt
+	python -m pip install -t ./bundled/libs --no-cache-dir --implementation py --no-deps --upgrade -r ./requirements.txt
+
+	# Temporary
+	python -m pip install -t ./bundled/libs --no-cache-dir --implementation py --no-deps --upgrade "git+https://github.com/openlawlibrary/pygls.git#egg=pygls"
+	python -m pip install -t ./bundled/libs --no-cache-dir --implementation py --no-deps --upgrade "git+https://github.com/swyddfa/esbonio#egg=esbonio&subdirectory=lib/esbonio"
+	python -m pip install -t ./bundled/libs --no-cache-dir --implementation py --no-deps --upgrade "git+https://github.com/swyddfa/lsp-devtools#egg=lsp-devtools&subdirectory=lib/lsp-devtools"
+
+requirements.txt: requirements.in
+	pip-compile --resolver=backtracking --generate-hashes --upgrade ./requirements.in
+
+update-lock: requirements.txt

code/README.md

@@ -2,36 +2,13 @@
 
 The Esbonio extension integrates the [`esbonio`](https://pypi.org/project/esbonio/) language server into VSCode.
 
-The `esbonio` language server aims to make it easier to work with [Sphinx](https://www.sphinx-doc.org/en/master/) documentation projects by providing completion suggestions for your cross references and many other features.
-
-## What about the reStructuredText Extension?
-
-You may already be familiar with the [reStructuredText](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext) extension which, as of [v171.0.0](https://github.com/vscode-restructuredtext/vscode-restructuredtext/releases/tag/171.0.0) now also integrates the `esbonio` language server into VSCode.
-It also integrates other tools such as the linters [`doc8`](https://pypi.org/project/doc8/) and [`rstcheck`](https://pypi.org/project/rstcheck/) and provides additional editor functionality making it easier to work with reStructuredText in general.
-
-**Wait.. so why does the Esbonio VSCode extension still exist?**
-
-The reStructuredText extension takes a more conservative approach to adopting new VSCode features and APIs leaving the Esbonio extension free to more aggressively follow new developments.
-The Esbonio extension is developed alongside the language server itself, which allows for easy testing of new features without waiting for downstream projects to catch up.
-Finally, the Esbonio extension serves as an up to date reference for projects that integrate `esbonio` into other editors.
-
-**That sounds great... but which extension is right for me?**
-
-Try the reStructuredText extension if
-
-- You need an extension compatible with older versions of VSCode
-- You are interested in additional features beyond what is provided by the language server
-
-Try the Esbonio extension if
-
-- You want to make use of the newer features available in recent VSCode versions
-- You are only interested in the features provided by the language server
+The `esbonio` language server aims to make it easier to work with [Sphinx](https://www.sphinx-doc.org/en/master/) documentation projects by bringing IDE-like features to your documentation.
 
 ## Features
 
-### Preview
+### Live Preview
 
-The extension can show a HTML preview of the documentation
+The extension can show a live HTML preview of the documentation
 
 ![HTML Preview](../resources/images/vscode-preview-demo.gif)
 
@@ -71,55 +48,7 @@ Sections within a document are displayed in the "Outline" view
 
 ![Document Outline](../resources/images/document-symbols-demo.png)
 
-### Syntax Highlighting
-
-Syntax Highlighting is provided thanks to the [reStructuredText Syntax Highlighting Extension](https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst) extension.
-
-## Setup
-
-The language server works by wrapping an instance of Sphinx's application object,
-inspecting it and exposing the results over the Language Service Protocol. As Sphinx is
-a Python application this also dictates thats the Language Server is written in Python
-and distributed as a package on [PyPi](https://pypi.org/project/esbonio/).
-
-In order to correctly wrap your Sphinx application this requires the Language Server be
-installed into the same environment as the one that you use to build your
-documentation.
-
-There are a number of ways this can be accomplished.
-
-### Automatically
-
-The extension does its best to automate the installation and application of updates to the
-Language Server. By default Esbonio will use the Python environment you have configured
-[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
-when installing and running the server. If however, you don't have the Python extension
-installed or you want to use a different Python environment for your documentation there
-is a configuration option `esbonio.server.pythonPath` that you can use to configure the
-environment.
-
-There are a number of configuration options that allow you to control exactly how
-installation and updates are handled. See the
-[documentation](https://swyddfa.github.io/esbonio/docs/lsp/editors/vscode.html#configuration)
-for more details.
-
-![Setup Demo](../resources/images/vscode-setup-demo.gif)
-
-### Manually
-
-Alternatively you can opt to manage the installation of the language server entirely
-yourself. To install the Lanaguage Server open the terminal in your desired Python
-environment and run
-
-```
-(env) $ pip install esbonio
-```
-
-Then all you have to ensure is that Esbonio is configured to use the same environment,
-either through the
-[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
-or through the `esbonio.server.pythonPath` configuration option.
+## Alternatives
 
-To also manage updates manually, be sure to look at the
-[documentation](https://swyddfa.github.io/esbonio/docs/lsp/editors/vscode.html#configuration)
-for options on how to disable automatic updates.
+The [reStructuredText](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext) extension  as of [v171.0.0](https://github.com/vscode-restructuredtext/vscode-restructuredtext/releases/tag/171.0.0) also integrates the `esbonio` language server into VSCode.
+It also integrates other tools such as the linters [`doc8`](https://pypi.org/project/doc8/) and [`rstcheck`](https://pypi.org/project/rstcheck/) and provides additional editor functionality for working with reStructuredText in general.

code/changes/619.breaking.rst

@@ -0,0 +1,28 @@
+The following server configuration options have been removed as they are no longer required.
+
+- ``esbonio.server.installBehavior``
+- ``esbonio.server.updateBehavior``
+- ``esbonio.server.updateFrequency``
+
+The language server is now bundled as part of the VSCode extension itself, so a separate installation step is no longer necessary.
+
+The following sphinx configuration options have been removed
+
+- ``esbonio.server.hideSphinxOutput``
+- ``esbonio.sphinx.buildDir``
+- ``esbonio.sphinx.builderName``
+- ``esbonio.sphinx.confDir``
+- ``esbonio.sphinx.doctreeDir``
+- ``esbonio.sphinx.forceFullBuild``
+- ``esbonio.sphinx.keepGoing``
+- ``esbonio.sphinx.makeMode``
+- ``esbonio.sphinx.numJobs``
+- ``esbonio.sphinx.quiet``
+- ``esbonio.sphinx.silent``
+- ``esbonio.sphinx.srcDir``
+- ``esbonio.sphinx.tags``
+- ``esbonio.sphinx.verbosity``
+- ``esbonio.sphinx.warningIsError``
+
+The Sphinx application instance is now launched using a standard ``sphinx-build`` command line provided through the ``esbonio.sphinx.buildCommand`` option, so individual options are no longer necessary.
+**Note:** The ``esbonio.sphinx.configOverrides`` option has been preserved as it can be easier to use than the equivalent command line options.

code/changes/xxx.breaking.rst

@@ -0,0 +1 @@
+The minimum required VSCode version is now 1.78.0

code/changes/xxx.enhancement.rst

@@ -0,0 +1,25 @@
+The following server configuration values have been added
+
+- ``esbonio.server.enableDevTools``: Enable integration with `lsp-devtools <https://github.com/swyddfa/lsp-devtools>`__ for the language server itself.
+
+The following sphinx configuration values have been added
+
+- ``esbonio.sphinx.buildCommand``: Set the ``sphinx-build`` command to use when invoking the Sphinx subprocess
+
+- ``esbonio.sphinx.pythonCommand``: By default, the extension will attempt to reuse the Python environment you have configured in the Python extension when invoking Sphinx.
+  This option can be used to override this behavior.
+
+- ``esbonio.sphinx.cwd``: The working directory from which to launch the Sphinx process
+
+- ``esbonio.sphinx.envPassthrough``: A list of envrionment variables to pass through to the Sphinx process.
+
+- ``esbonio.sphinx.enableDevTools``: Enable integration with `lsp-devtools <https://github.com/swyddfa/lsp-devtools>`__ for the sphinx process
+
+  - ``esbonio.sphinx.pythonPath``: Used to override the Python packages (typically ``esbonio.sphinx_agent``) that are injected into the Sphinx environment
+
+The following preview related options have been added
+
+- ``esbonio.sphinx.enableSyncScrolling``: Enable support for syncronised scrolling between the editor and preview pane
+- ``esbonio.preview.bind``: Set the network interface that the preview server binds to
+- ``esbonio.preview.httpPort``: Set the port number the HTTP server binds to
+- ``esbonio.preview.wsPort``: Set the port number the WebSocket server binds to