package ppx_js_style

  1. Overview
  2. Docs
Code style checker for Jane Street Packages

Install

Dune Dependency

github.com Readme Apache-2.0 License Edit opam file Versions (9)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

ppx_js_style-v0.9.0.tar.gz
md5=ad32e85a819693153dd7115e7025b7ef

README.md.html

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 = expr

  • Enabled 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.