Jule for Neovim

Official Jule extension for Neovim.

---

• Features
• Installation
  • vim-plug
• Configuration
  • Code formatting
  • Completion source
• Development
  • Requirements
  • Setup
  • Execution
• Code of Conduct
• License

---

Features

• Syntax highlighting
• Code formatting (julefmt)
• Basic keyword completion source for nvim-cmp

Installation

vim-plug

Add the following line to your Vim configuration file:

Plug 'julelang/jule.nvim'

Then run the following command:

:PlugInstall

Configuration

Code formatting

require('jule').setup {
  format_on_save = true,
  format_command = "julefmt -w %" -- default, optional
}

Completion source

Note that nvim-cmp has to be installed.

require('jule').setup {
  enable_cmp = true
}

require('cmp').setup {
  sources = {
    { name = 'jule' }
  }
}

Development

Requirements

• Lua
• Neovim
• JuleC
• JuleFmt

Setup

1. Make sure all the requirements are installed and are available in your PATH variable
2. Clone the repository and navigate to its directory:

$ git clone [email protected]:julelang/jule.nvim.git
$ cd jule.nvim

Execution

1. Create a test Jule module:

$ julec mod init
$ printf "fn main() {\n    println(\"Hello world\")\n}" > main.jule

2. Get the path to the plugin:

$ pwd

3. Open Neovim:

$ nvim main.jule

4. Set the runtime path and filetype:

:set runtimepath+=/path/to/jule.nvim
:set filetype=jule

5. Source the plugin:

:source /path/to/jule.nvim/lua/jule/init.lua

6. Configure the plugin:

:lua require('jule').setup { format_on_save = true }

7. Done! (you might need to re-open the buffer for the completion source to initialize properly)

Code of Conduct

See the Julenour Code of Conduct

License

The extension is distributed under the terms of the BSD 3-Clause license.
See License Details