ClassConstantVisibilitySniff: not fixable by default

Author: kukulich

README.md

@@ -209,6 +209,10 @@ Sniff provides the following settings:
 
 In PHP 7.1 it's possible to declare [visibility of class constants](https://wiki.php.net/rfc/class_const_visibility). In a similar vein to optional declaration of visibility for properties and methods which is actually required in sane coding standards, this sniff also requires declaring visibility for all class constants.
 
+Sniff provides the following settings:
+
+* `fixable`: the sniff is not fixable by default because we think it's better to decide about each constant one by one however you can enable fixability with this option
+
 ```php
 const FOO = 1; // visibility missing!
 public const BAR = 2; // correct

SlevomatCodingStandard/Sniffs/Classes/ClassConstantVisibilitySniff.php

@@ -16,6 +16,11 @@ class ClassConstantVisibilitySniff implements \PHP_CodeSniffer\Sniffs\Sniff
 	 */
 	public $enabled = true;
 
+	/**
+	 * @var bool
+	 */
+	public $fixable = false;
+
 	/**
 	 * @return mixed[]
 	 */
@@ -50,19 +55,21 @@ public function process(\PHP_CodeSniffer\Files\File $phpcsFile, $constantPointer
 
 		$visibilityPointer = TokenHelper::findPreviousEffective($phpcsFile, $constantPointer - 1);
 		if (!in_array($tokens[$visibilityPointer]['code'], [T_PUBLIC, T_PROTECTED, T_PRIVATE], true)) {
-			$fix = $phpcsFile->addFixableError(
-				sprintf(
-					'Constant %s::%s visibility missing.',
-					ClassHelper::getFullyQualifiedName($phpcsFile, $classPointer),
-					$tokens[TokenHelper::findNextEffective($phpcsFile, $constantPointer + 1)]['content']
-				),
-				$constantPointer,
-				self::CODE_MISSING_CONSTANT_VISIBILITY
+			$message = sprintf(
+				'Constant %s::%s visibility missing.',
+				ClassHelper::getFullyQualifiedName($phpcsFile, $classPointer),
+				$tokens[TokenHelper::findNextEffective($phpcsFile, $constantPointer + 1)]['content']
 			);
-			if ($fix) {
-				$phpcsFile->fixer->beginChangeset();
-				$phpcsFile->fixer->addContentBefore($constantPointer, 'public ');
-				$phpcsFile->fixer->endChangeset();
+
+			if ($this->fixable) {
+				$fix = $phpcsFile->addFixableError($message, $constantPointer, self::CODE_MISSING_CONSTANT_VISIBILITY);
+				if ($fix) {
+					$phpcsFile->fixer->beginChangeset();
+					$phpcsFile->fixer->addContentBefore($constantPointer, 'public ');
+					$phpcsFile->fixer->endChangeset();
+				}
+			} else {
+				$phpcsFile->addError($message, $constantPointer, self::CODE_MISSING_CONSTANT_VISIBILITY);
 			}
 		}
 	}

tests/Sniffs/Classes/ClassConstantVisibilitySniffTest.php

@@ -49,11 +49,21 @@ public function testDisabledSniff(): void
 		$this->assertNoSniffErrorInFile($report);
 	}
 
-	public function testFixable(): void
+	public function testFixableEnabled(): void
 	{
 		$report = $this->checkFile(
 			__DIR__ . '/data/fixableMissingClassConstantVisibility.php',
-			[],
+			['fixable' => true],
+			[ClassConstantVisibilitySniff::CODE_MISSING_CONSTANT_VISIBILITY]
+		);
+		$this->assertAllFixedInFile($report);
+	}
+
+	public function testFixableDisabled(): void
+	{
+		$report = $this->checkFile(
+			__DIR__ . '/data/fixableMissingClassConstantVisibilityFixableDisabled.php',
+			['fixable' => false],
 			[ClassConstantVisibilitySniff::CODE_MISSING_CONSTANT_VISIBILITY]
 		);
 		$this->assertAllFixedInFile($report);

tests/Sniffs/Classes/data/fixableMissingClassConstantVisibilityFixableDisabled.fixed.php

@@ -0,0 +1,33 @@
+<?php
+
+const NON_CLASS = 1;
+
+interface A
+{
+
+	const HELLO = 2;
+
+}
+
+class B
+{
+
+	const WORLD = 3;
+
+}
+
+class C
+{
+
+	const A = 1;
+	const B = 2;
+	const C = 3;
+
+}
+
+class D
+{
+
+	const A = 1, B = 2, C = 3;
+
+}

tests/Sniffs/Classes/data/fixableMissingClassConstantVisibilityFixableDisabled.php

@@ -0,0 +1,33 @@
+<?php
+
+const NON_CLASS = 1;
+
+interface A
+{
+
+	const HELLO = 2;
+
+}
+
+class B
+{
+
+	const WORLD = 3;
+
+}
+
+class C
+{
+
+	const A = 1;
+	const B = 2;
+	const C = 3;
+
+}
+
+class D
+{
+
+	const A = 1, B = 2, C = 3;
+
+}