fun icon indicating copy to clipboard operation
fun copied to clipboard

Json 2.0 (Rename to json_schema.ts)

Open baetheus opened this issue 3 years ago • 2 comments
trafficstars

Standard Module Implementation for CHANGE_ME

  • [x] Add file block comment at top of file describing the adt/structure.
  • [x] Check for any missing combinators/derivations that could be implemented.
  • [x] Modify all combinator variable names to be readable (use style guide).
  • [x] Add documentation to every export (and // comment local tools).
  • [x] Check that every function and line is covered by tests in the testing directory.

Style Guide

  • Use A -> I, B -> J, C -> K, D -> L for inner types.
  • Use ua, va to match URI, VRI, etc in generic positions.
  • Implement algebraic structure types (type classes) out to length 4.
  • Use functions over const arrow functions for root exports.
  • Document all type exports.
  • Order file exports by group and then alphabetically. Groups are Types, Constructors, Combinators, Type Class Instances, Type Class Constructors, and Derived Combinators.

Documentation Guide

  • Start with at least one full sentence describing the use case for the export.
  • Include a @since tag (default to 2.0.0)
  • Include an @example tag with a simple example
    • Imports should be relative for functional stuff and otherwise full urls with versions
    • Example should end with at least one assert from the deno std lib

baetheus avatar Sep 03 '22 00:09 baetheus

Fixed in #154

baetheus avatar Sep 17 '22 20:09 baetheus

Revisit after kind variance ticket

baetheus avatar Oct 01 '22 18:10 baetheus