Add support for abstract, override and readonly (#83)

Add support for matching by TypeScript abstract, override and readonly modifiers

Author: NogaMan

README.md

@@ -105,6 +105,9 @@ Members can be matched to positional slots using several criteria, including nam
 - `static`: `true|false` to restrict the match to static or instance members.
 - `private`: `true|false` to restrict the match to [private members](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/Private_class_fields). **Note**: Private members currently require a custom parser like [babel-eslint](https://github.com/babel/babel-eslint).
 - `accessibility`: `"public"|"private"|"protected"` to restrict the match to members with the specified typescript accessibility modifier. **Note**: Requires `@typescript-eslint/parser`.
+- `abstract`: `true|false` to restrict the match to members with typescript `abstract` keyword.
+- `override`: `true|false` to restrict the match to members with typescript `override` keyword.
+- `readonly`: `true|false` to restrict the match to members with typescript `readonly` keyword.
 - `async`: `true|false` to restrict the match to async members.
 - `sort`: `"alphabetical"|"none"`. Used to require a specific sorting within the slot for matched members. Defaults to `"none"`.
 - `groupByDecorator`: a string used to group properties with the same decorator name (e.g. `observable` for `@observable`). Can be used together with `sort`. **Note**: Decorators are a Stage 2 proposal and require a custom parser like [babel-eslint](https://github.com/babel/babel-eslint).

src/rules/schema.js

@@ -40,6 +40,9 @@ export const sortClassMembersSchema = [
 								private: { type: 'boolean' },
 								async: { type: 'boolean' },
 								accessibility: { enum: ['public', 'private', 'protected'] },
+								abstract: { type: 'boolean' },
+								override: { type: 'boolean' },
+								readonly: { type: 'boolean' },
 							},
 							additionalProperties: false,
 						},

src/rules/sort-class-members.js

@@ -176,6 +176,10 @@ function getMemberInfo(node, sourceCode) {
 	let async = false;
 	let decorators = [];
 	const accessibility = node.accessibility ?? 'public';
+	const abstract =
+		node.type === 'TSAbstractAccessorProperty' ||
+		node.type === 'TSAbstractPropertyDefinition' ||
+		node.type === 'TSAbstractMethodDefinition';
 
 	decorators =
 		(!!node.decorators &&
@@ -217,6 +221,9 @@ function getMemberInfo(node, sourceCode) {
 		type,
 		decorators,
 		static: node.static,
+		abstract,
+		override: node.override,
+		readonly: !!node.readonly,
 		async,
 		private: isPrivate,
 		accessibility,
@@ -421,6 +428,9 @@ const comparers = [
 	{ property: 'async', value: 10, test: (m, s) => s.async === m.async },
 	{ property: 'private', value: 10, test: (m, s) => s.private === m.private },
 	{ property: 'accessibility', value: 10, test: (m, s) => s.accessibility == m.accessibility },
+	{ property: 'abstract', value: 10, test: (m, s) => s.abstract == m.abstract },
+	{ property: 'override', value: 10, test: (m, s) => s.override == m.override },
+	{ property: 'readonly', value: 10, test: (m, s) => s.readonly == m.readonly },
 	{ property: 'kind', value: 10, test: (m, s) => s.kind === m.kind },
 	{
 		property: 'groupByDecorator',

test/rules/sort-class-members.spec.js

@@ -254,6 +254,29 @@ const typescriptAccessibilityOptions = [
 	},
 ];
 
+const typescriptKeywordsOptions = [
+	{
+		groups: {
+			abstract: [
+				{
+					abstract: true,
+				},
+			],
+			override: [
+				{
+					override: true,
+				},
+			],
+			readonly: [
+				{
+					readonly: true,
+				},
+			],
+		},
+		order: ['[override]', '[readonly]', '[abstract]'],
+	},
+];
+
 ruleTester.run('sort-class-members', rule, {
 	valid: [
 		{ code: 'class A {}', options: defaultOptions },
@@ -374,6 +397,11 @@ ruleTester.run('sort-class-members', rule, {
 			options: typescriptAccessibilityOptions,
 			parser: require.resolve('@typescript-eslint/parser'),
 		},
+		{
+			code: 'class { override a: any; readonly b = true; abstract c: () => {} }',
+			options: typescriptKeywordsOptions,
+			parser: require.resolve('@typescript-eslint/parser'),
+		},
 	],
 	invalid: [
 		{
@@ -886,6 +914,42 @@ ruleTester.run('sort-class-members', rule, {
 			options: typescriptAccessibilityOptions,
 			parser: require.resolve('@typescript-eslint/parser'),
 		},
+		{
+			code: 'class { abstract a; override b; }',
+			output: 'class { override b; abstract a;  }',
+			errors: [
+				{
+					message: 'Expected property b to come before method a.',
+					type: 'PropertyDefinition',
+				},
+			],
+			options: typescriptKeywordsOptions,
+			parser: require.resolve('@typescript-eslint/parser'),
+		},
+		{
+			code: 'class { readonly a; override b; }',
+			output: 'class { override b; readonly a;  }',
+			errors: [
+				{
+					message: 'Expected property b to come before property a.',
+					type: 'PropertyDefinition',
+				},
+			],
+			options: typescriptKeywordsOptions,
+			parser: require.resolve('@typescript-eslint/parser'),
+		},
+		{
+			code: 'class { abstract a(); readonly b; }',
+			output: 'class { readonly b; abstract a();  }',
+			errors: [
+				{
+					message: 'Expected property b to come before method a.',
+					type: 'PropertyDefinition',
+				},
+			],
+			options: typescriptKeywordsOptions,
+			parser: require.resolve('@typescript-eslint/parser'),
+		},
 	],
 });