MPF Language Server

Language server for MPF config.

Installation (from pypi)

To use the MPF language server, you will have needed to install mpf and mpf-mc using the pipx commands from the install guide.

The command below will inject the mpf-language-server into your mpf virtualenv and make the mpfls command available.

pipx inject mpf mpf-language-server --pip-args="--pre" --verbose --include-deps --include-apps

Usage in IDE

Any IDE supported by language service will work. Here are a few examples:

IntelliJ Based IDE

For any IntelliJ based IDE (such as PyCharm, WebStorm or PhpStorm) you need to install a LSP (Language Server Protocol) plugin, such as LSP4IJ.

Add a new Language Server named "MPF Language Server" from the "Settings -> Languages & Frameworks -> Language Servers" menu.

From the Server tab, enter the command: $PROJECT_DIR$/.venv/Scripts/mpfls. Environment Variables and Working Directory can remain blank.

From the Mappings tab, select the File type subtab, and add a new File type. Select YAML from the dropdown, and set the Language Id to mpfls. Next select the File name patterns subtab, and add .yaml and .yml patterns, both with Language Id mpfls.

VSCode

For vsCode install the extension found here: vscode-client. You will be installing the latest .vsix file from that location.

Emacs

Integration with Emacs is accomplished using lsp-mode.

A minimal completion setup can be achieved with the lsp-mode, yaml-mode, company, and lsp-company packages. Company is a general purpose completion package for Emacs. lsp-company is a helper package for using Company with lsp-mode.

1. Install lsp-mode, company, yaml-mode, and lsp-company by running M-x package-install and following the instructions.

2. Add the following to your Emacs init file:

   ;; Register the mpfls server
   (require 'lsp-mode)
   (add-hook 'yaml-mode-hook #'lsp)
   (defvar lsp-language-id-configuration
     '((yaml-mode . "mpfls")))
   
   (lsp-register-client
     (make-lsp-client :new-connection (lsp-stdio-connection "mpfls")
       :major-modes '(yaml-mode)
       :server-id 'mpfls))
   (add-hook 'after-init-hook 'global-company-mode)
   
   ;; Configure company-lsp
   (require 'company-lsp)
   (push 'company-lsp company-backends)
   

Installation (from git for local development)

If you want to contribute to this repository:

git checkout https://github.com/missionpinball/mpf-ls/
cd mpf-ls
pip3 install -e .

License

This project is made available under the MIT License. Code is based on the Python language server (also MIT).