cuadraman
cuadraman

Reputation: 15154

How to disable ESLint react/prop-types rule in a file?

I'm using React and ESLint with eslint-plugin-react.

I want to disable the prop-types rule in one file.

var React = require('react'); 
var Model = require('./ComponentModel');

var Component = React.createClass({
/* eslint-disable react/prop-types */
    propTypes: Model.propTypes,
/* eslint-enable react/prop-types */
    render: function () {
        return (
            <div className="component">
                {this.props.title}
            </div>
        );
    }
});

Upvotes: 153

Views: 209653

Answers (11)

phil87
phil87

Reputation: 21

Inside your react project root directory look for .eslintrc.cjs file then in the rules: add this like line of code and save:

{ "react/prop-types": "off" }

Upvotes: 2

hanorine
hanorine

Reputation: 7815

if you have only one file you want to disable prop-type validation you can use:

/* eslint react/prop-types: 0 */

in cases where you have multiple files you can add to your .eslintrc file in your root directory a rule to disable prop-type validation:

{
 "plugins": [
     "react"
  ],
  "rules": {
    "react/prop-types": 0
  }
}

for further rules you can checkout this link that solved my issue and for your convenience you can also read up from eslint-plugin-react's github documentation about how to disable or enable it with various options.

Upvotes: 277

Deba Dip Bhowmik
Deba Dip Bhowmik

Reputation: 9

Best is to add this line :

'react/prop-types':[disabled] //* disabling eslint prop-types all warnings

add this line to your module.exports object in .eslintrc.cjs in file.

Upvotes: 0

Rayan arnel
Rayan arnel

Reputation: 123

I needed React relaunch for this to be taken into account without error

rules: {
  'react/prop-types': 'off'
}

Upvotes: 1

s-sajib
s-sajib

Reputation: 41

To disable or modify the react/prop-types rule in your .eslint.cjs file, you can use the following configurations:

Option 1: Disable the rule completely

"rules": {
  "react/prop-types": "off"
}

or

"rules": {
  "react/prop-types": 0
}

or

"rules": {
  "react/prop-types": false
}

Option 2: Set the rule to generate warnings instead of errors

"rules": {
  "react/prop-types": ["warn"]
}

Choose the option that best suits your requirements and add it to your .eslint.cjs file. This will configure ESLint to either disable the react/prop-types rule or modify its severity to generate warnings instead of errors.

Upvotes: 2

Idan
Idan

Reputation: 4023

You can change it to be warning, put it inside eslint rules:

'react/prop-types': ['warn'],

Upvotes: 0

Gyandeep
Gyandeep

Reputation: 13538

Just put this on top of your file:

/* eslint-disable react/prop-types */

Upvotes: 102

krsna
krsna

Reputation: 4333

I had to do this in my .eslintrc config file to disable prop types validation error.

"rules": {
  "react/prop-types": "off"
}

Upvotes: 5

P-A
P-A

Reputation: 1278

Sometimes I have small components in the same file as the major one. There propTypes seems overkill. Then I usually do something like this

// eslint-disable-next-line react/prop-types
const RightArrow = ({ onPress, to }) => (<TouchableOpacity onPress={() => onPress(to)} style={styles.rightArrow}><Chevrons.chevronRight size={25} color="grey" /></TouchableOpacity>);

Upvotes: 8

Leopold Kristjansson
Leopold Kristjansson

Reputation: 2784

I had to do:

/* eslint react/forbid-prop-types: 0 */

this did not work for me:

/* eslint react/prop-types: 0 */

To disable globally in your .eslintrc file (old version v6.0 or below):

{
    "rules": {
        "react/forbid-prop-types": 0
    }
}

To disable globally in your .eslintrc file (new version above v6.0):

{
    "rules": {
        "react/prop-types": 0
    }
}

Upvotes: 37

cuadraman
cuadraman

Reputation: 15154

I had to wrap the whole component with the eslint ignore comments.

var React = require('react'); 
var Model = require('./ComponentModel');

/* eslint-disable react/prop-types */
var Component = React.createClass({

    propTypes: Model.propTypes,

    render: function () {
        return (
            <div className="component">
                {this.props.title}
            </div>
        );
    }
});
/* eslint-enable react/prop-types */

Upvotes: 9

Related Questions