-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathparams.json
1 lines (1 loc) · 15.6 KB
/
params.json
1
{"name":"Dlanguage","tagline":"Intellij Plugin for the D Programming Language","body":"# Intellij Plugin to provide support for the [D Programming Language](http://dlang.org/)\r\n\r\n[](https://gitter.im/kingsleyh/DLanguage?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\r\n[![ZenHub] (https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png)] (https://zenhub.io)\r\n[](https://travis-ci.org/kingsleyh/DLanguage)\r\n\r\nThis plugin brings D Language support to the Intellij IDE\r\n\r\n## MeetUp Group\r\n\r\nCome Along to the [London D Meetup!](http://www.meetup.com/London-D-Programmers/)\r\n\r\n[](http://www.meetup.com/London-D-Programmers/)\r\n\r\n## Advertising\r\n\r\nI recently contributed as a technical reviewer for this great book about Learning D written by Michael Parker. Get it cheap by clicking on the images below:\r\n\r\n[](http://bit.ly/1lSyjJ7)\r\n\r\n[](http://bit.ly/1lSyjJ7)\r\n\r\n## Background\r\n\r\nI've just started learning the D programming language. I love the intellij IDE and wanted to have D support in my favourite IDE. This is the first\r\nIntellij plugin I've written and is still a work in progress to get the full support working.\r\n\r\n## Supported JDK\r\n\r\nThis plugin has been written at the Java 1.7 language level. It will not work with a 1.6 JDK because\r\nit uses features of 1.7. If you are an OSX user like me - then if you usually run intellij with something less than 1.7 - you will need to Run intellij using 1.7 or 1.8 to use this plugin by doing the following:\r\n\r\nTo force running under JDK 1.7 copy `/Applications/<Product>.app/Contents/bin/idea.properties` to `~/Library/Preferences/<Product>/` and\r\nchange the JVMVersion key to 1.7*:\r\n\r\n```\r\nJVMVersion=1.7*\r\n```\r\n\r\n## Installation\r\n\r\n[Download](https://www.jetbrains.com/idea/) and install IntelliJ Community Edition (Free) or Ultimate (Paid)\r\nFrom IntelliJ go to Preferences > Plugins > Browse Repositories and search For \"D Language\" - you will see 2 plugins - Choose the *DLanguage* one and click install and then click restart intellij\r\n\r\nYou can also download the plugin jar to your local disk here: [Jetbrains plugin repository](https://plugins.jetbrains.com/plugin/8115?pr=) and then in intelliJ\r\ngo to Preferences > Plugins > Install plugin from disk and choose the jar you downloaded\r\n\r\n![installation]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/install.png)\r\n\r\n## Quick Usage\r\n\r\n#### Open existing DUB project\r\n\r\n * File -> Open then choose your existing dub project folder\r\n * After the project loads - right click on the module (first item in the project tree on left pane) and choose Module Settings (f4)\r\n * In Module Setting - in the right pane in the Sources tab - locate the source directory in the tree and click it - and then click the blue sources folder at the top of the pane where it says Mark as\r\n * That will mark the source folder as a Source folder in intellij - and it will go blue - now intellij know where to find the source code for your dub module and you can use the run configurations now\r\n\r\n#### New Project with DUB\r\n\r\n * When you select this to create a new project with dub - if dub is on your path it will attempt to use dub init to create a new dub project for you. If dub is not on your path it will create a source directory and you will have to create your sdl/json dub file manually or rename/delete the source folder and then use dub init to recreate it\r\n * Or you can open an existing dub project by doing File -> Open \r\n * Once a dub project is loaded there is right click menu option to run with dub, or you can use the run config - run with Dub\r\n * Before running go and configure the DTools in Preferences -> Other Settings -> D Tools\r\n \r\n#### Configure DTools\r\n\r\nThe best option is to do and get the following tools and build them according to their github page instructions:\r\n\r\n * [dub](http://code.dlang.org/download)\r\n * [DCD](https://github.com/Hackerpilot/DCD)\r\n * [DScanner](https://github.com/Hackerpilot/Dscanner)\r\n * [Dfmt](https://github.com/Hackerpilot/dfmt)\r\n\r\nIf you put these tools on your path you can go to Preferences -> Other Settings -> D Tools and just click autofind on each of the tools and it will find them. Otherwise you will need to select the correct path to the tool for each one.\r\n\r\nThere is a nice blog post about setting up the tools at: [www.samael.me.uk](http://www.samael.me.uk/2015/12/d-plugin-for-intellij-idea.html)\r\n\r\n#### Configuring DCD\r\n\r\nTo configure DCD in the dcd-server add a comma separated list of paths that point to your libraries that you want to include in autocompletion.\r\n\r\nFor example:\r\n\r\n /Library/D/dmd/src/phobos,/Library/D/dmd/src/druntime/import,/Users/hendriki/.dub/packages/rainbow-master/src\r\n \r\nThis will add the phobos and druntime/import as well as my rainbow dub project. You can add other dub packages by adding the path to them. I should be able to autoconfigure this stuff in a future release.\r\n\r\n#### DCD Server Restart Action\r\n\r\nI noticed that after a while the auto completion seemed to cause the editor to hang. As a first step I have added a menu action in Tools as the last option to Restart the DCD Server. This action will just kill the running process and restart it again which seems to fix the hanging issue. I will investigate further to find a way to prevent the hanging in the first place but this is a helpful restart action.\r\n\r\n#### DFormat\r\n\r\nTo reformat D code use the shortcut or the menu item - Code -> Reformat Code with D Format (ctrl+alt+K) or on mac (cmd+alt+K)\r\n\r\n#### DFix\r\n\r\nTo apply DFix to the a file use the shortcut or the menu item - Code -> Fix D code with DFi (ctrl+alt+M) or on mac (cmd+alt+M)\r\n\r\n#### Syntax Highlighting\r\n\r\nGo to Preferences -> Editor -> Colors and Fonts -> D File\r\n\r\nYou can customize the syntax highlighting colours here. Save as a new theme - and then untick the inherit from checkbox and this will allow you to choose a colour for each item.\r\nOnly the native items will show as changing in the code example. From function definition downwards the options are related to annotated highlighting which is based on the grammar and not the lexer. So these don't show as chanigng the code example but they do wok.\r\nI created one similar to the sublime dark theme by using Darcula theme and customizing the colours here.\r\n\r\n\r\n\r\n## Progress\r\n\r\nPlease see the development status on\r\n[DLanguage ZenBoard](https://github.com/kingsleyh/DLanguage#boards)\r\n\r\n#### Next Release - 1.8\r\n\r\nThe next release should have the following:\r\n\r\n * [Issue 66 - Dub build configuration dub options bug](https://github.com/kingsleyh/DLanguage/issues/66)\r\n * [Issue 65 - Bitwise Or token bug](https://github.com/kingsleyh/DLanguage/issues/65)\r\n * [Issue 64 - DCD auto add source directories](https://github.com/kingsleyh/DLanguage/issues/64)\r\n * [Issue 56 - DCD restart menu item bug](https://github.com/kingsleyh/DLanguage/issues/56)\r\n\r\n#### Latest Updates\r\n\r\n* 9th January 2016 - Fixed some bugs and working towards getting more of the intellij features working\r\n* 27th December 2015 - Fixed DCD bugs and added dub init wizard to dub project creation\r\n* 25th December 2015 - Added code formatting with DFmt\r\n* 24th December 2015 - Added Syntax highlighting, DCD autocompletion, dub compile checking and Dscanner annotation\r\n* 23rd December 2015 - Released an early test version to the intellij plugin repository\r\n* 9th December 2015 - I have finished the first pass of the BNF grammar complete with extensive tests - the next step is to move onto basic syntax highlighting\r\n* 21st October 2015 - Work has begun to re-organize and track the upcoming work as well an initial work on the BNF grammar - I have switched master to previous_master and current master is a currently not working bnf shell project\r\n* 7th October 2015 - I have finally figured out several aspects of the BNF grammar and feel like I know enough now to begin a complete re-write of the parser using the grammarkit plugin for intellij. This will overcome the terrible performance issues caused by the integration of the DDT parser and will enable a longer term view of complete language support and lots of cool features that are just not possible to add in any other way.\r\n* 29th March 2015 - I've not managed to fix the performance issue. The problem is that the integration of the DDT parser/lexer with intellij has to jump through many hoops to work correctly as intellij don't make it easy to use external parsers directly. I think the only option is to go back to writing the BNF grammer and JFlex lexer - which I have started working on - however I think this will take a few months of effort. So I'm pushing back the alpha release to after the summer.\r\n* 5th Feb 2015 - I've had some other demands on my time so had to push back the alpha release until end of March 2015. On the plus side I've discovered\r\nthe major peformance issue that was holding me back - so I've started work on fixing it. Once I'm happy with the performance work will resume on more features.\r\n\r\n## Notes\r\n\r\nI have seen a few other attempts at an intellij plugin for D. But none are complete yet. If another D plugin project advances\r\nfurther than this one - I will probably switch my efforts to that one and drop this one.\r\n\r\nIn the immediate future I have decided to re-use the eclipse DDT D Lexer and Parser and integrate it with my intellij plugin. I have\r\ndone some research into creating grammars and parsers and at the current point in time I have neither the time or the skills to\r\nwrite a lexer/parser or BNF Grammar for the D Language.\r\n\r\nWhen I find some time and as a learning opportunity I will try to write the BNF Grammar from scratch using the intellij Grammar-Kit\r\nand then I will also write the JFlex lexer by hand.\r\n(I've never written either a grammar or a lexer before so will probably get some help in this area and it probably will take a long time)\r\n\r\nI may also decide to re-write the eclipse DDT D lexer/parser within the intellij framework to better customize it for intellij - Again this\r\nmay or may not happen in this amazing future where I actually have time for things like this.\r\n\r\n## Release\r\n\r\nThe first official release will be published on the Jetbrains plugin site when I feel like the plugin offers the minimum viable functionality as\r\ncontained in the Alpha Release milestone detailed above.\r\n\r\n#### Release Schedule\r\n\r\n|Release|Date|Content Overview|\r\n| ------------- |:-------------:| -----:|\r\n|Alpha| 31 Jan 2016| Create D files, Dub, Syntax highlighting, Run Configs, Annotations, Indexes and References|\r\n|Beta| 31 Jul 2016| Improved features plus quick fixes|\r\n|Gamma|31 Dec 2016| Debugger support|\r\n\r\n## Screenshots\r\n\r\nHere are some screenshots of my progress so far:\r\n\r\n## Recent Screenshots\r\n\r\nDtools configuration\r\n\r\n![improved highlighting]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/tool_settings.png)\r\n\r\nAutocompletion using DCD\r\n\r\n![improved highlighting]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/autocomplete.png)\r\n\r\nCompile checking\r\n\r\n![improved highlighting]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/compile_checking.png)\r\n\r\nDscanner Code Linting\r\n\r\n![improved highlighting]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/dscanner_linting.png)\r\n\r\nGoto Class\r\n\r\n![improved highlighting]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/goto_class.png)\r\n\r\nConfigure Syntax Highlighting\r\n\r\n![highlighting settings]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/highlighting_settings.png)\r\n\r\n## Older Screenshots\r\n\r\nImproved Syntax Highlighting with Annotator:\r\n\r\n![improved highlighting]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/improved_syntax_highlighting.png)\r\n\r\nSyntax Highlighting and PSI Structure:\r\n\r\n![highlighting and psi structure]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/highlighting_and_psi_structure.png)\r\n\r\nCreate a new D project:\r\n\r\n![create a new d project]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/create_new_d_project.png)\r\n\r\nModule Settings - add D compiler:\r\n\r\n![module settings add d compiler]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/module_settings_add_d_compiler.png)\r\n\r\nModule Settings - set D compiler in project:\r\n\r\n![module settings add compiler to project]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/module_settings_set_project_d_compiler.png)\r\n\r\nAdd new D file (from right click menu)\r\n\r\n![right click add new d file]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/right_click_add_new_d_file.png)\r\n\r\nD file editor:\r\n\r\n![d file editor]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/d_file_editor.png)\r\n\r\nRun Configuration menus:\r\n\r\n![run configuration menus]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/run_configuration_menus.png)\r\n\r\nRun Configuration create box:\r\n\r\n![run configuration create box]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/run_configuration_create_box.png)\r\n\r\nRun Configuration edit:\r\n\r\n![run configuration edit]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/run_configuration_edit.png)\r\n\r\nRun Configuration running:\r\n\r\n![run configuration running]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/run_configuration_running.png)\r\n\r\nPSI Tree and Highlighting:\r\n\r\n![psi tree and highlighting]\r\n(https://github.com/kingsleyh/DLanguage/raw/master/.README/psi_structure.png)\r\n\r\n\r\n## Develop\r\n\r\nInterested in contributing to this D plugin please contact me at kingsley at masterthought dot net.\r\nContributions are accepted via fork and pull request but please co-ordinate with me so we don't duplicate effort.\r\n\r\n## Instructions for Developers\r\n\r\nread this document: [developing custom language plugins for intellij](https://confluence.jetbrains.com/display/IDEADEV/Developing+Custom+Language+Plugins+for+IntelliJ+IDEA)\r\n\r\nalso see this document for getting the environment setup: [plugin development](https://confluence.jetbrains.com/display/IDEADEV/PluginDevelopment)\r\n\r\nthis one is also helpful: [make a plugin in less than 30 mins](http://bjorn.tipling.com/how-to-make-an-intellij-idea-plugin-in-30-minutes)\r\n### Setup\r\n\r\n1. Download and install the community edition of intellij - [here](https://www.jetbrains.com/idea/download/)\r\n2. Download the intellij community edition source code - git clone --depth 1 https://github.com/JetBrains/intellij-community.git (use depth 1 to reduce history otherwise it will take a long time)\r\n3. Open this plugin project in intellij\r\n4. In the module setting (F4) set the SDK to the path of the community edition JDK under the intellij platform plugin SDK\r\n5. Optionally add the community edition source to the source code paths in the module settings to allow access to the core code while debugging etc\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}