Publish the parser as a standalone OCaml library
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- ocaml
- Domain
- build-system
Research direction
Start by reading the dune graph and the listed blocker issues #8567 and #8624, then trace the parser’s dependency closure with ocamldep. The proposed work spans AST boundaries, dependencies, namespacing, global state, C stubs, packaging, and CI, so it is not a small standalone change. Done means a clean-switch dune build -p rescript-syntax succeeds with only ocaml and dune dependencies.
Written by the indexing model from the issue text.
Description
Goal
Publish the ReScript parser/printer as a reusable OCaml library that needs only ocaml and dune.
Current state
The dune graph is syntax → ml → {ext, flow_parser}. flow_parser is the only part with heavy OPAM dependencies (ppxlib, ppx_deriving, ppx_gen_rec, wtf8, plus a vendored sedlex ppx). The parser pulls all of them in.
Transitive module closure of Res_core / Res_printer / Res_driver (via ocamldep):
| library | modules reached |
|---|---|
syntax/src |
16 / 24 |
ml |
~18 / 91 |
ext |
20 / 66 |
flow_parser |
27 / 27 |
The parser needs only a small part of ml/ext. A few edges drag in the rest.
Blockers
- The AST layer depends on the Flow JS parser.
ml/ast_payload.mlcallsParser_flowandClassify_functionto classify%rawpayloads.ml/ast_helper.mlusesAst_payload, so the plain AST builder depends onflow_parser.- Related: #8567 (replacing/vendoring the Flow parser). This issue needs Flow out of the parser's dependency closure either way.
- Compiler semantics live in
Parsetree.Prim_ffi of {spec: External_ffi_types.t}andPrim_inline_consttie the syntax tree to FFI/codegen types. Tracked in #8624 (section C / step B). - No library boundary.
syntaxdepends on all ofml(the type checker). - No namespacing. All libraries are
(wrapped false). Module names clash withcompiler-libs/ ppxlib (Location,Misc,Warnings,Ident,Parsetree,Asttypes,Longident,Ast_helper,Printast,Pprintast) and are generic (Literals,Map_gen,Identifiable). - Global mutable state.
Location→Clflags/Warnings/Misc. Diagnostics go through global refs, stderr and exceptions. - C stubs and build profiles.
exthas C stubs reachable from the parser (Ext_platform_primitives). Native vs. playground behavior is chosen with thebrowserprofile and copy rules instead ofselector virtual libraries.
Proposed plan
- Split
Ast_payloadinto a pure payload-inspection part and a%raw/%reclassification part. Move the classification tofrontend/core, and makeAst_helperflow-free. This alone drops ppxlib/ppx_deriving/ppx_gen_rec/wtf8 from the parser. - Move
Prim_ffi/Prim_inline_constout of the parsetree (see #8624). - Extract a small
rescript_astlibrary (Parsetree, Asttypes, Longident, Location, Ast_helper, pure Ast_payload, neededexthelpers). Makesyntaxdepend on it instead ofml. Decide wherejsx_ppxandRes_outcome_printer(Outcometree) go. - Make the AST library free of C stubs, or give it a pure-OCaml fallback, so it works under js_of_ocaml without a custom profile.
- Wrap the published libraries (
(wrapped true)or(wrapped (transition …))). - Expose a parser API that returns diagnostics and takes explicit config instead of relying on global state.
- Add an opam package (e.g.
rescript-syntax) withpublic_names. Its only dependencies should beocamlanddune. - Align with #8624 (parsetree v1) for API/AST stability.
- Confirm licensing for the package: compiler-derived files are LGPL with the OCaml linking exception.
- Add a CI job that builds the package alone in a clean switch (
dune build -p rescript-syntax) to catch dependency regressions.
- Dominant language
- ReScript
- Stars
- 7.5k
- Forks
- 483
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 120
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from rescript-lang/rescript
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
rescript-lang/rescript#8833 · 1 reaction ·
Maintainers usually reply within 1 day
-
rewatch watch on Linux stops watching a source folder when an overlapping recursive source folder is removed from rescript.jsonPossibly taken @cknitt claimed this 2 days ago. Open
Difficulty 4/5 1-2 days Newbie friendliness 35/100
rescript-lang/rescript#8825 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
rescript-lang/rescript#8806 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
rescript-lang/rescript#8798 ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 Half a day Newbie friendliness 58/100
rescript-lang/rescript#8757 ·
Maintainers usually reply within 1 day
All issues in rescript-lang/rescript
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
libsdl-org/SDL#16530 ·
Maintainers usually reply within 1 day
-
complexity: trivial good first issue impact: low
Difficulty 1/5 Under an hour Newbie friendliness 78/100
ueberdosis/tiptap#8522 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
msys2/MSYS2-packages#6825 ·
Maintainers usually reply within 1 day
-
in: build type: dependency-upgrade
Difficulty 1/5 Under an hour Newbie friendliness 62/100
spring-projects/spring-ldap#1791 ·
Maintainers usually reply within 1 day