Files

460 lines
11 KiB
JavaScript

/**
* @fileoverview Enforces that a return statement is present in property getters.
* @author Aladdin-ADD([email protected])
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const rule = require("../../../lib/rules/getter-return");
const RuleTester = require("../../../lib/rule-tester/rule-tester");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
const ruleTester = new RuleTester({ languageOptions: { ecmaVersion: 2022 } });
const expectedError = { messageId: "expected", data: { name: "getter 'bar'" } };
const expectedAlwaysError = {
messageId: "expectedAlways",
data: { name: "getter 'bar'" },
};
const options = [{ allowImplicit: true }];
ruleTester.run("getter-return", rule, {
valid: [
/*
* test obj: get
* option: {allowImplicit: false}
*/
"var foo = { get bar(){return true;} };",
// option: {allowImplicit: true}
{ code: "var foo = { get bar() {return;} };", options },
{ code: "var foo = { get bar(){return true;} };", options },
{
code: "var foo = { get bar(){if(bar) {return;} return true;} };",
options,
},
/*
* test class: get
* option: {allowImplicit: false}
*/
"class foo { get bar(){return true;} }",
"class foo { get bar(){if(baz){return true;} else {return false;} } }",
"class foo { get(){return true;} }",
// option: {allowImplicit: true}
{ code: "class foo { get bar(){return true;} }", options },
{ code: "class foo { get bar(){return;} }", options },
/*
* test object.defineProperty(s)
* option: {allowImplicit: false}
*/
'Object.defineProperty(foo, "bar", { get: function () {return true;}});',
'Object.defineProperty(foo, "bar", { get: function () { ~function (){ return true; }();return true;}});',
"Object.defineProperties(foo, { bar: { get: function () {return true;}} });",
"Object.defineProperties(foo, { bar: { get: function () { ~function (){ return true; }(); return true;}} });",
/*
* test reflect.defineProperty(s)
* option: {allowImplicit: false}
*/
'Reflect.defineProperty(foo, "bar", { get: function () {return true;}});',
'Reflect.defineProperty(foo, "bar", { get: function () { ~function (){ return true; }();return true;}});',
/*
* test object.create(s)
* option: {allowImplicit: false}
*/
"Object.create(foo, { bar: { get() {return true;} } });",
"Object.create(foo, { bar: { get: function () {return true;} } });",
"Object.create(foo, { bar: { get: () => {return true;} } });",
// option: {allowImplicit: true}
{
code: 'Object.defineProperty(foo, "bar", { get: function () {return true;}});',
options,
},
{
code: 'Object.defineProperty(foo, "bar", { get: function (){return;}});',
options,
},
{
code: "Object.defineProperties(foo, { bar: { get: function () {return true;}} });",
options,
},
{
code: "Object.defineProperties(foo, { bar: { get: function () {return;}} });",
options,
},
{
code: 'Reflect.defineProperty(foo, "bar", { get: function () {return true;}});',
options,
},
// not getter.
"var get = function(){};",
"var get = function(){ return true; };",
"var foo = { bar(){} };",
"var foo = { bar(){ return true; } };",
"var foo = { bar: function(){} };",
"var foo = { bar: function(){return;} };",
"var foo = { bar: function(){return true;} };",
"var foo = { get: function () {} }",
"var foo = { get: () => {}};",
"class C { get; foo() {} }",
"foo.defineProperty(null, { get() {} });",
"foo.defineProperties(null, { bar: { get() {} } });",
"foo.create(null, { bar: { get() {} } });",
// wrong argument index (not in the property descriptor position)
"Object.defineProperty({ get() {} }, 'foo', { value: 1 });",
{
code: "Reflect.defineProperty({ get() {} }, 'foo', { value: 1 });",
languageOptions: { ecmaVersion: 6 },
},
"Object.defineProperties({ foo: { get() {} } }, { bar: { value: 1 } });",
"Object.create({ foo: { get() {} } }, { bar: { value: 1 } });",
// global object is shadowed
"let Object; Object.defineProperty(foo, 'bar', { get() {} })",
{
code: "function f() { Reflect.defineProperty(foo, 'bar', { get() {} }); var Reflect;}",
languageOptions: { ecmaVersion: 6 },
},
"function f(Object) { Object.defineProperties(foo, { bar: { get() {} } }) }",
"if (x) { const Object = getObject(); Object.create(foo, { bar: { get() {} } }) }",
// global object doesn't exist
{
code: "Reflect.defineProperty(foo, 'bar', { get() {} })",
languageOptions: { globals: { Reflect: "off" } },
},
"/* globals Object:off */ Object.defineProperty(foo, 'bar', { get() {} })",
{
code: "Object.defineProperties(foo, { bar: { get() {} } })",
languageOptions: { globals: { Object: "off" } },
},
],
invalid: [
/*
* test obj: get
* option: {allowImplicit: false}
*/
{
code: "var foo = { get bar() {} };",
errors: [
{
...expectedError,
line: 1,
column: 13,
endLine: 1,
endColumn: 20,
},
],
},
{
code: "var foo = { get\n bar () {} };",
errors: [
{
...expectedError,
line: 1,
column: 13,
endLine: 2,
endColumn: 6,
},
],
},
{
code: "var foo = { get bar(){if(baz) {return true;}} };",
errors: [
{
...expectedAlwaysError,
line: 1,
column: 13,
endLine: 1,
endColumn: 20,
},
],
},
{
code: "var foo = { get bar() { ~function () {return true;}} };",
errors: [
{
...expectedError,
line: 1,
column: 13,
endLine: 1,
endColumn: 20,
},
],
},
{
code: "var foo = { get bar() { return; } };",
errors: [
{
...expectedError,
line: 1,
column: 25,
endLine: 1,
endColumn: 32,
},
],
},
// option: {allowImplicit: true}
{
code: "var foo = { get bar() {} };",
options,
errors: [expectedError],
},
{
code: "var foo = { get bar() {if (baz) {return;}} };",
options,
errors: [expectedAlwaysError],
},
/*
* test class: get
* option: {allowImplicit: false}
*/
{
code: "class foo { get bar(){} }",
errors: [
{
...expectedError,
line: 1,
column: 13,
endLine: 1,
endColumn: 20,
},
],
},
{
code: "var foo = class {\n static get\nbar(){} }",
errors: [
{
messageId: "expected",
data: { name: "static getter 'bar'" },
line: 2,
column: 3,
endLine: 3,
endColumn: 4,
},
],
},
{
code: "class foo { get bar(){ if (baz) { return true; }}}",
errors: [expectedAlwaysError],
},
{
code: "class foo { get bar(){ ~function () { return true; }()}}",
errors: [expectedError],
},
// option: {allowImplicit: true}
{ code: "class foo { get bar(){} }", options, errors: [expectedError] },
{
code: "class foo { get bar(){if (baz) {return true;} } }",
options,
errors: [expectedAlwaysError],
},
/*
* test object.defineProperty(s)
* option: {allowImplicit: false}
*/
{
code: "Object.defineProperty(foo, 'bar', { get: function (){}});",
errors: [
{
messageId: "expected",
data: { name: "method 'get'" },
line: 1,
column: 37,
endLine: 1,
endColumn: 51,
},
],
},
{
code: "Object.defineProperty(foo, 'bar', { get: function getfoo (){}});",
errors: [
{
messageId: "expected",
data: { name: "method 'get'" },
line: 1,
column: 37,
endLine: 1,
endColumn: 58,
},
],
},
{
code: "Object.defineProperty(foo, 'bar', { get(){} });",
errors: [
{
messageId: "expected",
data: { name: "method 'get'" },
line: 1,
column: 37,
endLine: 1,
endColumn: 40,
},
],
},
{
code: "Object.defineProperty(foo, 'bar', { get: () => {}});",
errors: [
{
messageId: "expected",
data: { name: "method 'get'" },
line: 1,
column: 37,
endLine: 1,
endColumn: 42,
},
],
},
{
code: 'Object.defineProperty(foo, "bar", { get: function (){if(bar) {return true;}}});',
errors: [{ messageId: "expectedAlways" }],
},
{
code: 'Object.defineProperty(foo, "bar", { get: function (){ ~function () { return true; }()}});',
errors: [{ messageId: "expected" }],
},
/*
* test reflect.defineProperty(s)
* option: {allowImplicit: false}
*/
{
code: "Reflect.defineProperty(foo, 'bar', { get: function (){}});",
errors: [
{
messageId: "expected",
data: { name: "method 'get'" },
line: 1,
column: 38,
endLine: 1,
endColumn: 52,
},
],
},
/*
* test object.create(s)
* option: {allowImplicit: false}
*/
{
code: "Object.create(foo, { bar: { get: function() {} } })",
errors: [
{
messageId: "expected",
data: { name: "method 'get'" },
line: 1,
column: 29,
endLine: 1,
endColumn: 42,
},
],
},
{
code: "Object.create(foo, { bar: { get() {} } })",
errors: [
{
messageId: "expected",
data: { name: "method 'get'" },
line: 1,
column: 29,
endLine: 1,
endColumn: 32,
},
],
},
{
code: "Object.create(foo, { bar: { get: () => {} } })",
errors: [
{
messageId: "expected",
data: { name: "method 'get'" },
line: 1,
column: 29,
endLine: 1,
endColumn: 34,
},
],
},
// option: {allowImplicit: true}
{
code: "Object.defineProperties(foo, { bar: { get: function () {}} });",
options,
errors: [{ messageId: "expected" }],
},
{
code: "Object.defineProperties(foo, { bar: { get: function (){if(bar) {return true;}}}});",
options,
errors: [{ messageId: "expectedAlways" }],
},
{
code: "Object.defineProperties(foo, { bar: { get: function () {~function () { return true; }()}} });",
options,
errors: [{ messageId: "expected" }],
},
{
code: 'Object.defineProperty(foo, "bar", { get: function (){}});',
options,
errors: [{ messageId: "expected" }],
},
{
code: "Object.create(foo, { bar: { get: function (){} } });",
options,
errors: [{ messageId: "expected" }],
},
{
code: 'Reflect.defineProperty(foo, "bar", { get: function (){}});',
options,
errors: [{ messageId: "expected" }],
},
// Optional chaining
{
code: "Object?.defineProperty(foo, 'bar', { get: function (){} });",
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "expected", data: { name: "method 'get'" } }],
},
{
code: "(Object?.defineProperty)(foo, 'bar', { get: function (){} });",
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "expected", data: { name: "method 'get'" } }],
},
{
code: "Object?.defineProperty(foo, 'bar', { get: function (){} });",
options,
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "expected", data: { name: "method 'get'" } }],
},
{
code: "(Object?.defineProperty)(foo, 'bar', { get: function (){} });",
options,
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "expected", data: { name: "method 'get'" } }],
},
{
code: "(Object?.create)(foo, { bar: { get: function (){} } });",
options,
languageOptions: { ecmaVersion: 2020 },
errors: [{ messageId: "expected", data: { name: "method 'get'" } }],
},
],
});