Add support for eager via the `{ eager: true }` argument to `import.meta.glob` #43

jazlalli · 2023-11-03T14:27:05Z

🙋🏽 Question

I've targeted the code as specified at https://vitejs.dev/guide/features.html#glob-import, but realise that that might not be what's needed in a Node env, can someone confirm? Should the code produced actually use require()?

What:

Addresses #42

Adds support for specifying eager import via the ImportGlobOptions argument to import.meta.glob

Why:

import.meta.globEager is deprecated in favour of the options argument. Without support in this plugin, Babel (and therefore Jest) is unable to understand this syntax.

How:

The target for what this should produce was obtained from the Vite docs on Glob Imports. Specifically,

If you'd rather import all the modules directly (e.g. relying on side-effects in these modules to be applied first), you can pass { eager: true } as the second argument:
const modules = import.meta.glob('./dir/*.js', { eager: true })
The above will be transformed into the following:
// code produced by vite
import * as __glob__0_0 from './dir/foo.js'
import * as __glob__0_1 from './dir/bar.js'
const modules = {
  './dir/foo.js': __glob__0_0,
  './dir/bar.js': __glob__0_1,
}

A new visitor is added to target the entire VariableDeclaration, and it is replaced with the specified code above.

Checklist:

Documentation updated
Tests
Ready to be merged
Added myself to contributors table - the npm run contributors:add command is not available, and I didn't want to manually modify the contributors sections, seeing as it says not to 🙃

packages/babel-plugin-transform-vite-meta-glob/src/__tests__/__snapshots__/index.ts.snap

@deprecated

According to Vite types, globEager is deprecated in favour of supplying an options argument to glob (from importMeta.d.ts 👇🏽) ``` /** * @deprecated Use `import.meta.glob('*', { eager: true })` instead */ globEager: import('./importGlob').ImportGlobEagerFunction ``` This commit adds tests cases to cover the desired behaviour, and the appropriate implementation. The target code was obtained from the Vite docs at [1]. This only supports the eager option, others are not covered here. [1] https://vitejs.dev/guide/features.html#glob-import:~:text=%7B%20eager%3A%20true%20%7D)-,The%20above%20will%20be%20transformed%20into%20the%20following%3A,-js

jazlalli · 2023-11-03T15:14:12Z

packages/babel-plugin-transform-vite-meta-glob/src/index.ts

+
+            path.replaceWith(replacement)
+          }
+        }


This can def be tidied up, but will wait until we're sure that this is producing the right/desired result before doing so

jazlalli · 2023-11-04T13:05:52Z

For the record, in my project where tests previously resulted in SyntaxError: Cannot use 'import.meta' outside a module, after installing from this branch

// package.json
"babel-plugin-transform-vite-meta-glob": "https://gitpkg.now.sh/jazlalli/babel-vite/packages/babel-plugin-transform-vite-meta-glob?pr/support-eager-glob-option"`

and adding the plugin into config

// babel.config.js
plugins: ["babel-plugin-transform-vite-meta-glob"],

All tests run successfully and pass 🟢

vctqs1 · 2023-12-12T04:49:13Z

@mpeyper Hi, could you help review this PR. I need this PR to upgrade vite@v5

mpeyper · 2023-12-12T06:36:28Z

Hey, sorry, github notifcations are rubbish and I completely missed this one (and the issue it references).

It's been a long time since I've looked at the code here, so I'm feeling very rusty and I don't really have the bandwidth at the moment to dig into it all again. That said, the change looks ok to me, especially the snapshot output from the tests, however, I can't see the button to approve the checks to run (It's probably been too long since the commits were made). @jazlalli, if you are still interested in getting this through, could you bump a new commit onto the branch and see if checks come back to life?

JacobMGEvans · 2023-12-12T15:13:54Z

Hey, sorry, github notifcations are rubbish and I completely missed this one (and the issue it references).

It's been a long time since I've looked at the code here, so I'm feeling very rusty and I don't really have the bandwidth at the moment to dig into it all again. That said, the change looks ok to me, especially the snapshot output from the tests, however, I can't see the button to approve the checks to run (It's probably been too long since the commits were made). @jazlalli, if you are still interested in getting this through, could you bump a new commit onto the branch and see if checks come back to life?

Wild, I also didn't get notifications and its my Organization lmao thanks GitHub...

vctqs1 · 2023-12-14T03:39:35Z

@mpeyper Could you help check again, I see @jazlalli fork and commit on last month (Nov), while the latest commit on repo is 8 months ago. I think the PR already included the latest commits

codecov · 2023-12-14T15:48:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (883dabd) 100.00% compared to head (855a136) 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #43   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines           93       130   +37     
  Branches        32        49   +17     
=========================================
+ Hits            93       130   +37

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mpeyper · 2023-12-14T21:32:59Z

It looks like the action failed to release this. I think this project needs a bit of TLC.

vctqs1 · 2023-12-16T12:01:51Z

@JacobMGEvans Could you help review this PR #46, just to upgrade node to 20. Also run test on CI in fork repo for sure

github-actions · 2023-12-18T09:47:59Z

🎉 This PR is included in version 1.1.1 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

github-actions · 2023-12-18T09:48:26Z

🎉 This PR is included in version 1.1.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

vctqs1 · 2023-12-18T10:55:55Z

I got some issue with jest if use import.meta.glob with second args {eager: true} everything will be fine if I removed second args cc @jazlalli

mpeyper · 2023-12-18T20:58:08Z

@vctqs1 I’m not sure how including the second argument could break jest parsing of es module syntax? Can you share a repo and open an issue for it?

vctqs1 · 2023-12-21T02:51:45Z

sure, let me create sandbox

vctqs1 · 2023-12-26T02:40:07Z

@mpeyper sorry for my late response, here is my sandbox
to test w this repo, please run npm test
also I put the import.meta.glob in HelloWorld.tsx


const all = import.meta.glob("./*.ts", {
  eager: true,
});

without second args

with second args

vctqs1 · 2023-12-26T05:47:25Z

@mpeyper I did a fix for above comment here #51 , could you please have a look?

jazlalli commented Nov 3, 2023

View reviewed changes

packages/babel-plugin-transform-vite-meta-glob/src/__tests__/__snapshots__/index.ts.snap Show resolved Hide resolved

jazlalli force-pushed the pr/support-eager-glob-option branch from f76b1f6 to 0c07dc6 Compare November 3, 2023 14:45

Jaz Lalli added 3 commits November 3, 2023 14:53

chore: add new snapshots for eager glob imports

5238198

docs: add details of imports that use ImportGlobOptions

855a136

jazlalli force-pushed the pr/support-eager-glob-option branch from 0c07dc6 to 855a136 Compare November 3, 2023 14:54

jazlalli commented Nov 3, 2023

View reviewed changes

JacobMGEvans closed this Dec 12, 2023

JacobMGEvans reopened this Dec 12, 2023

JacobMGEvans added Status: In Progress 🚧 Currently taking out the trash mobs or cleaning up the dungeon Status: Review labels Dec 12, 2023

JacobMGEvans approved these changes Dec 14, 2023

View reviewed changes

JacobMGEvans merged commit e8dbeb9 into OpenSourceRaidGuild:main Dec 14, 2023
4 checks passed

github-actions bot added the released label Dec 18, 2023

vctqs1 mentioned this pull request Dec 26, 2023

Add support for eager via the { eager: true } argument to import.meta.glob in Jest #51

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for eager via the `{ eager: true }` argument to `import.meta.glob` #43

Add support for eager via the `{ eager: true }` argument to `import.meta.glob` #43

jazlalli commented Nov 3, 2023 •

edited

Loading

jazlalli Nov 3, 2023

jazlalli commented Nov 4, 2023 •

edited

Loading

vctqs1 commented Dec 12, 2023

mpeyper commented Dec 12, 2023

JacobMGEvans commented Dec 12, 2023

vctqs1 commented Dec 14, 2023

codecov bot commented Dec 14, 2023

mpeyper commented Dec 14, 2023

vctqs1 commented Dec 16, 2023

github-actions bot commented Dec 18, 2023

github-actions bot commented Dec 18, 2023

vctqs1 commented Dec 18, 2023

mpeyper commented Dec 18, 2023

vctqs1 commented Dec 21, 2023

vctqs1 commented Dec 26, 2023 •

edited

Loading

vctqs1 commented Dec 26, 2023 •

edited

Loading

Add support for eager via the { eager: true } argument to import.meta.glob #43

Add support for eager via the { eager: true } argument to import.meta.glob #43

Conversation

jazlalli commented Nov 3, 2023 • edited Loading

jazlalli Nov 3, 2023

Choose a reason for hiding this comment

jazlalli commented Nov 4, 2023 • edited Loading

vctqs1 commented Dec 12, 2023

mpeyper commented Dec 12, 2023

JacobMGEvans commented Dec 12, 2023

vctqs1 commented Dec 14, 2023

codecov bot commented Dec 14, 2023

Codecov Report

mpeyper commented Dec 14, 2023

vctqs1 commented Dec 16, 2023

github-actions bot commented Dec 18, 2023

github-actions bot commented Dec 18, 2023

vctqs1 commented Dec 18, 2023

mpeyper commented Dec 18, 2023

vctqs1 commented Dec 21, 2023

vctqs1 commented Dec 26, 2023 • edited Loading

vctqs1 commented Dec 26, 2023 • edited Loading

Add support for eager via the `{ eager: true }` argument to `import.meta.glob` #43

Add support for eager via the `{ eager: true }` argument to `import.meta.glob` #43

jazlalli commented Nov 3, 2023 •

edited

Loading

jazlalli commented Nov 4, 2023 •

edited

Loading

vctqs1 commented Dec 26, 2023 •

edited

Loading

vctqs1 commented Dec 26, 2023 •

edited

Loading