refactor: Remove getEmitSkipped() from DirectoryEmitResult because it…

… was not accurate. BREAKING CHANGE: `DirectoryEmitResult#getEmitSkipped()` was removed. Check the output file paths and skipped file paths instead as that's more accurate.
dsherret · Aug 31, 2019 · f42ff74 · f42ff74
1 parent e3db1db
commit f42ff74
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 20 deletions.
diff --git a/lib/ts-morph.d.ts b/lib/ts-morph.d.ts
@@ -288,11 +288,6 @@ export declare class DirectoryEmitResult {
     private readonly _skippedFilePaths;
     private readonly _outputFilePaths;
     private constructor();
-    /**
-     * Gets if the emit was skipped.
-     * @deprecated This is being deprecated in favour of getSkippedFilePaths().
-     */
-    getEmitSkipped(): boolean;
     /**
      * Gets a collections of skipped file paths.
      */

diff --git a/src/fileSystem/DirectoryEmitResult.ts b/src/fileSystem/DirectoryEmitResult.ts
@@ -1,16 +1,8 @@
-export class DirectoryEmitResult {
+export class DirectoryEmitResult {
     /** @private */
     constructor(private readonly _skippedFilePaths: ReadonlyArray<string>, private readonly _outputFilePaths: ReadonlyArray<string>) {
     }
 
-    /**
-     * Gets if the emit was skipped.
-     * @deprecated This is being deprecated in favour of getSkippedFilePaths().
-     */
-    getEmitSkipped() {
-        return this._skippedFilePaths.length > 0;
-    }
-
     /** Gets a collections of skipped file paths. */
     getSkippedFilePaths() {
         return this._skippedFilePaths as string[];

diff --git a/src/next-major-deprecations.md b/src/next-major-deprecations.md
@@ -1,6 +1,6 @@
 # Deprecations in the next major
 
-* Remove DirectoryEmitResult#getSkippedFilePaths()
+* None
 
 # Future version
 

diff --git a/src/tests/fileSystem/directoryTests.ts b/src/tests/fileSystem/directoryTests.ts
@@ -1539,7 +1539,6 @@ describe(nameof(Directory), () => {
         function runChecks(fileSystem: FileSystemHost & CustomFileSystemProps, result: DirectoryEmitResult, outDir: string, declarationDir: string) {
             const writeLog = fileSystem.getWriteLog();
 
-            expect(result.getEmitSkipped()).to.be.false;
             expect(result.getOutputFilePaths().sort()).to.deep.equal(writeLog.map(l => l.filePath).sort());
             expect(writeLog.map(l => l.filePath).sort()).to.deep.equal([
                 outDir + "/file1.js.map",
@@ -1599,7 +1598,6 @@ describe(nameof(Directory), () => {
             subDir.createSourceFile("file1.ts", "export class Parent extends Child {}");
             subDir.createSourceFile("file2.ts", "");
             const result = await directory.emit();
-            expect(result.getEmitSkipped()).to.be.true;
             expect(result.getSkippedFilePaths()).to.deep.equal(["/dir/sub/file1.ts"]);
 
             const writeLog = fileSystem.getWriteLog();
@@ -1625,7 +1623,6 @@ describe(nameof(Directory), () => {
         function runChecks(fileSystem: FileSystemHost & CustomFileSystemProps, result: DirectoryEmitResult, outDir: string, declarationDir: string) {
             const writeLog = fileSystem.getWriteLog();
 
-            expect(result.getEmitSkipped()).to.be.false;
             expect(result.getOutputFilePaths()).to.deep.equal(writeLog.map(l => l.filePath));
             expect(writeLog[0].filePath).to.equal(outDir + "/file1.js.map");
             expect(writeLog[1].filePath).to.equal(outDir + "/file1.js");
@@ -1651,7 +1648,6 @@ describe(nameof(Directory), () => {
             const subDir2 = directory.createDirectory("sub2");
             subDir.createSourceFile("file1.ts", "");
             const result = subDir.emitSync({ outDir: "../sub2" });
-            expect(result.getEmitSkipped()).to.be.false;
 
             const writeLog = fileSystem.getWriteLog();
             expect(result.getOutputFilePaths()).to.deep.equal(writeLog.map(l => l.filePath));
@@ -1667,7 +1663,6 @@ describe(nameof(Directory), () => {
             subDir.createSourceFile("file1.ts", "export class Parent extends Child {}");
             subDir.createSourceFile("file2.ts", "");
             const result = directory.emitSync();
-            expect(result.getEmitSkipped()).to.be.true;
             expect(result.getSkippedFilePaths()).to.deep.equal(["/dir/sub/file1.ts"]);
 
             const writeLog = fileSystem.getWriteLog();