Skip to content

Allow ide module rebuilds without touching fs output/cache-db continued #4399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
purefunctor merged 8 commits into from
Oct 30, 2022
Merged

Allow ide module rebuilds without touching fs output/cache-db continued #4399

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
78a360d
Document changes to IDE Protocol
i-am-the-slime Oct 11, 2022
fc05772
Do not modify externs/cache-db when codgenTargets is empty
wclr Aug 26, 2021
bbb36b8
Add handling of source file text data instead of file path
wclr Sep 4, 2021
badee25
Add ffi check for ide rebuild without codegen
wclr Jul 4, 2022
915708c
Address review comments
i-am-the-slime Oct 11, 2022
0c126d2
Add changelog entry
i-am-the-slime Oct 20, 2022
a0fde84
Guess @wclr's real name and add to CONTRIBUTORS.md
i-am-the-slime Oct 29, 2022
2713ec3
Fix link
i-am-the-slime Oct 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Document changes to IDE Protocol
  • Loading branch information
@i-am-the-slime
i-am-the-slime committed Oct 11, 2022
commit 78a360db136fd10545d1ce5f46e6a478a4d87f66
7 changes: 4 additions & 3 deletions psc-ide/PROTOCOL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Communication with `purs ide server` is via a JSON protocol over a TCP connection:
the server listens on a particular (configurable) port, and will accept a single line
of JSON input in the format described below, terminated by a newline, before giving
of JSON input in the format described below, terminated by a newline, before giving
a JSON response and closing the connection.

The `purs ide client` command can be used as a wrapper for the TCP connection, but
Expand Down Expand Up @@ -80,7 +80,7 @@ The `complete` command looks up possible completions/corrections.
If no matcher is given every candidate, that passes the filters, is returned
in no particular order.

- `currentModule :: (optional) String`: The current modules name. Allows you
- `currentModule :: (optional) String`: The current modules name. Allows you
to see module-private functions after a successful rebuild. If it matches
with the rebuild cache non-exported modules will also be completed. You can
fill the rebuild cache by using the "Rebuild" command.
Expand Down Expand Up @@ -371,7 +371,8 @@ loaded. A successful rebuild will be stored to allow for completions of private
identifiers.

Arguments:
- `file :: String` the path to the module to rebuild
- `file :: String` the path to the module to rebuild **or** the complete
source code of the module to be compiled prefixed with `data:`
- `actualFile :: Maybe String` Specifies the path to be used for location
information and parse errors. This is useful in case a temp file is used as
the source for a rebuild.
Expand Down