Hey everyone ๐
Hereโs my latest update on what Iโve been building, learning, and overcoming this past week as part of my journey as a software developer.
๐ก ๐ฃ๐ฟ๐ผ๐ท๐ฒ๐ฐ๐ ๐ฅ๐ฒ๐ฐ๐ฎ๐ฝ โ ๐๐ฒ๐๐ ๐ฆ๐๐ ( https://github.com/JackEcuyer/hevy-sdk )
I'm continuing to build out a TypeScript SDK for the Hevy API, aiming to support Node.js, browsers, and modern JavaScript frameworks. The goal is to improve the API ecosystem and gain hands-on experience with TypeScript tooling.
โ
๐ง๐ต๐ถ๐ ๐ช๐ฒ๐ฒ๐ธโ๐ ๐๐ถ๐ด๐ต๐น๐ถ๐ด๐ต๐๐
โข Configured Prettier formatting & configured husky to run formatting on pre commit
โข Added JSDoc style comments across codebase & used the TypeDoc package to generate documentation for the SDK
โข Published the TypeDoc documentation to Github pages on the SDK repository.
๐ ๐ช๐ต๐ฎ๐ ๐โ๐๐ฒ ๐๐ฒ๐ฎ๐ฟ๐ป๐ฒ๐ฑ
โข That JSDoc is a commenting convention designed for raw JavaScript, and using the TypeDoc package means I don't have to add typing to my doc comments, because the package automatically interprets TypeScript.
โข The prettier VSCode plugin will automatically search for a Prettier configuration file in your project and format accordingly.
โข That Github deployment to Github pages is incredibly simple when using a basic HTML website document.
โ ๏ธ ๐๐ต๐ฎ๐น๐น๐ฒ๐ป๐ด๐ฒ๐
โข Determining which package to use to generate documentation files from JSDoc comments. There are many different packages for different formats (Markdown, HTML).
๐ ๐ก๐ฒ๐
๐ ๐ฆ๐๐ฒ๐ฝ๐
Next steps include stricter typing for responses received from API fetch requests, integrating mock fetch requests into jest, and expanding SDK functionality to include 'Routines' endpoints.
If youโre into dev logs, personal projects, or learning in public - feel free to follow! Iโd love to hear what others are building too.
Top comments (1)