chore: add cl helper

[janniks]

This PR was published to npm with the version 6.5.1-pr.f11b880.0
e.g. npm install @stacks/[email protected] --save-exact

• closes [RFC] Cl bundled export #1444

summary

Adds a Cl bundled export that allows better discovery of clarity methods and less importing.

examples

NEW

import { Cl } from '@stacks/transactions'
const tup = Cl.tuple({ a: Cl.unit(2) })

VS previously

import { uintCV, tupleCV } from '@stacks/transactions'
const tup = tupleCV({ a: unitCV(2) })

---

discussion

I'm still in love with the idea to add the type-constructors in uppercase, e.g. Cl.Int(2) (lowercase Cl.false won't works since false is a keyword) and keep methods lowercase, e.g. Cl.serialize(...) to add more distinction (and potentially group more methods under a new namespace, similar to Buffer.from) -- but I realize it could be confusing.. 🤷‍♂ cc @hugocaillard @lgalabru

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
stacksjs-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 19, 2023 4:00pm

[codecov]

Codecov Report

Merging #1479 (f11b880) into master (0370bf6) will increase coverage by 0.23%.
The diff coverage is 97.72%.

@@            Coverage Diff             @@
##           master    #1479      +/-   ##
==========================================
+ Coverage   65.95%   66.18%   +0.23%     
==========================================
  Files         117      118       +1     
  Lines        8597     8621      +24     
  Branches     1898     1899       +1     
==========================================
+ Hits         5670     5706      +36     
+ Misses       2689     2677      -12     
  Partials      238      238              

Impacted Files	Coverage Δ
packages/common/src/utils.ts	41.52% <0.00%> (+0.34%)	⬆️
packages/transactions/src/clarity/deserialize.ts	94.28% <ø> (ø)
packages/transactions/src/clarity/serialize.ts	100.00% <ø> (ø)
...ckages/transactions/src/clarity/types/booleanCV.ts	100.00% <ø> (ø)
...ackages/transactions/src/clarity/types/bufferCV.ts	87.50% <ø> (ø)
packages/transactions/src/clarity/types/intCV.ts	100.00% <ø> (ø)
packages/transactions/src/clarity/types/listCV.ts	100.00% <ø> (ø)
...kages/transactions/src/clarity/types/optionalCV.ts	54.54% <ø> (ø)
...kages/transactions/src/clarity/types/responseCV.ts	100.00% <ø> (ø)
packages/transactions/src/clarity/types/tupleCV.ts	87.50% <ø> (ø)
... and 4 more

... and 2 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[hugocaillard]

LGTM, just small remarks regarding JSDocs.

I feel like Cl.trueBool and Cl.falseBool could almost be omitted (in favor of bool(true|false)). But I guess it makes sense to have them for completeness.

[janniks]

I sort of agree, I don't like the trueBool method -- leaving out for now, we can always add it again later