mirror of
https://github.com/ilyakooo0/intellij-haskell.git
synced 2024-09-11 14:56:19 +03:00
Move things to CONTRIBUTING.md
This commit is contained in:
parent
d86d91dc9a
commit
5fcc5806a6
30
CONTRIBUTING.md
Normal file
30
CONTRIBUTING.md
Normal file
@ -0,0 +1,30 @@
|
||||
|
||||
# How to build project
|
||||
1. Clone this project;
|
||||
1. Go to root of project and start sbt;
|
||||
1. Run task `updateIdea` from the sbt console;
|
||||
1. Run task `compile` from the sbt console;
|
||||
1. Install/enable the following plugins in IntelliJ: Plugin Devkit, Grammar-Kit and PsiViewer;
|
||||
1. Import this project as an sbt project in IntelliJ;
|
||||
1. Be sure `JVM SDK` inside `Languages & Frameworks`>`Scala Compiler Server` is set to `1.8`, since the Scala compiler version (2.12.3) which this plugin is currently using is not compatible with Java 7 or lower, Java 9 is not yet supported;
|
||||
1. Select `Build`>`Build Project`;
|
||||
|
||||
|
||||
# How to prepare plugin for deployment
|
||||
1. Right click on top of `intellij-haskell.iml` inside `intellij-haskell` folder;
|
||||
1. Select `Import module`;
|
||||
1. Be sure `unmanaged-jars` dependency is set to `provided` inside `Project structure`>`Project settings`>`Modules`>`Dependencies` (btw, setting `provided` inside sbt file gives error);
|
||||
1. 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. 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;
|
||||
1. Set `Module-SDK` right for `intellij-haskell` plugin module inside `Project structure`>`Project structure`>`Project settings`>`Modules`;
|
||||
1. 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`;
|
||||
1. After making changes to `haskell.bnf`, run `Generate Parser Code`. This will generate parser Java files in `gen` directory;
|
||||
1. Never touch the generated code. They should be committed as-is.
|
||||
1. Add `sources.zip` inside `idea`>[`idea build #`] to `Project structure`>`Project settings`>`Modules`>`Dependencies`>`unmanaged-jars` to see IntelliJ sources;
|
32
README.md
32
README.md
@ -11,7 +11,7 @@ Further Haskell language support is provided with the help of external tools.
|
||||
|
||||
This plugin depends mainly on Stack and Intero. It can create new Stack projects and import existing Stack projects.
|
||||
|
||||
Any feedback is welcome!!
|
||||
Any feedback is welcomed!!
|
||||
|
||||
# Installing the plugin
|
||||
You can install this plugin using the [Jetbrains plugin repository](https://plugins.jetbrains.com/idea/plugin/8258-intellij-haskell):
|
||||
@ -86,32 +86,4 @@ When used with `hindent`, `intellij-haskell` automatically sets `--indent-size`
|
||||
7. The Haskell tools are built in a IntelliJ sandbox with LTS-13. So they have no dependency with Stackage resolvers in your projects. After Stackage LTS-13 minor updates one can use `Tools`>`Update Haskell tools`;
|
||||
8. Stack REPLs are running in the background. You can restart them by `Tools`>`Update Settings and Restart REPLs`.
|
||||
|
||||
# How to build project
|
||||
1. Clone this project;
|
||||
1. Go to root of project and start sbt;
|
||||
1. Run task `updateIdea` from the sbt console;
|
||||
1. Run task `compile` from the sbt console;
|
||||
1. Install/enable the following plugins in IntelliJ: Plugin Devkit, Grammar-Kit and PsiViewer;
|
||||
1. Import this project as an sbt project in IntelliJ;
|
||||
1. Be sure `JVM SDK` inside `Languages & Frameworks`>`Scala Compiler Server` is set to `1.8`, since the Scala compiler version (2.12.3) which this plugin is currently using is not compatible with Java 7 or lower, Java 9 is not yet supported;
|
||||
1. Select `Build`>`Build Project`;
|
||||
|
||||
|
||||
# How to prepare plugin for deployment
|
||||
1. Right click on top of `intellij-haskell.iml` inside `intellij-haskell` folder;
|
||||
1. Select `Import module`;
|
||||
1. Be sure `unmanaged-jars` dependency is set to `provided` inside `Project structure`>`Project settings`>`Modules`>`Dependencies` (btw, setting `provided` inside sbt file gives error);
|
||||
1. 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. 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;
|
||||
1. Set `Module-SDK` right for `intellij-haskell` plugin module inside `Project structure`>`Project structure`>`Project settings`>`Modules`;
|
||||
1. 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`;
|
||||
1. After making changes to `haskell.bnf`, run `Generate Parser Code`. This will generate parser Java files in `gen` directory;
|
||||
1. Never touch the generated code. They should be committed as-is.
|
||||
1. Add `sources.zip` inside `idea`>[`idea build #`] to `Project structure`>`Project settings`>`Modules`>`Dependencies`>`unmanaged-jars` to see IntelliJ sources;
|
||||
If you want to contribute to this project, read [the contributing guideline](CONTRIBUTING.md).
|
||||
|
Loading…
Reference in New Issue
Block a user