Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.05 KB

README.md

File metadata and controls

63 lines (47 loc) · 2.05 KB
Raw

Typescript & React Starter

Table Of Contents
  1. Why
  2. What the config does
  3. Setup
  4. Context API

Why ESLint

ESLint is the one of the most widely-used linting tools in web development. It’s an invaluable tool for keeping the team’s code consistent by ensuring everyone is following the same style conventions.

What the ESLint Config Does

Lints (with ESLint) based on the latest Airbnb standards (eslint-config-airbnb)

Lints and fixes on every save (with Prettier)

Setup

  • To install all dependencies, head over to your terminal and run the below command: yarn install or npm install
  • To run locally watching for changes: yarn start or npm run start

Install ESLint and Prettier extensions via Code > Preferences > Extensions.

In the settings.json file, add the following lines:

  "editor.formatOnSave": true,
  // turn it off for JS and JSX, we will do this via eslint
  "[javascript]": {
    "editor.formatOnSave": false
  },
  "[javascriptreact]": {
    "editor.formatOnSave": false
  },
  // tell the ESLint plugin to run on save
  "eslint.autoFixOnSave": true,
    // If you have the prettier extension enabled for other languages, turn it off for JS since we're already doing this with ESLint
  "prettier.disableLanguages": [
    "javascript",
    "javascriptreact"
  ],
  "javascript.updateImportsOnFileMove.enabled": "always",
  "editor.suggest.snippetsPreventQuickSuggestions": false,
  "typescript.updateImportsOnFileMove.enabled": "always",

Restart VSCode

Note: The ESLint extension for VSCode relies on node_modules/eslint, so make sure you have run yarn before restarting VSCode.

Context API

This project uses the React Context API along with React Hooks and more specifically the native React.useReducer hook. To see how it works, head over to the GlobalContext file.