EasyEngine/easyengine

Add phpcs rule to ensure one line is left empty after function declaration

Open

#1,222 opened on Sep 14, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)PHP (1,984 stars) (429 forks)batch import
good first issue

Description

Currently PHPCS does not flag this as warning(which it should) -

function abc($a) {
    if($a){
        ...
    }
}

This is the coding the team has agreed to(and it should not display warning) -

function abc($a) {

    if($a){
        ...
    }
}

phpcs.xml needs to be modified in this and all the commands and site type repos.

Contributor guide

Tech stack
php
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic PHP knowledgefamiliarity with phpcs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests adding a phpcs rule to require a blank line after function declarations. Examine the repository's `phpcs.xml` file (e.g., search for 'phpcs.xml' or 'phpcs.xml.dist') to understand the current configuration. Add a custom sniffs rule for blank lines after function declarations, possibly using PSR2 or a custom sniff. The issue references multiple repos, so check if the same modification is needed in site specific repositories as well. Consult phpcs documentation to create a custom rule if needed.