siriwatknp/babel-plugin-define-var

A babel plugin that add missing variable declaration to the root scope

babel-plugin-define-var

Problem

Sometimes the code that goes through wyw-in-js pre-evaluation phase can come out missing variable declaration which causes the evaluation to fail. For example, the following code:

const Divider = /*#__PURE__*/ _s(
  React.forwardRef(
    (_c = _s(
      function Divider(inProps, ref) {
        _s();
        // ...
        return /*#__PURE__*/ _jsx(
          DividerRoot,
          _extends(
            {
              as: component,
              className: clsx(classes.root, className),
              role: role,
              ref: ref,
              ownerState: ownerState,
            },
            other,
            {
              children: children
                ? /*#__PURE__*/ _jsx(DividerWrapper, {
                    className: classes.wrapper,
                    ownerState: ownerState,
                    children: children,
                  })
                : null,
            }
          )
        );
      },
      '526RDEpO1CGEADq5vnCvoNyCejQ=',
      false,
      function() {
        return [useThemeProps, useUtilityClasses];
      }
    ))
  ),
  '526RDEpO1CGEADq5vnCvoNyCejQ=',
  false,
  function() {
    return [useThemeProps, useUtilityClasses];
  }
);
_c1 = Divider;
/**
 * The following flag is used to ensure that this component isn't tabbable i.e.
 * does not get highlight/focus inside of MUI List.
 */ Divider.muiSkipListHighlight = true;

export default Divider;
var _c, _c1;
$RefreshReg$(_c, 'Divider$React.forwardRef');
$RefreshReg$(_c1, 'Divider');

The $RefreshReg$ is injected by React Refresh from a framework like Next.js or Vite. In the preeval phase, wyw-in-js will remove the global $RefreshReg$ but there is a bug in removing the _c (I am not sure is it the bug in wyw-in-js or babel) so the code that go through evaluation looks like this:

const Divider = /*#__PURE__*/ _s(
  React.forwardRef(
    (_c = _s(
      function Divider(inProps, ref) {
        _s();
        // ...
      },
      '526RDEpO1CGEADq5vnCvoNyCejQ=',
      false,
      function() {
        return [useThemeProps, useUtilityClasses];
      }
    ))
  ),
  '526RDEpO1CGEADq5vnCvoNyCejQ=',
  false,
  function() {
    return [useThemeProps, useUtilityClasses];
  }
);
/**
 * The following flag is used to ensure that this component isn't tabbable i.e.
 * does not get highlight/focus inside of MUI List.
 */ Divider.muiSkipListHighlight = true;

export default Divider;

Causing the error _c is not defined.

Solution

This plugin will add the missing variable declarations to the root scope of the file.

Installation

npm install babel-plugin-define-var

Usage

// .babelrc
{
  "plugins": ["babel-plugin-define-var"]
}