Merge pull request #37 from rxdi/feature/36-remove-gapi-build-replace…

…-with-esbuild

feat(esbuild): added esbuild transpiler and make it default

.nvmrc

@@ -0,0 +1 @@
+v14.21.2

.vscode/settings.json

@@ -16,7 +16,7 @@
   ],
   "typescript.tsdk": "node_modules/typescript/lib",
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
   "files.exclude": {
     "**/.classpath": true,

README.md

@@ -16,7 +16,7 @@ Migration library for `Mongodb` and `Mongoose` written in `TypeScript`
 - ACID transactions provided by MongoDB
 - `error` and `success` logs for `up`/`down` migrations
 - Infinite rrror log with `append` NodeJS streaming technique
-- 100% TypeScript support with JIT compilation provided by [@gapi/cli](https://github.com/Stradivario/gapi-cli) and [ParcelJS](https://parceljs.org)
+- 100% TypeScript support with JIT compilation provided by [esbuild](https://esbuild.github.io/)
 
 ## Installation
 
@@ -61,6 +61,7 @@ export default async () => {
     migrationsDir: './migrations',
     defaultTemplate: 'es6',
     typescript: true,
+    builder: 'ESBUILD',
     outDir: './.xmigrate',
     /* Custom datetime formatting can be applied like so */
     // dateTimeFormat: () => new Date().toISOString(),
@@ -255,7 +256,7 @@ export async function down(client: MongoClient) {
 }
 ```
 
-## TypeScript migrations
+## TypeScript migrations (Deprecated use option `builder: 'ESBUILD' in your xmigrate config file`)
 
 To be able to run migrations with TypeScript you need to set `typescript: true` inside `xmigrate.js` and install `@gapi/cli` globally
 
@@ -367,12 +368,6 @@ Up migration error log
 
 When you change your configuration file to `xmigrate.ts` it will automatically transpile to `ES5` and will be loaded
 
-This type of configuration requires `@gapi/cli` to be installed since we will transpile configuration with it!
-
-```bash
-npm i -g @gapi/cli
-```
-
 ```typescript
 import { Config } from '@rxdi/xmigrate';
 

package.json

@@ -23,6 +23,7 @@
   "dependencies": {
     "@rxdi/core": "^0.7.37",
     "chalk": "2.4.2",
+    "esbuild": "^0.20.2",
     "esm": "3.2.25",
     "mongodb": "3.3.3",
     "mongoose": "5.7.6"

src/default.config.ts

@@ -1,11 +1,12 @@
-import { Config } from './injection.tokens';
+import { BuilderType, Config } from './injection.tokens';
 
 export const DEFAULT_CONFIG: Config = {
   changelogCollectionName: 'migrations',
   migrationsDir: 'migrations',
   defaultTemplate: 'es6',
   typescript: true,
   outDir: './.xmigrate',
+  builder: BuilderType.ESBUILD,
   // dateTimeFormat: () => '1212',
   logger: {
     folder: './migrations-log',

src/helpers/log-factory.ts

@@ -25,7 +25,7 @@ export class Logger {
     });
   }
   log(res: unknown) {
-    return new Promise((resolve) => {
+    return new Promise<void | Error>((resolve) => {
       if (!this.successFinished) {
         return this.successLogger.write(
           this.getLogTemplate(res, '🚀'),
@@ -36,7 +36,7 @@ export class Logger {
     });
   }
   error(res: unknown) {
-    return new Promise((resolve) => {
+    return new Promise<void | Error>((resolve) => {
       if (!this.errorFinished) {
         return this.errorLogger.write(this.getLogTemplate(res, '🔥'), resolve);
       }

src/helpers/typescript-builder.ts

@@ -1,17 +1,43 @@
 import { spawn } from 'child_process';
+import { exit } from 'process';
 
-export const TranspileTypescript = (paths: string[], outDir: string) => {
+/* Deprecated */
+export const TranspileTypescript = (entryPoints: string[], outdir: string) => {
+  console.warn(
+    '***Deprecated Warning*** using `gapi` as a build for migrations is deprecated consider using builder type esbuild',
+  );
   return new Promise((resolve) => {
     const child = spawn('npx', [
       'gapi',
       'build',
       '--glob',
-      `${paths.toString()}`,
+      `${entryPoints.toString()}`,
       '--outDir',
-      outDir,
+      outdir,
     ]);
     // child.stdout.pipe(process.stdout);
     child.stderr.pipe(process.stderr);
     child.on('close', (code: number) => resolve(code));
   });
 };
+
+export const TranspileTypescriptESBuild = async (
+  entryPoints: string[],
+  outdir: string,
+) => {
+  try {
+    return (await import('esbuild')).build({
+      entryPoints,
+      bundle: true,
+      sourcemap: true,
+      minify: false,
+      platform: 'node',
+      format: 'cjs',
+      outdir,
+      logLevel: 'info',
+    });
+  } catch (e) {
+    console.error(e);
+    exit(1);
+  }
+};

src/injection.tokens.ts

@@ -29,6 +29,11 @@ export interface LoggerConfig {
   };
 }
 
+export enum BuilderType {
+  ESBUILD = 'ESBUILD',
+  GAPI = 'GAPI',
+}
+
 export interface Config {
   mongodb: {
     url: string;
@@ -44,6 +49,7 @@ export interface Config {
   logger?: LoggerConfig;
   defaultTemplate?: TemplateTypes;
   typescript?: boolean;
+  builder?: BuilderType;
 }
 
 export type Tasks =

src/migrations.module.ts

@@ -7,8 +7,12 @@ import { DEFAULT_CONFIG } from './default.config';
 import { ensureDir } from './helpers';
 import { includes, nextOrDefault } from './helpers/args-extractors';
 import { LogFactory } from './helpers/log-factory';
-import { TranspileTypescript } from './helpers/typescript-builder';
 import {
+  TranspileTypescript,
+  TranspileTypescriptESBuild,
+} from './helpers/typescript-builder';
+import {
+  BuilderType,
   CommandInjector,
   Config,
   LoggerConfig,
@@ -82,10 +86,18 @@ export class MigrationsModule {
                   './.xmigrate/config.temp',
                 );
                 const TranspileAndWriteTemp = async (stats: Stats) => {
-                  await TranspileTypescript(
-                    [`/${configFilename}.ts`],
-                    config.outDir,
-                  );
+                  if (config.builder === BuilderType.GAPI) {
+                    await TranspileTypescript(
+                      [`/${configFilename}.ts`],
+                      config.outDir,
+                    );
+                  } else {
+                    await TranspileTypescriptESBuild(
+                      [`./${configFilename}.ts`],
+                      config.outDir,
+                    );
+                  }
+
                   console.log('Transpile complete!');
                   await promisify(writeFile)(
                     './.xmigrate/config.temp',