Norwegian Polka Music

    eslint-config-nrk

    5.1.0 • Public • Published

    eslint-config-nrk Build Status Coverage Status npm version

    A shared ESLint configuration for and by JavaScript developers at NRK.

    Installation

    Get started by running this command in the root of your project (npm is also supported):

    yarn add eslint eslint-config-nrk --dev

    Then add an .eslintrc.json file to the root of your project (see Documentation below) before running the eslint command, with the following:

    {
      "extends": [
        "nrk"
      ]
    }

    NOTE: eslint plugins are available for most modern text editors, like Atom, emacs, vim, Sublime Text, etc.

    Documentation

    Basic configuration

    eslint is configured by adding an .eslintrc.json file to the root of a project where env and extends are specified. Refer to the eslint documentation for more configuration options.

    The following example shows a typical setup for linting both browser and Node.js (CommonJS) code:

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

    React configuration

    For supporting React projects, also add the nrk/rules/react extension:

    {
      "env": {
        "browser": true,
        "node": true
      },
      "extends": [
        "nrk",
        "nrk/rules/react"
      ]
    }

    Then install eslint-plugin-react:

    yarn add eslint-plugin-react --dev

    JSX

    For supporting JSX, also add the nrk/rules/jsx extension:

    {
      "env": {
        "browser": true,
        "node": true
      },
      "extends": [
        "nrk",
        "nrk/rules/react",
        "nrk/rules/jsx"
      ]
    }

    It is necessary to configure eslint to lint files matching the .jsx extension:

    eslint . --ext=.js,.jsx

    Please note that the nrk/rules/jsx configuration is always using the latest version of React. When using an older version, please refer to the eslint-plugin-react documentation.

    Legacy ES5 projects

    This configuration is available as a way of migrating to a more modern codebase (recommended).

    {
      "env": {
        "browser": true,
        "node": true
      },
      "extends": [
        "nrk/es5"
      ]
    }

    Keywords

    none

    Install

    npm i eslint-config-nrk

    DownloadsWeekly Downloads

    24

    Version

    5.1.0

    License

    MIT

    Last publish

    Collaborators

    • suxiang
    • norasv
    • eschoien
    • unaons
    • trulsl
    • syndrol
    • henit
    • mslhm
    • cbjerkan
    • hermangudesen
    • andreeldareide
    • henningkoller
    • davhu
    • oleob
    • meisen
    • espenhalstensen
    • hakonknutzen2
    • danjohnrk
    • olapeter
    • teodor-elstad
    • michaelpande
    • lysebraate
    • yngvar-nrk
    • lorecaster
    • wwalmnes
    • nrk-ps-teamcity
    • vincent.andersson
    • swla
    • nrk-midas-jenkins
    • andorpandor
    • jarlelin
    • aevare
    • nrkrichard
    • gesi
    • gundelsby-nrk
    • jonstalecarlsen
    • machineboy
    • vagifabilov
    • nrk-sofie-ci
    • nytamin
    • jesperstarkar
    • loftum
    • emte123
    • skjalgepalg
    • eirikhalvard
    • astokke
    • n640071
    • n07073
    • kristian.rosenvold
    • henrik-mattsson
    • eirikbacker
    • haavardm
    • popeindustries
    • yr
    • nrk-kurator-jenkins
    • toshb
    • torgeilo
    • nrk-user-sync
    • dhdeploy
    • janerikbr
    • espenwa
    • rogerhmar
    • ovstetun
    • eivind
    • stianlj
    • haraldkj
    • mariusu
    • spesialsnorre
    • cristobal
    • knuthaug
    • thohalv
    • johnarne
    • nrk-sup-jenkins
    • eshaswini
    • morrow
    • oyvindeh
    • laat
    • toggu
    • nrk-jenkins
    • plomma
    • evjand
    • moltubakk
    • ingridguren
    • lu-lux
    • andersli
    • silje
    • stiandg
    • sjurlur
    • anderscan
    • andipodnrk
    • pkej
    • yosrimti
    • zenangst
    • morten.nyhaug
    • ingvildcath
    • erlend.jones
    • brneirik
    • mollerse
    • eriksalhus
    • frdrks
    • tbnrk
    • nordanke
    • balte
    • mikaelrss
    • simonmitternacht
    • christiankarlsson9
    • martintorgersen
    • rebchr
    • steipal
    • discobus
    • ingvesund
    • martingundersen
    • tinkajts
    • hallvardlid
    • tomivar
    • ajaco
    • tobinus
    • mortenok
    • nrk-ark-deploy
    • jeangilbertlouis
    • heidimork
    • ingriddraagen
    • fridajalborg
    • bruusi
    • rosvoll
    • christianeide
    • enordby
    • artzag
    • glen_imrie
    • mia.aasbakken
    • elathamna
    • evjjan17
    • olatoft
    • kongsrud
    • chrpeter
    • ingvildforseth
    • esseb
    • talepre
    • haraldk76
    • stigok
    • dagfinno
    • johannesodland
    • anders993
    • vildefj
    • vildepk
    • malinaandahl
    • andreakn
    • rolerboler
    • meloygutt
    • anders.baggethun