realm / realm/SwiftLint

Rule Request: Properly formatted TODO comments

Open
#2,631 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

rule-request
Dominant language
Swift
Stars
19.7k
Forks
2.3k
Avg merge
1d 1h
Merged PRs (30d)
11

Description

New Issue Checklist
New rule request

I would like to ensure TODO comments are formatted properly.

It should also apply to FIXME comments. It could be useful for MARK comments to, but then the rule needs a more generic name I think.

  1. Why should this rule be added? Share links to existing discussion about what
    the community thinks about this.

It's important to format TODOs correctly for readability and for Xcode to parse it correctly.

  1. Provide several examples of what would and wouldn't trigger violations.
  • Colon after TODO. If this is left out, Xcode will not be able to parse it.
    • // TODO Something => // TODO: Something
    • /* TODO Something */ => /* TODO: Something */
  • No triple-slash or double-star comment. I often incorrectly use triple-slash comments for TODOs.
    • /// TODO: Something => // TODO: Something
    • /** TODO: Something */ => /* TODO: Something */
  • Spacing. For // comment, one space after the // and one space after the colon. For /* */ comment, one space after /* and before */ if it's inline.
    • //TODO:Something => // TODO: Something
    • /*TODO:Something*/ => /* TODO: Something */
  • Ability to enforce only using // for TODO comments and not /* */.
  1. Should the rule be configurable, if so what parameters should be configurable?

You should be able to opt into only allowing // for TODO comments.

  1. Should the rule be opt-in or enabled by default? Why?
    See README.md for guidelines on when to mark a rule as opt-in.

Enabled by default. I can't imagine anyone wanting //TODO:Something.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the opt-in rules guidance in README.md and review the requested TODO and FIXME examples in this issue. Determine the rule's scope, formatting behavior, and whether allowing only // comments is configurable. Done means the agreed violations are detected and the requested configuration behavior is covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.