My OSD600 release 0.1

UrlStatusChecker, The first cli I build.

UrlStatusChecker is a command-line tool written in Node.js to check all the URL's status inside your local file. It prints good, bad, unknown, and broken / no response to the console. 

The current version is 0.1. 

Link to the repo: https://github.com/tianlangwu/urlStatusChecker

How to install UrlStatusChecker

Run the command using "npm i -g https://github.com/tianlangwu/urlStatusChecker"






Or download the files from https://github.com/tianlangwu/urlStatusChecker, then "run npm install -g pathName"(e.g., "npm install -g C:\Seneca\OSD600\Release0.1"). After download, you can also "cd" to the path directory then run npm install -g.


How to use UrlStatusChecker


Run the command using "urlstatuschecker Path\filename"(e.g., 
urlstatuschecker C:\Seneca\OSD600\Release0.1\test1.html).



Optional Features

1. URLs printed in colors depending on their status.

If the URL is good with the status code 200, it prints "GOOD" in green.

If the URL is bad with the status code 400 or 404, it prints "BAD" in Red.

If the URL is redirect to somewhere with the status code 301, 307, 308, it prints "Redirect" in Blue.

If the URL is broken or no response, it prints "Broken / No response" in White.


2. Support command line args.

-v / -version /v /version will show the Current version of urlStatusChecker. 


-u: Check the URL status directly(e.g., "urlstatuschecker -u http://www.google.com").



3. Support redirect HTTP result codes(301, 307, 308).

4. Allow passing multiple file paths


The language I use and the problem I got

I am using node.js to do my release 0.1 because I feel that "npm" and npm packages can make my project easier. However, this release 0.1 still took me a quite long time to finish. The main reason I got stuck is that I don't know how to find the URL in a text. I am so dumb that I didn't notice regular expression can solve this problem easily. I was trying to use the indexOf() function to find the first index of "http" and the next index of the quotation mark. This can only work for some html files because URLs in the html file usually has a quotation mark at the end of the URL. Philip from slack reminds me that I can try regex for the problem. Therefore, I googled a URL regex, and use match() function to get them into an array.

The third-party Package I use

I used three third-party Package which is "chalk", "sync-request" and "optimits". I use chalk to change the color of the output console, "sync-request" to send the synchronized request, and "optimist" to accomplish the command line arguments. 


Comments

Post a Comment

Popular posts from this blog

My PR for release 0.3 External Project

Image
 Picking the issue I am so glad to hear that we are allowed to work on repositories that  we have already worked on in the past. That means we don't need to spend time on set it up and learn the code. I decide to work on  issue-collab  since I am so familiar with the repository. Different than any other issue I have work on, I filed the new issue-76 myself and tried to create a pull request for it. The issue I filed is that add a scroll to the top button. I am trying to add the scroll to the top button into this issue-collab repository just like the one in Telescope. The owner of Issue-collab thinks this is a good idea too. Working on the issue The first time when I tried to work on it, I just tried to study the code from Telescope and some from google and playing the code around. I was so annoying that I can't put some code together successfully in React. After watched some React video, I realized that there are two different components which are Class components and Function
Read more

OSD600 Lab8

Image
OSD600 LAB8 In this lab, we were asked to add unit tests, code coverage analysis, continuous integration to my open source project  urlStatusChecker .  we were also asked to add Tests to Another project. Choose and Set Up a Testing Framework Since my command-line tool is written in javascript, I choose Jest as my testing framework. It is a famous javascript testing framework that works with projects using: Babel, Typescript, Node, React, Angular, Vue, etc. I  know that Jest contains a code coverage analysis as well, so it is the perfect option. I simply use the command " npm install --save-dev jest " to install it and start writing my unit test. Write My First Test I have never write any unit tests before. After I watched this week's video, I have a basic concept of what is unit testing, integration testing, end to end testing. I chose the  simplest   function  in my project to begin to write my first unit test.  const   goodUrl  = ( urlString )  =>  {    const   PATT
Read more

OSD600 -- Release 0.4.1 -- Choose Project and issues

Release 0.4.1 -- Choose Project and issues For this release 0.4, we keep contributing to the open-source projects with larger/more pull requests. The next couple weeks would be very busy for me and I don't want to spend too much time on finding projects, and setting developer environments, so  I chose to keep contribute to  Telescope  for my last release. I have checked all the issues on the Telescope repository, and I found one I really want to work on Issue-1416  Improve Mobile Usability by adding a bottom app bar Sadly, it was picked by one of my classmates.  However, there are some front-end enhancements/bugs that I can work on.  I will start my release 0.4 by adding/fixing those  enhancements/bugs and keep finding all  related   enhancements/bugs to improve the overall front-end of the project. These are the issues I am currently working on: Issue-1424  Fix font colours in GitHub Contributor component Issue-1426   Scroll To Top button doesn't move to correct position Issue
Read more