dbian / scheme-langserver

Scheme-langserver

Implementing support like autocomplete, goto definition, or documentation on hover is a significant effort for programming. However, comparing to other language like java, python, javascript and c, language server protocol implementation for lisp language are just made in a vacuum. Geiser, racket langserver and swish-lint etc., their works are all based on repl(Read-Eval-Print Loop) or keyword tokenizer instead of programming. For example, if a programmer was coding on an unaccomplished project, in which the codes are not fully runnable, Geiser or any others would only complete top-level binding identifiers listed by environment-symbols procedure (for Chez). Which means for local bindings and unaccomplished codes, though making effort for programming is supposed of the importance mostly, Geiser and its counterparts help nothing. Familiar cases occur with goto definition and many other functionalities.

A primary cause is, for scheme and other lisp dialects, their abundant data sets and flexible control structures raise program analysis a big challenge. In fact, scheme even don't have commonly acknowledged project management frameworks and corresponding extension system. As for extensions SS, and SCM, most programmers suppose their codes are writing for a running environment and don't provide any library information. Although with Akku and Snow, SLS and SLD files can base a project on a stable library framework, load, load-program and many other procedures which maintain dynamic library linkages make static code analysis telling less.

This package is a language server protocol implementation helping scheme programming. It provides completion, definition and will provide many other functionalities for SLS and SLD files. These functionalities are established on static code analysis with r6rs standard and some obvious rules for unaccomplished codes. This package itself and related libraries are published or going to be published with Akku, which is a package manager for Scheme.

This package also has been tested with Chez Scheme versions 9.4 and 9.5.

Your donation will make this world better. Also, you can issue your advice and I might implement if it was available.

Log

1.0.9: Add parallel and synchronize mechanism, which can harshly speed up indexing. 1.0.8: Build index as document synchronizing instead of workspace initializing. 1.0.7: Catch syntax-* identifier bindings.

Setup

Building

Pre-require

1. Chez Scheme;

NOTE If you wanted to enable scheme-langserver's muti-thread feature, it would require Chez Scheme to have been compiled with the --threads option. I've test multi-thread feature for Linux, and according to this page, it will also excutable for Windows.

2. Akku；
3. chez-exe；

NOTE chez-exe requires boot files and kernel files of Chez Scheme. So, the compile command maybe like follows:scheme --script gen-config.ss --bootpath /path-to-ChezScheme/{machine-type}/boot/{machine-type}

For Linux

git clone https://github.com/ufo5260987423/scheme-langserver
cd scheme-langserver
akku install
bash .akku/env
compile-chez-program run.ss
./run path-to-logfile

TODO: for Windows

The run file is also executable for windows WSL environment, and I'm waiting for Chez Scheme 10. As their announcement, they will merge the racket implemented Chez Scheme into main branch. And in this page it seems that the racket implementation has solved the multi-thread problem.

Installation for LunarVim

I have pull request to mason.nvim and mason-lspconfig.nvim. In that case, you can get this implementation automatically with LunarVim.

But now, above configuration haven't been tested. So, manual installation is still needed: for installed plugin nvim-lspconfig, after manually building from above step Building, an executable file run would be available at {path-to-run}. Then, create file ~/.local/share/lunarvim/site/pack/packer/start/nvim-lspconfig/lua/lspconfig/server_configurations/scheme_langserver.lua as follows:

local util = require 'lspconfig.util'
local bin_name = '{path-to-run}'
local cmd = { bin_name }

return {
  default_config = {
    cmd = cmd,
    filetypes = { 'scheme' },
    root_dir = util.find_git_ancestor,
    single_file_support = true,
  },
  docs = {
    description = [[
https://github.com/ufo5260987423/scheme-langserver
`scheme-langserver`, a language server protocol implementation for scheme
]]   ,
  },
}

Then configure your ~/.config/lvim/init.lua and add following codes like:

require 'lspconfig'.scheme_langserver.setup {}

NOTE For LunarVim, default scheme file extension doesn't include ".SLS". A patch to .local/share/lunarvim/lvim/ftdetec/ is to add sls.lua file as following:

vim.cmd [[ au BufRead,BufNewFile *.sls set filetype=scheme ]]

Enable Multi-thread Response and Indexing

Current scheme-langserver haven't been fully tested in multi-thread scenario, and corresponding functionalities is default disabled. Please make sure you'd truly want to enable multi-thread features and the following changes were what you wanted.

Taking LunarVim as an example, steping above instructions and rewrite file ~/.local/share/lunarvim/site/pack/packer/start/nvim-lspconfig/lua/lspconfig/server_configurations/scheme_langserver.lua as follows:

local util = require 'lspconfig.util'
local bin_name = '{path-to-run}'
local cmd = { bin_name ,'{path-to-log}','enable'}

return {
  default_config = {
    cmd = cmd,
    filetypes = { 'scheme' },
    root_dir = util.find_git_ancestor,
    single_file_support = true,
  },
  docs = {
    description = [[
https://github.com/ufo5260987423/scheme-langserver
`scheme-langserver`, a language server protocol implementation for scheme
]]   ,
  },
}
### TODO: Installation for [VScode](https://code.visualstudio.com/)

## Status 

This project is still in early development, so you may run into rough edges with any of the features. The following list shows the status of various features.

### Features
 >NOTE 
 I made some configuration with `.config/lvim/config.lua` like following
 ```lua
 vim.keymap.set('n', 'gr', builtin.lsp_references, {})
 vim.keymap.set('n', 'gd', builtin.lsp_definitions, {})

1. Top-level and local identifiers binding completion.
2. Goto definition.
3. Compatible with package manager: Akku.
4. File changes synchronizing and corresponding index changing.
5. Hover.
6. References.
7. Document symbol.
8. Catching *-syntax(define-syntax, let-syntax, etc.) based local identifier binding.
9. Cross-platform parallel indexing.
10. Speed up document synchronizing.

TODOs

11. Renaming.
12. Fully compatible with r6rs standard.
13. Macro expanding.
14. Code eval.
15. Code diagnostic.
16. Add cross-language semantic supporting. Well, would java, c, python and many other languages can be supported with an AST transformer?
17. Self-made source code annotator to be compatible with .sps files as https://github.com/cisco/ChezScheme/blob/e63e5af1a5d6805c96fa8977e7bd54b3b516cff6/s/7.ss#L268-L280 mentioned.
18. Type inference.

TODO:Contributing

Debug

How to Debug

https://www.scheme.com/debug/debug.html#g1

Output Log

Following tips from Building, Installation for Lunar Vim and Installation for VScode, if anyone wants to do some developing and log something, it will be convenient to add path-to-log-file and re-write file ~/.local/share/lunarvim/site/pack/packer/start/nvim-lspconfig/lua/lspconfig/server_configurations/scheme_langserver.lua as follows:

local util = require 'lspconfig.util'
local bin_name = '{path-to-run}'
local cmd = { bin_name ,"path-to-log-file"}

return {
  default_config = {
    cmd = cmd,
    filetypes = { 'scheme' },
    root_dir = util.find_git_ancestor,
    single_file_support = true,
  },
  docs = {
    description = [[
https://github.com/ufo5260987423/scheme-langserver
`scheme-langserver`, a language server protocol implementation for scheme
]]   ,
  },
}

Recurring with Log

With above output log, you may use tests/log-debug.sps recurring bugs:

1. Rename {path-to-log}(usually ~/scheme-langserver.log) as ~/ready-for-analyse.log;
2. run scheme --script tests/log-debug.sps

Test

Almost all key procedures and APIs are tested. My work is just so rough but useful, maybe you would like to find what I've done in tests directory or just run following command in {scheme-langserver-root-directory}

bash test.sh

NOTE It's hard to do test with threaded environment. So, current tests focus on single thread.

Code Count

find . -name "*.sls" ! -path "./.akku/*" |xargs wc -l

Detailed Document

1. Catching identifier bindings
2. Synchronizing