feat: #709 - Check and display syntax diagnostics when a manipulation…

… error occurs.

package.json

@@ -70,6 +70,7 @@
   },
   "dependencies": {
     "@dsherret/to-absolute-glob": "^2.0.2",
+    "chalk": "^2.4.2",
     "code-block-writer": "^10.0.0",
     "fs-extra": "^8.1.0",
     "glob-parent": "^5.0.0",
@@ -90,7 +91,6 @@
     "@types/node": "^12.7.5",
     "@types/ts-nameof": "^3.2.0",
     "chai": "^4.2.0",
-    "chalk": "^2.4.2",
     "conditional-type-checks": "^1.0.1",
     "coveralls": "^3.0.6",
     "cross-env": "^6.0.0",

src/manipulation/manipulations/doManipulation.ts

@@ -1,5 +1,7 @@
 /* barrel:ignore */
-import { SourceFile } from "../../compiler";
+import chalk from "chalk";
+import { SourceFile, Diagnostic } from "../../compiler";
+import { Project, ProjectOptions } from "../../Project";
 import * as errors from "../../errors";
 import { NodeHandler } from "../nodeHandlers";
 import { TextManipulator } from "../textManipulators";
@@ -15,10 +17,33 @@ export function doManipulation(sourceFile: SourceFile, textManipulator: TextMani
         );
         nodeHandler.handleNode(sourceFile, replacementSourceFile, replacementSourceFile);
     } catch (err) {
-        throw new errors.InvalidOperationError(err.message + "\n"
-            + `-- Details --\n`
-            + `Path: ${sourceFile.getFilePath()}\n`
-            + `Text: ${JSON.stringify(textManipulator.getTextForError(newFileText))}\n`
-            + `Stack: ${err.stack}`);
+        const diagnostics = getSyntacticDiagnostics(sourceFile, newFileText);
+        const errorDetails = chalk.yellow(err.message) + "\n\n"
+            + chalk.blue(`-- Details --\n`)
+            + chalk.gray("Path: ") + sourceFile.getFilePath() + "\n"
+            + chalk.gray("Text: ") + JSON.stringify(textManipulator.getTextForError(newFileText)) + "\n"
+            + chalk.gray("Stack: ") + err.stack;
+
+        if (diagnostics.length > 0) {
+            throw new errors.InvalidOperationError(
+                chalk.red("Manipulation error: ") + chalk.yellow("A syntax error was inserted.") + "\n\n"
+                    + sourceFile._context.project.formatDiagnosticsWithColorAndContext(diagnostics, { newLineChar: "\n" })
+                    + "\n" + errorDetails
+            );
+        }
+
+        throw new errors.InvalidOperationError(chalk.red("Manipulation error: ") + errorDetails);
+    }
+}
+
+function getSyntacticDiagnostics(sourceFile: SourceFile, newText: string) {
+    try {
+        // hack to avoid circular references
+        const projectOptions: ProjectOptions = { useVirtualFileSystem: true };
+        const project = new (sourceFile._context.project.constructor as any)(projectOptions) as Project;
+        const newFile = project.createSourceFile(sourceFile.getFilePath(), newText);
+        return project.getProgram().getSyntacticDiagnostics(newFile);
+    } catch (err) {
+        return [] as Diagnostic[];
     }
 }

src/tests/manipulation/manipulations/doManipulationTests.ts

@@ -0,0 +1,23 @@
+import { expect } from "chai";
+import { getInfoFromText } from "../../compiler/testHelpers";
+import { SyntaxKind } from "../../../typescript";
+import { Block } from "../../../compiler";
+
+describe("doManipulation", () => {
+    it("should display the syntactic diagnostics if the user inserts a syntax error", () => {
+        const { sourceFile } = getInfoFromText("if (true) {\n}");
+        const ifStatement = sourceFile.getStatementByKindOrThrow(SyntaxKind.IfStatement);
+        const body = ifStatement.getThenStatement() as Block;
+        let foundErr: any;
+        try {
+            body.addStatements("testing {");
+        } catch (err) {
+            foundErr = err;
+        }
+
+        // don't bother with the rest because it will change between ts versions...
+        const expectedText = `Manipulation error: A syntax error was inserted.`;
+        const message: string = foundErr.message;
+        expect(message.replace(/\u001b\[[0-9][0-9]?m/g, "").substring(0, expectedText.length)).to.equal(expectedText);
+    });
+});