Merge pull request #206 from swyddfa/develop

New Release

.github/workflows/release.yml

@@ -110,13 +110,7 @@ jobs:
 
     - run: |
         cd code
-
         rm -r dist
-        npm run compile
-      name: Build Extension
-
-    - run: |
-        cd code
         npm run package
 
         vsix=$(find . -name '*.vsix' -exec basename {} \;)
@@ -297,7 +291,9 @@ jobs:
 
     - run: |
         cd lib/esbonio
-        python -m tox -e py`echo ${{ matrix.python-version }} | tr -d .`
+
+        version=$(echo ${{ matrix.python-version }} | tr -d .)
+        python -m tox -e `tox -l | grep $version | tr '\n' ','`
       name: Test
 
     - name: Package

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.0.1
+  hooks:
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+
+- repo: https://github.com/psf/black
+  rev: 21.5b2
+  hooks:
+  - id: black
+
+- repo: https://github.com/PyCQA/flake8
+  rev: 3.9.2
+  hooks:
+  - id: flake8
+    args: [--config=lib/esbonio/setup.cfg]
+
+- repo: https://github.com/asottile/reorder_python_imports
+  rev: v2.5.0
+  hooks:
+  - id: reorder-python-imports
+    args: [--application-directories=lib:esbonio]

.vscode/launch.json

@@ -89,4 +89,4 @@
             ]
         }
     ]
-}
+}

.vscode/settings.json

@@ -26,5 +26,11 @@
     },
     "python.pythonPath": "${workspaceRoot}/.env/bin/python",
     "python.formatting.provider": "black",
+    "python.testing.pytestArgs": [
+        "lib/esbonio/tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.nosetestsEnabled": false,
+    "python.testing.pytestEnabled": true,
     //"esbonio.trace.server": "verbose"
-}
+}

.vscode/tasks.json

@@ -88,4 +88,4 @@
             }
         }
     ]
-}
+}

README.md

@@ -1,10 +1,12 @@
+![Esbonio logo](./resources/io.github.swyddfa.Esbonio.svg)
 # Esbonio
 
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/swyddfa/esbonio/develop.svg)](https://results.pre-commit.ci/latest/github/swyddfa/esbonio/develop)
 
 This is a monorepo containing a number of subprojects
 
 | Folder | Description |
 |-|-|
 | `code/` | A VSCode extension for editing Sphinx projects <br />[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/swyddfa.esbonio?style=flat-square)![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/swyddfa.esbonio?style=flat-square)![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/swyddfa.esbonio?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio)|
-| `lib/esbonio/` | A Language Server for Sphinx projects. <br /> [![PyPI](https://img.shields.io/pypi/v/esbonio?style=flat-square)![PyPI - Downloads](https://img.shields.io/pypi/dm/esbonio?style=flat-square)](https://pypistats.org/packages/esbonio)  | 
+| `lib/esbonio/` | A Language Server for Sphinx projects. <br /> [![PyPI](https://img.shields.io/pypi/v/esbonio?style=flat-square)![PyPI - Downloads](https://img.shields.io/pypi/dm/esbonio?style=flat-square)](https://pypistats.org/packages/esbonio)  |
 | `lib/esbonio-extensions/` | A collection of Sphinx extensions  <br /> [![PyPI](https://img.shields.io/pypi/v/esbonio-extensions?style=flat-square)![PyPI - Downloads](https://img.shields.io/pypi/dm/esbonio-extensions?style=flat-square)](https://pypistats.org/packages/esbonio-extensions) |

code/.bumpversion.cfg

@@ -3,7 +3,7 @@ current_version = 0.6.2
 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/.vscodeignore

@@ -2,8 +2,10 @@ changes
 node_modules
 src/**
 dist/**/*.map
+dist/test
 syntaxes/tests
 .bumpversion.cfg
+.pytest_cache
 CHANGES.rst
 pyproject.toml
 tsconfig.json

code/CHANGES.rst

@@ -24,7 +24,7 @@ Misc
 - Improvements to the development experience (`#170 <https://github.com/swyddfa/esbonio/issues/170>`_)
 
 
-v0.6.0 - 2021-05-07v0.6.0 - 2021-05-07
+v0.6.0 - 2021-05-07
 -------------------
 
 Features

code/README.md

@@ -5,6 +5,33 @@
 Esbonio is an extension that provides a language server for working with
 [Sphinx](https://www.sphinx-doc.org/en/master/) documentation projects.
 
+## Features
+
+### Preview
+
+The extension can show a HTML preview of the documentation
+
+![HTML Preview](../resources/images/vscode-preview-demo.gif)
+
+### Completions
+
+The language server can provide completion suggestions in various contexts
+
+![Completion Demo](../resources/images/completion-demo.gif)
+
+### Diagnostics
+
+Errors from a build are published to VSCode as diagnostics
+
+![Diagnostics](../resources/images/diagnostic-sphinx-errors-demo.png)
+
+### Syntax Highlighting
+
+This extension also offers a simple grammar definition to enable some basic
+syntax highlighting
+
+![Syntax Highlighting](../resources/images/syntax-highlighting-demo.png)
+
 ## Setup
 
 The language server works by wrapping an instance of Sphinx's application object,
@@ -54,46 +81,6 @@ 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.
 
-## Features
-
-### Completions
-
-The language server can provide completion suggestions in various contexts
-#### Directives
-
-Completion suggestions are offered for the directives themselves, as well as any options
-that they expose.
-
-![Directive Completions](../resources/images/complete-directive-demo.gif)
-
-#### Roles
-
-In the case of roles, completions can also be offered for the targets of certain
-[supported](https://swyddfa.github.io/esbonio/docs/lsp/features.html#roles) role types
-
-![Role Completions](../resources/images/complete-role-demo.gif)
-
-#### Inter Sphinx
-
-The [intersphinx](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html)
-extension can be used to easily link to other Sphinx projects. If configured, the language
-server will offer suggestions when appropriate
-
-![InterSphinx Completions](../resources/images/complete-intersphinx-demo.gif)
-
-### Diagnostics
-
-Errors from a build are published to VSCode as diagnostics
-
-![Diagnostics](../resources/images/diagnostic-sphinx-errors-demo.png)
-
-### Syntax Highlighting
-
-This extension also offers a simple grammar definition to enable some basic
-syntax highlighting
-
-![Syntax Highlighting](../resources/images/syntax-highlighting-demo.png)
-
 ## Alternatives
 
 This project was created to scratch an itch, if it happens to also scratch an itch

code/changes/185.misc.rst

@@ -0,0 +1,4 @@
+The cli arguments ``--cache-dir``, ``--log-filter``, ``--log-level`` and
+``--hide-sphinx-output`` have been replaced with the configuration
+parameters ``esbonio.sphinx.buildDir``, ``esbonio.server.logFilter``,
+``esbonio.logLevel`` and ``esbonio.server.hideSphinxOutput`` respectively

code/changes/190.feature.rst

@@ -0,0 +1 @@
+Add the ability to preview the output from the ``html`` builder.`

code/changes/192.misc.rst

@@ -0,0 +1,3 @@
+The language server's startup sequence has been reworked. Language clients are now
+required to provide configuration parameters under the ``initializationOptions`` field
+in the ``initialize`` request.

code/changes/194.feature.rst

@@ -0,0 +1 @@
+Add a statusbar item that indicates the state of the language server.

code/changes/203.fix.rst

@@ -0,0 +1 @@
+Fix incorrect syntax highlighting of multiple links on a single line

code/changes/204.fix.rst

@@ -0,0 +1,2 @@
+VSCode now treats ``*`` characters as quotes, meaning selecting some text and entering
+a ``*`` will automatically surround that text rather than replacing it.

code/changes/205.feature.rst

@@ -0,0 +1 @@
+VSCode will now syntax highlight C, C++, Javascript and Typescript code blocks

code/changes/github-template.html

@@ -1,3 +1,3 @@
 %(body_pre_docinfo)s
 %(docinfo)s
-%(body)s
+%(body)s