browserify.ts

import { PassThrough, Transform, TransformCallback } from "stream";

import { EventEmitter } from "events";

import browserify from "@cypress/browserify-preprocessor";

import { ICypressConfiguration } from "@badeball/cypress-configuration";

import debug from "./lib/debug";

import { compile } from "./lib/template";

export function transform(
  configuration: ICypressConfiguration,
  filepath: string
) {
  if (!filepath.match(".feature$")) {
    return new PassThrough();
  }

  debug(`compiling ${filepath}`);

  let buffer = Buffer.alloc(0);

  return new Transform({
    transform(chunk, encoding, done) {
      buffer = Buffer.concat([buffer, chunk]);
      done();
    },
    async flush(done: TransformCallback) {
      try {
        done(
          null,
          await compile(configuration, buffer.toString("utf8"), filepath)
        );

        debug(`compiled ${filepath}`);
      } catch (e: any) {
        done(e);
      }
    },
  });
}

// https://docs.cypress.io/api/plugins/preprocessors-api.html#File-object
type ICypressPreprocessorFile = EventEmitter & {
  filePath: string;
  outputPath: string;
  shouldWatch: boolean;
};

function preprendTransformerToOptions(
  configuration: ICypressConfiguration,
  options: any
) {
  let wrappedTransform;

  if (
    !options.browserifyOptions ||
    !Array.isArray(options.browserifyOptions.transform)
  ) {
    wrappedTransform = [transform.bind(null, configuration)];
  } else {
    wrappedTransform = [
      transform.bind(null, configuration),
      ...options.browserifyOptions.transform,
    ];
  }

  return {
    ...options,
    browserifyOptions: {
      ...(options.browserifyOptions || {}),
      transform: wrappedTransform,
    },
  };
}

export function preprocessor(
  configuration: ICypressConfiguration,
  options = browserify.defaultOptions,
  { prependTransform = true }: { prependTransform?: boolean } = {}
) {
  if (prependTransform) {
    options = preprendTransformerToOptions(configuration, options);
  }

  return function (file: ICypressPreprocessorFile) {
    return browserify(options)(file);
  };
}

export { ICypressConfiguration };

export { compile };

export default preprocessor;