bmitch/codor

Custom PHPCS sniffs to find Code Smells

codor's Issues

Sniff for functions with "or" or "and" in the name.

Might help detect functions that do more than one thing.

Class length sniff

Classes should be no more than X lines.

• Any way to subtract comments from line count?
• Any way to make X configurable?

Sniff for nested if statements.

Sniff warning when method returns a primitive

Just a warning to suggest to the developer to see if an object could be returned instead.

Refactor IndentationLevelSniff

This class isn't as clean as I'd like it:

    public $indentationLimit = 2;

This doesn't really make sense because indentation limit is actually 1 but we use 2 in the class.

The function name inspectScope doesn't really explain what it is doing. This function also has more than 1 levels of indentation.

Sniff to limit number of parameters

From Clean Code:

The ideal number of arguments for a function is zero (niladic). Next comes one (monadic), followed closely by two (dyadic). Three arguments (triadic) should be avoided where possible. More than three (polyadic) requires very special justification -- and then shouldn't be used anyway.

Final classes - ensure no protected methods or members

Don't think there is a point to having protected since final classes cannot be extended.

Sniff to restrict number of lines between end of function and next function.

make sure there are X lines between the end of a function and the next functions doc block

Classes for Tokens and Token collections.

Think it would be good to have these classes:

• Wrapper around the Token array data to make it more OO to obtain information about a token.
• Perhaps a wrapper around an array of tokens to make it easy to iterate through all found tokens in a sniff.

Add info on how to supress for sections of code in README

Sniff for when constructor has too many interfaces passed in.

Wrap tokens and token in value objects.

Could wrap the array of tokens inside a collection and each token could be a value object.

Is it possible for tests to check which lines contained the error?

Sniff to warn when extending a class.

The warning could suggest to use composition over inheritance.

@Exadra37 feel free to take this one if you wish 😃

[Laravel Specific] Ensure all uses of `env()` provide a default value.

Maybe could make this more generic. Could have a config file where you list functions and how many parameters you expect them to be called with.

Remove any levels of indentation > 1

• Codor/src/Codor/Sniffs/Files/IndentationLevelSniff.php

  Lines 59 to 79 in c1447a2

  	/**
  	* Inspect the tokens in the scope of the provided $token.
  	* @codingStandardsIgnoreStart
  	* @param array $token Token Data.
  	* @param array $tokens Tokens.
  	* @return void
  	*/
  	protected function inspectScope(array $token, array $tokens)
  	{
  	$start = $token['scope_opener'];
  	$end = $token['scope_closer'];
  	$this->relativeScopeLevel = $tokens[$start]['level'];
  	for ($index=$start; $index <= $end; $index++) {
  	$nestedToken = $tokens[$index];
  	if ($nestedToken['type'] === "T_SWITCH") {
  	return;
  	}
  	$this->adjustMaxIndentationFound($nestedToken);
  	}
  	}
  	// @codingStandardsIgnoreEnd

• Codor/src/Codor/Sniffs/Files/ReturnNullSniff.php

  Lines 20 to 48 in c1447a2

  	/**
  	* Processes the tokens that this sniff is interested in.
  	* @codingStandardsIgnoreStart
  	* @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
  	* @param integer $stackPtr The position in the stack where
  	* the token was found.
  	* @return void
  	*/
  	public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
  	{
  	$tokens = $phpcsFile->getTokens();
  	$returnTokenIndex = $stackPtr;
  	$returnValueToken = '';
  	$numberOfTokens = count($tokens);
  	for ($index = $returnTokenIndex; $index < $numberOfTokens; $index++) {
  	if ($tokens[$index]['type'] === 'T_SEMICOLON') {
  	$returnValueToken = $tokens[$index - 1];
  	break;
  	}
  	}
  	// @codingStandardsIgnoreEnd
  	if ($returnValueToken['type'] === 'T_NULL') {
  	$error = "Return null value found.";
  	$phpcsFile->addError($error, $stackPtr);
  	}
  	}

Once fixed can remove the @codingStandardsIgnoreStart in the method doc block.

Make a PHP7 version

Sniff to prevent undeclared member variables.

Sniff to limit member variables.

Limit the number of member variables for a class.

How many to limit?

Sniff to prevent conditionals in constructors

Extracted from #71

Doesn't work with Atom Linter-PHPCS?

I tried setting it up to use with Atom's Linter-Phpcs package, but PHPCS just stops running. I don't see any errors or warnings where I should. If I remove the custom config from the Linter-PHPCS configuration, it resumes working normally.

Any suggestions on what I might try to debug this?

Thanks! :)

Remote security checker until it is back working again.

This package's service is occasionally down which fails the builds. Will make it always fail and can just refer to the build log to see if it failed.

Parameter length sniff not picking up interfaces.

Because it is ignoring functions with no body. Should not do this.

Run the package against itself

vendor/bin/phpcs --standard=src/Codor/ruleset.xml src

Add Travis-CI build

Sniff to limit the use of `new`?

Instead of using new should be using DI. Should this be sniffed out?

Fix tab indention on test cases to spaces

Looks like some of the indents are tabs. Should all be spaces.

[PHP7] Null Coalesce Operator check

https://wiki.php.net/rfc/isset_ternary

Tests for when you customize a rule.

Make sure the error or warning message received is updated with the custom value in the test.

Sniff for method flag parameters

warns if a boolean method parameter is used in an if statement with the method. Could indicate the method has more than one responsibility.

Sniffer to prevent returning null

Instead of returning null you can:

• Throw an exception.
• Return an empty array.
• Return a Null Object.

Sniff for only 1 level of indentation.

Sniff for conditional complexity.

Checks if if statement has too many conditions.

Codor.Syntax.LinesAfterMethod breaks on interfaces

Fix namespaces

Sniff for anonymous functions

Sometimes you don't want to have anonymous functions. Example is you may not want them in your routes.php file for Laravel.

This sniff will probably be one you only run against a handful of files.

Tests to test returned error message

Not sure if possible but if so would be good to test.

ignore try-catch block as indentation

Currently any loop or conditional in a try-catch block is reported. The only workaround is to put it in a function, but that doesn't always make sense. It's basically doubling the amount of functions if you need a try-catch block.

try {
    if ($this->eventShouldBeCollected($event)) {
        $this->collectEvent($event);
    }

    $this->fire($event);
} catch (\Exception) {
    // log event errors
}

also in the catch part:

try {
    $this->response = $this->guzzle->request(...);
    // etc..
} catch (\GuzzleHttp\Exception\ClientException $e) {
    if ($e->getResponse()->getStatusCode() == 404) {
        throw VacancyIsClosed::forId($vacancyId);
    }
}

Limit number of lines within an if or for(each) loop?

Functions containing forbidden words fail when it is part of a whole word

Sniff to look for conditionals or loops within a constructor.

Might need to extract this to 2 sniffs.

ConstructorLoopSniff breaks on interfaces with constructors

Enhance readme

• Add code examples for each sniff. Done
• Show how to run individual sniffs or exclude individual sniffs.
• For each sniff show how to customize if applicable.
• Explain why, benefits of why you'd want each sniff.

Sniff to prevent if/loops within any controller methods?

Not sure if this is a good idea or not but I guess users can always disable if they don't want to use it.

If the file ends in Controller.php then no methods within should contain any logic. Logic should be delegated to other classes.

• If file ends in controller.
• If file contains if, else, or any loop keyword it fails.

Sniff to remove unwanted blank lines.

• Blank lines at start/end of function/method
• Blank lines before/after function/method
• Blank lines after class declaration.
• Blank lines around namespaces/use statement.

Fix final class sniff

Need to init variables when starting

        $this->classIsMarkedFinal = false;
        $this->protectedMethods = [];
        $this->protectedVariables = [];

Line numbers reported are also broken.

Fix breaking build

Add https://github.com/Roave/SecurityAdvisories

Make rules configurable?

For example, could the max number of lines a function be a configurable value?

Changes to CodeSniffRunner

This class and the test classes could be cleaned up:

• To get the error count and warning count you have to run the sniff twice. Should only have to do it once.
• Can we get the error and warning message so that can be tested?

The code where it runs a sniff looks messy. Can this be cleaned up?

        $errorCount = $codeSnifferRunner->detectErrorCountInFileForSniff(
            __DIR__.'/Assets/FunctionLengthSniff/FunctionLengthSniff.inc',
            'Codor.Files.FunctionLength'
        );