DEV Community

Jack Ecuyer
Jack Ecuyer

Posted on

๐Ÿš€ ๐—ช๐—ฒ๐—ฒ๐—ธ๐—น๐˜† ๐——๐—ฒ๐˜ƒ ๐—Ÿ๐—ผ๐—ด โ€“ ๐—ช๐—ฒ๐—ฒ๐—ธ ๐Ÿญ

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)