generator-eslint/tests/rule/index.js at d5b5082a841689c791cdb503e44494fdd177d4d1 · Amnish04/generator-eslint · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/**
 * @fileoverview Rule generator tests
 * @author Nicholas C. Zakas
 */


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

import helpers from "yeoman-test";
import assert from "yeoman-assert";
import { fileURLToPath } from "node:url";
import path from "node:path";

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

const __dirname = path.dirname(fileURLToPath(import.meta.url)); // eslint-disable-line no-underscore-dangle -- cjs convention

const RULE_GENERATOR_PATH = path.join(__dirname, "..", "..", "rule", "index.js");

describe("ESLint Rule Generator", () => {
    describe("general case", () => {
        beforeEach(async () => {
            await helpers.run(RULE_GENERATOR_PATH)
                .withPrompts({
                    userName: "John Doe",
                    ruleId: "no-unused-vars",
                    desc: "Don't include unused variables.",
                    invalidCode: "x;",
                    target: "plugin"
                })
                .withOptions({ "skip-install": true });
        });

        it("creates expected files", async () => {
            const expected = [
                "docs/rules/no-unused-vars.md",
                "lib/rules/no-unused-vars.js",
                "tests/lib/rules/no-unused-vars.js"
            ];

            assert.file(expected);
        });

        it("has correct rule implementation file contents", () => {
            assert.fileContent("lib/rules/no-unused-vars.js", "description: \"Don't include unused variables.\"");
            assert.fileContent("lib/rules/no-unused-vars.js", "@fileoverview Don't include unused variables.");
            assert.fileContent("lib/rules/no-unused-vars.js", "@author John Doe");
        });

        it("has correct rule doc file contents", () => {
            assert.fileContent("docs/rules/no-unused-vars.md", "# Don&#39;t include unused variables. (`no-unused-vars`)");
        });

        it("has correct rule test file contents", () => {
            assert.fileContent("tests/lib/rules/no-unused-vars.js", "RuleTester = require(\"eslint\").RuleTester;");
            assert.fileContent("tests/lib/rules/no-unused-vars.js", "ruleTester.run(\"no-unused-vars\", rule, {");
            assert.fileContent("tests/lib/rules/no-unused-vars.js", "code: \"x;\"");
        });
    });

    describe("when generating an ESLint core rule", () => {
        beforeEach(async () => {
            await helpers.run(RULE_GENERATOR_PATH)
                .withPrompts({
                    userName: "John Doe",
                    ruleId: "no-unused-vars",
                    desc: "Don't include unused variables.",
                    invalidCode: "var x = \"foo\";",
                    target: "eslint"
                })
                .withOptions({ "skip-install": true });
        });

        it("has correct rule test file contents", () => {
            assert.fileContent("tests/lib/rules/no-unused-vars.js", "RuleTester = require(\"../../../lib/rule-tester\");");
        });
    });

    describe("With pathological input", () => {
        describe("Double quotes in description", () => {
            beforeEach(async () => {
                await helpers.run(RULE_GENERATOR_PATH)
                    .withPrompts({
                        userName: "John Doe",
                        ruleId: "no-unused-vars",
                        desc: "My \"foo\"",
                        invalidCode: "x;",
                        target: "plugin"
                    })
                    .withOptions({ "skip-install": true });
            });

            it("has correct description", () => {
                assert.fileContent("lib/rules/no-unused-vars.js", "description: \"My \\\"foo\\\"\"");
            });
        });

        describe("Double quotes in code snippet", () => {
            beforeEach(async () => {
                await helpers.run(RULE_GENERATOR_PATH)
                    .withPrompts({
                        userName: "John Doe",
                        ruleId: "no-unused-vars",
                        desc: "Don't include unused variables.",
                        invalidCode: "var x = \"foo\";",
                        target: "plugin"
                    })
                    .withOptions({ "skip-install": true });
            });

            it("has correct code snippet", () => {
                assert.fileContent("tests/lib/rules/no-unused-vars.js", "code: \"var x = \\\"foo\\\";\"");
            });
        });

        describe("Single quotes in description", () => {
            beforeEach(async () => {
                await helpers.run(RULE_GENERATOR_PATH)
                    .withPrompts({
                        userName: "John Doe",
                        ruleId: "no-unused-vars",
                        desc: "My 'foo'",
                        invalidCode: "x;",
                        target: "plugin"
                    })
                    .withOptions({ "skip-install": true });
            });

            it("has correct description", () => {
                assert.fileContent("lib/rules/no-unused-vars.js", "description: \"My 'foo'\"");
            });
        });

        describe("Single quotes in code snippet", () => {
            beforeEach(async () => {
                await helpers.run(RULE_GENERATOR_PATH)
                    .withPrompts({
                        userName: "John Doe",
                        ruleId: "no-unused-vars",
                        desc: "Don't include unused variables.",
                        invalidCode: "var x = 'foo';",
                        target: "plugin"
                    })
                    .withOptions({ "skip-install": true });
            });

            it("has correct code snippet", () => {
                assert.fileContent("tests/lib/rules/no-unused-vars.js", "code: \"var x = 'foo';\"");
            });
        });
    });
});