Basic Factor LSP

This is a very buggy LSP for the factor programming language, in its very early stages (or maybe very late stages, if I end up abandoning this project) If you are using this, be prepared to debug issues with bad error messages (or sometimes none at all). When reporting or debugging crashes, always make sure to look in the log file. Logging is disabled by default, but you can enable it by adding the name of the file as an input to the language server launch command

Installation

Installing this LSP requires the factor programming language, but considering that you're using an LSP for it, you likely already have this installed. The easiest way to install the LSP (at the moment) is to clone this repo into the work directory inside of the root factor directory, and then to go follow the editor-specific instructions below.

Features

• Code completion: shows the vocabulary and name of words, and automatically adds imports when they are missing
• Signature help: shows the stack effects and vocabularies of all words with a name
• Diagnostics: when working as intended, shows compiler errors (not lexer or parser errors, because Factor throws them when reading a file, instead of saving them to be read later on)
• Hover: displays the documentation of words as markdown
• Go-to-implementation: goes to the file and location that a word is defined in. Does not work if that file has unsaved changes, mearly taking you to the location of the old definition
• References: works, with the same caveats as go-to-implementation. It may miss out on certain references due to limitations with factor's usage word

Problems

Oh god, where do I even start?

• First of all, when you open a file, it takes several seconds for the LSP to load.
• Diagnostics appear sometimes, but it's so unreliable that it's just annoying when it happens. Because of this, it's turned off by default
• There is an abundence of bugs and crashes that I just haven't experienced yet

Editor Support

Nvim

Apperently I need to have 100 stars (according to their CONTRIBUTING.md) on github to even contribute this LSP config to nvim-lspconfig. This means you have to configure this the hard way

I'm gonna assume you have an LSP setup that provides stuff like keybindings. I'm not going to explain how to set this up here, but if you've already used neovim language servers before, you already probably have these set up

The minimum possible additions to init.lua that I'm confident will provide some functionality are as follows:

-- this is needed in order to find the root of your factor directory. you can theoretically exclude this if you're OK with the LSP having to go through a long setup process after you open any factor file
-- it also might not work on windows
function find_factor_folder(path)
	path = vim.fs.normalize(path)
	local factorroots = os.getenv("FACTOR_ROOTS") or ''
	local seperator = ':'
	if vim.fn['has']("win32") then
		seperator = ';'
	end
	local default_factor_root = vim.fs.root(path, 'factor.image')
	if default_factor_root then
		if factorroots then factorroots = factorroots .. seperator end
		factorroots = 
			factorroots
			.. default_factor_root .. '/work' .. seperator 
			.. default_factor_root .. '/core' .. seperator 
			.. default_factor_root .. '/basis' .. seperator
			.. default_factor_root .. '/extra' .. seperator
	end
	local roots = mysplit(factorroots, seperator)
	local i = 1
	local path_to_test = path
	local last_folder_name = ""
	while true do
		if (path_to_test == "/") or (path_to_test == 'C:/') then
			path_to_test = path
			last_folder_name = ""
			i = i + 1
		elseif i > #roots then
			return nil
		elseif path_to_test == roots[i] then
			return path_to_test .. '/' .. last_folder_name
		else
			last_folder_name = vim.fs.basename(path_to_test)
			path_to_test = vim.fs.dirname(path_to_test)
		end
	end
end


vim.api.nvim_create_autocmd('FileType', {
      		pattern = 'factor',
      		callback = function(ev)
                local client = vim.lsp.start { 
			    	cmd = {'path/to/factor', '-run=factor-lsp', '~/lsp.log'}, -- delete the last arg to disable logging. you should probably do this
                    root_dir = find_factor_folder(vim.api.nvim_buf_get_name(ev.buf)), -- if you exclude find_factor_path, just delete this line as well			    
                    name = 'factor-lsp',
				    offset_encoding = 'utf-8',
			    }
			    if client then
				    vim.lsp.buf_attach_client(ev.buf, client)
			    end
            end,
})

Sublime Text

Sublime Text has been confirmed to work out of the box

Others

I suggest you look at your editor's lsp support to figure out how to deal with this yourself. There's a high chance that your editor's defaults will leave things to be desired, so you might have to do as much or more configuration than I had to do for nvim. You'll probably want to have some knowlage of whatever scripting language your editor uses for configuration

I do have some specific comments about some editors below:

• Writing vscode extensions makes me want to die, so support for it is not planned.
• Support for Emacs is planned, I just haven't gotten around to it yet. Let's hope it's not that difficult. You could also just use the more feature-filled FUEL
• Same with regular vim (but you can't use FUEL of course)

An editor not being on this list does not mean that it is entirely unsupported. the language server protocol was designed to be cross-editor, after all