@samchon/ts-patch 3.2.2 → 3.4.0

package/projects/core/src/actions/patch.ts

@@ -0,0 +1,110 @@
+import { LogLevel, PatchError, TspError, } from '../system';
+import { getTsPackage } from '../ts-package';
+import chalk from 'chalk';
+import { getModuleFile, getTsModule, TsModule, ModuleFile } from '../module';
+import path from 'path';
+import { getInstallerOptions, InstallerOptions } from '../options';
+import { writeFileWithLock } from '../utils';
+import { getPatchedSource } from '../patch/get-patched-source';
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+/**
+ * Patch a TypeScript module
+ */
+export function patch(moduleName: string, opts?: Partial<InstallerOptions>): boolean
+export function patch(moduleNames: string[], opts?: Partial<InstallerOptions>): boolean
+export function patch(moduleNameOrNames: string | string[], opts?: Partial<InstallerOptions>): boolean {
+  const targetModuleNames = [ moduleNameOrNames ].flat();
+  if (!targetModuleNames.length) throw new PatchError(`Must provide at least one module name to patch`);
+
+  const options = getInstallerOptions(opts);
+  const { logger: log, dir, skipCache } = options;
+
+  /* Load Package */
+  const tsPackage = getTsPackage(dir);
+
+  /* Skip non-patchable modules (e.g. thin wrappers in TS 6+) */
+  const patchableModuleNames = targetModuleNames.filter(m => {
+    if (!TsModule.isPatchable(m, tsPackage.majorVer)) {
+      log([ '~',
+        `${chalk.blueBright(m)} is not independently patchable in TS ${tsPackage.majorVer}+ ` +
+        `(delegates to ${chalk.blueBright('typescript.js')})`
+      ]);
+      return false;
+    }
+    return true;
+  });
+
+  /* Get modules to patch and patch info */
+  const moduleFiles: [ string, ModuleFile ][] =
+    patchableModuleNames.map(m => [ m, getModuleFile(tsPackage.getModulePath(m)) ]);
+
+  /* Determine files not already patched or outdated  */
+  const patchableFiles = moduleFiles.filter(entry => {
+    const [ moduleName, moduleFile ] = entry;
+    if (!moduleFile.patchDetail || moduleFile.patchDetail.isOutdated) return true;
+    else {
+      log([ '!',
+        `${chalk.blueBright(moduleName)} is already patched with the latest version. For details, run: ` +
+        chalk.bgBlackBright('ts-patch check')
+      ]);
+
+      return false;
+    }
+  });
+
+  if (!patchableFiles.length) return true;
+
+  /* Patch modules */
+  const failedModulePaths: string[] = [];
+  for (let entry of patchableFiles) {
+    /* Load Module */
+    const { 1: moduleFile } = entry;
+    const tsModule = getTsModule(tsPackage, moduleFile, { skipCache: true });
+
+    const { moduleName, modulePath, moduleContentFilePath } = tsModule;
+    log(
+      [ '~', `Patching ${chalk.blueBright(moduleName)} in ${chalk.blueBright(path.dirname(modulePath ))}` ],
+      LogLevel.verbose
+    );
+
+    try {
+      const { js, dts, loadedFromCache } = getPatchedSource(tsModule, { skipCache, log });
+
+      /* Write Patched Module */
+      log(
+        [
+          '~',
+          `Writing patched ${chalk.blueBright(moduleName)} to ` +
+          `${chalk.blueBright(moduleContentFilePath)}${loadedFromCache ? ' (cached)' : ''}`
+        ],
+        LogLevel.verbose
+      );
+
+      writeFileWithLock(moduleContentFilePath, js!);
+      if (dts) writeFileWithLock(tsModule.dtsPath!, dts!);
+
+      log([ '+', chalk.green(`Successfully patched ${chalk.bold.yellow(moduleName)}.\r\n`) ], LogLevel.verbose);
+    } catch (e) {
+      if (e instanceof TspError || options.logLevel >= LogLevel.verbose) log([ '!', e.message ]);
+      failedModulePaths.push(tsModule.modulePath);
+    }
+  }
+
+  if (failedModulePaths.length > 1) {
+    log([ '!',
+      `Some files can't be patched! You can run again with --verbose to get specific error detail. The following files are unable to be ` +
+      `patched:\n  - ${failedModulePaths.join('\n  - ')}`
+    ]);
+
+    return false;
+  }
+
+  return true;
+}
+
+// endregion

package/projects/core/src/actions/uninstall.ts

@@ -0,0 +1,24 @@
+import chalk from 'chalk';
+import { defaultInstallLibraries } from '../config';
+import { unpatch } from './unpatch';
+import { getInstallerOptions, InstallerOptions } from "../options";
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+/**
+ * Remove patches from TypeScript modules
+ */
+export function uninstall(opts?: Partial<InstallerOptions>) {
+  const options = getInstallerOptions(opts);
+  const { logger: log } = options;
+
+  const ret = unpatch(defaultInstallLibraries, opts);
+  if (ret) log([ '-', chalk.green(`ts-patch removed!`) ]);
+
+  return ret;
+}
+
+// endregion

package/projects/core/src/actions/unpatch.ts

@@ -0,0 +1,109 @@
+import { LogLevel, PatchError, RestoreError } from '../system';
+import chalk from 'chalk';
+import path from 'path';
+import { getTsPackage } from '../ts-package';
+import { getModuleFile, getTsModule, ModuleFile } from '../module';
+import fs from 'fs';
+import { getInstallerOptions, InstallerOptions } from '../options';
+import { copyFileWithLock } from '../utils';
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+export function unpatch(moduleName: string, opts?: Partial<InstallerOptions>): boolean
+export function unpatch(moduleNames: string[], opts?: Partial<InstallerOptions>): boolean
+export function unpatch(moduleNameOrNames: string | string[], opts?: Partial<InstallerOptions>): boolean {
+  let res = false;
+
+  const targetModuleNames = [ moduleNameOrNames ].flat();
+  if (!targetModuleNames.length) throw new PatchError(`Must provide at least one module name to patch`);
+
+  const options = getInstallerOptions(opts);
+  const { logger: log, dir } = options;
+
+  /* Load Package */
+  const tsPackage = getTsPackage(dir);
+
+  /* Get modules to patch and patch info */
+  const moduleFiles: [ string, ModuleFile ][] =
+    targetModuleNames.map(m => [ m, getModuleFile(tsPackage.getModulePath(m)) ]);
+
+  /* Determine patched files */
+  const unpatchableFiles = moduleFiles.filter(entry => {
+    const [ moduleName, moduleFile ] = entry;
+    if (moduleFile.patchDetail) return true;
+    else {
+      log([ '!', `${chalk.blueBright(moduleName)} is not patched. For details, run: ` + chalk.bgBlackBright('ts-patch check') ]);
+      return false;
+    }
+  });
+
+  /* Restore files */
+  const errors: Record<string, Error> = {};
+  for (const entry of unpatchableFiles) {
+    /* Load Module */
+    const { 1: moduleFile } = entry;
+    const tsModule = getTsModule(tsPackage, moduleFile, { skipCache: true });
+
+    try {
+      /* Get Backups */
+      const backupPaths: string[] = []
+      backupPaths.push(tsModule.backupCachePaths.js);
+      if (tsModule.backupCachePaths.dts) backupPaths.push(tsModule.backupCachePaths.dts);
+
+      const baseNames = backupPaths.map(p => path.basename(p)).join(' & ');
+
+      log(
+        [
+          '~',
+          `Restoring ${chalk.blueBright(baseNames)} in ${chalk.blueBright(path.dirname(tsPackage.libDir))}`
+        ],
+        LogLevel.verbose
+      );
+
+      /* Restore files */
+      for (const backupPath of backupPaths) {
+        if (!fs.existsSync(backupPath))
+          throw new Error(`Cannot find backup file: ${backupPath}. Try reinstalling typescript.`);
+
+        const moduleDir = path.dirname(tsModule.modulePath);
+
+        /* Determine destination path (Need to use moduleContentPath if we're working with a cached module file */
+        const baseFileName = path.basename(backupPath);
+        const destPathName = baseFileName === tsModule.moduleName
+          ? path.basename(tsModule.moduleContentFilePath)
+          : baseFileName;
+
+        const destPath = path.join(moduleDir, destPathName);
+
+        copyFileWithLock(backupPath, destPath);
+      }
+
+      log([ '+', chalk.green(`Successfully restored ${chalk.bold.yellow(baseNames)}.\r\n`) ], LogLevel.verbose);
+    } catch (e) {
+      errors[tsModule.moduleName] = e;
+    }
+  }
+
+  /* Handle errors */
+  if (Object.keys(errors).length > 0) {
+    Object.values(errors).forEach(e => {
+      log([ '!', e.message ], LogLevel.verbose)
+    });
+
+    log('');
+    throw new RestoreError(
+      `[${Object.keys(errors).join(', ')}]`,
+      'Try reinstalling typescript.' +
+      (options.logLevel < LogLevel.verbose ? ' (Or, run uninstall again with --verbose for specific error detail)' : '')
+    );
+  } else {
+    res = true;
+  }
+
+  return res;
+}
+
+// endregion

package/projects/core/src/bin/ts-patch.ts

@@ -0,0 +1,7 @@
+import * as cliModule from '../cli/cli'
+
+/* ****************************************************************************************************************** *
+ * Entry
+ * ****************************************************************************************************************** */
+
+cliModule.run();

package/projects/core/src/bin/tspc.ts

@@ -0,0 +1,12 @@
+
+
+/* ****************************************************************************************************************** *
+ * Entry
+ * ****************************************************************************************************************** */
+
+// Run if main module cli
+if (require.main === module) {
+  require('../compiler/tsc');
+} else {
+  throw new Error('tspc must be run as a CLI');
+}

package/projects/core/src/cli/cli.ts

@@ -0,0 +1,94 @@
+import minimist from 'minimist';
+import { createLogger, getCacheRoot, getLockFilePath, LogLevel } from '../system';
+import { getTsPackage } from '../ts-package';
+import chalk from 'chalk';
+import * as actions from '../actions';
+import { getCliOptions, getInstallerOptionsFromCliOptions } from './options';
+import { getCliCommand } from './commands';
+import { getHelpMenu } from './help-menu';
+import { tspPackageJSON } from '../config';
+import fs from 'fs';
+
+
+/* ****************************************************************************************************************** */
+// region: Types
+/* ****************************************************************************************************************** */
+
+export type CliConfig = Record<string, { short?: string, caption: string, paramCaption?: string, inverse?: boolean }>
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+export function run(opt?: { cmdArgs?: string }) {
+  /* Parse Input */
+  const args = minimist(opt?.cmdArgs?.split(' ') ?? process.argv.slice(2));
+  const cliOptions = getCliOptions(args);
+  const cmd = getCliCommand(args);
+
+  /* Setup */
+  const options = getInstallerOptionsFromCliOptions(cliOptions);
+  const log = createLogger(options.logLevel, options.useColor, options.silent);
+
+  try {
+    /* Handle commands */
+    (() => {
+      switch (cmd) {
+        case 'help':
+          return log(getHelpMenu(), LogLevel.system);
+
+        case 'version':
+          const { version: tsVersion, packageDir } = getTsPackage(options.dir);
+          return log('\r\n' +
+            chalk.bold.blue('ts-patch:    ') + tspPackageJSON.version + '\r\n' +
+            chalk.bold.blue('typescript:  ') + tsVersion + chalk.gray(`   [${packageDir}]`),
+            LogLevel.system
+          );
+
+        case 'install':
+          return actions.install(options);
+
+        case 'uninstall':
+          return actions.uninstall(options);
+
+        case 'patch':
+          return actions.patch(args._.slice(1).join(' '), options);
+
+        case 'unpatch':
+          return actions.unpatch(args._.slice(1).join(' '), options);
+
+        case 'check':
+          return actions.check(undefined, options);
+
+        case 'clear-cache':
+          const cacheRoot = getCacheRoot();
+
+          /* Clear dir */
+          fs.rmSync(cacheRoot, { recursive: true, force: true });
+
+          /* Recreate Dirs */
+          getCacheRoot();
+          getLockFilePath('');
+
+          return log([ '+', 'Cleared cache & lock-files' ], LogLevel.system);
+
+        default:
+          log([ '!', 'Invalid command. Try ts-patch /? for more info' ], LogLevel.system)
+      }
+    })();
+  }
+  catch (e) {
+    log([
+      '!',
+      chalk.bold.yellow(e.name && (e.name !== 'Error') ? `[${e.name}]: ` : 'Error: ') + chalk.red(e.message)
+    ], LogLevel.system);
+  }
+
+  // Output for analysis by tests
+  return ({ cmd, args, options });
+}
+
+// endregion

package/projects/core/src/cli/commands.ts

@@ -0,0 +1,55 @@
+import chalk from 'chalk';
+import minimist from 'minimist';
+import type { CliConfig } from './cli';
+
+
+/* ****************************************************************************************************************** */
+// region: Config
+/* ****************************************************************************************************************** */
+
+/** @internal */
+export const cliCommandsConfig: CliConfig = {
+  install: { short: 'i', caption: `Installs ts-patch (to main libraries)` },
+  uninstall: { short: 'u', caption: 'Restores original typescript files' },
+  check: {
+    short: 'c', caption:
+      `Check patch status (use with ${chalk.cyanBright('--dir')} to specify TS package location)`
+  },
+  patch: {
+    short: void 0, paramCaption: '<module_file>', caption:
+      'Patch specific module(s) ' + chalk.yellow('(advanced)')
+  },
+  unpatch: {
+    short: void 0, paramCaption: '<module_file>', caption:
+      'Un-patch specific module(s) ' + chalk.yellow('(advanced)')
+  },
+  'clear-cache': { caption: 'Clears cache and lock-files' },
+  version: { short: 'v', caption: 'Show version' },
+  help: { short: '/?', caption: 'Show help menu' },
+};
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+export function getCliCommand(args: minimist.ParsedArgs) {
+  let cmd: string | undefined = args._[0] ? args._[0].toLowerCase() : void 0;
+
+  /* Handle special cases */
+  if ((args.v) && (!cmd)) return 'version';
+  if (args.h) return 'help';
+
+  if (!cmd) return cmd;
+
+  /* Get long command */
+  cmd = Object
+    .entries(cliCommandsConfig)
+    .find(([ long, { short } ]) => long === cmd || short === cmd)?.[0];
+
+  return cmd;
+}
+
+// endregion

package/projects/core/src/cli/help-menu.ts

@@ -0,0 +1,48 @@
+import chalk from 'chalk';
+import stripAnsi from 'strip-ansi';
+import { cliCommandsConfig } from './commands';
+import { cliOptionsConfig } from './options';
+
+
+/* ****************************************************************************************************************** */
+// region: Config
+/* ****************************************************************************************************************** */
+
+const LINE_INDENT = '\r\n\t';
+const COL_WIDTH = 45;
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+export function getHelpMenu() {
+  return LINE_INDENT + chalk.bold.blue('ts-patch [command] ') + chalk.blue('<options>') + '\r\n' + LINE_INDENT +
+
+    // Commands
+    Object
+      .entries(cliCommandsConfig)
+      .map(([ cmd, { short, caption, paramCaption } ]) => formatLine([ cmd, short ], caption, paramCaption))
+      .join(LINE_INDENT) +
+
+    // Options
+    '\r\n' + LINE_INDENT + chalk.bold('Options') + LINE_INDENT +
+    Object
+      .entries(cliOptionsConfig)
+      .map(([ long, { short, inverse, caption, paramCaption } ]) => formatLine([
+        short && `${chalk.cyanBright('-' + short)}`,
+        long && `${chalk.cyanBright(`${inverse ? '--no-' : '--'}${long}`)}`
+      ], caption, paramCaption))
+      .join(LINE_INDENT);
+
+  function formatLine(left: (string | undefined)[], caption: string, paramCaption: string = '') {
+    const leftCol = left.filter(Boolean).join(chalk.blue(', ')) + ' ' + chalk.yellow(paramCaption);
+    const dots = chalk.grey('.'.repeat(COL_WIDTH - stripAnsi(leftCol).length));
+
+    return `${leftCol} ${dots} ${caption}`;
+  }
+}
+
+// endregion

package/projects/core/src/cli/options.ts

@@ -0,0 +1,83 @@
+import minimist from 'minimist';
+import type { CliConfig } from './cli';
+import { LogLevel, OptionsError } from '../system';
+import { getInstallerOptions, InstallerOptions } from "../options";
+import { getGlobalTsDir } from "../utils";
+
+
+/* ****************************************************************************************************************** */
+// region: Types
+/* ****************************************************************************************************************** */
+
+export interface CliOptions {
+  silent: boolean;
+  global: boolean;
+  verbose: boolean;
+  dir: string;
+  color: boolean;
+}
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Config
+/* ****************************************************************************************************************** */
+
+/** @internal */
+export const cliOptionsConfig: CliConfig = {
+  silent: { short: 's', caption: 'Run silently' },
+  global: { short: 'g', caption: 'Target global TypeScript installation' },
+  verbose: { short: 'v', caption: 'Chat it up' },
+  cache: { inverse: true, caption: 'Skip cache' },
+  dir: {
+    short: 'd',
+    paramCaption: '<dir>',
+    caption: 'TypeScript directory or directory to resolve typescript package from'
+  },
+  color: { inverse: true, caption: 'Strip ansi colours from output' }
+};
+
+
+// endregion
+
+
+/* ****************************************************************************************************************** */
+// region: Utils
+/* ****************************************************************************************************************** */
+
+export function getCliOptions(args: minimist.ParsedArgs) {
+  let res: CliOptions = <CliOptions>{};
+
+  for (const [ key, { short } ] of Object.entries(cliOptionsConfig)) {
+    if (args.hasOwnProperty(key) || (short && args.hasOwnProperty(short))) {
+      (<any>res)[key] = args.hasOwnProperty(key) ? args[key] : args[short!];
+    }
+  }
+
+  return res;
+}
+
+export function getInstallerOptionsFromCliOptions(cliOptions: CliOptions): InstallerOptions {
+  let partialOptions: Partial<InstallerOptions> = {};
+
+  /* Dir option */
+  if (cliOptions.global && cliOptions.dir) throw new OptionsError(`Cannot specify both --global and --dir`);
+  if ('dir' in cliOptions) partialOptions.dir = cliOptions.dir;
+  if ('global' in cliOptions) partialOptions.dir = getGlobalTsDir();
+
+  /* LogLevel option */
+  if (cliOptions.silent && cliOptions.verbose) throw new OptionsError(`Cannot specify both --silent and --verbose`);
+  if (cliOptions.silent) {
+    partialOptions.logLevel = LogLevel.system;
+    partialOptions.silent = true;
+  }
+  else if (cliOptions.verbose) partialOptions.logLevel = LogLevel.verbose;
+
+  /* Color option */
+  if (cliOptions.color) partialOptions.useColor = cliOptions.color;
+
+  return getInstallerOptions(partialOptions);
+}
+
+// endregion

package/projects/core/src/compiler/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "typescript",
+  "main": "./typescript.js"
+}

package/projects/core/src/compiler/tsc.js

@@ -0,0 +1,19 @@
+const indexPath = '../';
+const path = require('path');
+const { getLiveModule } = require(indexPath);
+const { runInThisContext } = require("vm");
+
+
+/* ****************************************************************************************************************** *
+ * Entry
+ * ****************************************************************************************************************** */
+
+const { js, tsModule } = getLiveModule('tsc.js');
+
+const script = runInThisContext(`
+    (function (exports, require, module, __filename, __dirname) {
+      ${js}
+    });
+  `);
+
+script.call(exports, exports, require, module, tsModule.modulePath, path.dirname(tsModule.modulePath));

package/projects/core/src/compiler/tsserver.js

@@ -0,0 +1,19 @@
+const indexPath = '../';
+const path = require('path');
+const { getLiveModule } = require(indexPath);
+const { runInThisContext } = require("vm");
+
+
+/* ****************************************************************************************************************** *
+ * Entry
+ * ****************************************************************************************************************** */
+
+const { js, tsModule } = getLiveModule('tsserver.js');
+
+const script = runInThisContext(`
+    (function (exports, require, module, __filename, __dirname) {
+      ${js}
+    });
+  `);
+
+script.call(exports, exports, require, module, tsModule.modulePath, path.dirname(tsModule.modulePath));

package/projects/core/src/compiler/tsserverlibrary.js

@@ -0,0 +1,19 @@
+const indexPath = '../';
+const path = require('path');
+const { getLiveModule } = require(indexPath);
+const { runInThisContext } = require("vm");
+
+
+/* ****************************************************************************************************************** *
+ * Entry
+ * ****************************************************************************************************************** */
+
+const { js, tsModule } = getLiveModule('tsserverlibrary.js');
+
+const script = runInThisContext(`
+    (function (exports, require, module, __filename, __dirname) {
+      ${js}
+    });
+  `);
+
+script.call(exports, exports, require, module, tsModule.modulePath, path.dirname(tsModule.modulePath));

package/projects/core/src/compiler/typescript.js

@@ -0,0 +1,19 @@
+const indexPath = '../';
+const path = require('path');
+const { getLiveModule } = require(indexPath);
+const { runInThisContext } = require("vm");
+
+
+/* ****************************************************************************************************************** *
+ * Entry
+ * ****************************************************************************************************************** */
+
+const { js, tsModule } = getLiveModule('typescript.js');
+
+const script = runInThisContext(`
+    (function (exports, require, module, __filename, __dirname) {
+      ${js}
+    });
+  `);
+
+script.call(exports, exports, require, module, tsModule.modulePath, path.dirname(tsModule.modulePath));