Merge pull request #4 from allegro/feature/compile-time-tsstrict-checking

Feature/compile time tsstrict checking

Author: KostkaBrukowa

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2021-06-15
+
+### Added
+
+- Adds cli tool to check strict files during build time
+
 ## [1.0.1] - 2021-06-01
 
 ### Fixed

README.md

@@ -4,7 +4,12 @@ Typescript plugin that allows turning on strict mode in specific files or direct
 
 ## Do i need this plugin?
 This plugin was created for bigger repositories that want to incorporate typescript strict mode, but project is so big that refactoring everything would take ages. This plugin allows user to simply put `//@ts-strict` comment to a top of a file and turn a strict mode to that file. If needed, strict mode can be turned on to directories too.
-NOTE: this plugin doesn't work in compile time. It will show errors in your IDE but they won't appear during compilation.
+Plugins in general doesn't work in compile time. They will show errors in your IDE but they won't appear during compilation.
+To check strict errors in marked files you can use our script `tsc-strict`.
+This command line tool is created to check for files that should be checked with strict rules in compilation time.
+It finds all files with `//@ts-strict` comment and files specified in `paths` parameter and checks for strict typescript errors only for that files.
+Therefore, we have strict errors inside our files and during build time.
+
 
 ## How to install
 
@@ -33,7 +38,7 @@ and add plugin to your `tsconfig.json`:
 That's it! You should be able to use `@ts-strict` comment to strictly check your files.
 
 ## Configuration
-Plugin takes one extra non mandatory argument `paths` that is an array of relative or absolute paths of directories that should be included.
+Plugin takes one extra non-mandatory argument `paths` that is an array of relative or absolute paths of directories that should be included.
 ```json
 {
   "compilerOptions": {
@@ -51,7 +56,24 @@ Plugin takes one extra non mandatory argument `paths` that is an array of relati
   }
 }
 ```
-All files contained in those paths will be be strictly checked. Yay!
+All files contained in those paths will be strictly checked. Yay!
+
+To add cli tool to your build time you can add a script to scripts list in package.json
+```json
+{
+  "scripts": {
+    ...,
+    "typecheck": "tsc && tsc-strict",
+  },
+}
+```
+
+Then you can simply run 
+```shell
+yarn tsc-strict
+```
+
+All your strict files should be checked from command line.
 
 ## Examples
 Let's consider this type and a variable

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
+};

e2e/compile-time-tool-tests/compile-time-tool.spec.ts

@@ -0,0 +1,35 @@
+import execa from 'execa';
+import { join } from 'path';
+
+const runInPath = async (path: string): Promise<string> => {
+  const cwd = process.cwd();
+  const cli = join(cwd, 'dist/compile-time-tool/cli.js');
+
+  process.chdir(path);
+  return execa('node', [cli], {
+    env: {
+      //the assertions break in an environment that supports color
+      //override chalk color detection https://github.com/chalk/supports-color/blob/master/index.js
+      FORCE_COLOR: 'false',
+    },
+  })
+    .then((response) => {
+      console.log('Response', response);
+      return response.stdout;
+    })
+    .catch((error) => error.stdout)
+    .finally(() => process.chdir(cwd));
+};
+
+test('files are detected correctly', async () => {
+  jest.setTimeout(20000);
+  const path = process.cwd() + '/e2e/compile-time-tool-tests/repository';
+
+  await runInPath(path).then((stdout) => {
+    expect(stdout).toMatch(/notOnPath.ts/);
+    expect(stdout).toMatch(/onPath.ts/);
+    expect(stdout).toMatch(/TS2532: Object is possibly 'undefined'/);
+    expect(stdout).toMatch(/Found 2 strict files/);
+    expect(stdout).toMatch(/2 errors found/);
+  });
+});

e2e/compile-time-tool-tests/repository/lib/onPath.ts

@@ -0,0 +1,7 @@
+interface TestType {
+  bar: string;
+}
+
+const foo: TestType | undefined = undefined;
+
+const boo = foo.bar;

e2e/compile-time-tool-tests/repository/src/notOnPath.ts

@@ -0,0 +1,8 @@
+//@ts-strict
+interface TestType {
+  bar: string;
+}
+
+const foo1: TestType | undefined = undefined;
+
+const boo1 = foo.bar;

e2e/compile-time-tool-tests/repository/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "plugins": [
+      {
+        "name": "typescript-strict-plugin",
+        "paths": ["./lib"]
+      }
+    ]
+  }
+}

e2e/fixtures/lang-server.js renamed to e2e/plugin-tests/fixtures/lang-server.ts

@@ -3,7 +3,30 @@ const { fork } = require('child_process');
 const path = require('path');
 const { EventEmitter } = require('events');
 
-class TSServer {
+export interface ServerResponse {
+  command: string;
+  event: string;
+  type: string;
+  body: any;
+}
+
+export interface ServerRequest {
+  command?: string;
+  event?: string;
+  type?: string;
+  arguments: any;
+}
+
+export class TSServer {
+  public responses: ServerResponse[];
+
+  private _responseEventEmitter: NodeJS.EventEmitter;
+  private _responseCommandEmitter: NodeJS.EventEmitter;
+  private _exitPromise: Promise<string>;
+  private _isClosed: boolean;
+  private _server: any;
+  private _seq: number;
+
   constructor() {
     this._responseEventEmitter = new EventEmitter();
     this._responseCommandEmitter = new EventEmitter();
@@ -16,13 +39,13 @@ class TSServer {
       stdio: ['pipe', 'pipe', 'pipe', 'ipc'],
     });
     this._exitPromise = new Promise((resolve, reject) => {
-      server.on('exit', (code) => resolve(code));
-      server.on('error', (reason) => reject(reason));
+      server.on('exit', (code: string) => resolve(code));
+      server.on('error', (reason: string) => reject(reason));
     });
     server.stdout.setEncoding('utf-8');
-    server.stdout.on('data', (data) => {
+    server.stdout.on('data', (data: string) => {
       const [, , res] = data.split('\n');
-      const obj = JSON.parse(res);
+      const obj = JSON.parse(res) as ServerResponse;
       if (obj.type === 'event') {
         this._responseEventEmitter.emit(obj.event, obj);
       } else if (obj.type === 'response') {
@@ -36,7 +59,7 @@ class TSServer {
     this.responses = [];
   }
 
-  send(command) {
+  send(command: ServerRequest) {
     const seq = ++this._seq;
     const req = JSON.stringify(Object.assign({ seq: seq, type: 'request' }, command)) + '\n';
     this._server.stdin.write(req);
@@ -50,13 +73,13 @@ class TSServer {
     return this._exitPromise;
   }
 
-  waitEvent(eventName) {
-    return new Promise((res) => this._responseEventEmitter.once(eventName, () => res()));
+  waitEvent(eventName: string) {
+    return new Promise((res) => this._responseEventEmitter.once(eventName, () => res(undefined)));
   }
 }
 
 function createServer() {
   return new TSServer();
 }
 
-module.exports = createServer;
+module.exports = { createServer };

e2e/it.js renamed to e2e/plugin-tests/it.ts

@@ -1,11 +1,18 @@
+import { ServerResponse, TSServer } from './fixtures/lang-server';
+
 const assert = require('assert');
 const path = require('path');
 
-function findResponse(responses, eventName) {
+function findResponse(responses: ServerResponse[], eventName: string) {
   return responses.find((response) => response.event === eventName);
 }
 
-async function it(fileName, server, fileContent, assertionCallback) {
+async function it(
+  fileName: string,
+  server: TSServer,
+  fileContent: string,
+  assertionCallback: (args: any[]) => void,
+) {
   const file = path.resolve(__dirname, './project-fixture/' + fileName);
 
   server.send({ command: 'open', arguments: { file, fileContent, scriptKindName: 'TS' } });
@@ -19,7 +26,7 @@ async function it(fileName, server, fileContent, assertionCallback) {
   return server.close().then(() => {
     const semanticDiagEvent = findResponse(server.responses, 'semanticDiag');
     assert(!!semanticDiagEvent);
-    assertionCallback(semanticDiagEvent.body.diagnostics);
+    assertionCallback(semanticDiagEvent?.body.diagnostics);
   });
 }
 

e2e/project-fixture/.vscode/settings.json renamed to e2e/plugin-tests/project-fixture/.vscode/settings.json

@@ -10,7 +10,7 @@
     "noImplicitAny": true,
     "plugins": [
       {
-        "name": "../../dist",
+        "name": "../../dist/plugin",
         "paths": [
           "./lib"
         ]

e2e/project-fixture/lib/onPath.ts renamed to e2e/plugin-tests/project-fixture/lib/onPath.ts

@@ -1,13 +1,15 @@
+import { TSServer } from './fixtures/lang-server';
+
 const path = require('path');
 const glob = require('glob');
-const createServer = require('./fixtures/lang-server');
+const { createServer } = require('./fixtures/lang-server');
 
 async function runLangServerSpecs() {
-  const langServerSpecFiles = glob.sync('tests/*.js', { cwd: __dirname });
+  const langServerSpecFiles = glob.sync('tests/*.ts', { cwd: __dirname });
   console.log('Start lang server e2e testing.');
-  let server;
+  let server: TSServer;
   await langServerSpecFiles.reduce(
-    (queue, file) =>
+    (queue: Promise<void>, file: string) =>
       queue.then(() =>
         require(path.join(__dirname, file))((server = createServer())).then(() => server.close()),
       ),

e2e/project-fixture/src/notOnPath.ts renamed to e2e/plugin-tests/project-fixture/src/notOnPath.ts

@@ -1,3 +1,5 @@
+import { TSServer } from '../fixtures/lang-server';
+
 const assert = require('assert');
 const it = require('../it');
 
@@ -12,8 +14,8 @@ const foo: TestType | undefined = undefined;
 const boo = foo.bar;
 `;
 
-async function run(server) {
-  await it('src/notOnPath.ts', server, fileContent, (diagnostics) => {
+async function run(server: TSServer) {
+  await it('src/notOnPath.ts', server, fileContent, (diagnostics: any[]) => {
     assert.strictEqual(diagnostics.length, 1);
     assert.strictEqual(diagnostics[0].text, "Object is possibly 'undefined'.");
   });

e2e/project-fixture/src/otherFileNotOnPath.ts renamed to e2e/plugin-tests/project-fixture/src/otherFileNotOnPath.ts

@@ -1,3 +1,5 @@
+import { TSServer } from '../fixtures/lang-server';
+
 const assert = require('assert');
 const it = require('../it');
 
@@ -12,8 +14,8 @@ const foo: TestType | undefined = undefined;
 const boo = foo.bar;
 `;
 
-async function run(server) {
-  await it('lib/onPath.ts', server, fileContent, (diagnostics) => {
+async function run(server: TSServer) {
+  await it('lib/onPath.ts', server, fileContent, (diagnostics: any[]) => {
     assert.strictEqual(diagnostics.length, 1);
     assert.strictEqual(diagnostics[0].text, "Object is possibly 'undefined'.");
   });

e2e/project-fixture/tsconfig.json renamed to e2e/plugin-tests/project-fixture/tsconfig.json

@@ -1,3 +1,5 @@
+import { TSServer } from '../fixtures/lang-server';
+
 const assert = require('assert');
 const it = require('../it');
 
@@ -11,8 +13,8 @@ const foo: TestType | undefined = undefined;
 const boo = foo.bar;
 `;
 
-async function run(server) {
-  await it('src/notOnPath.ts', server, fileContent, (diagnostics) => {
+async function run(server: TSServer) {
+  await it('src/notOnPath.ts', server, fileContent, (diagnostics: any[]) => {
     assert.strictEqual(diagnostics.length, 0);
   });
 }

e2e/run.js renamed to e2e/plugin-tests/run.ts

@@ -1,3 +1,5 @@
+import { TSServer } from '../fixtures/lang-server';
+
 const assert = require('assert');
 const it = require('../it');
 
@@ -11,8 +13,8 @@ const foo: TestType | undefined = undefined;
 const boo = foo.bar;
 `;
 
-async function run(server) {
-  await it('lib/onPath.ts', server, fileContent, (diagnostics) => {
+async function run(server: TSServer) {
+  await it('lib/onPath.ts', server, fileContent, (diagnostics: any[]) => {
     assert.strictEqual(diagnostics.length, 1);
     assert.strictEqual(diagnostics[0].text, "Object is possibly 'undefined'.");
   });

e2e/tests/fileWithTsStrictNotOnPath.js renamed to e2e/plugin-tests/tests/fileWithTsStrictNotOnPath.ts

@@ -1,6 +1,7 @@
+import { ServerResponse, TSServer } from '../fixtures/lang-server';
+
 const assert = require('assert');
 const path = require('path');
-const it = require('../it');
 
 const fileContent = `
 //@ts-strict
@@ -19,11 +20,11 @@ const foo1: TestType | undefined = undefined;
 const boo1 = foo1.bar;
 `;
 
-function findResponse(responses, eventName) {
+function findResponse(responses: ServerResponse[], eventName: string) {
   return responses.filter((response) => response.event === eventName);
 }
 
-async function run(server) {
+async function run(server: TSServer) {
   const rootPath = path.resolve(__dirname, '../project-fixture/');
   const file = path.resolve(__dirname, '../project-fixture/' + 'src/notOnPath.ts');
   const otherFile = path.resolve(__dirname, '../project-fixture/' + 'src/otherFileNotOnPath.ts');