CircleCI-Public / circleci-config-sdk-ts

Generate CircleCI Configuration YAML from JavaScript or TypeScript. Use Dynamic Configuration and the Config SDK together for live generative config.
https://circleci-public.github.io/circleci-config-sdk-ts/
Apache License 2.0
82 stars 29 forks source link

docs: update code docs and styling #116

Closed KyleTryon closed 2 years ago

ghost commented 2 years ago
👇 Click on the image for a new way to code review - Make big changes easier — review code in small groups of related files - Know where to start — see the whole change at a glance - Take a code tour — explore the change with an interactive tour - Make comments and review — all fully sync’ed with github [Try it now!](https://app.codesee.io/r/reviews?pr=116&src=https%3A%2F%2Fgithub.com%2FCircleCI-Public%2Fcircleci-config-sdk-ts)

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map Legend

codecov[bot] commented 2 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (main@e57fcba). Click here to learn what that means. The diff coverage is n/a.

:exclamation: Current head 52e4f4b differs from pull request most recent head 1266325. Consider uploading reports for the commit 1266325 to get more accurate results

@@           Coverage Diff           @@
##             main     #116   +/-   ##
=======================================
  Coverage        ?   99.67%           
=======================================
  Files           ?       61           
  Lines           ?      614           
  Branches        ?       46           
=======================================
  Hits            ?      612           
  Misses          ?        1           
  Partials        ?        1           
Impacted Files Coverage Δ
src/index.ts 100.00% <ø> (ø)
src/lib/Components/Logic/exports/conditions/And.ts 100.00% <ø> (ø)
...c/lib/Components/Logic/exports/conditions/Equal.ts 100.00% <ø> (ø)
src/lib/Components/Logic/exports/conditions/Not.ts 100.00% <ø> (ø)
src/lib/Components/Logic/exports/conditions/Or.ts 100.00% <ø> (ø)
src/lib/Config/Pipeline/Git.ts 100.00% <ø> (ø)
src/lib/Config/Pipeline/Project.ts 100.00% <ø> (ø)
src/lib/Config/Pipeline/index.ts 100.00% <ø> (ø)
src/lib/Orb/exports/OrbImport.ts 100.00% <ø> (ø)
src/lib/Orb/exports/OrbRef.ts 100.00% <ø> (ø)

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