feat: create code snippets for api (#342)

[kacper-cyra]

Closes #342

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

coderscamp-website – ./

🔍 Inspect: https://vercel.com/coderscamp/coderscamp-website/2Uf2LQhPfEbSLzryvNdV6uTss64b
✅ Preview: https://coderscamp-website-git-issue-342-createcodesn-1520a2-coderscamp.vercel.app

coderscamp-storybook – ./

🔍 Inspect: https://vercel.com/coderscamp/coderscamp-storybook/A94PiDybNbq16p6aXG8t9HzY1Cca
✅ Preview: https://coderscamp-storybook-git-issue-342-createcode-6467b1-coderscamp.vercel.app

coderscamp-docs – ./

🔍 Inspect: https://vercel.com/coderscamp/coderscamp-docs/3wDnrfxBcqpdVGYLHCsDa7jV7CN1
✅ Preview: https://coderscamp-docs-git-issue-342-createcodesnipp-9d12bb-coderscamp.vercel.app

[codecov-commenter]

Codecov Report

Merging #396 (d8c2bf2) into main (23a9f2c) will increase coverage by 0.04%.
The diff coverage is n/a.

❗ Current head d8c2bf2 differs from pull request most recent head dafd9a4. Consider uploading reports for the commit dafd9a4 to get more accurate results

@@            Coverage Diff             @@
##             main     #396      +/-   ##
==========================================
+ Coverage   87.87%   87.92%   +0.04%     
==========================================
  Files         150      151       +1     
  Lines        1806     1830      +24     
  Branches      236      243       +7     
==========================================
+ Hits         1587     1609      +22     
- Misses        218      220       +2     
  Partials        1        1              

Flag	Coverage Δ
api	85.60% <ø> (ø)
ui	98.48% <ø> (-0.54%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ckages/ui/src/components/EventsCard/EventsCard.tsx	91.66% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 23a9f2c...dafd9a4. Read the comment docs.

[MateuszNaKodach]

@kacper-cyra Could you write in README or docs how to use it :) ?

[KrystianKjjk]

If you change snippet like I suggested below, then you can change that snippet to this:

Suggested change

	(pastEvents) => {{camelCase domainFunction}}(pastEvents, command),
	);
	{{camelCase domainFunction}}(command),
	);

[hkawalek]

Maybe, we can go even further and change applicationService.execute interface to sth like this.

this.applicationService.execute<{{properCase event}}>(
      eventStream,
      command,
      {{camelCase domainFunction}},
    );

Then inside execute we can map command to metadata and we don't need extra currying of domainFunction as proposed by @KrystianKjjk .
What do you think @nowakprojects ?

[KrystianKjjk]

It will be good to add automationModule generator which add this 4 required files ;)

[hkawalek]

Overall it looks good (it's cross-platform and it uses CLI, so it meets our requirements). If I were you, I would add some tests to give some kind of documentation, and what is more important, to protect from bugs if someone would like to change or add a new template. I would recommend you to use snapshot-testing and tmp.dir for that.

[hkawalek]

Maybe, we can go even further and change applicationService.execute interface to sth like this.

this.applicationService.execute<{{properCase event}}>(
      eventStream,
      command,
      {{camelCase domainFunction}},
    );

Then inside execute we can map command to metadata and we don't need extra currying of domainFunction as proposed by @KrystianKjjk .
What do you think @nowakprojects ?

[MateuszNaKodach]

Looks very good for me :)
Big thank you for initiative and implementation.
We can introduce change proposed by @HTK4 in ApplicationService. Of course it could be done in another task.
Snapshot testing for that would be awesome!