Rule proposal: Forbidden property key

Repository metrics

Stars

5,022 stars (5,022 stars)

PR merge metrics

Avg merge 1d 16h (Avg merge 1d 16h)399 merged PRs in 30d (399 merged PRs in 30d)

Description

// May lead to unexpected result.
const array = [];
const object = {};

const a = {
	[array]: 1,
	[object]() {}
};

class A {
	[array]: 1
	[object]() {}
}

// `4n` is used as `4` not `'4n'`
const array = [];
array[4n] = '';
// array.length === 5

const a = {
  1.00000000000000001: 1
};

const a = {
  1234567891012345678910: 1
};

const array = [];
const object = {};

const a = {
	[array.join('')]: 1,
	[toString(object)]: 2
};

const array = [];
array[Number(4n)] = '';

const symbol = Symbol("key")
const a = {
	[symbol]: 1
};

Contributor guide

Research direction

Study the issue's examples and existing rules in eslint plugin unicorn that handle computed properties. Understand how to use ESLint's context.getScope() or typescript eslint's parser services for type analysis. Then implement the rule.

Tech stack

javascript

Domain

tooling

Issue type

Feature

DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.

3

Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.

1-2 days

Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.

Active

ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.

Clear

Prerequisites

JavaScriptESLint

Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.

55