package ppxlib

Build not checked
  1. Overview
  2. Docs
Standard infrastructure for ppx rewriters

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (25)

Authors

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

  1. O
    opensource@janestreet.com

Sources

2e150834476230e99e48dfdf34c5e4a1ea6e749b.tar.gz
sha256=591d694609fed01783c9f360602e8660ae0e49eb33b7074c1317a261e00c6cdb
sha512=e15e956a114ab3f61dfa8f7eceed088082a116f3b6fc832b901729f611258af3b39bda748b2046b4886f429617aa64802f90e0520db82302443ecbba461970b2

Description

Ppxlib is the standard infrastructure for ppx rewriters and other programs that manipulate the in-memory representation of OCaml programs, a.k.a the "Parsetree".

It also comes bundled with two ppx rewriters that are commonly used to write tools that manipulate and/or generate Parsetree values; ppxlib.metaquot which allows to construct Parsetree values using the OCaml syntax directly and ppxlib.traverse which provides various ways of automatically traversing values of a given type, in particular allowing to inject a complex structured value into generated code.

Added to opam-repository:

README

Ppxlib - Meta-programming for OCaml

ocaml-ci status trunk-build-status AppVeyor status

Ppxlib documentation

Overview

Ppxlib is the standard library for ppx rewriters and other programs that manipulate the in-memory representation of OCaml programs, a.k.a. the "Parsetree".

It also comes bundled with two ppx rewriters that are commonly used to write tools that manipulate and/or generate Parsetree values: ppxlib.metaquot, which allows constructing Parsetree values using the OCaml syntax directly, and ppxlib.traverse, which provides various ways of automatically traversing values of a given type, in particular allowing to inject a complex structured value into generated code.

For more information about ppxlib and how to use it, please consult the documentation.

What is the relation between ppxlib and other ppx libraries?

The ppx world has a long and storied history, and if you look around, you may find other projects that offer functionalities similar to ppxlib. The following blog post gives a good overview of the various libraries that have been developed over time. At this point, ppxlib is considered the de facto library for writing ppx rewriters.

History of the project

This repository was created by merging several older smaller projects that were developed at Jane Street. See the history for more details.

Dependencies (5)

  1. sexplib0 >= "v0.15"
  2. ppx_derivers >= "1.0"
  3. ocaml-compiler-libs >= "v0.11.0"
  4. ocaml >= "4.08.0" & < "5.7.0"
  5. dune >= "3.8"

Dev Dependencies (5)

  1. odoc with-doc
  2. ocamlformat with-dev-setup & = "0.28.1"
  3. cinaps with-test & >= "v0.12.1"
  4. re with-test & >= "1.9.0"
  5. ocamlfind with-test

Optional Dependencies

None

  1. arrayjit != "0.5.2"
  2. awsm-codegen
  3. bam-ppx >= "0.4"
  4. base_quickcheck >= "v0.17.1"
  5. bisect_ppx_ng
  6. bistro
  7. bonsai >= "v0.16.0"
  8. bytestring
  9. chatoyant
  10. clangml >= "4.7.0"
  11. cmdlang-to-base < "0.0.11"
  12. codex
  13. comby < "1.3.0"
  14. commons
  15. crs < "0.0.20260307"
  16. diff
  17. diffast-misc = "0.3.5.1"
  18. dream-html >= "3.11.2"
  19. dune >= "3.17.2"
  20. dunolint
  21. dunolint-lib < "0.0.20251006"
  22. dunolint-lib-base
  23. ego
  24. eliom >= "8.9.0"
  25. elpi >= "3.3.1"
  26. embedded_ocaml_templates < "0.3.1" | >= "0.7"
  27. extunix >= "0.4.4"
  28. frama-c >= "32.0~beta"
  29. fsml
  30. fstar >= "2025.06.20"
  31. GT = "0.5.1" | >= "0.5.5"
  32. gen_js_api < "1.0.8" | >= "1.1.1"
  33. gendarme >= "0.4.1"
  34. goblint >= "2.5.0"
  35. gospel >= "0.3.1"
  36. hack_parallel
  37. hardcaml >= "v0.14.1" & != "v0.17.0"
  38. hegel >= "0.24.1"
  39. html_of_jsx >= "0.0.2"
  40. http_async
  41. js_of_ocaml >= "3.8.0"
  42. js_of_ocaml-compiler >= "6.1.0"
  43. js_of_ocaml-lwt >= "3.10.0" & < "6.1.0"
  44. js_of_ocaml-ocamlbuild >= "3.10.0" & < "5.0"
  45. js_of_ocaml-ppx >= "6.1.0"
  46. js_of_ocaml-ppx_deriving_json
  47. js_of_ocaml-toplevel >= "3.10.0"
  48. js_of_ocaml-tyxml >= "3.10.0" & < "6.1.0"
  49. jsonkit
  50. jsonkit-melange
  51. kube
  52. lablqml
  53. landmarks-ppx >= "1.6"
  54. lascar >= "0.7.0"
  55. learn-ocaml
  56. learn-ocaml-client
  57. lens >= "1.2.5"
  58. logs-ppx
  59. lwt_ppx >= "5.9.2"
  60. MlFront_Cli >= "2.1.4~prerel2" & < "2.3.1"
  61. MlFront_Config
  62. MlFront_Manip
  63. mcp-kit-ppx
  64. melange >= "6.0.1-51"
  65. melange-json >= "1.2.0"
  66. melange-json-native
  67. merlin >= "4.7-412"
  68. metaquot >= "0.5.0"
  69. mlt_parser != "v0.14.0"
  70. mlx
  71. mutaml >= "0.4"
  72. neural_nets_lib != "0.5.2"
  73. noCanren
  74. node_of_ocaml
  75. nuscr >= "2.0.0"
  76. OCanren-ppx >= "0.3.0"
  77. obus >= "1.2.5"
  78. ocaml-monadic >= "0.5"
  79. ocamlmerlin-mlx
  80. ocf_ppx >= "1.0.0"
  81. ocgtk < "0.1~preview2"
  82. ocsigen-i18n >= "4.0.0"
  83. ocsigen-ppx-rpc >= "1.1"
  84. ojs_base_ppx != "0.8.0"
  85. ometrics = "0.2.0"
  86. ortac-core
  87. ortac-qcheck-stm
  88. ortac-wrapper
  89. pacomb >= "1.4.3"
  90. pancake
  91. pgocaml_ppx >= "4.3.0"
  92. pla >= "2.0"
  93. polymarket >= "0.2.0"
  94. ppx-owl-opt
  95. ppx_accessor >= "v0.14.3"
  96. ppx_assert
  97. ppx_bap
  98. ppx_base
  99. ppx_bench >= "v0.17.1"
  100. ppx_bin_prot >= "v0.17.1"
  101. ppx_bin_there
  102. ppx_bitstring >= "5.0.0"
  103. ppx_blob >= "0.7.2"
  104. ppx_catch
  105. ppx_cold
  106. ppx_compare
  107. ppx_compose >= "0.2.1"
  108. ppx_const >= "2.0.1"
  109. ppx_conv_func
  110. ppx_counters
  111. ppx_css
  112. ppx_cstruct >= "6.0.0"
  113. ppx_cstubs >= "0.6.1" & < "0.7.0"
  114. ppx_csv_conv
  115. ppx_custom_printf >= "v0.14.1"
  116. ppx_decimal
  117. ppx_defer >= "0.5.0"
  118. ppx_demo
  119. ppx_derive_at_runtime != "v0.17.0"
  120. ppx_deriving >= "6.1.0"
  121. ppx_deriving_cad
  122. ppx_deriving_decoders < "0.2"
  123. ppx_deriving_encoding >= "0.4.2"
  124. ppx_deriving_ezjsonm >= "0.4.1"
  125. ppx_deriving_hardcaml
  126. ppx_deriving_hash >= "0.1.3"
  127. ppx_deriving_jsonschema
  128. ppx_deriving_jsont
  129. ppx_deriving_madcast >= "0.2"
  130. ppx_deriving_melange
  131. ppx_deriving_popper
  132. ppx_deriving_protobuf
  133. ppx_deriving_qcheck
  134. ppx_deriving_rpc >= "10.0.0"
  135. ppx_deriving_scad
  136. ppx_deriving_variant_string
  137. ppx_deriving_yaml >= "0.4.1"
  138. ppx_deriving_yamlx
  139. ppx_deriving_yojson >= "3.10.0"
  140. ppx_diff >= "v0.17.1"
  141. ppx_disable_unused_warnings
  142. ppx_dream_eml
  143. ppx_elpi
  144. ppx_embed_file
  145. ppx_enforce
  146. ppx_enumerate
  147. ppx_expect = "v0.16.2" | >= "v0.17.3"
  148. ppx_expect_nobase
  149. ppx_ezlua
  150. ppx_factory >= "0.2.0"
  151. ppx_fail
  152. ppx_fields_conv >= "v0.14.2"
  153. ppx_fixed_literal
  154. ppx_forbid
  155. ppx_format
  156. ppx_fun
  157. ppx_gen_rec >= "2.0.0"
  158. ppx_getenv >= "2.1"
  159. ppx_globalize >= "v0.17.2"
  160. ppx_hardcaml
  161. ppx_hash
  162. ppx_hegel_compat
  163. ppx_hegel_generator
  164. ppx_hegel_test
  165. ppx_here
  166. ppx_ignore_instrumentation
  167. ppx_import < "1.8.0" | >= "1.11.0"
  168. ppx_inline_test >= "v0.17.1"
  169. ppx_inline_test_nobase >= "v0.17.0.3"
  170. ppx_interact >= "0.2.0"
  171. ppx_irmin >= "3.0.0"
  172. ppx_jane
  173. ppx_js_style >= "v0.17.1"
  174. ppx_jsobject_conv < "0.9.0" | >= "0.21.1"
  175. ppx_jsonaf_conv >= "v0.15.1" & != "v0.17.0"
  176. ppx_let >= "v0.17.1"
  177. ppx_log
  178. ppx_lun >= "0.0.2"
  179. ppx_make >= "0.3.4"
  180. ppx_map
  181. ppx_marshal >= "0.4.1"
  182. ppx_marshal_ext >= "0.4.1"
  183. ppx_matches >= "0.1.0"
  184. ppx_mica
  185. ppx_mikmatch
  186. ppx_minidebug != "2.2.0"
  187. ppx_mixins
  188. ppx_module
  189. ppx_module_timer
  190. ppx_monad
  191. ppx_monoid >= "0.3.3"
  192. ppx_mysql >= "1.1.3"
  193. ppx_open
  194. ppx_optcomp >= "v0.17.1"
  195. ppx_optcomp_nobase
  196. ppx_optint
  197. ppx_optional
  198. ppx_parser >= "0.2.1"
  199. ppx_partial
  200. ppx_pattern_bind != "v0.17.0"
  201. ppx_pipebang
  202. ppx_platform
  203. ppx_protocol_conv >= "5.2.3"
  204. ppx_python >= "v0.15.0"
  205. ppx_quick_test >= "v0.17.1"
  206. ppx_regexp >= "0.5.2"
  207. ppx_repr >= "0.8.0"
  208. ppx_seq
  209. ppx_sexp_conv >= "v0.17.1"
  210. ppx_sexp_message >= "v0.14.1"
  211. ppx_sexp_value
  212. ppx_show
  213. ppx_stable >= "v0.17.1"
  214. ppx_stable_witness
  215. ppx_string >= "v0.14.1"
  216. ppx_string_conv
  217. ppx_string_interpolation
  218. ppx_subliner
  219. ppx_system
  220. ppx_ts
  221. ppx_tydi >= "v0.17.1"
  222. ppx_type_directed_value
  223. ppx_typed_fields != "v0.17.0"
  224. ppx_typerep_conv >= "v0.17.1"
  225. ppx_units
  226. ppx_unreachable
  227. ppx_update
  228. ppx_variants_conv >= "v0.17.1"
  229. ppx_viewpattern >= "0.1.1"
  230. ppx_windtrap
  231. ppx_xml_conv
  232. ppx_yojson_conv >= "v0.15.1" & != "v0.17.0"
  233. ppxlib_jane >= "v0.17.3"
  234. qcow < "0.12.1"
  235. quint-connect
  236. react-rules-of-hooks-ppx
  237. reason >= "3.16.0"
  238. reason-react-day-picker
  239. reason-react-ppx >= "0.17.0"
  240. refl >= "0.4.1"
  241. repr-fuzz >= "0.8.0"
  242. res_tailwindcss
  243. sedlex >= "3.4"
  244. serde_derive
  245. server-reason-react >= "0.2.0" & != "0.4.0"
  246. soteria
  247. spectrum_palette_ppx
  248. speed
  249. spin >= "0.8.0"
  250. sqlgg >= "20260721"
  251. stdint-literals
  252. stk_ppx
  253. streamable != "v0.17.0"
  254. styled-ppx
  255. togglelog
  256. toplevel_expect_test >= "v0.14.1"
  257. tyxml-jsx >= "4.5.0"
  258. tyxml-ppx >= "5.0.0"
  259. tyxml-syntax >= "4.5.0"
  260. visitors = "20210608" | >= "20251010"
  261. vlt >= "0.2.5"
  262. volgo < "0.0.21"
  263. volgo-base
  264. volgo-git-backend < "0.0.21"
  265. volgo-git-eio < "0.0.21"
  266. volgo-git-unix < "0.0.21"
  267. volgo-hg-backend < "0.0.21"
  268. volgo-hg-eio < "0.0.21"
  269. volgo-hg-unix < "0.0.21"
  270. volgo-vcs < "0.0.21"
  271. wasm_of_ocaml-compiler
  272. wtr < "3.0.0"
  273. wtr-ppx
  274. xtmpl_ppx >= "1.1.0"

Conflicts (3)

  1. ocaml-variants = "5.1.0~alpha1+options"
  2. ocaml-base-compiler = "5.1.0~alpha1"
  3. ocaml-migrate-parsetree < "2.0.0"

Build status

Results of building ppxlib with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

This version is not in the latest run; the versions below are.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.39.0 good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure