Skip to content

joshraphael/npp-rascript

Repository files navigation

npp-rascript

Notepad++ plugin to define RAScript grammar

GitHub License pipeline pipeline GitHub Tag GitHub repo size

Setup

This plugin pulls the raw source code from notepad-plus-plus using git submodules. You can use the pre-defined make commands to build the DLL of the plugin and move it to your plugins folder. A provided RAScript.vcxproj file is also included for those that use Windows to build this module.

Note: If building on Windows, be sure to generate the files located in the templates folder over to the src/ folder before trying to build, you can use the provided scripts/generate.ps1 powershell script

Debugging

The plugin has printing enabled when compiled in debug mode, use the -DDEBUG flag to enable printing. To view the logs you need to have a progam like DebugView running so it can capture the logging output and display it for you. The makefile has some pre-existing commands to help get started using make debug

LSP

This language uses rascript-language-server to handle language hints and code tools, download the latest release and place the file somewhere you can remember on your computer (ex: C:\Users\joshraphael\rascript-language-server_v0.0.1_win-x64.exe)

Install the NppLspClient plugin and place it in your plugins folder. When starting up Notepad++ after installation go to Plugins > NppLspClient > Open configuration file and paste in the following configuration for RAScript

[lspservers."rascript"]
mode = "io"
executable = 'C:\Users\joshraphael\rascript-language-server_v0.0.1_win-x64.exe'
auto_start_server = true

Save and restart your editor and your RAScripts should start getting code tools.

Make Commands

Title Command Parameters Description
Compile 64-bit Plugin make compile-x64 None Builds the x64 version of the plugin
Compile 32-bit Plugin make compile-Win32 None Builds the Win32 version of the plugin
Linux Dependencies make deps None Download the Linux binaries to build a Windows C++ DLL
Start Debug Print Window make debug None Start DebugView to view logs (under wine defaults)
Install make install None Install the extension locally (under wine defaults)
Generate Linux files make generate None Generate files based on Linux OS
Generate Windows files make generate-win None Generate files based on Windows OS