Voice of a Developer: JavaScript JSLint v1

We will begin this article by reading this phrase "The Software shall be used for Good, not Evil." - Wikipedia

We will discuss in this section about how to write good code. Our code shall be clean, beautified, and other programmers are able to read & understand it; rather debug it. In order to achieve that we will look into the process of linting and then apply in the context of JavaScript.

Lint

It is a tool, which is used to flag code quality. It takes source code and find issues in it. This tool is available for many programming languages like C, PHP, etc. Linting is a process of running a program that will analyze code for potential errors.

As JavaScript is so popular and widely used, a lint for JavaScript is needed. In JavaScript, I am a fan of JSLint. This tool was developed by Douglas Crockford http://www.crockford.com/. Let us, deep-dive, into this tool.

JSLint

JSLint is a code quality tool for JavaScript. There are various advantages of this tool:

Provide another pair of eyes at your code
Another layer of language on top of JavaScript
Helps you write better JavaScript
Reject the code which claims that it is perfectly fine
Reduce error and give perfect code

URL: http://www.jslint.com/

You can use an online version of JSLint and paste your JavaScript code & test it.

Here is a simple f1() function and we will validate in JSLint

The above will validate perfectly fine and this code will sail perfectly. To see how JSLint helps let me modify code & generate warnings:

It is so fantastic to do statistical analysis of your code so quickly! If we review four warnings, three are related to ‘whitespace’. One grabs my attention is

Expected ‘” use strict”: ‘before ‘var’. line 2 column 5

What is ‘use strict’?

We have not talked about ‘use strict’ rule so far. Nevertheless, this is an instruction that JavaScript code should be executed in ‘strict mode’. This directive was introduced in ECMAScript 5. You can define scope of ‘use strict’ to the beginning of a script (global scope) or a function but you cannot keep it within block statements enclosed in {} braces. The below picture could explain it better.

Advantages of script mode are

Avoid created an undeclared variable
Cannot duplicate variable
Avoid mistyping a variable to avoid a global variable declaration

In the above example ‘y’ was not declared but referred, hence it caused below error ‘y is not defined’. Switch gear back to JSLint now 

Other examples where JSLint could help in finding issues in code:

Declaring variable again: In JavaScript if you declare variable again it does not pose any problem, as we know JavaScript uses ‘hoisting’, closures model. As good programmers, we shall not re-declare or duplicate variable declaration in the same scope. Take a look at below code:
1. // fahrenheit to celsius code
2. 'use strict';
4. function toFahreheit(celsius)
5. {
6. var celsius = celsius;
7. var F = celsius * 9 / 5 + 32;
8. return F;
9. }

Upon execution, JSLint will give below message:

Summary

There are various advantages of JSLint and it helps programmers a lot. In the next article, I will talk about various options associated with it & how useful these are. Much more is coming in the ‘Voice of developer’ series; please share your feedback/comment below.

Voice of a Developer: JavaScript JSLint v1 - Part 22

Introduction

Lint

JSLint

What is ‘use strict’?

Advantages of script mode are

Summary