ChainSafe / ChainSafe/lodestar

Add eslint rule to format `TODO` tags and similar meta comments

Open
#5,242 3 comments 0 reactions 0 assignees View on GitHub
prio-none scope-devex
Dominant language
TypeScript
Stars
1.4k
Forks
483
Avg merge
1d 16h
Merged PRs (30d)
150

Description

**Is your feature request related to a problem? Please describe.**

For fork items it has been very helpful to tag TODO comments as
```ts
// TODO EIP-4844
```

That way with a text search you can locate pending fork items before the fork

**Describe the solution you'd like**

Add eslint rule to enforce formating

Contributor guide

Open the contributing guide

Research direction

Start by locating the repository's ESLint configuration and existing custom rules, then inspect how comments are currently handled. Done means the rule consistently enforces the requested TODO-style formatting, including the example `// TODO EIP-4844`; the issue does not name a file or test to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.