ctil VS go-go-web

Since git tags are snapshots of entire repositories, my initial GitHub release contained archives of my source code. This was unacceptable as users only require the final compiled executable. To make my executable available I had to edit my release and drag-and-drop the compiled executable (compressed into a .ZIP archive) into the release:

After adding the template, my first build failed due to the following error:

Another task I completed this week in open source was contributing to Roy's project by adding some unit tests. This was my first time contributing open source code in C++, and I am glad that Roy reached out to collab with me since I've been mostly working with Python/Java/JavaScript these days and I wanted to step out of my comfort zone. Roy created an issue for the tests he required and I submitted my PR which he later merged :)

For this lab exercise, I had to select and setup a testing framework to my Markdown-to-HTML converter, ctil.

In my previous blog post on Code Reading, I read the codebase of Docusaurus to research how the project implements Syntax Highlighting for fenced code blocks. My research taught me that Docusaurus actually uses Prism-React-Renderer, a third-party library, to provide Syntax Highlighting. This knowledge was useful because I wanted to add syntax highlighting to ctil, my Markdown-to-HTML converter, but didn't want to implement the feature from scratch. Although I can't use Prism React Renderer in my own project, researching Docusaurus gave me the idea to find a Open Source library I could use.

[metadata] name = gogoweb version = 1.0.3 author = Katie Liu author_email = [email protected] description = Command-line tool that converts .txt or .md files into .html files. long_description = file: README.md long_description_content_type = text/markdown url = https://github.com/kliu57/go-go-web project_urls = Bug Tracker = https://github.com/kliu57/go-go-web/issues classifiers = Programming Language :: Python :: 3 License :: OSI Approved :: MIT License Operating System :: OS Independent [options] package_dir = = src packages = find: python_requires = >=3.7 [options.packages.find] where = src

For this lab exercise I had the opportunity to add unit tests to a classmate's project and experience their CI workflow. For this exercise I worked on go-go-web by kliu57. Go-Go Web is written in Python and uses the pytest testing framework. This was my first time writing tests for pytest, but I found the pytest docs helpful. However, more helpful was the information provided in the associated issue and the tests already written, which helped me write the test I needed in the author's preferences.

This week, I am using Continuous Integration to automatically lint and test my open source project whenever the code is pulled or pushed to GitHub!

This week I want to add a new feature to my text to HTML converter, go-go-web. The feature I plan to add is Markdown Front Matter support. When a user converts an .md file to .html using my program, my program would be able to convert Front Matter in the .md file into metadata tag content in the resulting .html file.

I chose to write my program in Python while she used Java. Aside from syntax differences, she has much more exception handling in her code compared to mine. It made me think that I should add more exception handling to my own code. Having another person test my code definitely helps to find more issues. She discovered that I missed implementing the spec for deleting the default output folder at the start of the run. Also, she uses a VS Code extension called Pylint which helped to find many problems with my code. Pylint found many issues with my code which were not best practice, such as not specifying an encoding when reading from a file, or using an f-string that does not have any interpolated variables.