@automattic/eslint-plugin-wpvip 0.11.0 → 0.12.0

package/configs/testing.js

@@ -1,10 +1,12 @@
+const isPackageInstalled = require( '../utils/is-package-installed' );
+
 /**
  * Based on:
  * - https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/test-unit.js
  * - https://github.com/WordPress/gutenberg/blob/%40wordpress/eslint-plugin%4014.1.0/packages/eslint-plugin/configs/test-e2e.js
  */
 
-module.exports = {
+const config = {
 	extends: [ 'plugin:jest/recommended' ],
 
 	env: {
@@ -13,3 +15,19 @@ module.exports = {
 
 	plugins: [ 'jest' ],
 };
+
+if ( isPackageInstalled( 'typescript' ) ) {
+	// Add an override for TypeScript's overzealous unbound-method rule that allows
+	// Jest mocks to be inspected without being bound to a variable.
+	config.overrides = [
+		{
+			files: [ '__tests__/**/*.ts', '**/*.test.ts', '**/*.spec.ts' ],
+			rules: {
+				'@typescript-eslint/unbound-method': 'off',
+				'jest/unbound-method': 'error',
+			},
+		},
+	];
+}
+
+module.exports = config;

package/configs/typescript.js

@@ -23,6 +23,20 @@ module.exports = {
 			},
 
 			rules: {
+				// Ensures NestJS route prefixes are correctly formatted.
+				'@automattic/wpvip/nestjs-route-prefix': 'error',
+
+				// Require explicity visibility for class methods and properties to avoid
+				// implicit public access. Allow constructors to be implicitly public.
+				'@typescript-eslint/explicit-member-accessibility': [
+					'error',
+					{
+						overrides: {
+							constructors: 'off',
+						},
+					},
+				],
+
 				// TypeScript `any` type must not be used. This is a warning in the base
 				// config, and is elevated to an error here.
 				'@typescript-eslint/no-explicit-any': 'error',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/eslint-plugin-wpvip",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "ESLint plugin for internal WordPress VIP projects",
   "main": "index.js",
   "scripts": {

package/rules/README.md

@@ -34,3 +34,13 @@ console.log( 'done! but not really' );
 ```
 
 In the example above, `'done! but not really'` is logged before the promises returned by `processLetter` have resolved. This is because the array is iterated immediately and execution proceeds without awaiting promise resolution.
+
+## `nestjs-route-prefix`
+
+This rule checks Nest.js controller route decorators for specific conventions related to route configuration. These constraints are enforced in an effort to improve code readability and searchability within the application.
+
+The `@Controller` and HTTP method decorators (`@Get`, `@Post`, `@Put`, `@Delete`, `@Patch`, `@Options`, `@Head`) are examined in this process.
+
+- The `@Controller` decorator should not have any route prefixes. For example, this means `@Controller('users')` will be flagged as incorrect.
+
+- The HTTP method decorators (`@Get`, `@Post`, etc.) should have a route that starts with `/` and does not end with `/`. For example, `@Get('/users/')` would be flagged as incorrect.

package/rules/index.js

@@ -3,6 +3,7 @@
  */
 module.exports = {
 	'dependency-group': require( './dependency-group' ),
+	'nestjs-route-prefix': require( './nestjs-route-prefix' ),
 	'no-async-foreach': require( './no-async-foreach' ),
 	'no-unguarded-get-range-at': require( './no-unguarded-get-range-at' ),
 };

package/rules/nestjs-route-prefix.js

@@ -0,0 +1,46 @@
+/**
+ * Rule: @automattic/wpvip/nestjs-route-prefix
+ */
+
+const nestJsControllerDecorators = [ 'Controller' ];
+const nestJsRouteDecorators = [ 'Get', 'Post', 'Put', 'Delete', 'Patch', 'Options', 'Head' ];
+
+module.exports = {
+	create( context ) {
+		return {
+			Decorator( node ) {
+				if ( ! node.expression.callee?.name ) {
+					// If it's not a callable method, bail out since Nest.js route controller decorators always a callable method.
+					return;
+				}
+
+				const decoratorName = node.expression.callee.name;
+				const argument = node.expression?.arguments[ 0 ] ?? [];
+
+				if ( nestJsControllerDecorators.includes( decoratorName ) ) {
+					if ( argument && argument.type === 'Literal' && argument.value !== '' ) {
+						context.report( {
+							node,
+							message: '@Controller should not have route prefixes.',
+						} );
+					}
+					return;
+				}
+
+				if ( nestJsRouteDecorators.includes( decoratorName ) ) {
+					if (
+						! argument ||
+						argument.type !== 'Literal' ||
+						! argument.value.startsWith( '/' ) ||
+						argument.value.endsWith( '/' )
+					) {
+						context.report( {
+							node,
+							message: `@${ decoratorName } should have a route starting with '/' and not ending with '/'.`,
+						} );
+					}
+				}
+			},
+		};
+	},
+};