Nighttime Peanut Migrations

    eslint-config-sanity

    6.0.0 • Public • Published

    eslint-config-sanity

    Shared eslint rules for official Sanity.io projects

    Installing

    npm install --save-dev eslint-config-sanity

    Usage

    Create an .eslintrc in the root of your project (or an eslintConfig entry in package.json) and extend the sanity config:

    {
      "env": {"node": true, "browser": true},
      "extends": ["sanity"]
    }

    Adjust env according to your use case, obviously.

    Usage: React

    ESLint requires plugins to be peer dependencies (they resolve relative to the end-user project), as such you need to install an additional dependency if you're using React:

    npm install --save-dev eslint-plugin-react

    Then, make sure to extend sanity/react in your .eslintrc:

    {
      "extends": ["sanity/react"]
    }

    Note: It's not necessary to extend both sanity and sanity/react - extending sanity/react will implicitly extend sanity first.

    Note: If you're using TypeScript and React, make sure you extend sanity/react before sanity/typescript:

    {
      "extends": ["sanity/react", "sanity/typescript"]
    }

    Usage: Typescript

    ESLint requires plugins to be peer dependencies (they resolve relative to the end-user project), as such you need to install a few more dependencies if you're using typescript:

    npm install --save-dev \
      typescript \
      @typescript-eslint/parser \
      @typescript-eslint/eslint-plugin

    Then, make sure to extend sanity/typescript in your .eslintrc:

    {
      "extends": ["sanity/typescript"]
    }

    Note: It's not necessary to extend both sanity and sanity/typescript - extending sanity/typescript will implicitly extend sanity first.

    Note: If you're using TypeScript and React, make sure you extend sanity/react before sanity/typescript:

    {
      "extends": ["sanity/react", "sanity/typescript"]
    }

    License

    MIT © Sanity.io

    Install

    npm i eslint-config-sanity

    DownloadsWeekly Downloads

    2,646

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    22.5 kB

    Total Files

    11

    Last publish

    Collaborators

    • nina.andal
    • rankers
    • snorreeb
    • mattcraig
    • dkhuntrods
    • vincentquigley
    • stipsan
    • michael-sanity
    • rubioz
    • tonina
    • ritasdias
    • simeonsanity
    • kmelve
    • ricokahler
    • bjoerge
    • rexxars
    • skogsmaskin
    • simenss
    • hdoro
    • robinpyon
    • mariuslundgard
    • sanity-io
    • evenw
    • radhe_sanity
    • rbotten
    • vicbergquist
    • judofyr
    • obliadp
    • dcilke
    • fredcarlsen
    • jorn_georg
    • hermanw
    • svirs
    • mikolajsanity
    • sgulseth
    • atombender