Eslint is a linter which enforces developer to write good and consistent code all over Project. Prettier is a good formatter tool that automatically formats the source code.

Setup Eslint, Prettier with TypeScript and React

Eslint is a linter which enforces developer to write good and consistent code all over Project. Prettier is a good formatter tool that automatically formats the source code.

In this blog, I will teach you, how to set up eslint, prettier with TypeScript and React. Even if you are not using TypeScript or react you can still follow along.

I have already created a video about it on my youtube channel. Check that out for more details.

If you like this video, please like share, and Subscribe to my channel.

For react, I will use Nextjs. Again the principles are the same. You can also use it with create-react-app.

Editor setup

You need to install eslint and prettier plugins for your editor. To learn more, visit these links. Eslint Prettier

Setup

yarn create-next-app

Then put your app name. I am going to call it eslint-prettier-typescript-react

After that, it will set everything for you.

Now change the directory to the folder.

cd eslint-prettier-typescript-react

TypeScript setup for Nextjs (optional)

Create a tsconfig.json file.

touch tsconfig.json

Install typescript packages.

yarn add --dev typescript @types/react

Then start the server.

yarn dev

It will fill up the tsconfig.json file. Now convert all the javascript files to typescript files.

Setup Absolute import

Absolute Import vs Relative Import

Alt Text

Inside the tsconfig.json file. create a new property baseUrl and set the import point. I will create an src folder and put all source code inside that.

So add this extra code:

{
"baseUrl": "src/"
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "src/"],
}

Setup eslint

  • Install eslint globally on your computer.
yarn global add eslint
  • Inside your project initialize eslint.
eslint --init
  • Choose 3.

Alt Text

  • Choose 1

Alt Text

  • Choose your framework if you are using it. In my case react

Alt Text

  • If you are using TypeScript then yes. I am using TypeScript.

Alt Text

  • Browser in my case.

Alt Text

  • Use a popular style guide.

Alt Text

  • I would like to use the Airbnb style guide. You can choose any style guide. But Airbnb is good and I recommend it.

Alt Text

  • I will use json for my config file.

Alt Text

  • It will ask you to install some packages to Install with npm. If you want to use npm then go ahead. But I will use yarn.

Alt Text

So For those who are using yarn like me, You can copy and paste package names and install them.

With typescript:
yarn add --dev eslint-plugin-react @typescript-eslint/eslint-plugin@latest eslint-config-airbnb@latest eslint eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react-hooks @typescript-eslint/parser@latest
Without typescript:
yarn add --dev eslint-plugin-react eslint-config-airbnb@latest eslint eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react-hooks

It will create an eslint config file .eslintrc. It will be a hidden file.

Prettier Setup

  • Let's install prettier.
yarn add --dev eslint-config-prettier prettier
  • Create a prettier config file.
touch .prettierrc.json

Now you can put your config in the .prettierrc.json file in json format. You can find the options from here

My basic config for prettier.

{
"singleQuote": true,
"useTabs": true,
"tabWidth": 1,
"semi": false,
"jsxSingleQuote": true,
"arrowParens": "avoid"
}

Now we are done with prettier. Let's set up eslint config.

ESlint config setup

Your .eslintrc file should look like this.

{
"env": {
"browser": true,
"es2021": true
},
"extends": [
"plugin:react/recommended",
"airbnb"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 12,
"sourceType": "module"
},
"plugins": [
"react",
"@typescript-eslint"
],
"rules": {
}
}

We need to extend the eslint config with prettier. So add prettier to extends array.

{
"extends": [
"plugin:react/recommended",
"airbnb",
"prettier"
],
}
Let's fix some eslint errors

To turn any rule off or on, add the rules to the rules array. You can find the docs from here. Please watch my video to understand it well.

  • allow jsx on other extensions.
{
"rules": {
"react/jsx-filename-extension": [
1, { "extensions": [".js", ".jsx", ".ts", ".tsx"] }
]
}
}
  • File extension on import statement.
{
"rules": {
"import/extensions": [
"error",
"always",
{
"js": "never",
"jsx": "never",
"ts": "never",
"tsx": "never"
}
],
}
}
  • Import unresolved error for absolute import(if you are using).
{
"settings": {
"import/resolver": {
"node": {
"extensions": [".js", ".jsx", ".ts", ".tsx"],
"moduleDirectory": ["node_modules", "src/"]
}
}
}
}

You can find my Eslint config from here

So, that's it for today. I hope I have covered everything that you need to know about how to set up.

Shameless Plug

I have made a video about how to build a carousel postcard with React, Material-UI, and Swiper.js. If you are interested you can check the video.

You can also demo the application form here

Screenshot of Insta Carousel

Please like and subscribe to Cules Coding. It motivates me to create more content like this.

If you have any questions, feel free to contact me on any social media as @thatanjan. Stay safe. Goodbye.

About me

Why do I do what I do?

The Internet has revolutionized our life. I want to make the internet more beautiful and useful.

What do I do?

I ended up being a full-stack software engineer.

What can I do?

I can develop complex full-stack web applications like social media applications or e-commerce sites.

What have I done?

I have developed a social media application called Confession. The goal of this application is to help people overcome their imposter syndrome by sharing our failure stories.

Screenshot

Homepage

More screenshots

I also love to share my knowledge. So, I run a youtube channel called Cules Coding where I teach people full-stack web development, data structure algorithms, and many more. So, Subscribe to Cules Coding so that you don't miss the cool stuff.

Want to work with me?

I am looking for a team where I can show my ambition and passion and produce great value for them. Contact me through my email or any social media as @thatanjan. I would be happy to have a touch with you.

Contacts

Blogs you might want to read:

Videos might you might want to watch:

Previous Post13 reasons why you should use Nextjs
Next Post10 reasons why I love Material-UI