Setting Up Node Environment

We will discuss the configuration needed for node using:

1. Typescript
2. ESLint
3. Prettier

Learning Goals

By the end of this tutorial, you will be able to

• Initiate a Typescript project
• Add relevant scripts
• Configure linters for the project
• Configure formatting for the project
• Extend additional rules, if you want

Creating a new project

> npm init -y

Installation

# install all ESLint & Prettier dev-dependencies
> npm i eslint --save-dev # linter (code analysis tool used to flag programming errors)
> npm i prettier --save-dev # opinionated code formatter
> npm i eslint-config-prettier --save-dev # Turns off all rules that are unnecessary or might conflict with Prettier.
> npm i eslint-plugin-prettier --save-dev # Runs Prettier as an ESLint rule and reports differences as individual ESLint issues.

# install 
> npm nodemon #nodemon is a tool that helps develop Node.js based applications by automatically restarting the node application when file changes in the directory are detected.

# install typescript and node support
> npm i typescript --save-dev
> npm i ts-node --save-dev # Enabling you to directly execute TypeScript on Node.js without precompiling. 

# install @types for all packages
> npm i @types/node --save-dev 
> npm i @typescript-eslint/eslint-plugin --save-dev 
> npm i @typescript-eslint/parser --save-dev 

OR everything together

npm i eslint prettier eslint-config-prettier eslint-plugin-prettier nodemon typescript ts-node @types/node @typescript-eslint/eslint-plugin  @typescript-eslint/parser --save-dev

Or with YARN

yarn add eslint prettier eslint-config-prettier eslint-plugin-prettier nodemon typescript ts-node @types/node @typescript-eslint/eslint-plugin  @typescript-eslint/parser --dev

Testing our changes

Create a src folder and inside create a index.ts file. This file can be deleted later, but for now, we are going to have some code in it so we can see the effect of our configurations.

In the index.ts file write:

var favoriteAnimal = "cat"
favoriteAnimal = "dog"

var name = "joe"

const user = {
   name: "john doe",
   age: 20
}

console.log("hello world!"

Configuration

We are going to configure ESLint, Prettier and Typescript using configuration files. Those files should be in the root folder:

Don't create tsconfig.json by yourself! instead use this command:

# create a tsconfig.json
> npx tsc --init 

Now, inside tsconfig.json, don't copy paste the following code, but look up those keys, and make sure they are uncommented and equal in value to the following keys:

For example, make sure that the key target is equal to es5.

tsconfig.json

{
	"compilerOptions": {
		"target": "es5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,           
		"lib": ["ES2018", "DOM"], /* Specify a set of bundled library declaration files that describe the target runtime environment. */,

		"module": "commonjs", /* Specify what module code is generated. */                     
		"allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
		"outDir": "./build", /* Specify an output folder for all emitted files. */,                  
		"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,


		"strict": true /* Enable all strict type-checking options. */,
		"noImplicitAny": true /* Enable error reporting for expressions and declarations with an implied 'any' type. */,
		"strictNullChecks": true /* When type checking, take into account 'null' and 'undefined'. */,            
		
		"skipDefaultLibCheck": true /* Skip type checking .d.ts files that are included with TypeScript. */,
		"skipLibCheck": true /* Skip type checking all .d.ts files. */
	},
	"exclude": ["node_modules", "tests"]
}

Feel free to check out other options for ts-config as well!

Go to index.ts and save the file. You should see the following changes:

1. var should change to let or const, depending if the variable was redefined)
2. You should see a warning under console.log saying Unexpected console statement.eslintno-console (at the end of the description, in the last line)

.prettierrc

Create a .prettierrc file inside root and copy the following code into the empty file:

{
       "printWidth": 120,
        "singleQuote": true,
        "tabWidth": 4,
        "useTabs": false,
        "editor.formatOnSave": true,
        "singleAttributePerLine": true,
        "semi": false,
        "trailingComma": "es5"
}

Feel free to check out other options for prettier as well!

printWidth can be changed to a smaller number if you want narrower code (it will break the line sooner) and to a larger number for a wider code lines.

Change tabWitdh to change the indentation (space between the start of the line and the code). Try changing it to 2 (default) or to 8. Then go to index.ts and save the file. You should see the different spaces' size.

.eslintrc

Create a .eslintrc file inside root and copy the following code into the empty file:

{
	"extends": [
		"plugin:@typescript-eslint/recommended",
		"prettier",
		"eslint:recommended",
	],
	"parser": "@typescript-eslint/parser",
	"plugins": ["@typescript-eslint", "prettier"],
	"rules": {
		"no-console": 1,
		"no-var": 2
	},
	"parserOptions": {
		"ecmaVersion": 2018,
		"sourceType": "module"
	},
	"env": {
		"es6": true
	}
}

Feel free to check out other options for eslint as well!

.gitignore

Create a .gitignore file inside root and copy the following code into the empty file:

node_modules

.eslintignore

Create a .eslintignore file inside root and copy the following code into the empty file:

node_modules

Configure IDE (vs-code)

Install Extension

ESLint: Will integrate ESLint erros into the IDE as you make them! https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint

Prettier: Will save your code every time you save the file! https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

• If the code is not being formatted on-save, there is an error in the code that needs to be solved first!

Configure Extensions

Open setting.json and add

{
 	"editor.defaultFormatter": "esbenp.prettier-vscode", // prettier as default!
	"editor.formatOnSave": true, // saving code will format it
 	"editor.formatOnPaste": true, // [optional]: pasting code will format it
	
	// Eslint
	"eslint.validate": ["javascript"],
	"editor.codeActionsOnSave": {
   	"source.fixAll.eslint": true
	},
 	
}

Scripting

// package.json

{
  "scripts": {
	"start": "nodemon index.ts",
	"build": "npx tsc",
	"lint": "eslint . --ext .ts",
	"prettier": "prettier --config .prettierrc 'src/**/*.ts' --write"
  }
}

TS to JS

npm run build

Bonus

Integrate ESLint into your GIT

Linting makes more sense when run before committing your code. By doing so you can ensure no errors go into the repository and enforce code style. But running a lint process on a whole project is slow, and linting results can be irrelevant. Ultimately you only want to lint files that will be committed.

https://github.com/okonet/lint-staged

Or, to keep it simple (read more):

> npm i husky --save-dev

Add to package.json:

{
  "husky": {
    "hooks": {
      "pre-commit": "yarn lint"
    }
  }
}

Read more

• Typescript: TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
• ts-node: Enabling you to directly execute TypeScript on Node.js
• typescript-eslint: Monorepo for all the tooling which enables ESLint to support TypeScript
• typescript-eslint: official docs
• eslint-config-prettier: Turns off all rules that are unnecessary or might conflict with Prettier.
• eslint-plugin-prettier: Runs Prettier as an ESLint rule and reports differences as individual ESLint issues.
• nodemon: nodemon is a tool that helps develop Node.js based applications by automatically restarting the node application when file changes in the directory are detected.