xdegtyarev / dkit Goto Github PK

DKit is a package to aid developing D programs using Sublime Text 3.

• Autocompletion using DCD (D Completion Daemon).
• Integration with DUB build system.
• Simple build systems using rdmd and dub.

• Find a better way to show call tips (there are some sublime text limitations).
• Better DUB integration

Currently I would like to postpone supporting Sublime Package Control installation until things stabilize with the plugin and proper testing is done on all platforms. Only Linux has been tested so far. Although it should work properly on other operating systems. (I welcome any feedback)

To install the plugin:

1. Clone this repository into your Sublime Text packages folder. You can find where your folder is located by clicking on 'Preferences -> Browse Packages'. Alternatively, on Linux, look in your ~/.config/sublime-text-3/Packages/, or in sublime-text-3\Data\Packages on Windows.

2. You'll need to install DCD first. Follow the steps in DCD's readme.

3. Do not run the server. DKit will automatically run the server when needed.

4. Go to 'Preferences -> Package Settings -> DKit -> Settings - User', and set it up like 'Settings - Default' to match your system. Notably you need to set dcd_path to your DCD's installation path.

5. Setup include_paths to your DMD installation. + On Linux, the default path to dlang includes are either (/usr/include/dmd/phobos and /usr/include/dmd/druntime/import) or (/usr/include/dlang/dmd/) on Arch-based distributions + On Windows, you should have your includes point to d\\src\\phobos and d\\src\\druntime\\import

6. You can also add include_paths per project.

7. To use DUB features, you'll need to have DUB installed and in your PATH environment variable.

8. You might want to add custom key bindings for Goto Definition and Show Documentation commands or other commands. You can do that by going to Preferences -> Key Bindings - User and having the following as an example: [{ "keys": ["ctrl+shift+g"], "command": "dcd_goto_definition" }, { "keys": ["ctrl+\\"], "command": "dcd_show_documentation" }]

• DKit: Restart DCD Autocompletion Server
  • If you notice that the autocompletion stopped working, try running this command to resolve the issue.
• DKit: Update Import Paths
  • If you have just added a new file to your project or created a Sublime project from a DUB package, run this command to update the imports.
• DKit: List Installed DUB Packages
  • This command lists the DUB packages installed as reported by DUB.
• DKit: Create DUB Package File
  • This command creates a dub package template file.
• DKit: Create Project From DUB Package File
  • You can create a Sublime project from a DUB package file using this command. Open the DUB package file, then run this to create the project.
• DKit: Goto Definition (requires at least DCD 0.3.0-beta)
  • Use goto definition by setting the cursor in the symbol that you want to goto, and then running the command. The default keybinding for this command is ctrl+shift+g.
• DKit: Show Documentation (requires at least DCD 0.3.0-beta)
  • Use show documentation by setting the cursor in the symbol that you want to see documentation for, and then running the command. The default keybinding for this command is ctrl+\.

• If you find that your includes are not being suggested, try running DKit: Update Import Paths command in Sublime.
• If you notice that the autocompletion stopped working, try running DKit: Restart DCD Autocompletion Server command in Sublime.
• For other problems, please use the issue tracker.

There is a sublime plugin for linting D code that uses dscanner at the following link.

Please use GitHub's issue tracker for questions and problems.