Add a fixer to fix reference directive errors

also, reword the error messages to be explicit on which directives to
add.

Signed-off-by: Hana Joo <hanajoo@google.com>

Author: h-joo

src/compiler/diagnosticMessages.json

@@ -7227,8 +7227,11 @@
     "Annotate types of properties expando function in a namespace": {
       "category": "Message",
       "code": 90071
-  },
-
+    },
+    "Add triple slash directives for import resolution": {
+      "category": "Message",
+      "code": 90072
+    },
     "Convert function to an ES2015 class": {
         "category": "Message",
         "code": 95001

src/compiler/transformers/declarations.ts

@@ -722,8 +722,8 @@ export function transformDeclarations(context: TransformationContext) {
                     if (!isPresentInSource && isolatedDeclarations) {
                         context.addDiagnostic(createDiagnosticForNode(
                             requestingNode,
-                            Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_type_reference_directive_to_0_with_isolatedDeclarations,
-                            specifier,
+                            Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_path_reference_directive_to_0_with_isolatedDeclarations,
+                            fileName,
                         ));
                     }
                     references.push({ pos: -1, end: -1, fileName });

src/harness/isolatedDeclarationFixer.ts

@@ -4,6 +4,7 @@ import * as vfs from "./_namespaces/vfs";
 
 export const isolatedDeclarationsErrors = new Set([
     ts.Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_type_reference_directive_to_0_with_isolatedDeclarations,
+    ts.Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_path_reference_directive_to_0_with_isolatedDeclarations,
     ts.Diagnostics.Assigning_properties_to_functions_without_declaring_them_is_not_supported_with_isolatedDeclarations_Add_an_explicit_declaration_for_the_properties_assigned_to_this_function,
     ts.Diagnostics.Declaration_emit_for_this_parameter_requires_implicitly_adding_undefined_to_it_s_type_This_is_not_supported_with_isolatedDeclarations,
     ts.Diagnostics.Function_must_have_an_explicit_return_type_annotation_with_isolatedDeclarations,
@@ -98,6 +99,8 @@ export function fixProjectInternal(
 
             const fixAll = service.getCombinedCodeFix({ type: "file", fileName: file.fileName }, "fixMissingTypeAnnotationOnExports", defaultFormatOptions, userPreferences);
             applyFix(fixAll.changes);
+            const fixAll2 = service.getCombinedCodeFix({ type: "file", fileName: file.fileName }, "fixMissingReferenceDirectivesForIsolatedDeclarations", defaultFormatOptions, userPreferences);
+            applyFix(fixAll2.changes);
 
             // Some fixes need to be applied individually such as fixing `export =`
             diagnostics = getIsolatedDeclarationsErrors(file.fileName);

src/services/_namespaces/ts.codefix.ts

@@ -49,6 +49,7 @@ export * from "../codefixes/fixUnreachableCode";
 export * from "../codefixes/fixUnusedLabel";
 export * from "../codefixes/fixJSDocTypes";
 export * from "../codefixes/fixMissingCallParentheses";
+export * from "../codefixes/fixMissingReferenceDirectivesForIsolatedDeclarations";
 export * from "../codefixes/fixMissingTypeAnnotationOnExports";
 export * from "../codefixes/fixAwaitInSyncFunction";
 export * from "../codefixes/fixPropertyOverrideAccessor";

src/services/codefixes/fixMissingReferenceDirectivesForIsolatedDeclarations.ts

@@ -0,0 +1,42 @@
+import {CodeFixContextBase, Diagnostics, DiagnosticWithLocation, textChanges} from "../_namespaces/ts";
+import {codeFixAll, createCodeFixAction, registerCodeFix} from "../_namespaces/ts.codefix";
+import {ChangeTracker} from "../textChanges";
+
+
+const fixId = "fixMissingReferenceDirectivesForIsolatedDeclarations";
+const errorCodes = [
+  Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_type_reference_directive_to_0_with_isolatedDeclarations,
+  Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_path_reference_directive_to_0_with_isolatedDeclarations
+].map((diag) => diag.code);
+
+registerCodeFix({
+  errorCodes,
+  fixIds: [fixId],
+  getCodeActions(context) {
+    const {span, sourceFile, program} = context;
+    const diags = program.getDeclarationDiagnostics(sourceFile);
+    const diagOnNode = diags.find((diag) => diag.start === span.start);
+    if (diagOnNode) {
+      const changes = textChanges.ChangeTracker.with(context, (changeTracker) => fixDiag(context, diagOnNode, changeTracker));
+      return [
+        createCodeFixAction(
+          fixId,
+          changes,
+          Diagnostics.Add_triple_slash_directives_for_import_resolution,
+          fixId,
+          // TODO: ADD
+          Diagnostics.Add_triple_slash_directives_for_import_resolution)];
+    }
+  },
+  getAllCodeActions: context => codeFixAll(context, errorCodes, (changes, diag) => {
+    fixDiag(context, diag, changes)
+  }),
+});
+
+function fixDiag(context: CodeFixContextBase, diag: DiagnosticWithLocation, changeTracker: ChangeTracker) {
+  const messageText = diag.messageText as string;
+  const first = messageText.indexOf("'");
+  const last = messageText.lastIndexOf("'");
+  const tripleSlashType = diag.code === Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_type_reference_directive_to_0_with_isolatedDeclarations.code ? 'types' : 'path'
+  changeTracker.insertText(context.sourceFile, 0, `/// <reference ${tripleSlashType}='${messageText.substring(first + 1, last)}' />\n`);
+}

src/testRunner/compilerRunner.ts

@@ -599,6 +599,7 @@ class IsolatedDeclarationTest extends CompilerTestBase {
         ts.Diagnostics.Enum_member_initializers_must_be_computable_without_references_to_external_symbols_with_isolatedDeclarations,
         ts.Diagnostics.Extends_clause_can_t_contain_an_expression_with_isolatedDeclarations,
         ts.Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_type_reference_directive_to_0_with_isolatedDeclarations,
+        ts.Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_path_reference_directive_to_0_with_isolatedDeclarations,
         ts.Diagnostics.Assigning_properties_to_functions_without_declaring_them_is_not_supported_with_isolatedDeclarations_Add_an_explicit_declaration_for_the_properties_assigned_to_this_function,
         ts.Diagnostics.Objects_that_contain_shorthand_properties_can_t_be_inferred_with_isolatedDeclarations,
         ts.Diagnostics.Objects_that_contain_spread_assignments_can_t_be_inferred_with_isolatedDeclarations,
@@ -747,6 +748,7 @@ export class FixedIsolatedDeclarationTest extends IsolatedDeclarationTest {
     }
     private static referenceDirectiveErrors = new Set([
         ts.Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_type_reference_directive_to_0_with_isolatedDeclarations.code,
+        ts.Diagnostics.Declaration_emit_for_this_expression_requires_adding_a_path_reference_directive_to_0_with_isolatedDeclarations.code,
     ]);
 
     protected override get baselinePath() {

tests/baselines/reference/isolated-declarations/original/diff/declarationEmitBundleWithAmbientReferences.d.ts.diff

@@ -16,7 +16,7 @@
 -
 -/// [Errors] ////
 -
--src/datastore_result.ts(1,1): error TS9024: Declaration emit for this expression requires adding a type reference directive to './lib/lib' with --isolatedDeclarations.
+-src/datastore_result.ts(1,1): error TS9025: Declaration emit for this expression requires adding a path reference directive to '../lib/lib.d.ts' with --isolatedDeclarations.
 -
 -
 -==== lib/lib.d.ts (0 errors) ====
@@ -29,7 +29,7 @@
 -==== src/datastore_result.ts (1 errors) ====
 -    import { Result } from "lib/result";
 -    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--!!! error TS9024: Declaration emit for this expression requires adding a type reference directive to './lib/lib' with --isolatedDeclarations.
+-!!! error TS9025: Declaration emit for this expression requires adding a path reference directive to '../lib/lib.d.ts' with --isolatedDeclarations.
 -    
 -    export type T<T> = Result<Error, T>;
 -    

tests/baselines/reference/isolated-declarations/original/diff/moduleAugmentationsImports2.d.ts.diff

@@ -23,7 +23,7 @@
 -
 -/// [Errors] ////
 -
--e.ts(2,1): error TS9024: Declaration emit for this expression requires adding a type reference directive to '.c' with --isolatedDeclarations.
+-e.ts(2,1): error TS9025: Declaration emit for this expression requires adding a path reference directive to 'c.d.ts' with --isolatedDeclarations.
 -
 -
 -==== a.ts (0 errors) ====
@@ -55,7 +55,7 @@
 -    import {A} from "./a";
 -    import {Cls} from "C";
 -    ~~~~~~~~~~~~~~~~~~~~~~
--!!! error TS9024: Declaration emit for this expression requires adding a type reference directive to '.c' with --isolatedDeclarations.
+-!!! error TS9025: Declaration emit for this expression requires adding a path reference directive to 'c.d.ts' with --isolatedDeclarations.
 -    
 -    A.prototype.getCls = function () { return undefined; }
 -    

tests/baselines/reference/isolated-declarations/original/diff/nodeModulesAllowJsImportHelpersCollisions2(module=node16).d.ts.diff

@@ -19,7 +19,7 @@
    The file is in the program because:
      Root file specified for compilation
  subfolder/index.ts(2,1): error TS2343: This syntax requires an imported helper named '__exportStar' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.
--subfolder/index.ts(2,1): error TS9024: Declaration emit for this expression requires adding a type reference directive to './types' with --isolatedDeclarations.
+-subfolder/index.ts(2,1): error TS9025: Declaration emit for this expression requires adding a path reference directive to '../types.d.ts' with --isolatedDeclarations.
  subfolder/index.ts(3,1): error TS2343: This syntax requires an imported helper named '__importStar' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.
 
 
@@ -33,7 +33,7 @@
      ~~~~~~~~~~~~~~~~~~~
  !!! error TS2343: This syntax requires an imported helper named '__exportStar' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.
 -    ~~~~~~~~~~~~~~~~~~~
--!!! error TS9024: Declaration emit for this expression requires adding a type reference directive to './types' with --isolatedDeclarations.
+-!!! error TS9025: Declaration emit for this expression requires adding a path reference directive to '../types.d.ts' with --isolatedDeclarations.
      export * as fs from "fs";
      ~~~~~~~~~~~~~~~~~~~~~~~~~
  !!! error TS2343: This syntax requires an imported helper named '__importStar' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.

tests/baselines/reference/isolated-declarations/original/diff/nodeModulesAllowJsImportHelpersCollisions2(module=nodenext).d.ts.diff

@@ -19,7 +19,7 @@
    The file is in the program because:
      Root file specified for compilation
  subfolder/index.ts(2,1): error TS2343: This syntax requires an imported helper named '__exportStar' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.
--subfolder/index.ts(2,1): error TS9024: Declaration emit for this expression requires adding a type reference directive to './types' with --isolatedDeclarations.
+-subfolder/index.ts(2,1): error TS9025: Declaration emit for this expression requires adding a path reference directive to '../types.d.ts' with --isolatedDeclarations.
  subfolder/index.ts(3,1): error TS2343: This syntax requires an imported helper named '__importStar' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.
 
 
@@ -33,7 +33,7 @@
      ~~~~~~~~~~~~~~~~~~~
  !!! error TS2343: This syntax requires an imported helper named '__exportStar' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.
 -    ~~~~~~~~~~~~~~~~~~~
--!!! error TS9024: Declaration emit for this expression requires adding a type reference directive to './types' with --isolatedDeclarations.
+-!!! error TS9025: Declaration emit for this expression requires adding a path reference directive to '../types.d.ts' with --isolatedDeclarations.
      export * as fs from "fs";
      ~~~~~~~~~~~~~~~~~~~~~~~~~
  !!! error TS2343: This syntax requires an imported helper named '__importStar' which does not exist in 'tslib'. Consider upgrading your version of 'tslib'.