Skip to content

An extension for VS Code which provides support for the Nim language.

License

Notifications You must be signed in to change notification settings

cooldome/vscode-nim

 
 

Repository files navigation

Nim for Visual Studio Code

Version Installs Ratings Build Status

This extension adds language support for the Nim language to VS Code, including:

  • Syntax Highlight (nim, nimble, nim.cfg)
  • Code Completion
  • Signature Help
  • Goto Definition
  • Find References
  • File outline
  • Build-on-save
  • Workspace symbol search
  • Quick info

Using

First, you will need to install Visual Studio Code 0.10. In the command palette (cmd-shift-p) select Install Extension and choose Nim.

The following tools are required for the extension:

Note: It is recommended to turn Auto Save on in Visual Studio Code (File -> Auto Save) when using this extension.

Options

The following Visual Studio Code settings are available for the Nim extension. These can be set in user preferences (cmd+,) or workspace settings (.vscode/settings.json).

  • nim.buildOnSave - perform build task from tasks.json file, to use this options you need declare build task according to Tasks Documentation, for example:
     {
     	"version": "0.1.0",
     	"command": "nim",
     	"args": ["c", "-r", "module.nim"],
     	"options": {
     		"cwd": "${workspaceRoot}"
     	},
     	"isShellCommand": true
     }
  • nim.lintOnSave - perform the project check for errors on save
  • nim.project - optional array of projects file, if nim.project is not defined then all nim files will be used as separate project
  • nim.licenseString - optional license text that will be inserted on nim file creation

Example

{
	"nim.buildOnSave": false,
	"nim.buildCommand": "c",
	"nim.lintOnSave": true,
	"nim.project": ["project.nim", "project2.nim"],
	"nim.licenseString": "# Copyright 2017.\n\n"
}

Commands

The following commands are provided by the extension:

  • Nim: Run selected file - compile and run selected file, it uses c compiler by default, but you can specify cpp in nim.buildCommand config parameter. This command available from file context menu or by F6 keyboard shortcut.

TODO

  • Rename support
  • Code action for imports (suggest available modules to import)
  • Debug support

ChangeLog

ChangeLog is located here

About

An extension for VS Code which provides support for the Nim language.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%