NWScript: EE Language Server

NWScript: EE Language Server is a Visual Studio Code extension for the NWScript language.

While it seems to work well, even in bigger and older code bases, it is still an early project and there might be some unintended behaviours.

Features

• Enhanced syntax highlighting
• Completion
• Hover information
• Goto definition
• Formatting
• Range formatting
• Signature help
• Diagnostics

Dependencies

Formatting

clang-format.

Diagnostics

Neverwinter Nights home and installation folders.

Usage

Simply open a project with nss files and the extension installed. The extension will index your files and you will be ready to go - it can currently take up to 10-15 seconds to index big projects.

Notes:

• The files are indexed in background processes, which means it will not block other features of the language server like formatting, and a file's local definitions generated on the fly will be available.
• The files are indexed incrementally, which means a file's global definitions become available as soon as it has been indexed.

Formatting

{
  "editor.formatOnSave": true,
  "files.associations": {
    "*.nss": "nwscript"
  },
  "[nwscript]": {
    "editor.defaultFormatter": "PhilippeChab.nwscript-ee-language-server"
  },
  "nwscript-ee-lsp.formatter": {
    "enabled": true,
    "executable": "clang-format",
    "ignoredGlobs": ["/folder/to/ignore/*.nss", "file/to/ignore/filename.nss"],
    "style": {
      "BasedOnStyle": "Google",
      "AlignTrailingComments": true,
      "AlignConsecutiveAssignments": true,
      "ColumnLimit": 250,
      "BreakBeforeBraces": "Allman",
      "AlignEscapedNewlinesLeft": true,
      "AlwaysBreakBeforeMultilineStrings": true,
      "MaxEmptyLinesToKeep": 1,
      "TabWidth": 4,
      "IndentWidth": 4,
      "UseTab": "Always"
    }
  }
}

Notes:

• The executable setting must either bet set to your path executable's identifier, or its absolute path.
• The style object must respect clang-format rules.

Diagnostics

{
  "nwscript-ee-lsp.compiler": {
    "enabled": true,
    "verbose": false,
    "nwnHome": "C:\\Users\\YOUR_USERNAME\\Documents\\Neverwinter Nights",
    "nwnInstallation": "D:\\Program Files (x86)\\Steam\\steamapps\\common\\Neverwinter Nights"
  }
}

Notes:

• Diagnostics are provided by compiling the file with the nwnsc executable.
• The compiler executable is provided for Windows, Darwin and Linux operating systems.
• Diagnostics are currently published when opening or saving a file.
• By default, the compiler will try to detect automatically your Neverwinter Nights home and installation folders if they are not specified. If it fails to do so, you can provide the paths in the extension settings like shown above - input paths are wrapped into quotes automatically.
• In order to compile a file's includes, the compiler needs to know their directories. Files that had been requested a diagnostic while the project is being indexed are queued and processed once the indexing is done.
• You can set the verbose setting to true if you wish to see detailed logs of the compilation process.
• Big files with a lot of includes can take between half a second to a second to compile on older machines - it will not affect the client performances as the processing is done on the server.

Syntax highligthing

I personally use the One Dark Pro theme . See VS Code documentation if you wish to customize the highlighting further.

Building and running

• Install NodeJS from https://nodejs.org/en/.
• Invoke npm install -g yarn vsce which will install Yarn, a dependency manager, and vsce, a VS Code packaging library.
• In the project root directory, invoke yarn install which will install all dependencies using Yarn.
• In the project root directory, invoke vsce package which will produce a .vsix file.
• To install, in VS Code on the extension pane, click on the three dots at the top right then select Install From VSIX and navigate to the package you just produced.

Generating the language library definitions

Replace server/scripts/nwscript.nss by its new version and execute yarn run generate-lib-defs in the server root directory.

Issues

Please report any issues on the github repository.