Link Check Open Source: url-fi

-

Introduction

Url-fi is a command-line tool written in NodeJS for finding and reporting dead links in a file. Users might use this tool to help locate broken URLs in any type of file (e.g., HTML, text file). This is the GitHub repository you can get my codes: https://github.com/hyunjiLeeTech/URL-FI




How to set up the tool

  1. Copy and paste the link into a terminal or visual studio code with the following command: git clone https://github.com/hyunjiLeeTech/URL-FI.git
  2. To start the tool, use the cd command to make sure you are in the correct folder and then install all the dependencies using the npm command: npm i
  3. Enter the command to start the tool. You need to mention the file name.


Usage

url-fi [argument(s)] [filename]


Arguments

  • -v: Running the tool with v argument prints the name of the tool and its version
  • -s: Running the tool with the s argument checks both http:// https://
  • -h: Running the tool with the h argument prints the usage of this tool


Features

  • Colorized output. Good URLs should be printed in green, bad URLs in red, and unknown URLs in gray & running the tool with the v argument should print the name of the tool and its version
  • Add a command-line flag to allow checking whether http:// URLs actually work using https://
  • Optimize network code so that this tool only request headers vs. downloading full bodies


Examples of how to use this tool

-v



-s 



-h



License

Distributed under the MIT License

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