feat: add no-final rule (#52)

Closes #13

Author: StyleShit

src/configs/recommended.ts

@@ -6,6 +6,7 @@ export const recommended: Linter.Config = {
 		'php/disallow-references': 'error',
 		'php/eqeqeq': 'error',
 		'php/no-array-keyword': 'error',
+		'php/no-final': 'error',
 		'php/require-type-annotations': 'error',
 		'php/require-visibility': 'error',
 	},

src/index.ts

@@ -5,6 +5,7 @@ import { type ESLint } from 'eslint';
 import { disallowReferences } from './rules/disallow-references';
 import { eqeqeq } from './rules/eqeqeq';
 import { noArrayKeyword } from './rules/no-array-keyword';
+import { noFinal } from './rules/no-final';
 import { requireTypeAnnotations } from './rules/require-type-annotations';
 import { requireVisibility } from './rules/require-visibility';
 
@@ -26,6 +27,7 @@ const plugin = {
 		'disallow-references': disallowReferences,
 		eqeqeq,
 		'no-array-keyword': noArrayKeyword,
+		'no-final': noFinal,
 		'require-type-annotations': requireTypeAnnotations,
 		'require-visibility': requireVisibility,
 	},

src/rules/__tests__/no-final.test.ts

@@ -0,0 +1,135 @@
+import { RuleTester } from 'eslint';
+
+import php from '../../index';
+import { noFinal } from '../no-final';
+
+const ruleTester = new RuleTester({
+	plugins: { php },
+	language: 'php/php',
+});
+
+ruleTester.run('no-final', noFinal, {
+	valid: [
+		{
+			name: 'methods',
+			code: `
+			<?php
+				class Test {
+					public function method1() {}
+					protected function method2() {}
+					private function method3() {}
+				}
+			`,
+		},
+
+		{
+			name: 'properties',
+			code: `
+			<?php
+				class Test {
+					public $property1;
+					protected $property2;
+					private $property3;
+				}
+			`,
+		},
+	],
+	invalid: [
+		{
+			name: 'final class',
+			code: '<?php final class Test {}',
+			errors: [
+				{
+					messageId: 'noFinal',
+					line: 1,
+					column: 19,
+					endLine: 1,
+					endColumn: 23,
+				},
+			],
+		},
+
+		{
+			name: 'final class constant',
+			code: `
+			<?php 
+				class Test {
+					final const CONSTANT = 'value';	
+				}
+			`,
+			errors: [
+				{
+					messageId: 'noFinal',
+					line: 4,
+					column: 6,
+					endLine: 4,
+					endColumn: 36,
+					suggestions: [
+						{
+							messageId: 'removeFinal',
+							output: `
+			<?php 
+				class Test {
+					 const CONSTANT = 'value';	
+				}
+			`,
+						},
+					],
+				},
+			],
+		},
+
+		{
+			name: 'final class property',
+			code: `
+			<?php 
+				class Test {
+					final public $property = 'value',
+						$property2 = 'value-1';
+				}
+			`,
+			errors: [
+				{
+					messageId: 'noFinal',
+					line: 4,
+					column: 6,
+					endLine: 5,
+					endColumn: 29,
+					suggestions: [
+						{
+							messageId: 'removeFinal',
+							output: `
+			<?php 
+				class Test {
+					 public $property = 'value',
+						$property2 = 'value-1';
+				}
+			`,
+						},
+					],
+				},
+			],
+		},
+
+		{
+			name: 'final class method',
+			code: `
+			<?php 
+				class Test {
+					final public function method() {
+						// Code
+					}
+				}
+			`,
+			errors: [
+				{
+					messageId: 'noFinal',
+					line: 4,
+					column: 28,
+					endLine: 4,
+					endColumn: 34,
+				},
+			],
+		},
+	],
+});

src/rules/no-final.ts

@@ -0,0 +1,67 @@
+import type { ClassConstant, Identifier, PropertyStatement } from 'php-parser';
+
+import { createRule } from '../utils/create-rule';
+
+type MessageIds = 'noFinal' | 'removeFinal';
+type Options = [];
+
+export const noFinal = createRule<MessageIds, Options>({
+	meta: {
+		hasSuggestions: true,
+		type: 'suggestion',
+		docs: {
+			description: 'Disallow using the `final` keyword',
+		},
+		messages: {
+			noFinal: 'The `final` keyword is not allowed.',
+			removeFinal: 'Remove the `final` keyword`.',
+		},
+		schema: [],
+	},
+
+	create(context) {
+		return {
+			'class[isFinal=true] > .name, method[isFinal=true] > .name'(
+				node: Identifier,
+			) {
+				context.report({
+					node,
+					messageId: 'noFinal',
+				});
+			},
+
+			'classconstant, propertystatement'(
+				node: ClassConstant | PropertyStatement,
+			) {
+				const finalKeyword = context.sourceCode.findClosestKeyword(
+					node,
+					'final',
+				);
+
+				if (!finalKeyword) {
+					return;
+				}
+
+				context.report({
+					node,
+					loc: {
+						start: finalKeyword.start,
+						end: context.sourceCode.getLoc(node).end,
+					},
+					messageId: 'noFinal',
+					suggest: [
+						{
+							messageId: 'removeFinal',
+							fix(fixer) {
+								return fixer.removeRange([
+									finalKeyword.start.offset,
+									finalKeyword.end.offset,
+								]);
+							},
+						},
+					],
+				});
+			},
+		};
+	},
+});