no-string-prototype-includes.js

/**
 * @author Toru Nagashima <https://github.com/mysticatea>
 * See LICENSE file in root directory for full license.
 */
"use strict"

const path = require("path")
const RuleTester = require("../../tester")
const rule = require("../../../lib/rules/no-string-prototype-includes.js")
const ruleId = "no-string-prototype-includes"

new RuleTester().run(ruleId, rule, {
    valid: [
        "includes('a')",
        "foo.charAt(0)",
        "foo.includes('a')",
        { code: "includes('a')", settings: { "es-x": { aggressive: true } } },
        { code: "foo.charAt(0)", settings: { "es-x": { aggressive: true } } },
        {
            code: "foo.includes('a')",
            options: [{ aggressive: false }],
            settings: { "es-x": { aggressive: true } },
        },
        {
            code: "[foo].includes('a')",
            settings: { "es-x": { aggressive: true } },
        },
    ],
    invalid: [
        {
            code: "'foo'.includes('a')",
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
        },
        {
            code: "foo.includes('a')",
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
            settings: { "es-x": { aggressive: true } },
        },
        {
            code: "foo.includes('a')",
            options: [{ aggressive: true }],
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
            settings: { "es-x": { aggressive: false } },
        },
    ],
})

// -----------------------------------------------------------------------------
// TypeScript
// -----------------------------------------------------------------------------
const parser = require("@typescript-eslint/parser")
const tsconfigRootDir = path.resolve(__dirname, "../../fixtures")
const project = "tsconfig.json"
const filename = path.join(tsconfigRootDir, "test.ts")

new RuleTester({
    languageOptions: { parser, parserOptions: { tsconfigRootDir, project } },
}).run(`${ruleId} TS Full Type Information`, rule, {
    valid: [
        { filename, code: "includes('a')" },
        { filename, code: "foo.charAt(0)" },
        { filename, code: "foo.includes('a')" },
        { filename, code: "let foo = {}; foo.includes('a')" },
        {
            filename,
            code: "includes('a')",
            settings: { "es-x": { aggressive: true } },
        },
        {
            filename,
            code: "foo.charAt(0)",
            settings: { "es-x": { aggressive: true } },
        },
        {
            filename,
            code: "[foo].includes('a')",
            settings: { "es-x": { aggressive: true } },
        },
    ],
    invalid: [
        {
            filename,
            code: "'foo'.includes('a')",
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
        },
        {
            filename,
            code: "let foo = 'foo'; foo.includes('a')",
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
        },
        {
            filename,
            code: "let foo = String(); foo.includes('a')",
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
        },
        {
            filename,
            code: "function f<T extends string>(a: T) { a.includes('a') }",
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
        },
        {
            filename,
            code: "function f<T extends 'a' | 'b'>(a: T) { a.includes('a') }",
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
        },
        {
            filename,
            code: "foo.includes('a')",
            errors: ["ES2015 'String.prototype.includes' method is forbidden."],
            settings: { "es-x": { aggressive: true } },
        },
    ],
})