neovim config hints

Author: XavierCooney

.gitignore

@@ -8,4 +8,3 @@ mipsy/
 target/
 syntaxes/
 lsp_data.json
-vim-out/

README.md

@@ -65,7 +65,17 @@ The inclusion of `a.s` in the above line is optional, but makes it easy to copy
 
 If you're using a build of code without the proprietary marketplace, you can either grab a release from the Github releases (it might be out of date, let me know if that's the case), download the VSIX for the [extension page](https://marketplace.visualstudio.com/items?itemName=xavc.xavc-mipsy-features), or build the extension yourself.
 
-I've got the language server working somewhat smoothly in neovim. If you're interested in more details let me know and I'll write up some more specific instructions. The language server should work for [any editor which supports the language server protocol](https://microsoft.github.io/language-server-protocol/implementors/tools/). The debugger uses the debug adapter protocol, which means that the basic features of the debugger should theoretically work with other editors, but I haven't tested that yet.
+I've got the language server working somewhat smoothly in neovim, see below. The language server should work for [any editor which supports the language server protocol](https://microsoft.github.io/language-server-protocol/implementors/tools/). The debugger uses the debug adapter protocol, which means that the basic features of the debugger should theoretically work with other editors, but I haven't tested that yet.
+
+## Neovim
+
+A bit of manual config is required (this is far from ergonomic), but these steps work for me:
+1. Either build this repo (see [Build](#build)), or grab a built copy by unzipping the published VSIX.
+2. Copy/symlink `vim-out/mipsy.lua` into `~/.config/nvim/lua/mipsy.lua`, and adjust the path to the `mipsy-lsp.sh` script in the LSP setup part of `mipsy.lua` to the correct location. Or add `vim-out` to your PATH and just replace the line with `cmd = { 'mipsy-lsp.sh' }`.
+3. Copy/symlink `vim-out/mips.vim` into where you put your syntax files, e.g. `~/.config/nvim/syntax/mips.vim`. You may want to edit the syntax file to your taste.
+4. Make sure to `require('mipsy').setup()` and then call `lspconfig.mipsy_editor_features.setup(...)` in your startup lua config.
+
+Some tweaking and debugging is probably required.
 
 # Technical details
 

generate_syntax.py

@@ -289,8 +289,9 @@ def read_instructions(key):
 for directive in DIRECTIVES:
     vimscript_syntax.append(f'syn match Type "\\.{directive}"')
 
-vimscript_syntax.append(f'syn match Identifier "{PARSE_IDENT}"')
-vimscript_syntax.append(f'syn match Label "{PARSE_IDENT}[ \\t]:"')
+# vimscript_syntax.append(f'syn match Identifier "{PARSE_IDENT}"')
+vimscript_syntax.append(f'syn match Function "{PARSE_IDENT}"')
+vimscript_syntax.append(f'syn match Label "{PARSE_IDENT}[ \\t]*:"')
 vimscript_syntax.append(f'syn match Comment "#.*$"')
 
 vimscript_syntax.append(r'syn region asmString start="\"" end="\"" skip="\\\\\|\\\""')
@@ -320,11 +321,12 @@ def vim_escape(s):
 )
 
 vimscript_syntax.extend([
+    'hi def link asmString String',
     '', '',
     'let b:current_syntax = "mips"',
     'let &cpo = s:cpo_save',
     'unlet s:cpo_save',
 ])
 
 with open(os.path.join('vim-out', 'mips.vim'), 'w', newline='\n') as mips_syntax_file:
-    mips_syntax_file.write('\n'.join(vimscript_syntax))
+    print('\n'.join(vimscript_syntax), file=mips_syntax_file)

package-lock.json

@@ -3,7 +3,7 @@
   "displayName": "Mipsy Editor Features",
   "description": "",
   "publisher": "xavc",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "repository": {
     "url": "https://github.com/XavierCooney/mipsy-editor-features"
   },

package.json

@@ -0,0 +1,65 @@
+if exists("b:current_syntax")
+  finish
+endif
+let s:cpo_save = &cpo
+set cpo&vim
+syn case ignore
+
+
+syn match Type "\.text"
+syn match Type "\.data"
+syn match Type "\.ktext"
+syn match Type "\.kdata"
+syn match Type "\.ascii"
+syn match Type "\.asciiz"
+syn match Type "\.byte"
+syn match Type "\.half"
+syn match Type "\.word"
+syn match Type "\.float"
+syn match Type "\.double"
+syn match Type "\.space"
+syn match Type "\.align"
+syn match Type "\.globl"
+syn match Function "[A-Za-z_][A-Za-z_0-9.]*"
+syn match Label "[A-Za-z_][A-Za-z_0-9.]*[ \t]*:"
+syn match Comment "#.*$"
+syn region asmString start="\"" end="\"" skip="\\\\\|\\\""
+syn match Number "\(-\?\)\(\(0x\)\([0-9a-fA-F]\+\)\|\(0b\)\([0-1]\+\)\|\(0o\?\)\([0-7]\+\)\|\([1-9][0-9]*\|0\)\)"
+syn match Identifier "\$zero"
+syn match Identifier "\$at"
+syn match Identifier "\$v0"
+syn match Identifier "\$v1"
+syn match Identifier "\$a0"
+syn match Identifier "\$a1"
+syn match Identifier "\$a2"
+syn match Identifier "\$a3"
+syn match Identifier "\$t0"
+syn match Identifier "\$t1"
+syn match Identifier "\$t2"
+syn match Identifier "\$t3"
+syn match Identifier "\$t4"
+syn match Identifier "\$t5"
+syn match Identifier "\$t6"
+syn match Identifier "\$t7"
+syn match Identifier "\$s0"
+syn match Identifier "\$s1"
+syn match Identifier "\$s2"
+syn match Identifier "\$s3"
+syn match Identifier "\$s4"
+syn match Identifier "\$s5"
+syn match Identifier "\$s6"
+syn match Identifier "\$s7"
+syn match Identifier "\$t8"
+syn match Identifier "\$t9"
+syn match Identifier "\$k0"
+syn match Identifier "\$k1"
+syn match Identifier "\$gp"
+syn match Identifier "\$sp"
+syn match Identifier "\$fp"
+syn match Identifier "\$ra"
+hi def link asmString String
+
+
+let b:current_syntax = "mips"
+let &cpo = s:cpo_save
+unlet s:cpo_save

vim-out/mips.vim

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+cd "$(dirname "$(realpath $0)")"/..
+node ./out/server.js --stdio

vim-out/mipsy-lsp.sh

@@ -0,0 +1,32 @@
+return {
+    setup = function()
+        -- register the 'mips' filetype (use pattern to have higher
+        -- priority over native asm filetype)
+        vim.filetype.add({
+            pattern = { ['.*%.s'] = { 'mips', { priority = 10 } } }
+        })
+
+        -- make a custom lspconfig
+        local lspconfig = require('lspconfig')
+        require('lspconfig.configs').mipsy_editor_features = {
+            default_config = {
+                cmd = { vim.fn.expand('~/src/mipsy-editor-features/vim-out/mipsy-lsp.sh') },
+                filetypes = { 'mips' },
+                root_dir = lspconfig.util.root_pattern('*.s'),
+                single_file_support = true,
+                settings = {},
+            };
+        }
+
+        -- indentation config
+        local indentGroup = vim.api.nvim_create_augroup("MipsIndentation", { clear = true })
+        vim.api.nvim_create_autocmd(
+            { 'FileType' },
+            {
+                pattern = 'mips',
+                command = 'setlocal shiftwidth=8 tabstop=8 noexpandtab',
+                group = indentGroup
+            }
+        )
+    end
+}