lab9: Publish Link Checker Tool

-

This is the final lab in the OSD600 course. In this lab, I publish my command-line tool to a package so other users can use my tool! The package I chose is npm because the programming language I used is node.js. This is the detailed instruction of lab 9: https://github.com/Seneca-CDOT/topics-in-open-source-2020/wiki/lab-9

Firstly, I read a document from npm website to publish my tool. I ran 'npm init' and created node.js module. I've completed those steps quickly. However, there are two struggles I've got while I'm publishing my tool. One is from the npm account. Before I publish my tool, I should log in npm account. I can check whether I log in or not by entering 'npm whoami'. If I don't have an account, I need to create an account running 'npm adduser'. After verifying the email account, I can login using 'npm login'. The other struggle happened after I log in and tried to publish my tool. It made an error to publish it. I googled why it created an error and search Youtube and this Youtube gave me the answer: How to create and publish NPM Packages? The reason was my package name was not unique. I changed the package name on 'package.json' file and it finally allowed me to publish my tool!

My link checker npm package link (hyunji-link-checker): https://www.npmjs.com/package/hyunji-link-checker

After I've published my tool, I asked my friend to test whether my package works well or not. I gave her the test file and she shared her screen to show me how she followed the installation steps. Installing the package entering 'npm i hyunji-link-checker' works well! Testing each feature is also working well. The image below is the test result using my npm package. The images are the output when I've tested my tool.



npx hyunji-link-checker test.html


npx hyunji-link-checker --good test.html

npx hyunji-ink-checker -vs test.html

I didn't know publishing my tool doesn't take a long time like this. Creating tool takes lots of time but publishing. I'm so proud of myself my tool will help other people to check the broken link and I got confident my skill can contribute to other people. All labs I've got from this course are amazing and so useful! I will never forget the feeling I've got from this course.

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