Skip to content

Latest commit

 

History

History
285 lines (208 loc) · 7.29 KB

CONTRIBUTING.md

File metadata and controls

285 lines (208 loc) · 7.29 KB

Contribute to jupyterlab-lsp and jupyter-lsp ❤️

jupyter-lsp and jupyterlab-lsp are open source software, and all contributions conforming to good sense, good taste, and the Jupyter Code of Conduct are welcome, and will be reviewed by the contributors, time-permitting.

You can contribute to the project through:

  • creating language server specs
    • you can publish them yourself (it might be a single file)...
    • or advocate for adding your spec to the github repository and its various distributions
      • these are great first issues, as you might not need to know any python or javascript
  • proposing parts of the architecture that can be extended
  • improving documentation
  • tackling Big Issues from the future roadmap
  • improving testing
  • reviewing pull requests

Set up the environment

Development requires:

  • nodejs 8 or later
  • python 3.5+
  • jupyterlab 1.1

It is recommended to use a virtual environment (e.g. virtualenv or conda env) for development.

conda env update -n jupyterlab-lsp   # create a conda env
source activate jupyterlab-lsp       # activate it
# or...
pip install -r requirements-dev.txt  # in a virtualenv, probably
                                     # ... and install nodejs, somehow

Install jupyter-lsp from source in your virtual environment:

python -m pip install -e .

Enable the server extension:

jupyter serverextension enable --sys-prefix --py jupyter_lsp

Install npm dependencies, build TypeScript packages, and link to JupyterLab for development:

jlpm
jlpm build
jlpm lab:link

Frontend Development

To rebuild the packages and the JupyterLab app:

jlpm build
jupyter lab build

To watch the files and build continuously:

jlpm build --watch   # leave this running...
jupyter lab --watch  # ...in another terminal

To check and fix code style:

jlpm lint

To run test the suite:

jlpm test

Server Development

Testing jupyter-lsp

python scripts/utest.py

Browser-based Acceptance Tests

The browser tests will launch JupyterLab on a random port and exercise the Language Server features with Robot Framework and SeleniumLibrary.

First, ensure you've prepared JupyterLab for jupyterlab-lsp frontend and server development.

Prepare the enviroment:

conda env update -n jupyterlab-lsp --file environment-atest.yml
# or
pip install -r requirements-atest.txt  # ... and install geckodriver, somehow
apt-get install firefox-geckodriver    # ... e.g. on debian/ubuntu

Run the tests:

python scripts/atest.py

The Robot Framework reports and screenshots will be in atest/output, with <operating system>_<python version>.log.html being the most interesting artifacts, e.g.

- linux_37.log.html
- linux_37.report.html

Troubleshooting

  • If you see the following error message:

    Parent suite setup failed:
TypeError: expected str, bytes or os.PathLike object, not NoneType

    it may indicate that you have no firefox, or geckodriver installed (or discoverable in the search path).

  • If a test suite for a specific language fails it may indicate that you have no appropriate server language installed (see packages table in README.md)

Formatting

Minimal code style is enforced with flake8 during unit testing. If installed, pytest-black and pytest-isort can help find potential problems, and lead to cleaner commits, but are not enforced during CI.

You can clean up your code using the project's style guide with:

isort -y -rc py_src
black py_src

TBD

  • hypothesis
  • mypy

Documentation

TBD

  • sphinx
  • one of the sphinx/ipynb connectors

Specs

It is convenient to collect common patterns for connecting to installed language servers as pip-installable packages that Just Work with jupyter-lsp.

If an advanced user installs, locates, and configures, their own language server it will always win vs an auto-configured one.

Writing a spec

See the built-in specs for implementations and some helpers.

A spec is a python function that accepts a single argument, the LanguageServerManager, and returns a dictionary of the form:

{
  "python-language-server": {            # the name of the implementation
      "version": 1,                      # the version of the spec schema
      "argv": ["python", "-m", "pyls"],  # a list of command line arguments
      "languages": ["python"]            # a list of languages it supports
  }
}

The absolute minimum listing requires argv (a list of shell tokens to launch the server) and languages (which languages to respond to), but many number of other options to enrich the user experience are available in the schema and are exercised by the current entry_points-based specs.

The spec should only be advertised if the command could actually be run:

  • its runtime (e.g. julia, nodejs, python, r, ruby) is installed
  • the language server itself is installed (e.g. python-language-server)
Common Concerns
  • some language servers need to have their connection mode specified
    • the stdio interface is the only one supported by jupyter_lsp
      • PRs welcome to support other modes!
  • because of its VSCode heritage, many language servers use nodejs
    • LanguageServerManager.nodejs will provide the location of our best guess at where a user's nodejs might be found
  • some language servers are hard to start purely from the command line
    • use a helper script to encapsulate some complexity.
      • See the r spec for an example
Example: making a pip-installable cool-language-server spec

Consider the following (absolutely minimal) directory structure:

- setup.py
- jupyter_lsp_my_cool_language_server.py

You should consider adding a LICENSE, some documentation, etc.

Define your spec:

# jupyter_lsp_my_cool_language_server.py
from shutil import which


def cool(app):
    cool_language_server = shutil.which("cool-language-server")

    if not cool_language_server:
        return {}

    return {
        "cool-language-server": {
            "version": 1,
            "argv": [cool_language_server],
            "languages": ["cool"]
        }
    }

Tell pip how to package your spec:

# setup.py
import setuptools
setuptools.setup(
    name="jupyter-lsp-my-cool-language-server",
    py_modules=["jupyter_lsp_my_cool_language_server"],
    entry_points={
        "jupyter_lsp_spec_v1": [
            "cool-language-server":
              "jupyter_lsp_my_cool_language_server:cool"
        ]
    }
)

Test it!

python -m pip install -e .

Build it!

python setup.py sdist bdist_wheel