feat/fix: CLI Option tsconfigFilePath, code sanity fixes (#8)

* feat/fix: CLI Option tsconfigFilePath, code sanity fixes

 - add yarn.lock which had uncommitted changes (prettier);
 - rename serverlessTypes.ts to types.ts (convention);
 - move watchFiles into private method of index.ts main class -- utility below;
 - add cli option tsconfigFilePath for more flexibility in specifying tsconfig to use;
 - compute which tsconfig to use based on options, custom:typeScript:... or default (save in this.tsconfigFilePath of main class)
 - only pass this.tsconfigFilePath as a string to getTypescriptConfig;
 - run yarn lint on the project

* chore: enable GH action on pull request

* chore: set prettier endOfLine as auto

* chore: update TypeScript dev dependency to 3.8.3

* tests: properly pass tsconfig path on test suite

* styles: apply prettier to index

Co-authored-by: KingDarBoja <stevenbojato04@gmail.com>

Author: tpscrpt

.prettierrc

@@ -1,4 +1,5 @@
 {
     "singleQuote": true,
-    "trailingComma": "all"
+    "trailingComma": "all",
+    "endOfLine": "auto"
 }

package-lock.json

@@ -61,7 +61,7 @@
     "mock-fs": "4.10.4",
     "prettier": "^2.0.2",
     "ts-jest": "25.2.1",
-    "typescript": "^3.6.4"
+    "typescript": "^3.8.3"
   },
   "dependencies": {
     "fs-extra": "^8.1.0",

package.json

@@ -7,16 +7,22 @@ import {
   ServerlessTSInstance,
   ServerlessTSOptions,
   ServerlessTSFunction,
-} from './serverlessTypes';
-import { extractFileNames, getTypescriptConfig, run } from './typescript';
-import { watchFiles } from './watchFiles';
+} from './types';
+import {
+  extractFileNames,
+  getTypescriptConfig,
+  run,
+  getSourceFiles,
+} from './typescript';
+import { unwatchFile, watchFile, Stats } from 'fs-extra';
 
 const SERVERLESS_FOLDER = '.serverless';
 const BUILD_FOLDER = '.build';
 
 class TypeScriptPlugin {
   private originalServicePath: string;
   private isWatching: boolean;
+  private tsconfigFilePath: string;
 
   serverless: ServerlessTSInstance;
   options: ServerlessTSOptions;
@@ -25,7 +31,10 @@ class TypeScriptPlugin {
   constructor(serverless: ServerlessTSInstance, options: ServerlessTSOptions) {
     this.serverless = serverless;
     this.options = options;
-
+    this.tsconfigFilePath =
+      options.tsconfigFilePath ||
+      serverless.service.custom?.typeScript?.tsconfigFilePath ||
+      'tsconfig.json';
     this.hooks = {
       'before:run:run': async (): Promise<void> => {
         this.compileTs();
@@ -136,7 +145,7 @@ class TypeScriptPlugin {
     this.serverless.cli.log(`Watch function ${this.options.function}...`);
 
     this.isWatching = true;
-    watchFiles(
+    this.watchFiles(
       this.rootFileNames,
       this.originalServicePath,
       this.serverless,
@@ -154,7 +163,7 @@ class TypeScriptPlugin {
     this.serverless.cli.log('Watching typescript files...');
 
     this.isWatching = true;
-    watchFiles(
+    this.watchFiles(
       this.rootFileNames,
       this.originalServicePath,
       this.serverless,
@@ -178,7 +187,7 @@ class TypeScriptPlugin {
 
     const tsconfig = getTypescriptConfig(
       this.originalServicePath,
-      this.serverless,
+      this.tsconfigFilePath,
       this.isWatching ? null : this.serverless.cli,
     );
 
@@ -322,6 +331,52 @@ class TypeScriptPlugin {
       throw error;
     });
   }
+
+  private watchFiles(
+    rootFileNames: string[],
+    originalServicePath: string,
+    serverless: ServerlessTSInstance,
+    cb: () => Promise<void>,
+  ): void {
+    const tsConfig = getTypescriptConfig(
+      originalServicePath,
+      this.tsconfigFilePath,
+    );
+    let watchedFiles = getSourceFiles(rootFileNames, tsConfig);
+
+    const watchCallback = (curr: Stats, prev: Stats): void => {
+      // Check timestamp
+      if (+curr.mtime <= +prev.mtime) {
+        return;
+      }
+
+      cb();
+
+      // use can reference not watched yet file or remove reference to already watched
+      const newWatchFiles = getSourceFiles(rootFileNames, tsConfig);
+      watchedFiles.forEach((fileName) => {
+        if (!newWatchFiles.includes(fileName)) {
+          unwatchFile(fileName, watchCallback);
+        }
+      });
+
+      newWatchFiles.forEach((fileName) => {
+        if (!watchedFiles.includes(fileName)) {
+          watchFile(
+            fileName,
+            { persistent: true, interval: 250 },
+            watchCallback,
+          );
+        }
+      });
+
+      watchedFiles = newWatchFiles;
+    };
+
+    watchedFiles.forEach((fileName) => {
+      watchFile(fileName, { persistent: true, interval: 250 }, watchCallback);
+    });
+  }
 }
 
 export = TypeScriptPlugin;

src/index.ts

@@ -30,6 +30,7 @@ export interface ServerlessTSOptions {
   function?: string;
   watch?: boolean;
   extraServicePath?: string;
+  tsconfigFilePath?: string;
 }
 
 export interface ServerlessTSFunction {

src/serverlessTypes.ts src/types.tssrc/serverlessTypes.ts renamed to src/types.ts

@@ -3,7 +3,7 @@ import * as fse from 'fs-extra';
 import * as _ from 'lodash';
 import * as path from 'path';
 
-import { ServerlessTSFunction, ServerlessTSInstance } from './serverlessTypes';
+import { ServerlessTSFunction } from './types';
 
 export const makeDefaultTypescriptConfig = (): ts.CompilerOptions => {
   const defaultTypescriptConfig: ts.CompilerOptions = {
@@ -136,27 +136,10 @@ export const getSourceFiles = (
 
 export const getTypescriptConfig = (
   cwd: string,
-  serverless?: Partial<ServerlessTSInstance>,
+  tsconfigFilePath: string,
   logger?: { log: (str: string) => void },
 ): ts.CompilerOptions => {
-  let configFilePath = path.join(cwd, 'tsconfig.json');
-
-  if (
-    serverless &&
-    serverless.service.custom &&
-    serverless.service.custom.typeScript &&
-    serverless.service.custom.typeScript.tsconfigFilePath
-  ) {
-    configFilePath = path.join(
-      cwd,
-      serverless.service.custom.typeScript.tsconfigFilePath,
-    );
-    if (!fse.existsSync(configFilePath)) {
-      throw new Error(
-        `Custom Typescript Config File not found at "${configFilePath}"`,
-      );
-    }
-  }
+  const configFilePath = path.join(cwd, tsconfigFilePath);
 
   if (fse.existsSync(configFilePath)) {
     const configFileText = fse.readFileSync(configFilePath).toString();

src/typescript.ts

@@ -1,8 +1,5 @@
 import TypeScriptPlugin from '../src';
-import {
-  ServerlessTSInstance,
-  ServerlessTSFunctionMap,
-} from '../src/serverlessTypes';
+import { ServerlessTSInstance, ServerlessTSFunctionMap } from '../src/types';
 
 const createInstance = (
   functions: ServerlessTSFunctionMap,

src/watchFiles.ts

@@ -1,7 +1,7 @@
 import * as path from 'path';
 
 import { extractFileNames } from '../src/typescript';
-import { ServerlessTSFunction } from '../src/serverlessTypes';
+import { ServerlessTSFunction } from '../src/types';
 
 const functions: { [key: string]: ServerlessTSFunction } = {
   hello: {

tests/index.functions.test.ts

@@ -5,36 +5,14 @@ import {
 
 describe('getTypescriptConfig', () => {
   it('returns default typescript configuration if the one provided does not exist', () => {
-    expect(getTypescriptConfig('/ciaone/my-folder')).toEqual(
+    expect(getTypescriptConfig(process.cwd(), '/ciaone/my-folder')).toEqual(
       makeDefaultTypescriptConfig(),
     );
   });
 
-  it('should throw an error if configured typescript configuration does not exist', () => {
-    expect(() =>
-      getTypescriptConfig(process.cwd(), {
-        service: {
-          custom: {
-            typeScript: {
-              tsconfigFilePath: './some-path',
-            },
-          },
-        },
-      }),
-    ).toThrowError('Custom Typescript Config File not found');
-  });
-
   it('returns configured typescript configuration if provided', () => {
     expect(
-      getTypescriptConfig(process.cwd(), {
-        service: {
-          custom: {
-            typeScript: {
-              tsconfigFilePath: './tests/custom.tsconfig.json',
-            },
-          },
-        },
-      }).target,
+      getTypescriptConfig(process.cwd(), './tests/custom.tsconfig.json').target,
     ).toEqual(2);
   });
 });