WordPress / WordPress/WordPress-Coding-Standards

Add arithmetic bracketing sniff ?

Open
#589 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Focus: Code analysis Type: Enhancement Type: Question
Dominant language
PHP
Stars
2.8k
Forks
521
Avg merge
5d 20h
Merged PRs (30d)
1

Description

As operator precedence is a mystery to a lot of programmers, demanding brackets around arithmetics is good practice and prevents bugs.

So, should we add it ? Squiz.Formatting.OperatorBracket.MissingBrackets does the trick.

Optionally this sniff could be forked to throw a warning instead of an error.

As it's not in the handbook, should probably go in extra.

Opinions ?

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 by reviewing the existing Squiz.Formatting.OperatorBracket.MissingBrackets sniff and the issue discussion. Determine whether the rule belongs in the extra ruleset and whether warning behavior is required. Done means the scope and behavior are agreed and the corresponding WordPress coding-standard rule is implemented and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
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.