Lab5: Refactor the code to improve maintainability

-

Thanks to the people's contributions to my link-checker command-line tool named url-fi, my tool gets a huge improvement. However, it has some coding style inconsistent because my code has other people's code as well. I took some time to walk through my link-checker tool and made some refactoring.

There are five commits I add to improve my code

  • Move the global variable to the top
  • Add comments to the variables and functions
  • Rename variable name
  • Erase unnecessary code
  • Update help message

Firstly, I found some global variables named rFlag, ignore, ignoredLink was located in the middle of the file. Therefore, I move those variables on the top of the file. Secondly, I added comments to the variables and functions so other people can easily get what my code is. Thirdly, I renamed variable names ignore to iFlag to make the variable name consistent. Fourthly, I erased unnecessary code. There was code duplicate that the process.exit(1) and the process.exitCode=1 was written in a row. As the process.exit(1) already made the process.exitcode 1 and then exited the program, the process.exitCode=1 is unnecessary. Finally, I got the help message my tool display is out of date so I updated the message.

The git log after I've committed all the commits are the following.

I rebased the commits to squash those five commits into one commit and these are the images to squash them. I entered 'git rebase master -i' to squash them.

The git log after I've squashed all the commits is the following

The git log after I've amended my commit is the following: 

The merge commit URL after I've merged my refactoring branch is the following: https://github.com/hyunjiLeeTech/URL-FI/commit/e7bcb976c0a703e504a0ad15ad8e3659c4739079

I did not get any errors and conflicts to follow these steps. Also, the concept of refactoring was interesting. I felt it is powerful. Also, I did not know I can amend the commit message so the process of the rebase and the amend message was really impressive. I had confidence I can do better in the future when I need this knowledge.

Comments

Post a Comment

Popular posts from this blog

Release 4.0 - Part 3: Release

-
In this post, I am going to describe the journey of the release 4.0. Release 4.0 is the 3 weeks project. In the first week, I chose the project to work on. As the issue I chose required knowledge I do not have any idea (Gatsby and Nextjs), I need to learn these. In the second week, I learned the Gatsby and Nextjs to read the document on the Next official website. Also, I checked the pull request other people already created for the project. And this week, I started writing codes to resolve the issue. It was hard to begin to migrate the pages from Gatsby to the Nextjs. I needed to google a lot to find the proper way to migrate the code for the project. The components I was assigned are Error page, SEO, and SearchHelp components. The SEO component is relatively easy because the Next official website indicated how to do it most. However, the Error page is the most difficult part for me. When I googled how to make the Nextjs Errorpage, most people recommend to use the JavaScript extension ...
Read more

Hacktoberfest: Second Pull Request - wanikani-notifier

-
 This post describes the journey of the second pull request for Hacktoberfest which encourages new people to get involved in the open-source community. The post for the first pull request for Hacktoberfest is the following:  https://hyunjijanelee.blogspot.com/2020/10/hacktoberfest-first-pull-request-tower.html In this time, I have struggled to find an issue to work on. Most of the issues I would like to work on are already taken to another person and other issues have some problems on the project so I cannot run it properly. I kept finding a proper project and found one project named wanikani-notifier. The link for the wanikani-notifier is the following:  https://github.com/upsetdog/wanikani-notifier When I found an issue with this project, I cloned the project to check whether I can run this project. At that time, I found it has another issue to make it better. On this project, there is no 'package-lock.json' file so users need to install modules checking what modules ar...
Read more

Open Source Project: Lab2 (Pull Request)

-
Image
 Introduction In this lab, I practiced contributing and submitting pull requests to other repositories I don't own. Following the lab instruction , the things I plan to practice are the following: forking and cloning other projects creating branches to work on new features and fix bugs working on code I didn't write, trying to maintain the original style and not break things creating pull requests collaborating with other developers on GitHub updating my pull requests to include fixes for review comments The Project I picked for pull request ( https://github.com/lixiaoqity/testLink/pull/7 ) I looked around the classmates' open source project and picked the project named testLink. The GitHub repository link is the following:  https://github.com/lixiaoqity/testLink/pull/7 .  I picked this project because it also uses the NodeJS which I picked for my project. It was really interesting to see how code can be written differently for the same subject. When I look over the proje...
Read more