plugin.ts

namespace tsp {
  const path = require('path');
  const fs = require('fs');

  const requireStack: string[] = [];

  /* ****************************************************** */
  // region: Types
  /* ****************************************************** */

  export namespace TspPlugin {
    export interface CreateOptions {
      resolveBaseDir: string
    }

    export type Kind = 'SourceTransformer' | 'ProgramTransformer'
  }

  // endregion

  /* ****************************************************** */
  // region: Helpers
  /* ****************************************************** */

  // Could likely fail if the plugin is in a symlinked directory or the package's main file is in a
  // directory above the package.json – however, I believe that the walking up method used here is the common
  // approach, so we'll consider these acceptable edge cases for now.
  function getPackagePath(entryFilePath: string): string | undefined {
    let currentDir = path.dirname(entryFilePath);

    const seenPaths = new Set<string>();
    while (currentDir !== path.parse(currentDir).root) {
      if (seenPaths.has(currentDir)) return undefined;
      seenPaths.add(currentDir);

      const potentialPkgPath = path.join(currentDir, 'package.json');
      if (fs.existsSync(potentialPkgPath)) return potentialPkgPath;

      currentDir = path.resolve(currentDir, '..');
    }

    return undefined;
  }

  // endregion

  /* ****************************************************** */
  // region: TspPlugin
  /* ****************************************************** */

  export class TspPlugin {
    public readonly config: PluginConfig;
    public readonly tsConfigPath: string | undefined;
    public readonly entryFilePath: string;
    public readonly importKey: string;
    public readonly packageConfig: PluginPackageConfig | undefined;
    public readonly kind: TspPlugin.Kind;

    private readonly _createOptions: TspPlugin.CreateOptions;

    constructor(config: PluginConfig, createOptions: TspPlugin.CreateOptions) {
      this.config = { ...config };
      this.validateConfig();

      this._createOptions = createOptions;
      this.importKey = config.import || 'default';
      this.kind = config.transformProgram === true ? 'ProgramTransformer' : 'SourceTransformer';

      const { resolveBaseDir } = createOptions;
      const configTransformValue = config.transform!;

      /* Resolve paths */
      this.tsConfigPath = config.tsConfig && path.resolve(resolveBaseDir, config.tsConfig);
      const entryFilePath = require.resolve(configTransformValue, { paths: [ resolveBaseDir ] });
      this.entryFilePath = entryFilePath;

      /* Get module PluginPackageConfig */
      let pluginPackageConfig: PluginPackageConfig | undefined;

      const modulePackagePath = getPackagePath(entryFilePath);
      if (modulePackagePath) {
        const modulePkgJsonContent = fs.readFileSync(modulePackagePath, 'utf8');
        const modulePkgJson = JSON.parse(modulePkgJsonContent) as { tsp?: PluginPackageConfig };

        pluginPackageConfig = modulePkgJson.tsp;
        if (pluginPackageConfig === null || typeof pluginPackageConfig !== 'object') pluginPackageConfig = undefined;
      }

      this.packageConfig = pluginPackageConfig;
    }

    private validateConfig() {
      const { config } = this;

      const configTransformValue = config.transform;
      if (!configTransformValue) throw new TsPatchError(`Invalid plugin config: missing "transform" value`);

      if (config.resolvePathAliases && !config.tsConfig) {
        console.warn(`[ts-patch] Warning: resolvePathAliases needs a tsConfig value pointing to a tsconfig.json for transformer" ${configTransformValue}.`);
      }
    }

    createFactory() {
      const { entryFilePath, config, tsConfigPath, importKey } = this;
      const configTransformValue = config.transform!;

      /* Prevent circular require */
      if (requireStack.includes(entryFilePath)) return;
      requireStack.push(entryFilePath);

      const isTs = configTransformValue.match(/\.[mc]?ts$/) != null;

      const registerConfig: RegisterConfig = {
        isTs,
        tsConfig: tsConfigPath,
        pluginConfig: config
      };

      registerPlugin(registerConfig);

      try {
        /* Load plugin */
        const commonjsModule = loadEntryFile();

        const factoryModule = (typeof commonjsModule === 'function') ? { default: commonjsModule } : commonjsModule;
        const factory = factoryModule[importKey];

        if (!factory)
          throw new TsPatchError(
            `tsconfig.json > plugins: "${configTransformValue}" does not have an export "${importKey}": ` +
            require('util').inspect(factoryModule)
          );

        if (typeof factory !== 'function') {
          throw new TsPatchError(
            `tsconfig.json > plugins: "${configTransformValue}" export "${importKey}" is not a plugin: ` +
            require('util').inspect(factory)
          );
        }

        return {
          factory,
          registerConfig: registerConfig
        };
      }
      finally {
        requireStack.pop();
        unregisterPlugin();
      }

      function loadEntryFile(): PluginFactory | { [key: string]: PluginFactory } {
        /* Load plugin */
        try {
          return require(entryFilePath);
        } catch (e) {
          const hint = describeEsmInCjsError(e);
          if (hint) throw new TsPatchError(hint);
          throw e;
        }
      }
    }
  }

  // endregion
}

// endregion