Skip to content

Commit 76710a7

Browse files
committed
update README for the new project direction
1 parent 8215d4f commit 76710a7

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
1-
# erlide_parser
2-
An Erlang preprocessor+scanner+parser tailored for use in an IDE.
1+
# sourcer
2+
3+
> This is a new incarnation of the sourcer project, the old code is still available on the `legacy` branch.
4+
5+
*Sourcer* aims to provide:
6+
7+
- a generic language server implementation `lsp_server`
8+
- Erlang support for the above `erlang_ls`
9+
- tooling for extracting information about code in a simple format `sourcer`
10+
11+
## Generic language server
12+
13+
The language server uses a TCP connection to talk LSP with clients. It delegates the actual work to a language specific server. It includes an implementation of an cancelable worker process.
14+
15+
## Erlang server
16+
17+
This is an adapter from LSP to the 'sourcer' data (see below) and back.
18+
19+
## Sourcer
20+
21+
The actual work is done by this application. It is meant to be LSP-agnostic so that it can be used in other contexts and tools.
22+
23+
An own parser (largely based on the legacy 'sourcer' code, but simpler) processes the source code and produces a ctags-like database containing information about all interesting code entities. The database should be distributed, in the sense that libraries should be able to provide the data about their own code (produced at build time).

0 commit comments

Comments
 (0)