package ppx_js_style
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=6b26892808a61fa12b8f6f924f5bc1210e828b0c66a7e0c7a875ac17c7157fd8
md5=ad32e85a819693153dd7115e7025b7ef
Description
Part of the Jane Street's PPX rewriters collection.
This packages is a no-op ppx rewriter. It is used as a 'lint' tool to enforce some coding conventions across all Jane Street packages.
Published: 22 Mar 2017
README
title: ppx_js_style - Enforce Jane Street coding styles parent: ../README.md
ppx_js_style is an identity ppx rewriter that enforces Jane Street coding styles.
Coding rules
The following rules are enforced by ppx_js_style:
[@@deprecated]attributes must contain the date of deprecation, using the format"[since MM-YYYY] ..."Enabled by -annotated-ignores: Ignored expressions must come with a type annotation, such as:
ignore (expr : typ)let _ : type = exprEnabled by -check-doc-comments: Comments in mli must either be documentation comments or explicitely "ignored":
(** documentation comment *)(*_ ignored comment *)Normal(* comment *)comments are disallowed.This flag additionally enables warning 50, which checks the placement of documentation comments.
Finally, doc comments are checked to be syntactically valid.
Dependencies (7)
- octavius
-
ocaml-migrate-parsetree
>= "0.4" & < "2.0.0" -
ppx_metaquot
>= "v0.9" & < "v0.10" -
ppx_driver
>= "v0.9" & < "v0.10" -
ppx_core
>= "v0.9" & < "v0.10" -
jbuilder
>= "1.0+beta4" -
ocaml
>= "4.03.0"
Dev Dependencies
None
Used by (3)
-
parsexp
< "v0.10.0" -
parsexp_io
< "v0.10.0" -
ppx_base
< "v0.10.0"
Conflicts
None