Develop Url Checker Open Source Named Url-fi

-

This is a post to document my journey to create an URL checker command-line tool. There are various languages I can use to create this tool such as NodeJS, Go, and Java. I chose NodeJS as a language and worked on creating it under Unix. I created a GitHub public repository to push my codes so other people can review or test my tool.

When I completed my tool, I asked to review and test my code on Slack. Mr. David Humphrey and Mr. Calvin Ho gave me some directions to improve my code. The following are the things they ask me to change

  • Change all var variable type to let variable type. Also, if the value is not going to change, use const variable type
  • Move the regex (data type: const) to the top
  • If I need to check error with other conditions, check error early and then check others
  • The async function is not needed
  • I don't need to cover 'finding the error and exit the process' code into if statement because if I exit the process, it's already done

It was really interesting to discuss the things I can improve. Some of the things such as changing the variable type and moving the regex to the top are the ones I already know. However, I did not catch them when I wrote my code. Some other things are the ones I did not think while I'm writing the code. I realize I can learn much more if I show my code to other people and ask them to review it.


After I got checked my code to them (Mr. David Humphrey and Mr. Calvin Ho), Kimin Lee who met on Slack suggested reviewing each other's code and file issues into our repository. As we used the same language (NodeJS) to create the tool, it seemed goot to work together. I looked over Kimin's project (https://github.com/klee214/findBreakURL) and Kimin looked over my project (https://github.com/hyunjiLeeTech/URL-FI). When I looked over his project, it was impressed that people can write different codes using the same language. He and I used different modules. Also, the way of his coding and the way of my coding was different.


These are the issues I filed to his project

  1. Spelling and content on README (https://github.com/klee214/findBreakURL/issues/1): There is one spelling mistake. He wrote 'description' to 'describtion'. Also, The tool should handle all types of files not only HTML files. However, he only mentioned HTML files on README
  2. Regex issue (https://github.com/klee214/findBreakURL/issues/2): He wrote the constant type of regex pattern in the middle of the file. I request him to move it to the top
  3. Types of files to be handled (https://github.com/klee214/findBreakURL/issues/3): The tool should handle all types of files but it only handles HTML file. I ask him to fix it to get all types of files


These are the issues Kimin filed to my project

  1. Linux common command-line options (https://github.com/hyunjiLeeTech/URL-FI/issues/1): The way I get the version argument was --v or --version. Kimin said --version is for Window but -v is for Linux so -v is more appropriate for my tool. I accepted this
  2. Error: getaddrinfo ENOTFOUND (https://github.com/hyunjiLeeTech/URL-FI/issues/2): As I make the process throw the error when the program creates an error, this tool does not check other links once it has an error. I decided to print out the error not throw the error
  3. Possible skipping the link issue (https://github.com/hyunjiLeeTech/URL-FI/issues/3): He said there's one case my tool skip the link. However, it does not happen to me and another person I asked to test. I decided to close this issue for now.

It was amazing how others can discover the things I missed. I've learned a lot from others and I get confident my knowledge can be helped to their project. I had lots of fun fixing all issues.

Comments

Post a Comment

Popular posts from this blog

Lab 8: Automated Testing and Continuous Integration

-
When I developed a program, it was time-consuming to test all the functions I created when I add a feature. I needed to run each feature, check whether it gives expected output or not, and check all the output. It is possible I forgot to test a feature and later on, I realize I did not test the feature. I wonder if there any ways I can do it automatically. Now, I got the way how to do that. There is automated testing for it! To begin with it, I started searching the testing framework to apply my command-line tool named url-fi. There are some testing frameworks for Node.js such as Jest, Mocha, and AVA. The testing framework I chose is  Jest  which is a testing framework developed by Facebook. I've installed Jest running 'npm install --save-dev jest' and test whether it works properly or not.  This document  is the way I followed to install the Jest testing framework. After I've installed the Jest testing framework, I worked on separating functions. As my tool contains al
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 project
Read more

Release 0.3: External Project (Hasura GraphQL Engine)

-
For Release 3.0, I need to create two pull requests, one for internal Seneca College's project named Telescope and the other for an external project. This post is about the journey of the external project.  After I've created a pull request for the internal project, I started finding an external project I can work on. There are thousands of issues on GitHub but I need to find a project which is bigger than I've worked for the release 0.2. To find a bigger project, I read the issues which have a number bigger than 100. I found some issues and asked whether I can work on it or not. Finally, I found a project I can work on named Hasura.  Project name: Hasura GraphQL Engine GitHub link: https://github.com/hasura/graphql-engine When I looked around this project, I was surprised by how big this project and how many people contributed to this project. I would like to contribute to this project so started to read a README.md file and a contributing guide. When I scrolled down the R
Read more