ilyakooo0/intellij-haskell
1
0
Fork 0
mirror of https://github.com/ilyakooo0/intellij-haskell.git synced 2024-09-11 14:56:19 +03:00
Code Issues Projects Releases Wiki Activity
7aa98fa122
intellij-haskell/CONTRIBUTING.md
Rik 561a63e737
Update CONTRIBUTING.md
2020-01-30 20:22:14 +01:00

2.2 KiB
Raw Blame History

How to build project

  1. Clone this project;
  2. Go to root of project;
  3. Run task sbt updateIntellij from the shell;
  4. Install/enable the following plugins in IntelliJ: Plugin Devkit, Grammar-Kit and PsiViewer;
  5. Import this project as an sbt project in IntelliJ;
  6. Be sure JVM SDK inside Languages & Frameworks>Scala Compiler Server is set to 1.8, since the Scala compiler version (2.13.0) which this plugin is currently using is not compatible with Java 7 or lower, Java 9 is not yet supported;
  7. Select Build>Build Project;

How to prepare plugin for deployment

  1. Right click on top of intellij-haskell.iml inside intellij-haskell folder;
  2. Select Import module;
  3. Be sure unmanaged-jars dependency is set to provided inside Project structure>Project settings>Modules>Dependencies (btw, setting provided inside sbt file gives error);
  4. Right click on top of intellij-haskell plugin module and select Prepare Plugin Module 'intellij-haskell' for deployment;

How to run/debug plugin inside IntelliJ

  1. Create Project SDK in Project structure>Project settings>Project by using the New button and selecting Intellij Platform Plugin SDK and setting the path to the IntelliJ folder;
  2. Set Plugin SDK settings right inside Project structure>Platform settings>SDKs. For example to, set SDK home path to idea/142.5239.7 inside project root folder;
  3. Set Module-SDK right for intellij-haskell plugin module inside Project structure>Project structure>Project settings>Modules;
  4. To run plugin inside IntelliJ, first run configuration has to be created. Navigate to Run>Edit configurations and create plugin configuration for intellij-haskell;

Development remarks

  1. After making changes to _HaskellLexer.flex, run Run Flex Generator. This will generate _HaskellLexer.java;
  2. After making changes to haskell.bnf, run Generate Parser Code. This will generate parser Java files in gen directory;
  3. Never touch the generated code. They should be committed as-is.
  4. Add sources.zip inside idea>[idea build #] to Project structure>Project settings>Modules>Dependencies>unmanaged-jars to see IntelliJ sources;