Giter Club home page Giter Club logo

eslint-config's Introduction

@imhoff/eslint-config

My personal ESLint config.

This is meant to be used alongside Prettier (with @imhoff/prettier-config).

Usage

  1. Remove existing .eslintrc.* file, if present.

  2. Install eslint and the config.

    npm install -D eslint @imhoff/eslint-config
    
  3. Add the following to package.json:

    "eslintConfig": {
      "extends": "@imhoff/eslint-config/recommended"
    },

๐Ÿ“ You can also use the base rule set: @imhoff/eslint-config

With Prettier and @imhoff/prettier-config

  1. Set up Prettier and @imhoff/prettier-config.

  2. When using with Prettier and @imhoff/prettier-config, ESLint should run first. Set up your scripts in package.json like this:

      "scripts": {
        "lint": "npm run eslint && npm run prettier -- --check",
        "fmt": "npm run eslint -- --fix && npm run prettier -- --write",
        "prettier": "prettier \"**/*.ts\"",
        "eslint": "eslint . --ext .ts",
      }
    • npm run lint: for checking if ESLint and Prettier complain
    • npm run fmt: attempt to autofix lint issues and autoformat code

    ๐Ÿ“ Not every rule in this configuration is autofixable, so npm run fmt may continue failing until lint issues are addressed manually.

With Captain Hook

  1. Install captainhook:

    npm install -D captainhook
    
  2. Add the following to package.json:

    "hooks": {
      "pre-commit": "npm run lint"
    },

eslint-config's People

Contributors

imhoffd avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

rjshelley69

eslint-config's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.