Fixes error with pretty and adds cache to compilation (#28)

Author: KostkaBrukowa

.github/workflows/ci.yml

@@ -1,19 +1,19 @@
 name: CI
 
 on:
-  [push]
+  [pull_request]
 
 jobs:
   build:
     runs-on: ${{ matrix.os }}
-    strategy:     
+    strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
 
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js 14.x
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: '14.x'
       - run: npm i

CHANGELOG.md

@@ -11,6 +11,9 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - Strict by default without `@ts-strict` comment
 - Ignores file with `@ts-strict-ignore` comment
 - Migration tool `update-strict-comments` which updates comments in files which contain at least 1 strict error
+- Fixes error when `pretty: true` option was set in `tsconfig.json`
+- Adds a cache to compilation for `tsc-strict` process resulting in
+  50% speedup
 
 ## [1.1.2] - 2021-06-15
 

e2e/fixtures/default-config/tsconfig.json

@@ -6,6 +6,7 @@
     "baseUrl": "./",
     "outDir": "./dist",
     "strict": false,
+    "pretty": true,
     "esModuleInterop": true,
     "noImplicitAny": true,
     "plugins": [

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-strict-plugin",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.2",
   "description": "Typescript tools that help with migration to the strict mode",
   "author": "Allegro",
   "contributors": [

src/cli/findStrictFiles.ts

@@ -1,4 +1,4 @@
-import { getPosixFilePath } from '../common/utils';
+import { getPosixFilePath, isFile } from '../common/utils';
 import * as typescript from './typescript/typescript';
 import { CliStrictFileChecker } from './CliStrictFileChecker';
 import { getPluginConfig } from './getPluginConfig';
@@ -23,8 +23,8 @@ const filterOutNodeModulesFiles = (files: string[]): string[] => {
 };
 
 async function getFilesCheckedByTs(): Promise<string[]> {
-  const filesCheckedByTs = await typescript.listFilesOnly();
-  const filePaths = filesCheckedByTs.split(/\r?\n/).map(getPosixFilePath);
+  const filesCheckedByTs = await typescript.compile();
+  const filePaths = filesCheckedByTs.split(/\r?\n/).filter(isFile).map(getPosixFilePath);
 
   return filterOutNodeModulesFiles(filePaths);
 }

src/cli/typescript/compile.ts

@@ -1,6 +1,6 @@
 import { resolve } from 'path';
 import * as typescript from './typescript';
-import { ExecaError } from 'execa';
+import { isFile } from '../../common/utils';
 
 /**
  * @param tscOutput
@@ -40,14 +40,9 @@ function getPathToErrorsMap(tscOutput: string[]): Map<string, string[]> {
 }
 
 export async function compile(): Promise<Map<string, string[]>> {
-  let tscOutput: string[] = [];
-  try {
-    await typescript.compile();
-  } catch (error) {
-    if (isExecaError(error) && error.all) {
-      tscOutput = error.all.split(/\r?\n/);
-    }
-  }
+  const tscOutput: string[] = (await typescript.compile())
+    .split(/\r?\n/)
+    .filter((it) => !isFile(it));
 
   if (tscOutput.some((it) => it.startsWith('error'))) {
     console.log(`💥 Typescript did not compile due to some errors. Errors: `, tscOutput);
@@ -56,7 +51,3 @@ export async function compile(): Promise<Map<string, string[]>> {
 
   return getPathToErrorsMap(tscOutput);
 }
-
-function isExecaError(error: unknown): error is ExecaError {
-  return typeof (error as ExecaError)?.all === 'string';
-}

src/cli/typescript/typescript.ts

@@ -1,25 +1,40 @@
-import execa from 'execa';
+import execa, { ExecaError } from 'execa';
 
-export const listFilesOnly = async (): Promise<string> => {
-  const output = await execa('tsc', ['--listFilesOnly'], {
+export const showConfig = async (): Promise<string> => {
+  const output = await execa('tsc', ['--showConfig'], {
     all: true,
     preferLocal: true,
   });
 
   return output.stdout;
 };
 
-export const showConfig = async (): Promise<string> => {
-  const output = await execa('tsc', ['--showConfig'], {
-    all: true,
-    preferLocal: true,
-  });
+let compilerOutputCache = '';
+export const compile = async (): Promise<string> => {
+  if (compilerOutputCache) {
+    return compilerOutputCache;
+  }
 
-  return output.stdout;
+  try {
+    const compilerResult = await execa(
+      'tsc',
+      [...process.argv.slice(2), '--strict', '--noEmit', '--pretty', 'false', '--listFiles'],
+      {
+        all: true,
+        preferLocal: true,
+      },
+    );
+
+    compilerOutputCache = compilerResult.stdout;
+  } catch (error) {
+    if (isExecaError(error) && error.all) {
+      compilerOutputCache = error.all;
+    }
+  }
+
+  return compilerOutputCache;
 };
 
-export const compile = () =>
-  execa('tsc', ['--strict', '--noEmit', ...process.argv.slice(2)], {
-    all: true,
-    preferLocal: true,
-  });
+function isExecaError(error: unknown): error is ExecaError {
+  return typeof (error as ExecaError)?.all === 'string';
+}

src/common/utils.ts

@@ -1,4 +1,5 @@
 import path from 'path';
+import fs from 'fs';
 
 export function getPosixFilePath(filePath: string) {
   return filePath.split(path.sep).join(path.posix.sep);
@@ -7,3 +8,13 @@ export function getPosixFilePath(filePath: string) {
 export function pluralize(word: string, count: number) {
   return count === 1 ? word : `${word}s`;
 }
+
+export function isFile(path: string) {
+  try {
+    const stats = fs.statSync(path);
+
+    return stats.isFile();
+  } catch {
+    return false;
+  }
+}