You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 7, 2020. It is now read-only.
This project aims to be the __universal IDE interface__ to __all haskell tools__, proving a __full-featured and easy to query ide-backend__.
14
+
This project aims to be __the universal interface__ to __a growing number of Haskell tools__, proving a __full-featured and easy to query backend__ for editors and IDEs that require Haskell-specific functionality.
15
15
16
-
Features: (planned)
16
+
Planned features:
17
17
18
-
-[ ]cabal / stack project `Configuration` and `Compilation`
19
-
-[ ]Errors Checking, Warnings, Linter, Dead code detection
### Is this _again_ an other `ghc-mod` or `ide-backend` like project ?
30
-
31
-
No:
29
+
### This is *not* yet another [`ghc-mod`](https://github.com/kazu-yamamoto/ghc-mod) or [`ide-backend`](https://github.com/fpco/ide-backend) project
32
30
33
31
> Both the ghc-mod and ide-backend maintainers have agreed to contribute code to this new repository and then rebase the old repos on this. The reason we're using a new repo instead of modifying one of the existing ones is so that the existing projects experience no disruption during this migration process. If this was a new set of people starting a new project without support from existing projects, I'd agree with you. But Alan's reached out to existing players already, which is an important distinction.
34
32
35
-
This project doesn't start from scratch:
33
+
This project is not started from scratch:
36
34
37
35
1. See why [we should supersede previous tools](/docs/Challenges.md)
38
-
2. Check the [list of existing tools / features ](/docs/Tools.md)
39
-
3. See more [other tools / ide for inspiration](/docs/Inspirations.md)
36
+
2. Check the [list of existing tools and functionality](/docs/Tools.md)
37
+
3. See more [other tools and IDEs for inspiration](/docs/Inspirations.md)
38
+
40
39
41
-
## It's time to join the project!
40
+
## It's time to join the project!
42
41
43
-
:heart: Haskell tooling dream is near, we need your help! :heart:
42
+
:heart: Haskell tooling dream is near, we need your help! :heart:
44
43
45
-
- Register in our [google group mailing list](https://groups.google.com/forum/#!forum/haskell-ide)
46
-
- Join our IRC channel at `#haskell-ide-engine` on `freenode`.
44
+
- Register in [our google group mailing list](https://groups.google.com/forum/#!forum/haskell-ide).
45
+
- Join [our IRC channel](http://webchat.freenode.net/?channels=haskell-ide-engine) at `#haskell-ide-engine` on `freenode`.
47
46
- Fork this repo and hack as much as you can.
48
47
- Ask @alanz or @hvr to join the project.
49
48
@@ -52,43 +51,46 @@ This project doesn't start from scratch:
52
51
53
52
## Architecture
54
53
55
-
1.__BIOS layer__:
54
+
Below you find a short overview of the main architectural layers of `haskell-ide-engine`.
55
+
For more info have a look in [the docs folder](/docs) at the root of this project, especially:
56
56
57
-
ghc-mod stays an AGPL project, and is used for its "awesome sauce" in terms of
58
-
the BIOS functions that it does so well. This interface is
59
-
[straightforward to use](http://alanz.github.io/haskell%20refactorer/2015/10/02/ghc-mod-for-tooling),
60
-
and if a license-constrained user wants to do something else it is also easy to
61
-
replace, if there is strong control of the operating environment.
57
+
- The [Architecture discussion](/docs/Architecture.md)
58
+
- The [Protocol discussion](/docs/Protocol.md)
59
+
- The [Design discussion](/docs/Design.md)
62
60
63
-
2.__Plugin layer__:
61
+
#### 1. BIOS layer
64
62
65
-
A layer providing a point to integrate tools and existing functions, probably
66
-
including ghci.
63
+
[`ghc-mod`](https://github.com/kazu-yamamoto/ghc-mod) stays an AGPL project,
64
+
and is used for its "awesome sauce" in terms of
65
+
the BIOS functions that it does so well. This interface is
66
+
[straightforward to use](http://alanz.github.io/haskell%20refactorer/2015/10/02/ghc-mod-for-tooling),
67
+
and if a license-constrained user wants to do something else it is also easy to
68
+
replace, if there is strong control of the operating environment.
67
69
68
-
3.__IDE interfacing layer__:
70
+
#### 2. Plugin layer
69
71
70
-
This provides a set of logical channels that can be integrated into standard
71
-
IDEs. The details still need to be worked out, but I would imagine something
72
-
like a channel for querying information about a project, one for a ghci session,
73
-
and whatever others are needed. These logical channels can then run over
74
-
whatever transport is appropriate to the specific IDE being integrated.
72
+
A layer providing a point to integrate tools and existing functions, probably
73
+
including ghci.
75
74
76
-
According to [#2](https://github.com/haskell/haskell-ide-engine/issues/2) it seems the
77
-
consensus is toward (re) using the Idris protocol, as the languages are similar
78
-
enough and it offers cross-IDE support already.
75
+
#### 3. IDE interfacing layer
79
76
80
-
The Plugin and IDE layers are very fuzzy at this point, and there has been some
81
-
discussion on IRC around it. These layers may well live in a single repository
82
-
(this one), as two separate layers or just be a feature of how
83
-
haskell-ide-engine is built.
77
+
This provides a set of logical channels that can be integrated into standard
78
+
IDEs. The details still need to be worked out, but I would imagine something
79
+
like a channel for querying information about a project, one for a ghci session,
80
+
and whatever others are needed. These logical channels can then run over
81
+
whatever transport is appropriate to the specific IDE being integrated.
84
82
85
-
You can see more info [in the docs folder](/docs) at the root of the project, especially:
83
+
According to [#2](https://github.com/haskell/haskell-ide-engine/issues/2) it seems the
84
+
consensus is toward (re-)using the Idris protocol, as the languages are similar
85
+
enough and it offers cross-IDE support already.
86
+
87
+
The __Plugin layer__ and __IDE layer__ are very fuzzy at this point, and there has been some
88
+
discussion on IRC around it. These layers may well live in a single repository
89
+
(this one), as two separate layers or just be a feature of how
90
+
`haskell-ide-engine` is built.
86
91
87
-
- The [Architecture discussion](/docs/Architecture.md)
88
-
- The [Protocol discussion](/docs/Protocol.md)
89
-
- The [Design discussion](/docs/Design.md)
90
92
91
93
92
94
## Documentation
93
95
94
-
All the documentation is [in the docs folder](/docs) at the root of the project.
96
+
All the documentation is in [the docs folder](/docs) at the root of this project.
0 commit comments