eslint-config-nfl/test/test-react-order.js

NFL's ESLint config

/* eslint-disable mocha/no-global-tests, mocha/handle-done-callback, import/default */

import test from "tape";
import {CLIEngine} from "eslint";
import eslintrc from "../";
import reactRules from "../rules/react";

const cli = new CLIEngine({
    useEslintrc: false,
    baseConfig: eslintrc,

    // This rule fails when executing on text.
    rules: {
        indent: 0
    },
});

function lint(text) {
    // @see http://eslint.org/docs/developer-guide/nodejs-api.html#executeonfiles
    // @see http://eslint.org/docs/developer-guide/nodejs-api.html#executeontext
    const linter = cli.executeOnText(text);
    return linter.results[0];
}

function wrapComponent(body) {
    return `
import React from "react";
export default class MyComponent extends React.Component {
${body}
}
`;
}

test("validate react prop order", t => {
    t.test("make sure our eslintrc has React and JSX linting dependencies", t => {
        t.plan(1);
        t.deepEqual(reactRules.plugins, ["react"]);
    });

    t.test("passes a good component", t => {
        t.plan(3);
        const result = lint(wrapComponent(`
    componentWillMount() {}
    componentDidMount() {}
    getFoo() {}
    setFoo() {}
    setBar() {}
    someMethod() {}
    renderDogs() {}
    render() { return <div />; }
`));

        t.notOk(result.warningCount, "no warnings");
        t.notOk(result.errorCount, "no errors");
        t.deepEquals(result.messages, [], "no messages in results");
    });

    t.test("order: when random method is first", t => {
        t.plan(2);
        const result = lint(wrapComponent(`
    someMethod() {}
    componentWillMount() {}
    componentDidMount() {}
    getFoo() {}
    setFoo() {}
    setBar() {}
    renderDogs() {}
    render() { return <div />; }
`));

        t.ok(result.errorCount, "fails");
        t.equal(result.messages[0].ruleId, "react/sort-comp", "fails due to sort");
    });

    t.test("order: when random method after lifecycle methods", t => {
        t.plan(2);
        const result = lint(wrapComponent(`
    componentWillMount() {}
    componentDidMount() {}
    someMethod() {}
    getFoo() {}
    setFoo() {}
    setBar() {}
    renderDogs() {}
    render() { return <div />; }
`));

        t.ok(result.errorCount, "fails");
        t.equal(result.messages[0].ruleId, "react/sort-comp", "fails due to sort");
    });
});