Add ESLint rule to enforce "pull request" over "PR" in user-facing strings (#7693)

* Initial plan

* Initial plan for PR lint rule implementation

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

* Implement ESLint rule to detect PR in user-facing strings

- Add no-pr-in-user-strings.js rule to detect PR in vscode.l10n.t() calls
- Export rule from build/eslint-rules/index.js
- Configure rule as error level in .eslintrc.js
- Rule uses word boundary regex to detect standalone 'PR'
- Successfully detects existing issue in issueFeatureRegistrar.ts

The rule correctly identifies 1 existing violation which will need to be fixed
in a follow-up commit to demonstrate the rule is working properly.

* Fix PR reference in user-facing string to use pull request

Replace 'PR' with 'pull request' in @githubpr Summarize command to comply with new ESLint rule

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

* remove proposed change

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>

Author: Copilot

.eslintrc.js

@@ -28,7 +28,8 @@ module.exports = {
 		{
 			files: ['**/*.ts', '**/*.tsx'],
 			rules: {
-				'rulesdir/no-any-except-union-method-signature': 'error'
+				'rulesdir/no-any-except-union-method-signature': 'error',
+				'rulesdir/no-pr-in-user-strings': 'error'
 			}
 		}
 	]

build/eslint-rules/index.js

@@ -8,4 +8,5 @@
 module.exports = {
 	'public-methods-well-defined-types': require('./public-methods-well-defined-types'),
 	'no-any-except-union-method-signature': require('./no-any-except-union-method-signature'),
+	'no-pr-in-user-strings': require('./no-pr-in-user-strings'),
 };

build/eslint-rules/no-pr-in-user-strings.js

@@ -0,0 +1,96 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+'use strict';
+
+/**
+ * ESLint rule to detect the string "PR" in user-facing strings and suggest using "pull request" instead.
+ * This rule checks:
+ * - String literals passed to vscode.l10n.t() calls
+ * - String literals passed to l10n.t() calls
+ */
+
+module.exports = {
+	meta: {
+		type: 'problem',
+		docs: {
+			description: 'Detect "PR" in user-facing strings and suggest using "pull request" instead',
+			category: 'Best Practices',
+			recommended: true,
+		},
+		schema: [],
+		messages: {
+			noPrInUserString: 'Use "pull request" instead of "PR" in user-facing strings. Found: {{foundText}}',
+		},
+	},
+
+	create(context) {
+		/**
+		 * Check if a string contains "PR" as a standalone word
+		 */
+		function containsPR(str) {
+			// Use word boundary regex to match "PR" as a standalone word
+			const prRegex = /\bPR\b/;
+			return prRegex.test(str);
+		}
+
+		/**
+		 * Check if a node is a call to vscode.l10n.t or l10n.t
+		 */
+		function isL10nTCall(node) {
+			if (node.type !== 'CallExpression') {
+				return false;
+			}
+
+			const callee = node.callee;
+			
+			// Handle l10n.t() calls
+			if (callee.type === 'MemberExpression' && 
+				callee.property && 
+				callee.property.name === 't') {
+				
+				// Check for vscode.l10n.t
+				if (callee.object.type === 'MemberExpression' &&
+					callee.object.object &&
+					callee.object.object.name === 'vscode' &&
+					callee.object.property &&
+					callee.object.property.name === 'l10n') {
+					return true;
+				}
+				
+				// Check for l10n.t
+				if (callee.object.type === 'Identifier' &&
+					callee.object.name === 'l10n') {
+					return true;
+				}
+			}
+			
+			return false;
+		}
+
+		return {
+			// Check CallExpression nodes for l10n.t calls
+			CallExpression(node) {
+				if (isL10nTCall(node)) {
+					// Check the first argument (string literal)
+					if (node.arguments && node.arguments.length > 0) {
+						const firstArg = node.arguments[0];
+						if (firstArg.type === 'Literal' && typeof firstArg.value === 'string') {
+							if (containsPR(firstArg.value)) {
+								context.report({
+									node: firstArg,
+									messageId: 'noPrInUserString',
+									data: {
+										foundText: firstArg.value
+									}
+								});
+							}
+						}
+					}
+				}
+			}
+		};
+	}
+};

src/issues/issueFeatureRegistrar.ts

@@ -510,7 +510,7 @@ export class IssueFeatureRegistrar extends Disposable {
 				} else {
 					const pullRequestModel = issue.pullRequestModel;
 					const remote = pullRequestModel.githubRepository.remote;
-					commands.executeCommand(chatCommandID, vscode.l10n.t('@githubpr Summarize PR {0}/{1}#{2}', remote.owner, remote.repositoryName, pullRequestModel.number));
+					commands.executeCommand(chatCommandID, vscode.l10n.t('@githubpr Summarize pull request {0}/{1}#{2}', remote.owner, remote.repositoryName, pullRequestModel.number));
 				}
 			}),
 		);