Use Static analysis tools in Lab7

 This week we learn to manage our projects using Static analysis tools. Static analysis tools help us maintain the quality of our source code by fixing formatting issues, spotting suspicious coding constructs, or alerting us to common errors. Now I use my testLink project to practice these tools.

Create a CONTRIBUTING.md File

First, I create a CONTRIBUTING.md file to separate the setup and development content from README.md file.

Add a Source Code Formatter

I pick Prettier formatter for my JavaScript project. Following the instruction, I use the command "npm install --save-dev --save-exact prettier" to install the tool. After installing, I use the command "npx prettier --write ." to formate all my files and "npx prettier --check ." to check the files if there are some wrong formation. I also set the ".prettierrc.json" and ".prettierrcignore" file.

Then, I create a simple "one-step" solution for running my formatter in package.json file.


Add a Linter

I choose to install ESLint linter for my project.  Following the instruction, I use the command "npm install eslint --save-dev" to install the tool. Then I use "npx eslint --init" command to set up a configuration file and set some rules for my project in the ".eslintrc.json" file.


When I use "npx eslint ." to check my project, I find there are some errors and I use "npx eslint . --fix" command to fix some errors automatically and fix the other errors manually by myself. Then,  I create a simple "one-step" solution for running my linter in package.json file.


Editor/IDE Integration

For this part, I install the extensions in my vscode and set my settings in the "settings.json" and "extensions.json" files.




In the above steps, I commit the changes for every step. After making code changes, I rebase and squash all the commits to a single commit. Then I merge it with my master branch and push them to my GitHub repo.







Comments

Post a Comment

Popular posts from this blog

Choose a project in Release 0.4

 Release 0.4 is my fourth assignment for OSD600 course. There are three steps to complete it. The first step is to choose a project which you will work with. The second step is to update the process about the work. The last step is to show my result for the project. Because it is close to my test week. I don't have enough time to search for a new suitable project. So, I decide to work with the former project in this course. Actually I plan to work with my link checker project . I had designed some features which can be used to test if a link work well. But I think there are still something which I can promote. This is true for every IT project, and you can continually improve the project to make it better and better. In the first assignment for this course, my professor list many optional features which can be designed into the link check project. I will choose one of them which I don't complete to further refine my project.
Read more

Open source development course

 I'm Leon and a student of Computer Programming & Analysis program in Seneca College. I am taking OSD600 course of this semester in Toronto .   I am vey interesting in the open source. The course is my opportunity to know more things about it.  Open source development can provide us the opportunities to work with the developers around the world.  Open source technology and open source thinking also can benefit everyone, not only programmers. I want to study the open source tools and accumulate the development experience of real software project. I'm gonna search for commercial service development projects to understand the requirements of a business project. The GitHub trending repo I research is  Rocket.Chat . It is Open Source Solution for team communications.  Instant messaging is a widely used network application. I want to know how to develop this kinds of softwares. I'm gonna share my learning process with this course during this semester in my blog. I'd like
Read more

Publish project in Lab 9

Image
This week we start to practice how to release your project into public. In this way, the users don't need to clone  and build your project to run it locally. They can install it globally and use it easily. In this lab, I utilize my link checker project to practice to release it. Because my project was written by Node.js, so I choose npm platform to create my release.  First of all, I read the npm documents and check my project files step by step. I make sure the package.json file includes everything required such as name, version, dependencies, scripts, author and so on. After modifying all the things, I push these changes into my GitHub. Second, I create an account in npm website . It  is a necessary step if you want to publish your project into npm platform. Then,  I us e the command "npm login" to login the npm platform. After that, I use the command "npm push" to release my project. In the first release operation, there is a 403 error which shows " Yo
Read more