no-deprecated.js

/**
 * @fileoverview Prevent usage of deprecated methods
 * @author Yannick Croissant
 * @author Scott Feeney
 * @author Sergei Startsev
 */
'use strict';

// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------

const rule = require('../../../lib/rules/no-deprecated');
const RuleTester = require('eslint').RuleTester;

const parserOptions = {
  ecmaVersion: 2018,
  sourceType: 'module',
  ecmaFeatures: {
    jsx: true
  }
};

function errorMessage(oldMethod, version, newMethod, refs) {
  newMethod = newMethod ? `, use ${newMethod} instead` : '';
  refs = refs ? `, see ${refs}` : '';
  return `${oldMethod} is deprecated since React ${version}${newMethod}${refs}`;
}

// ------------------------------------------------------------------------------
// Tests
// ------------------------------------------------------------------------------

const ruleTester = new RuleTester({parserOptions});
ruleTester.run('no-deprecated', rule, {

  valid: [
    // Not deprecated
    'var element = React.createElement(\'p\', {}, null);',
    'var clone = React.cloneElement(element);',
    'ReactDOM.render(element, container);',
    'ReactDOM.unmountComponentAtNode(container);',
    'ReactDOM.findDOMNode(instance);',
    'ReactDOMServer.renderToString(element);',
    'ReactDOMServer.renderToStaticMarkup(element);',
    {
      code: `
        var Foo = createReactClass({
          render: function() {}
        })
      `
    },
    // Non-React
    {
      code: `
        var Foo = createReactClassNonReact({
          componentWillMount: function() {},
          componentWillReceiveProps: function() {},
          componentWillUpdate: function() {}
        });
      `
    },
    {
      code: `
        var Foo = {
          componentWillMount: function() {},
          componentWillReceiveProps: function() {},
          componentWillUpdate: function() {}
        };
      `
    },
    {
      code: `
        class Foo {
          constructor() {}
          componentWillMount() {}
          componentWillReceiveProps() {}
          componentWillUpdate() {}
        }
      `
    },
    // Deprecated in a later version
    {code: 'React.renderComponent()', settings: {react: {version: '0.11.0'}}},
    {code: 'React.createClass()', settings: {react: {version: '15.4.0'}}},
    {code: 'PropTypes', settings: {react: {version: '15.4.0'}}},
    {
      code: `
        class Foo extends React.Component {
          componentWillMount() {}
          componentWillReceiveProps() {}
          componentWillUpdate() {}
        }
      `,
      settings: {react: {version: '16.2.0'}}
    }
  ],

  invalid: [
    {
      code: 'React.renderComponent()',
      errors: [{message: errorMessage('React.renderComponent', '0.12.0', 'React.render')}]
    },
    {
      code: 'Foo.renderComponent()',
      settings: {react: {pragma: 'Foo'}},
      errors: [{message: errorMessage('Foo.renderComponent', '0.12.0', 'Foo.render')}]
    },
    {
      code: '/** @jsx Foo */ Foo.renderComponent()',
      errors: [{message: errorMessage('Foo.renderComponent', '0.12.0', 'Foo.render')}]
    },
    {
      code: 'this.transferPropsTo()',
      errors: [{message: errorMessage('this.transferPropsTo', '0.12.0', 'spread operator ({...})')}]
    },
    {
      code: 'React.addons.TestUtils',
      errors: [{message: errorMessage('React.addons.TestUtils', '15.5.0', 'ReactDOM.TestUtils')}]
    },
    {
      code: 'React.addons.classSet()',
      errors: [{message: errorMessage('React.addons.classSet', '0.13.0', 'the npm module classnames')}]
    },
    {
      code: 'React.render(element, container);',
      errors: [{message: errorMessage('React.render', '0.14.0', 'ReactDOM.render')}]
    },
    {
      code: 'React.unmountComponentAtNode(container);',
      errors: [{message: errorMessage('React.unmountComponentAtNode', '0.14.0', 'ReactDOM.unmountComponentAtNode')}]
    },
    {
      code: 'React.findDOMNode(instance);',
      errors: [{message: errorMessage('React.findDOMNode', '0.14.0', 'ReactDOM.findDOMNode')}]
    },
    {
      code: 'React.renderToString(element);',
      errors: [{message: errorMessage('React.renderToString', '0.14.0', 'ReactDOMServer.renderToString')}]
    },
    {
      code: 'React.renderToStaticMarkup(element);',
      errors: [{message: errorMessage('React.renderToStaticMarkup', '0.14.0', 'ReactDOMServer.renderToStaticMarkup')}]
    },
    {
      code: 'React.createClass({});',
      errors: [{message: errorMessage('React.createClass', '15.5.0', 'the npm module create-react-class')}]
    },
    {
      code: 'Foo.createClass({});',
      settings: {react: {pragma: 'Foo'}},
      errors: [{message: errorMessage('Foo.createClass', '15.5.0', 'the npm module create-react-class')}]
    },
    {
      code: 'React.PropTypes',
      errors: [{message: errorMessage('React.PropTypes', '15.5.0', 'the npm module prop-types')}]
    },
    {
      code: 'var {createClass} = require(\'react\');',
      parser: 'babel-eslint',
      errors: [{message: errorMessage('React.createClass', '15.5.0', 'the npm module create-react-class')}]
    },
    {
      code: 'var {createClass, PropTypes} = require(\'react\');',
      parser: 'babel-eslint',
      errors: [
        {message: errorMessage('React.createClass', '15.5.0', 'the npm module create-react-class')},
        {message: errorMessage('React.PropTypes', '15.5.0', 'the npm module prop-types')}
      ]
    },
    {
      code: 'import {createClass} from \'react\';',
      parser: 'babel-eslint',
      errors: [{message: errorMessage('React.createClass', '15.5.0', 'the npm module create-react-class')}]
    },
    {
      code: 'import {createClass, PropTypes} from \'react\';',
      parser: 'babel-eslint',
      errors: [
        {message: errorMessage('React.createClass', '15.5.0', 'the npm module create-react-class')},
        {message: errorMessage('React.PropTypes', '15.5.0', 'the npm module prop-types')}
      ]
    },
    {
      code: `
      import React from 'react';
      const {createClass, PropTypes} = React;
    `,
      parser: 'babel-eslint',
      errors: [
        {message: errorMessage('React.createClass', '15.5.0', 'the npm module create-react-class')},
        {message: errorMessage('React.PropTypes', '15.5.0', 'the npm module prop-types')}
      ]
    },
    {
      code: 'import {printDOM} from \'react-addons-perf\';',
      parser: 'babel-eslint',
      errors: [{message: errorMessage('ReactPerf.printDOM', '15.0.0', 'ReactPerf.printOperations')}]
    },
    {
      code: `
        import ReactPerf from 'react-addons-perf';
        const {printDOM} = ReactPerf;
      `,
      parser: 'babel-eslint',
      errors: [{message: errorMessage('ReactPerf.printDOM', '15.0.0', 'ReactPerf.printOperations')}]
    },
    {
      code: 'React.DOM.div',
      errors: [{message: errorMessage('React.DOM', '15.6.0', 'the npm module react-dom-factories')}]
    },
    {
      code: `
        class Bar extends React.PureComponent {
          componentWillMount() {}
          componentWillReceiveProps() {}
          componentWillUpdate() {}
        };
      `,
      errors: [
        {
          message: errorMessage(
            'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
          ),
          type: 'Identifier',
          line: 3,
          column: 11
        },
        {
          message: errorMessage(
            'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
          ),
          type: 'Identifier',
          line: 4,
          column: 11
        },
        {
          message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
          ),
          type: 'Identifier',
          line: 5,
          column: 11
        }
      ]
    },
    {
      code: `
        function Foo() {
          return class Bar extends React.PureComponent {
            componentWillMount() {}
            componentWillReceiveProps() {}
            componentWillUpdate() {}
          };
        }
      `,
      errors: [
        {
          message: errorMessage(
            'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
          ),
          type: 'Identifier',
          line: 4,
          column: 13
        },
        {
          message: errorMessage(
            'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
          ),
          type: 'Identifier',
          line: 5,
          column: 13
        },
        {
          message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
          ),
          type: 'Identifier',
          line: 6,
          column: 13
        }
      ]
    },
    {
      code: `
        class Bar extends PureComponent {
          componentWillMount() {}
          componentWillReceiveProps() {}
          componentWillUpdate() {}
        };
      `,
      errors: [
        {
          message: errorMessage(
            'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
          ),
          type: 'Identifier',
          line: 3,
          column: 11
        },
        {
          message: errorMessage(
            'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
          ),
          type: 'Identifier',
          line: 4,
          column: 11
        },
        {
          message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
          ),
          type: 'Identifier',
          line: 5,
          column: 11
        }
      ]
    },
    {
      code: `
        class Foo extends React.Component {
          componentWillMount() {}
          componentWillReceiveProps() {}
          componentWillUpdate() {}
        }
      `,
      errors: [
        {
          message: errorMessage(
            'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
          ),
          type: 'Identifier',
          line: 3,
          column: 11
        },
        {
          message: errorMessage(
            'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
          ),
          type: 'Identifier',
          line: 4,
          column: 11
        },
        {
          message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
          ),
          type: 'Identifier',
          line: 5,
          column: 11
        }
      ]
    },
    {
      code: `
        class Foo extends Component {
          componentWillMount() {}
          componentWillReceiveProps() {}
          componentWillUpdate() {}
        }
      `,
      errors: [
        {
          message: errorMessage(
            'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
          ),
          type: 'Identifier',
          line: 3,
          column: 11
        },
        {
          message: errorMessage(
            'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
          ),
          type: 'Identifier',
          line: 4,
          column: 11
        },
        {
          message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
          ),
          type: 'Identifier',
          line: 5,
          column: 11
        }
      ]
    },
    {
      code: `
        var Foo = createReactClass({
          componentWillMount: function() {},
          componentWillReceiveProps: function() {},
          componentWillUpdate: function() {}
        })
      `,
      errors: [
        {
          message: errorMessage(
            'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
          ),
          type: 'Identifier',
          line: 3,
          column: 11
        },
        {
          message: errorMessage(
            'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
          ),
          type: 'Identifier',
          line: 4,
          column: 11
        },
        {
          message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
          ),
          type: 'Identifier',
          line: 5,
          column: 11
        }
      ]
    },
    {
      code: `
        class Foo extends React.Component {
          constructor() {}
          componentWillMount() {}
          componentWillReceiveProps() {}
          componentWillUpdate() {}
        }
      `,
      errors: [
        {
          message: errorMessage(
            'componentWillMount', '16.3.0', 'UNSAFE_componentWillMount',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillmount'
          ),
          type: 'Identifier',
          line: 4,
          column: 11
        },
        {
          message: errorMessage(
            'componentWillReceiveProps', '16.3.0', 'UNSAFE_componentWillReceiveProps',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops'
          ),
          type: 'Identifier',
          line: 5,
          column: 11
        },
        {
          message: errorMessage('componentWillUpdate', '16.3.0', 'UNSAFE_componentWillUpdate',
            'https://reactjs.org/docs/react-component.html#unsafe_componentwillupdate'
          ),
          type: 'Identifier',
          line: 6,
          column: 11
        }
      ]
    }
  ]
});