package ppxlib

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

a6fadbd212f3cd7d5d8dcfefc46c884f710fedc0.tar.gz
sha256=25e81f2085ad19688f7056c6df49ca48b3df4cea8304ba3be2550e172d59bfec
sha512=cfdaa06fd32d206f72de05a5289d33ec85fa6bdf7c5be7c85874a16d9e154cdc080465453b60fe7f6c01589eb92e4296b18067413ac2d8dec47b9539f55e301e

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 (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.6.0"
  6. dune >= "3.8"

Dev Dependencies (6)

  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
  6. sexplib0 with-test & >= "v0.15"

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"
  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. kube
  50. lablqml
  51. landmarks-ppx >= "1.6"
  52. lascar >= "0.7.0"
  53. learn-ocaml
  54. learn-ocaml-client
  55. lens >= "1.2.5"
  56. logs-ppx
  57. lwt_ppx >= "5.9.2"
  58. MlFront_Cli >= "2.1.4~prerel2" & < "2.3.1"
  59. MlFront_Config
  60. MlFront_Manip
  61. mcp-kit-ppx
  62. melange >= "6.0.1-51"
  63. melange-json >= "1.2.0"
  64. melange-json-native
  65. merlin >= "4.7-412"
  66. metaquot >= "0.5.0"
  67. mlt_parser != "v0.14.0"
  68. mlx < "0.12"
  69. mutaml >= "0.4"
  70. neural_nets_lib != "0.5.2"
  71. noCanren
  72. node_of_ocaml
  73. nuscr >= "2.0.0"
  74. OCanren-ppx >= "0.3.0"
  75. obus >= "1.2.5"
  76. ocaml-monadic >= "0.5"
  77. ocamlmerlin-mlx < "0.12"
  78. ocf_ppx >= "1.0.0"
  79. ocgtk < "0.1~preview2"
  80. ocsigen-i18n >= "4.0.0"
  81. ocsigen-ppx-rpc >= "1.1"
  82. ojs_base_ppx != "0.8.0"
  83. ometrics = "0.2.0"
  84. ortac-core
  85. ortac-qcheck-stm
  86. ortac-wrapper
  87. pacomb >= "1.4.3"
  88. pancake
  89. pgocaml_ppx >= "4.3.0"
  90. pla >= "2.0"
  91. polymarket >= "0.2.0"
  92. ppx-owl-opt
  93. ppx_accessor >= "v0.14.3"
  94. ppx_assert
  95. ppx_bap
  96. ppx_base
  97. ppx_bench >= "v0.17.1"
  98. ppx_bin_prot >= "v0.17.1"
  99. ppx_bin_there
  100. ppx_bitstring >= "5.0.0"
  101. ppx_blob >= "0.7.2"
  102. ppx_catch
  103. ppx_cold
  104. ppx_compare
  105. ppx_compose >= "0.2.1"
  106. ppx_const >= "2.0.1"
  107. ppx_conv_func
  108. ppx_counters
  109. ppx_css
  110. ppx_cstruct >= "6.0.0"
  111. ppx_cstubs >= "0.6.1" & < "0.7.0"
  112. ppx_csv_conv
  113. ppx_custom_printf >= "v0.14.1"
  114. ppx_decimal
  115. ppx_defer >= "0.5.0"
  116. ppx_demo
  117. ppx_derive_at_runtime != "v0.17.0"
  118. ppx_deriving >= "6.1.0"
  119. ppx_deriving_cad
  120. ppx_deriving_decoders < "0.2"
  121. ppx_deriving_encoding >= "0.4.2"
  122. ppx_deriving_ezjsonm >= "0.4.1"
  123. ppx_deriving_hardcaml
  124. ppx_deriving_hash >= "0.1.3"
  125. ppx_deriving_jsonschema
  126. ppx_deriving_jsont
  127. ppx_deriving_madcast >= "0.2"
  128. ppx_deriving_melange
  129. ppx_deriving_popper
  130. ppx_deriving_protobuf
  131. ppx_deriving_qcheck
  132. ppx_deriving_rpc >= "10.0.0"
  133. ppx_deriving_scad
  134. ppx_deriving_variant_string
  135. ppx_deriving_yaml >= "0.4.1"
  136. ppx_deriving_yamlx
  137. ppx_deriving_yojson >= "3.10.0"
  138. ppx_devtools-expect
  139. ppx_devtools-optcomp
  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_optint
  196. ppx_optional
  197. ppx_parser >= "0.2.1"
  198. ppx_partial
  199. ppx_pattern_bind != "v0.17.0"
  200. ppx_pipebang
  201. ppx_platform
  202. ppx_protocol_conv >= "5.2.3"
  203. ppx_python >= "v0.15.0"
  204. ppx_quick_test >= "v0.17.1"
  205. ppx_regexp >= "0.5.2"
  206. ppx_repr >= "0.8.0"
  207. ppx_seq
  208. ppx_sexp_conv >= "v0.17.1"
  209. ppx_sexp_message >= "v0.14.1"
  210. ppx_sexp_value
  211. ppx_show
  212. ppx_stable >= "v0.17.1"
  213. ppx_stable_witness
  214. ppx_string >= "v0.14.1"
  215. ppx_string_conv
  216. ppx_string_interpolation
  217. ppx_subliner
  218. ppx_system
  219. ppx_ts
  220. ppx_tydi >= "v0.17.1"
  221. ppx_type_directed_value
  222. ppx_typed_fields != "v0.17.0"
  223. ppx_typerep_conv >= "v0.17.1"
  224. ppx_units
  225. ppx_unreachable
  226. ppx_update
  227. ppx_variants_conv >= "v0.17.1"
  228. ppx_viewpattern >= "0.1.1"
  229. ppx_windtrap
  230. ppx_xml_conv
  231. ppx_yojson_conv >= "v0.15.1" & != "v0.17.0"
  232. ppxlib_jane >= "v0.17.3"
  233. qcow < "0.12.1"
  234. quint-connect
  235. react-rules-of-hooks-ppx
  236. reason >= "3.16.0"
  237. reason-react-day-picker
  238. reason-react-ppx >= "0.17.0"
  239. refl >= "0.4.1"
  240. repr-fuzz >= "0.8.0"
  241. res_tailwindcss
  242. sedlex >= "3.4"
  243. serde_derive
  244. server-reason-react >= "0.2.0" & != "0.4.0"
  245. spectrum_palette_ppx
  246. speed
  247. spin >= "0.8.0"
  248. sqlgg >= "20260721"
  249. stdint-literals
  250. stk_ppx
  251. streamable != "v0.17.0"
  252. styled-ppx
  253. togglelog
  254. toplevel_expect_test >= "v0.14.1"
  255. tyxml-jsx >= "4.5.0"
  256. tyxml-ppx >= "5.0.0"
  257. tyxml-syntax >= "4.5.0"
  258. visitors = "20210608" | >= "20251010"
  259. vlt >= "0.2.5"
  260. volgo < "0.0.21"
  261. volgo-base
  262. volgo-git-backend < "0.0.21"
  263. volgo-git-eio < "0.0.21"
  264. volgo-git-unix < "0.0.21"
  265. volgo-hg-backend < "0.0.21"
  266. volgo-hg-eio < "0.0.21"
  267. volgo-hg-unix < "0.0.21"
  268. volgo-vcs < "0.0.21"
  269. wasm_of_ocaml-compiler
  270. wtr < "3.0.0"
  271. wtr-ppx
  272. 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 8d8d144. 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