ESLint and Prettier setup for Tilt ✨⚙

These are the settings for ESLint and Prettier followed by the Tilt codebase.

What it does

• Lints JavaScript based on the latest standards
• Fixes issues and formatting errors with Prettier
• Lints + fixes inside of HTML script tags
• Lints + fixes React via eslint-config-standard-react
• You can see all the rules here

Installing

You can use ESLint globally and/or locally per project.

It's usually best to install this locally once per project, that way you can have project specific settings as well as sync those settings with others working on your project via git.

You can also install globally so that any project or rogue JS file you write will have linting and formatting applied without having to go through the setup.

Local/Per Project Install

1. If you don't already have a package.json file, create one with npm init.

2. Then we need to install everything needed by the config:

npx install-peerdeps --dev eslint-config-tilt

3. You can see a big list of devDependencies in your package.json now.

4. Create a .eslintrc file in the root of your project's directory (it should live where package.json does). Your .eslintrc file should look like this:

{
  "extends": [
    "tilt"
  ]
}

Tip: You can alternatively put this object in your package.json under the property "eslintConfig":. This makes one less file in your project.

5. You can add two scripts to your package.json to lint and/or fix:

"scripts": {
  "lint": "eslint .",
  "lint:fix": "eslint . --fix"
},

6. Now you can manually lint your code by running npm run lint and fix all fixable issues with npm run lint:fix. You probably want your editor to do this though.

Global Install

1. First install everything needed:

npx install-peerdeps --global eslint-config-tilt

2. Then you need to make a global .eslintrc file:

ESLint will look for one in your home directory

• ~/.eslintrc for macOS
• C:\Users\username\.eslintrc for Windows

Your .eslintrc file should look like this:

{
  "extends": [
    "tilt"
  ]
}

3. To use from the CLI, you can now run eslint . or configure your editor.

With VS Code

Once you have done one, or both, of the above installs. You probably want your editor to lint and fix for you. Here are the instructions for VS Code:

1. Install the ESLint package
2. Now we need to setup some VS Code settings via Code/File → Preferences → Settings. It's easier to enter these settings while editing the settings.json file, so click the {} icon in the top right corner:

  // These are all my auto-save configs
"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,
// Optional BUT IMPORTANT: If you have the prettier extension enabled for other languages like CSS and HTML, turn it off for JS since we are doing it through Eslint already
"prettier.disableLanguages": ["javascript", "javascriptreact"],

🤬🤬🤬🤬 IT'S NOT WORKING

Start fresh. Sometimes global modules can goof you up. This will remove them all.

npm remove --global eslint-config-tilt babel-eslint eslint eslint-config-prettier eslint-config-standard eslint-config-standard-react eslint-plugin-html eslint-plugin-prettier eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react prettier eslint-plugin-react-hooks

To do the above for a local project:

1. Omit the --global flag and remove all packages:

npm remove --global eslint-config-tilt babel-eslint eslint eslint-config-prettier eslint-config-standard eslint-config-standard-react eslint-plugin-html eslint-plugin-prettier eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react prettier eslint-plugin-react-hooks

2. Remove your package-lock.json file and delete the node_modules directory.

3. Follow the setup instructions again.

Credits

This project was derived from No-Sweat™ Eslint and Prettier Setup by Wes Bos.