Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

README.md

psc-ide

A tool which provides editor support for the PureScript programming language.

Editor Integration

Running the Server

Start the server by running the psc-ide-server [SOURCEGLOBS] executable, where SOURCEGLOBS are (optional) globs that match your PureScript sourcefiles.

It supports the following options:

  • -p / --port specify a port. Defaults to 4242
  • -d / --directory specify the toplevel directory of your project. Defaults to the current directory
  • --output-directory: Specify where to look for compiled output inside your project directory. Defaults to output/, relative to either the current directory or the directory specified by -d.
  • --polling: Uses polling instead of file system events to watch the externs files. This flag is reversed on Windows and polling is the default.
  • --debug: DEPRECATED: use --log-level="debug"
  • --log-level: Can be set to one of "all", "none", "debug" and "perf"
  • --no-watch: Disables the filewatcher
  • --version: Output psc-ide version

Issuing queries

After you started the server you can start issuing requests using psc-ide-client. Make sure you start by loading the modules before you try to query them.

psc-ide-server expects the build externs.purs inside the output/ folder of your project after running pulp build or psc-make respectively.

(If you changed the port of the server you can change the port for psc-ide-client by using the -p option accordingly)

Protocol

For documentation about the protocol have a look at: PROTOCOL.md