DLCheck Command Line Tool

 DLCheck (Dead Link Checker) is a command line tool made using NodeJS, this is the tool that I made for OSD-600 release 0.1, it reads a file and extracts the URLs contained in the file, then tests if the links are good or bad. Initially I thought this project would take a good amount of time to complete since this was my first time creating a command line tool, but thanks to the course Slack community, one of my classmates has shared an blog on how to create CLI tools using NodeJS, this blog helped and guided me to create the DLCheck tool in a timely manner.

How to Use the Tool:

DLChecker has been published to npm, to install the tool, simply run the command: npm install dlcheck -g to install the tool globally on your system.

In the CLI, users may use the command dlcheck globally (within any directory) followed by:

FILENAME (ie dlcheck FILENAME) or PATH/FILENAME to detect URL status included in the file.

Features:

After the links are tested by DLCheck, good links are returned in green, the bad ones are red, the ones with special errors such as timeouts(page takes too long to load) are blue and unknowns are grey.

Users may use the dlcheck command followed by any of (--v, --version, /v, /version) to check the version of DLCheck installed on the system.

Example Screenshot:






GitHub Repo:

The DLCheck project has been uploaded to GitHub, the source codes are available and licensed for everyone to view, clone and make changes to. Please find the GitHub repository here: https://github.com/Wei-J-Huang/dlcheck .


Comments

Post a Comment

Popular posts from this blog

Working on the Telescope Project

Image
Two weeks ago, I've had my first chance of working with the Telescope project and utilized it's back-end API to work with my DLCheck Project. In the past few days, I got more involved, played around and worked with Telescope's front-end portion. One of the issues that I found in the project repository got an idea from the Node.js webpage and requested for a React Component to display the contributors' information to thank them for their effort in developing/maintaining the Telescope project. In the beginning, I was a bit lost by reading the existing code, but luckily, the telescope project was developed using the React JS library and utilizes Material-UI framework, I have worked with a project which was also developed using the same tools during my Release 0.2 assignment, therefore, I was able to understand pieces of codes fairly quick. The new Card Component was overall not that hard to implement but it still took me a quite bit of time, I was given a custom React Hook...
Read more

Hacktoberfest -1

 This week the Hacktoberfest event has finally started and I had the chance to contribute to real open source projects. Finding an issue that I can fix took way longer than I thought it would, most of the issues were either taken or they were too complicated for a first time contributor. After a while of searching around GitHub repos with "good-first-issue" labels applied, I found a couple repositories that seemed interesting to me. One of the repositories requested for a new URL redirects in their projects, I thought this was an easy fix, but that it was more complicated than I thought it would be, the original repository had no instruction on how to run and test the application, therefore, I had to leave a comment in the issue asking for instructions. As it turns out a test must be written first before adding any code to the project, and when I ran the initial test before adding anything into the project, I was already getting testing errors, it seems like a challenging one...
Read more

Using Code Formatter and Linter

This week I was introduced to automated code formatting and linter to check for mistakes in code, I have heard of those tools before but never used them until this week. Those tools assisted me to maintain the code structure and readability, using those tools resulted in huge differences between the original project and "fixed project". To install Prettier, I followed their official installation instructions, which can be found here , and I did the same to install ESLint . There was a small problem that I ran into when I ran "eslint file.js" command, the system warmed that "eslint" is not a valid command, this was eventually solved by installing the eslint-cli, which was not mentioned in the official instructions. After I finished the set ups and configurated the tools, I ran the "script npx prettier --write ." to automate the formatting, this changed hundreds of lines in my .js files, I wasn't really surprised by this because I have always t...
Read more