Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

Publish the parser as a standalone OCaml library

未關閉
#8,727 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
35/100
Issue 類型
功能
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
ocaml
領域
build-system

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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

  1. The AST layer depends on the Flow JS parser.
    • ml/ast_payload.ml calls Parser_flow and Classify_function to classify %raw payloads.
    • ml/ast_helper.ml uses Ast_payload, so the plain AST builder depends on flow_parser.
    • Related: #8567 (replacing/vendoring the Flow parser). This issue needs Flow out of the parser's dependency closure either way.
  2. Compiler semantics live in Parsetree. Prim_ffi of {spec: External_ffi_types.t} and Prim_inline_const tie the syntax tree to FFI/codegen types. Tracked in #8624 (section C / step B).
  3. No library boundary. syntax depends on all of ml (the type checker).
  4. No namespacing. All libraries are (wrapped false). Module names clash with compiler-libs / ppxlib (Location, Misc, Warnings, Ident, Parsetree, Asttypes, Longident, Ast_helper, Printast, Pprintast) and are generic (Literals, Map_gen, Identifiable).
  5. Global mutable state. Location → Clflags / Warnings / Misc. Diagnostics go through global refs, stderr and exceptions.
  6. C stubs and build profiles. ext has C stubs reachable from the parser (Ext_platform_primitives). Native vs. playground behavior is chosen with the browser profile and copy rules instead of select or virtual libraries.

Proposed plan

  • Split Ast_payload into a pure payload-inspection part and a %raw/%re classification part. Move the classification to frontend/core, and make Ast_helper flow-free. This alone drops ppxlib/ppx_deriving/ppx_gen_rec/wtf8 from the parser.
  • Move Prim_ffi / Prim_inline_const out of the parsetree (see #8624).
  • Extract a small rescript_ast library (Parsetree, Asttypes, Longident, Location, Ast_helper, pure Ast_payload, needed ext helpers). Make syntax depend on it instead of ml. Decide where jsx_ppx and Res_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) with public_names. Its only dependencies should be ocaml and dune.
  • 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.
主要語言
OCaml
星號
7.5k
分支
485
平均合併
19 小時 40 分鐘
30 天內合併 PR
54

環境準備

在 Codespaces 中開啟

在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

rescript-lang/rescript 的其他 Issue

查看 rescript-lang/rescript 的全部 Issue

相似的 Issue

更多 Build System Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。