package ppxlib

  1. Overview
  2. Docs
Standard infrastructure for ppx rewriters

Install 

dune-project
 Dependency

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

Authors

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

Maintainers

  1. O
    opensource@janestreet.com

Sources

757f6c284b1fe748d5027eef3bbef924b6bbd7ce.tar.gz
sha256=89a98c95ddd0bfbac17b5a936f6811af7097be3258c482d5859b73e9de9b4552
sha512=b19306473d867252d382e58e9b697531c5edccdc9283b5eaf72f524803c2fca2a58a5e8f25bee198b00de82cf8ef805b43f7488791c3ac5beb0ffba938ded826

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.

Published: 27 May 2025

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 (6)

  1. stdlib-shims
  2. sexplib0 >= "v0.12"
  3. ppx_derivers >= "1.0"
  4. ocaml-compiler-libs >= "v0.11.0"
  5. ocaml >= "4.08.0" & < "5.5.0"
  6. dune >= "3.8"

Dev Dependencies (6)

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

  1. arrayjit != "0.5.2"
  2. awsm-codegen
  3. bam-ppx >= "0.4"
  4. base_quickcheck >= "v0.17.1"
  5. bistro >= "0.6.0"
  6. bonsai >= "v0.16.0"
  7. bytestring
  8. clangml >= "4.7.0"
  9. cmdlang-to-base
  10. comby < "1.3.0"
  11. commons
  12. crs
  13. diff
  14. diffast-misc = "0.3.5.1"
  15. dream-html >= "3.11.2"
  16. dune >= "3.17.2"
  17. dunolint
  18. dunolint-lib < "0.0.20251006"
  19. dunolint-lib-base
  20. ego
  21. eliom >= "8.9.0"
  22. elpi >= "3.3.1"
  23. embedded_ocaml_templates < "0.3.1" | >= "0.7"
  24. extunix >= "0.4.4"
  25. frama-c >= "32.0~beta"
  26. fsml
  27. fstar >= "2025.06.20"
  28. GT = "0.5.1"
  29. gen_js_api < "1.0.8" | >= "1.1.1"
  30. genprint = "0.3"
  31. goblint >= "2.5.0"
  32. hack_parallel >= "1.0.1"
  33. hardcaml >= "v0.14.1" & != "v0.17.0"
  34. html_of_jsx >= "0.0.2"
  35. http_async
  36. js_of_ocaml >= "3.8.0"
  37. js_of_ocaml-compiler >= "6.1.0"
  38. js_of_ocaml-lwt >= "3.10.0" & < "6.1.0"
  39. js_of_ocaml-ocamlbuild >= "3.10.0" & < "5.0"
  40. js_of_ocaml-ppx >= "6.1.0"
  41. js_of_ocaml-ppx_deriving_json >= "3.7.1"
  42. js_of_ocaml-toplevel >= "3.10.0"
  43. js_of_ocaml-tyxml >= "3.10.0" & < "6.1.0"
  44. lablqml >= "0.7"
  45. lascar >= "0.7.0"
  46. learn-ocaml
  47. learn-ocaml-client
  48. lens >= "1.2.5"
  49. logs-ppx
  50. lwt_ppx >= "5.9.2"
  51. MlFront_Cli >= "2.1.4~prerel2" & < "2.3.1"
  52. MlFront_Config
  53. MlFront_Manip
  54. melange-json >= "1.2.0"
  55. melange-json-native
  56. merlin >= "4.7-412"
  57. metaquot >= "0.5.0"
  58. mlt_parser = "v0.13.0" | >= "v0.14.1"
  59. mlx
  60. neural_nets_lib != "0.5.2"
  61. noCanren >= "0.3.0~alpha1"
  62. node_of_ocaml
  63. nuscr >= "2.0.0"
  64. OCanren-ppx >= "0.3.0"
  65. obus >= "1.2.5"
  66. ocaml-monadic >= "0.5"
  67. ocamlmerlin-mlx
  68. ocsigen-i18n >= "4.0.0"
  69. octez-internal-libs
  70. ojs_base_ppx < "0.9.0"
  71. ometrics = "0.2.0"
  72. ortac-core
  73. ortac-qcheck-stm
  74. ortac-wrapper
  75. pancake
  76. pgocaml_ppx >= "4.3.0"
  77. pla >= "2.0"
  78. ppx-owl-opt
  79. ppx_accessor >= "v0.14.3"
  80. ppx_assert >= "v0.13.0"
  81. ppx_bap
  82. ppx_base >= "v0.13.0"
  83. ppx_bench >= "v0.17.1"
  84. ppx_bin_prot >= "v0.17.1"
  85. ppx_bitstring >= "5.0.0"
  86. ppx_blob >= "0.7.2"
  87. ppx_catch
  88. ppx_cold
  89. ppx_compare >= "v0.13.0"
  90. ppx_compose >= "0.2.1"
  91. ppx_const >= "2.0.1"
  92. ppx_conv_func >= "v0.13.0"
  93. ppx_counters
  94. ppx_css
  95. ppx_cstruct >= "6.0.0"
  96. ppx_cstubs >= "0.6.1" & < "0.7.0"
  97. ppx_csv_conv >= "v0.13.0"
  98. ppx_custom_printf >= "v0.14.1"
  99. ppx_decimal
  100. ppx_defer >= "0.5.0"
  101. ppx_demo
  102. ppx_derive_at_runtime != "v0.17.0"
  103. ppx_deriving >= "6.1.0"
  104. ppx_deriving_cad
  105. ppx_deriving_decoders < "0.2"
  106. ppx_deriving_encoding >= "0.4.2"
  107. ppx_deriving_ezjsonm >= "0.4.1"
  108. ppx_deriving_hardcaml >= "v0.13.0"
  109. ppx_deriving_hash >= "0.1.3"
  110. ppx_deriving_jsonschema
  111. ppx_deriving_jsont
  112. ppx_deriving_madcast >= "0.2"
  113. ppx_deriving_popper
  114. ppx_deriving_protobuf >= "3.0.0"
  115. ppx_deriving_qcheck
  116. ppx_deriving_scad
  117. ppx_deriving_variant_string
  118. ppx_deriving_yaml >= "0.4.1"
  119. ppx_deriving_yojson >= "3.10.0"
  120. ppx_diff >= "v0.17.1"
  121. ppx_disable_unused_warnings
  122. ppx_dream_eml
  123. ppx_embed_file
  124. ppx_enumerate >= "v0.13.0"
  125. ppx_expect = "v0.16.2" | >= "v0.17.3"
  126. ppx_expect_nobase
  127. ppx_factory = "0.1.0" | >= "0.2.0"
  128. ppx_fail >= "v0.13.0"
  129. ppx_fields_conv >= "v0.14.2"
  130. ppx_fixed_literal
  131. ppx_format
  132. ppx_fun
  133. ppx_gen_rec >= "2.0.0"
  134. ppx_getenv >= "2.1"
  135. ppx_globalize >= "v0.17.2"
  136. ppx_hardcaml
  137. ppx_hash >= "v0.13.0"
  138. ppx_here >= "v0.13.0"
  139. ppx_ignore_instrumentation
  140. ppx_import < "1.8.0" | >= "1.11.0"
  141. ppx_inline_test >= "v0.17.1"
  142. ppx_interact >= "0.2.0"
  143. ppx_irmin >= "3.0.0"
  144. ppx_jane >= "v0.13.0"
  145. ppx_js_style >= "v0.17.1"
  146. ppx_jsobject_conv = "0.8.0" | >= "0.21.1"
  147. ppx_jsonaf_conv >= "v0.15.1" & != "v0.17.0"
  148. ppx_let >= "v0.17.1"
  149. ppx_log
  150. ppx_lun >= "0.0.2"
  151. ppx_map
  152. ppx_matches >= "0.1.0"
  153. ppx_mica
  154. ppx_minidebug != "2.2.0"
  155. ppx_module_timer >= "v0.13.0"
  156. ppx_monad
  157. ppx_monoid >= "0.3.3"
  158. ppx_mysql >= "1.1.3"
  159. ppx_open
  160. ppx_optcomp >= "v0.17.1"
  161. ppx_optint
  162. ppx_optional >= "v0.13.0"
  163. ppx_partial
  164. ppx_pattern_bind >= "v0.13.1" & != "v0.17.0"
  165. ppx_pipebang >= "v0.13.0"
  166. ppx_protocol_conv >= "5.2.3"
  167. ppx_pyformat
  168. ppx_python >= "v0.15.0"
  169. ppx_quick_test >= "v0.17.1"
  170. ppx_seq
  171. ppx_sexp_conv >= "v0.17.1"
  172. ppx_sexp_message >= "v0.14.1"
  173. ppx_sexp_value >= "v0.13.0"
  174. ppx_show >= "0.2.0"
  175. ppx_stable >= "v0.17.1"
  176. ppx_stable_witness
  177. ppx_string >= "v0.14.1"
  178. ppx_string_conv
  179. ppx_string_interpolation
  180. ppx_subliner
  181. ppx_system
  182. ppx_ts
  183. ppx_tydi >= "v0.17.1"
  184. ppx_type_directed_value
  185. ppx_typed_fields != "v0.17.0"
  186. ppx_typerep_conv >= "v0.17.1"
  187. ppx_units
  188. ppx_unreachable
  189. ppx_update
  190. ppx_variants_conv >= "v0.17.1"
  191. ppx_viewpattern >= "0.1.1"
  192. ppx_xml_conv >= "v0.13.0"
  193. ppx_yojson_conv >= "v0.15.1" & != "v0.17.0"
  194. ppxlib_jane >= "v0.17.3"
  195. qcow = "0.11.0"
  196. rdf_ppx
  197. reason >= "3.16.0"
  198. reason-react-ppx >= "0.13.0" & < "0.14.1"
  199. refl >= "0.4.1"
  200. res_tailwindcss
  201. sedlex >= "3.4"
  202. serde_derive
  203. server-reason-react
  204. speed
  205. spin >= "0.8.0"
  206. stdint-literals
  207. stk_ppx
  208. streamable != "v0.17.0"
  209. styled-ppx
  210. togglelog
  211. toplevel_expect_test >= "v0.14.1"
  212. tyxml-jsx >= "4.5.0"
  213. tyxml-syntax >= "4.5.0"
  214. visitors = "20210608" | = "20251010"
  215. vlt >= "0.2.5"
  216. volgo < "0.0.21"
  217. volgo-base
  218. volgo-git-backend < "0.0.21"
  219. volgo-git-eio < "0.0.21"
  220. volgo-git-unix < "0.0.21"
  221. volgo-hg-backend < "0.0.21"
  222. volgo-hg-eio < "0.0.21"
  223. volgo-hg-unix < "0.0.21"
  224. volgo-vcs < "0.0.21"
  225. wasm_of_ocaml-compiler
  226. wtr < "3.0.0"
  227. wtr-ppx
  228. 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"