From d3587e5c58c7068d15d70490252caed6583f1cc3 Mon Sep 17 00:00:00 2001 From: Godfrey Chan Date: Mon, 5 Jun 2023 13:50:13 -0700 Subject: [PATCH] Run jscodeshift with `--no-babel` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit By default, jscodeshift use babel to transform the transform files (i.e. the "plugins") themselves before running them in Node. The motivation of this seems to be to allow using more modern features in the transform plugins. In the "old days" this may be necessary/desirable, but with modern Node versions having pretty good support for modern features/syntaxes, this benefit seems margin/dubious, and it can sometimes cause problem. One example is that we tried to use `@embroider/core` in our transform, which depends on a fairly old package called `sourcemap-validator`. The source code of the package is NOT written with strict mode in mind, but the default settings for jscodeshift's babel transform blindly adds the `"use strict";` declaration on top of each file, including dependencies in node_modules. This ultimately causes a hard error when running the codemod, in this case a `ReferenceError: createBuffer is not defined` when loading the file. Coincidentally the `jscodeshift` set up of running things in workers and babel overriding `require()` in Node also makes it harder to discover the root cause of the problem. It's unclear what can be done about this – I tried adding an empty `.babelrc` on the transform plugin side but that doesn't seem to be picked up. I am not sure how we are supposed to customize the babel options used for this purpose (which also further diminishes its utility). Ultimately, given the utility of this seems dubious on modern node, most transforms probably do not take advantage of this and most authors and consumers probably aren't aware of this little-known feature on `jscodeshift`, it's easier to just disable that which would probably make things run a little faster. It's also unclear if this ever worked "correctly" given that the template transforms don't get the same babel treatment. --- src/bin-support.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/bin-support.js b/src/bin-support.js index 94a4b4e..a2c2c80 100644 --- a/src/bin-support.js +++ b/src/bin-support.js @@ -24,6 +24,7 @@ async function runJsTransform(transformPath, args, extensions = DEFAULT_JS_EXTEN let binPath = path.join(jscodeshiftPath, jscodeshiftPkg.bin.jscodeshift); let binOptions = [ + '--no-babel', '-t', transformPath, '--extensions',