[compiler] Fix error description inconsistency

Small fix to make all descriptions consistently printed with a single period at the end.

Ran `grep -rn "description:" packages/babel-plugin-react-compiler/src --include="*.ts" --exclude-dir="__tests__" | grep '\.\s*["\`]'` to find all descriptions ending in a period and manually fixed them.

Author: poteto

compiler/packages/babel-plugin-react-compiler/src/CompilerError.ts

@@ -141,11 +141,10 @@ export class CompilerDiagnostic {
   }
 
   printErrorMessage(source: string, options: PrintErrorMessageOptions): string {
-    const buffer = [
-      printErrorSummary(this.category, this.reason),
-      '\n\n',
-      this.description,
-    ];
+    const buffer = [printErrorSummary(this.category, this.reason)];
+    if (this.description != null) {
+      buffer.push('\n\n', `${this.description}.`);
+    }
     for (const detail of this.options.details) {
       switch (detail.kind) {
         case 'error': {

compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Imports.ts

@@ -256,7 +256,7 @@ export function addImportsToProgram(
         {
           reason:
             'Encountered conflicting import specifiers in generated program',
-          description: `Conflict from import ${loweredImport.module}:(${loweredImport.imported} as ${loweredImport.name}).`,
+          description: `Conflict from import ${loweredImport.module}:(${loweredImport.imported} as ${loweredImport.name})`,
           details: [
             {
               kind: 'error',

compiler/packages/babel-plugin-react-compiler/src/Entrypoint/ValidateNoUntransformedReferences.ts

@@ -96,7 +96,7 @@ function assertValidEffectImportReference(
             reason:
               'Cannot infer dependencies of this effect. This will break your build!',
             description:
-              'To resolve, either pass a dependency array or fix reported compiler bailout diagnostics.' +
+              'To resolve, either pass a dependency array or fix reported compiler bailout diagnostics' +
               (maybeErrorDiagnostic ? ` ${maybeErrorDiagnostic}` : ''),
             details: [
               {
@@ -128,9 +128,7 @@ function assertValidFireImportReference(
         reason: '[Fire] Untransformed reference to compiler-required feature.',
         description:
           'Either remove this `fire` call or ensure it is successfully transformed by the compiler' +
-          maybeErrorDiagnostic
-            ? ` ${maybeErrorDiagnostic}`
-            : '',
+          (maybeErrorDiagnostic != null ? ` ${maybeErrorDiagnostic}` : ''),
         details: [
           {
             kind: 'error',

compiler/packages/babel-plugin-react-compiler/src/HIR/BuildHIR.ts

@@ -110,7 +110,7 @@ export function lower(
           CompilerDiagnostic.create({
             category: ErrorCategory.Invariant,
             reason: 'Could not find binding',
-            description: `[BuildHIR] Could not find binding for param \`${param.node.name}\`.`,
+            description: `[BuildHIR] Could not find binding for param \`${param.node.name}\``,
           }).withDetails({
             kind: 'error',
             loc: param.node.loc ?? null,
@@ -174,7 +174,7 @@ export function lower(
         CompilerDiagnostic.create({
           category: ErrorCategory.Todo,
           reason: `Handle ${param.node.type} parameters`,
-          description: `[BuildHIR] Add support for ${param.node.type} parameters.`,
+          description: `[BuildHIR] Add support for ${param.node.type} parameters`,
         }).withDetails({
           kind: 'error',
           loc: param.node.loc ?? null,
@@ -205,7 +205,7 @@ export function lower(
       CompilerDiagnostic.create({
         category: ErrorCategory.Syntax,
         reason: `Unexpected function body kind`,
-        description: `Expected function body to be an expression or a block statement, got \`${body.type}\`.`,
+        description: `Expected function body to be an expression or a block statement, got \`${body.type}\``,
       }).withDetails({
         kind: 'error',
         loc: body.node.loc ?? null,

compiler/packages/babel-plugin-react-compiler/src/Inference/DropManualMemoization.ts

@@ -465,7 +465,7 @@ export function dropManualMemoization(
                       manualMemo.loadInstr.value.kind === 'PropertyLoad'
                         ? 'React.useMemo'
                         : 'useMemo'
-                    } callback doesn't return a value. useMemo is for computing and caching values, not for arbitrary side effects.`,
+                    } callback doesn't return a value. useMemo is for computing and caching values, not for arbitrary side effects`,
                     suggestions: null,
                   }).withDetails({
                     kind: 'error',

compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingEffects.ts

@@ -475,7 +475,7 @@ function applySignature(
             const diagnostic = CompilerDiagnostic.create({
               category: ErrorCategory.Immutability,
               reason: 'This value cannot be modified',
-              description: `${reason}.`,
+              description: reason,
             }).withDetails({
               kind: 'error',
               loc: effect.value.loc,
@@ -1096,7 +1096,7 @@ function applyEffect(
           const diagnostic = CompilerDiagnostic.create({
             category: ErrorCategory.Immutability,
             reason: 'Cannot access variable before it is declared',
-            description: `${variable ?? 'This variable'} is accessed before it is declared, which prevents the earlier access from updating when this value changes over time.`,
+            description: `${variable ?? 'This variable'} is accessed before it is declared, which prevents the earlier access from updating when this value changes over time`,
           });
           if (hoistedAccess != null && hoistedAccess.loc != effect.value.loc) {
             diagnostic.withDetails({
@@ -1135,7 +1135,7 @@ function applyEffect(
           const diagnostic = CompilerDiagnostic.create({
             category: ErrorCategory.Immutability,
             reason: 'This value cannot be modified',
-            description: `${reason}.`,
+            description: reason,
           }).withDetails({
             kind: 'error',
             loc: effect.value.loc,
@@ -2271,7 +2271,7 @@ function computeEffectsForLegacySignature(
           'This API returns functions which cannot be memoized without leading to stale UI. ' +
             'To prevent this, by default React Compiler will skip memoizing this component/hook. ' +
             'However, you may see issues if values from this API are passed to other components/hooks that are ' +
-            'memoized.',
+            'memoized',
         ].join(''),
       }).withDetails({
         kind: 'error',

compiler/packages/babel-plugin-react-compiler/src/ReactiveScopes/AssertScopeInstructionsWithinScope.ts

@@ -83,7 +83,7 @@ class CheckInstructionsAgainstScopesVisitor extends ReactiveFunctionVisitor<
       CompilerError.invariant(false, {
         reason:
           'Encountered an instruction that should be part of a scope, but where that scope has already completed',
-        description: `Instruction [${id}] is part of scope @${scope.id}, but that scope has already completed.`,
+        description: `Instruction [${id}] is part of scope @${scope.id}, but that scope has already completed`,
         details: [
           {
             kind: 'error',

compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateLocalsNotReassignedAfterRender.ts

@@ -39,7 +39,7 @@ export function validateLocalsNotReassignedAfterRender(fn: HIRFunction): void {
       CompilerDiagnostic.create({
         category: ErrorCategory.Immutability,
         reason: 'Cannot reassign variable after render completes',
-        description: `Reassigning ${variable} after render has completed can cause inconsistent behavior on subsequent renders. Consider using state instead.`,
+        description: `Reassigning ${variable} after render has completed can cause inconsistent behavior on subsequent renders. Consider using state instead`,
       }).withDetails({
         kind: 'error',
         loc: reassignment.loc,

compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoCapitalizedCalls.ts

@@ -59,7 +59,7 @@ export function validateNoCapitalizedCalls(
             CompilerError.throwInvalidReact({
               category: ErrorCategory.CapitalizedCalls,
               reason,
-              description: `${calleeName} may be a component.`,
+              description: `${calleeName} may be a component`,
               loc: value.loc,
               suggestions: null,
             });
@@ -83,7 +83,7 @@ export function validateNoCapitalizedCalls(
             errors.push({
               category: ErrorCategory.CapitalizedCalls,
               reason,
-              description: `${propertyName} may be a component.`,
+              description: `${propertyName} may be a component`,
               loc: value.loc,
               suggestions: null,
             });

compiler/packages/babel-plugin-react-compiler/src/Validation/ValidateNoFreezingKnownMutableFunctions.ts

@@ -67,7 +67,7 @@ export function validateNoFreezingKnownMutableFunctions(
           CompilerDiagnostic.create({
             category: ErrorCategory.Immutability,
             reason: 'Cannot modify local variables after render completes',
-            description: `This argument is a function which may reassign or mutate ${variable} after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead.`,
+            description: `This argument is a function which may reassign or mutate ${variable} after render, which can cause inconsistent behavior on subsequent renders. Consider using state instead`,
           })
             .withDetails({
               kind: 'error',