generated from JetBrains/intellij-platform-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated Read Me
- Loading branch information
Showing
1 changed file
with
45 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,56 @@ | ||
| # DartHints | ||
|
|
||
|  | ||
| [](https://plugins.jetbrains.com/plugin/PLUGIN_ID) | ||
| [](https://plugins.jetbrains.com/plugin/PLUGIN_ID) | ||
| # What are Inlay Hints? | ||
| They are a feature used to assist the writer of a code by eliminating the type ambiguity from the static code through adding local hints to variables or methods parameters, just like `java` or `C#` hints! | ||
|
|
||
| ## Template ToDo list | ||
| - [x] Create a new [IntelliJ Platform Plugin Template][template] project. | ||
| - [ ] Get familiar with the [template documentation][template]. | ||
| - [ ] Verify the [pluginGroup](/gradle.properties), [plugin ID](/src/main/resources/META-INF/plugin.xml) and [sources package](/src/main/kotlin). | ||
| - [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html). | ||
| - [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time. | ||
| - [ ] Set the Plugin ID in the above README badges. | ||
| - [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html). | ||
| - [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes. | ||
| ## What is Dart Inlay Hints Project? | ||
| The project purpose is to implement one of a kind feature called (Dart Inlay Hints) on IntelliJ idea 2021.2.4 IDE as a (Plugin). It implements the missing inlay hints feature for dart code. | ||
|
|
||
| <!-- Plugin description --> | ||
| This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have. | ||
| ## What Are the Currently Supported Versions? | ||
| The plugin currently support version 2021.2.4. | ||
| Will update the plugin to the newer versions soon! | ||
|
|
||
| This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process. | ||
| ## What Are the currently supported hints’ types? | ||
| The stable version of the plugin supports the variables hints completely. | ||
| The methods are not well supported due to missing API endpoints for methods in dart analyzer. | ||
| I will develop an extension for dart analyzer and custom endpoint for the required functionality then add the hints feature for the methods. | ||
|
|
||
| To keep everything working, do not remove `<!-- ... -->` sections. | ||
| <!-- Plugin description end --> | ||
| # How To Use Dart Inlay Hints | ||
| Simply right click on any dart file and turn on dart inlay hints. | ||
|  | ||
| the generated hints will be displayed right before the variables and methods. | ||
|  | ||
|
|
||
| ## Installation | ||
|
|
||
| - Using IDE built-in plugin system: | ||
|
|
||
| <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "DartHints"</kbd> > | ||
| <kbd>Install Plugin</kbd> | ||
|
|
||
| - Manually: | ||
| # Used Languages and Frameworks | ||
| This project is developed using java, and extends IntelliJ Idea plugins platform. It used dart SDK as a base to visit the required types and detect the static types. | ||
|
|
||
| # Motivations Behind Implementation | ||
| When I was a university student, I started with c++ and java, one of the features that I really liked was the `inlay hints` in IntelliJ platform! It was very helpful as I was programming with java. When I started learning dart, it was missing this feature, so I decided to implement it as a plugin for IntelliJ Idea, and write a full academic documentation on it as a software. | ||
|
|
||
| # What Are the Obstacles of Plugin Development? | ||
| When it comes to non-commercial development, the learning sources are very limited, and the official documentation barely touches the surface. The only way to learn plugin development is by reading third party plugins and observe how they work and try to understand the process. | ||
|
|
||
| # Future Aspects | ||
| The project will continue to develop and implement the same feature for methods’ parameters. | ||
|
|
||
| # How Does it Work? | ||
| this plugin relies on `dart analyzer` API from dart SDK, and several IntelliJ Idea packages | ||
| - `com.intellij.codeinsight`: This package is used in the platform to present various in-editor information, such as documents, syntax error highlight, coloring, hints, indentations, folding, and more. For this project only hints functionalities were used (com.intellij.codeinsight.hints.*) which is used to add inline text ignored by the compiler and has other multiple properties. | ||
| - `com.intellij.openapi`: This package is used in various functionalities in the platform, editor features, abstract IO features, IDE actions (every button in the IDE represents an action), It is major part of the IDE. Only editor and action features were used (com.intellij.openapi.editor.*) which is used to access the editor and manipulate it, (com.intellij.openapi.actionsSystem.*) which is used create a way for user to interact with the plugin behavior -a clickable button for example-. | ||
| - `com.intellij.psi`: This package works as A layer between the language and all platform features. This project uses two different PSI layers, the first one is intellij idea implementation of PSI layer to communicate with all platform features, the second one is Dart language implementation of PSI layer to recognize Dart code and manipulate it. The libraries used are (com.intellij.psi.*) which was used to manipulate intelij idea components as elements, files as this report will discuss later, (com.jetbrains.lang.dart.psi.*). | ||
|
|
||
| # Software Analysis UML Diagrams | ||
| this section will view the required diagram in order to understand the overall workflow of Dart Inlay Hints. | ||
| ## Use Case Diagram | ||
|  | ||
|
|
||
| ## Functional Flow Block Diagram | ||
|  | ||
|
|
||
|
|
||
| # Documentation | ||
| this documentation [here](https://github.com/MohaAmiry/DartHints/files/14041840/DartHints.Document.Clear.pdf), is a very detailed academic documentation on the plugin and it explains every details on the working packages, and how are they used. | ||
|
|
||
| Download the [latest release](https://github.com/MohaAmiry/DartHints/releases/latest) and install it manually using | ||
| <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd> | ||
|
|
||
|
|
||
| --- | ||
| Plugin based on the [IntelliJ Platform Plugin Template][template]. | ||
|
|
||
| [template]: https://github.com/JetBrains/intellij-platform-plugin-template |