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

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

Dependencies (7)

  1. octavius
  2. ocaml-migrate-parsetree >= "0.4" & < "2.0.0"
  3. ppx_metaquot >= "v0.9" & < "v0.10"
  4. ppx_driver >= "v0.9" & < "v0.10"
  5. ppx_core >= "v0.9" & < "v0.10"
  6. jbuilder >= "1.0+beta4"
  7. ocaml >= "4.03.0"

Dev Dependencies

None

Used by (3)

  1. parsexp < "v0.10.0"
  2. parsexp_io < "v0.10.0"
  3. ppx_base < "v0.10.0"

Conflicts

None