feat(es/transforms): Add `module.outFileExtension` by hanseltime · Pull Request #9784 · swc-project/swc

hanseltime · 2024-12-06T02:38:04Z

Description:

Summary of Changes:

Adds an outFileExtension property to every module configuration option struct
passes this configuration through to the resolver function and changes all hard-coded "js" checks to use the new parameter
As a matter of backwards compatibility, structures default to "js" if nothing is provided
@swc/core snapshot tests for each module using resolveFully and outFileExtension (Please check the rendered output of the snapshots to make sure you don't have any issues with it).
QOL - updates @swc/core jest config to use explicit module names (this was because the mapping util in jest was exploding when it would try to load in the .node files that were over 512MB)
QOL - updates the test script to pass through any existing NODE_OPTIONS - this allows debugging tools to add their own inspect configurations while preserving our esm module flag

Note

This is a rudimentary fix to: #3067 (comment). I had to implement it locally since I could not find a workaround in my timeline.

I do know that @kdy1 said they would work on it a few days ago, so I am opening this to either provide some visibility to a solution that works for me if they haven't started or to let them switch to PR critique if that feels more valuable for their time on this issue. Let me know if this should be closed due to a better implementation already being in the works.

Related issue:

Closes Output mjs file extension #3067

…low in jest

changeset-bot · 2024-12-06T02:38:09Z

🦋 Changeset detected

Latest commit: 4eb8ad0

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

CLAassistant · 2024-12-06T02:38:11Z

All committers have signed the CLA.

…option

codspeed-hq · 2024-12-06T04:34:13Z

CodSpeed Performance Report

Merging #9784 will degrade performances by 4.89%

_{Comparing hanseltime:feat-out-file-extension-resolution (4eb8ad0) with main (5a44c6b)}

Summary

❌ 1 regressions
✅ 193 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	`main`	`hanseltime:feat-out-file-extension-resolution`	Change
❌	`es/visitor/base-perf/boxing_boxed_clone`	2.3 µs	2.4 µs	-4.89%

socket-security · 2024-12-06T22:07:17Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

View full report↗︎

hanseltime · 2024-12-07T00:17:03Z

Noting here a few things that I'm unsure on:

The Miri tests are failing, but they seem to fail on things like test_fixtures macro, and "unimplemented functions". If someone could set me straight on it, I can sit down and debug it if asked.
If I should be submitting a documentation change to the website in tandem with this

Thanks in advance!

kdy1 · 2024-12-09T02:46:46Z

    mut base_url: PathBuf,
    paths: CompiledPaths,
    resolve_fully: bool,
+    file_extension: &String,


I think clippy will be angry at this

Suggested change

file_extension: &String,

file_extension: &str,

Ah thanks. I have updated it!

kdy1 · 2024-12-09T02:57:50Z

@@ -21,6 +22,9 @@ pub struct Config {

    #[serde(default)]


I think you should remove this

@kdy1 - I didn't add this attribute. Did you mean the inner Config attribute below it or were you hoping I would clean this up? Also, I'm assuming you would want this changed across all Module Shapes or just this one?

I mean the whole resolve_fully: bool. It's now duplicated as you added a field below.

Oh I see. Thanks for clarifying. Okay, I've updated that for the ESModuleConfig and the SystemJS Config.

kdy1 · 2024-12-09T02:58:58Z

+pub fn default_js_ext() -> String {
+    "js".to_string()
 }


Suggested change

pub fn default_js_ext() -> String {

"js".to_string()

}

impl Config {

pub fn default_js_ext() -> String {

"js".to_string()

}

}

I've switched the function to an impl on Config and all calls to the function to use the Config::default_js_ext() as well.

kdy1

Thank you!

socket-security · 2024-12-09T06:26:52Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	environment	`0`	252 kB	zombiej
npm/[email protected]	environment	`0`	133 kB	zombiej
npm/[email protected]	environment	`0`	145 kB	afc163
npm/[email protected]	environment	`+1`	460 kB	afc163
npm/[email protected]	None	`0`	62.6 kB	zombiej
npm/[email protected]	None	`0`	27.4 kB	benjamn
npm/[email protected]	None	`0`	302 kB	mysticatea
npm/[email protected]	filesystem	`0`	115 kB	ljharb
npm/[email protected]	None	`0`	39.6 kB	stipsan
npm/[email protected]	None	`0`	88.2 kB	isaacs
npm/[email protected]	None	`0`	7.35 kB	dashed
npm/[email protected]	None	`0`	766 kB	tromey
npm/[email protected]	None	`0`	4.14 kB	akiran
npm/[email protected]	None	`0`	4.03 kB	sindresorhus
npm/[email protected]	None	`0`	148 kB	gajus
npm/[email protected]	None	`0`	11 kB	substack
npm/[email protected]	None	`0`	3.32 kB	sudodoki
npm/[email protected]	None	`0`	111 kB	sindresorhus
npm/[email protected]	None	`0`	470 kB	garycourt
npm/[email protected]	environment, filesystem, unsafe	`0`	16.8 kB	zertosh
npm/[email protected]	None	`0`	9.47 kB	berkeleytrue

🚮 Removed packages: npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected]

View full report↗︎

test(@swc/core): add moduleFileExtensions to avoid .node buffer overf…

339084c

…low in jest

hanseltime requested review from a team as code owners December 6, 2024 02:38

hanseltime added 3 commits December 5, 2024 19:43

test(@swc/core): NODE_OPTIONS pass through for better debug support

cfe149c

feat(swc, swc_ecma_transofmrs_module): added outFileExtension module …

5203e73

…option

test(@swc/core): testing outFileExtension resolution options

9a35817

hanseltime force-pushed the feat-out-file-extension-resolution branch from 3ef730f to 9a35817 Compare December 6, 2024 02:44

hanseltime mentioned this pull request Dec 6, 2024

Output mjs file extension #3067

Closed

fix: missing . in index check

55c6095

test: adding swc test packages

a05963a

kdy1 added this to the Planned milestone Dec 9, 2024

kdy1 reviewed Dec 9, 2024

View reviewed changes

hanseltime force-pushed the feat-out-file-extension-resolution branch from 252afff to 258b834 Compare December 9, 2024 04:05

fix: applying type change request and default function as part of struct

efe8f77

hanseltime force-pushed the feat-out-file-extension-resolution branch from 258b834 to efe8f77 Compare December 9, 2024 04:09

fix: consolidate resolve_fully to included config

b749621

kdy1 mentioned this pull request Dec 9, 2024

Update swc_core to v9 wooorm/mdxjs-rs#59

Merged

Create heavy-apes-collect.md

4eb8ad0

kdy1 changed the title ~~Feat out file extension resolution~~ feat(es/transforms): Add module.outFileExtension Dec 9, 2024

kdy1 merged commit e04c7b3 into swc-project:main Dec 9, 2024

kdy1 removed this from the Planned milestone Dec 9, 2024

kdy1 added this to the v1.10.1 milestone Dec 9, 2024

swc-project locked as resolved and limited conversation to collaborators Jan 9, 2025

Uh oh!

Uh oh!

Conversation

hanseltime commented Dec 6, 2024 • edited by kdy1 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

CLAassistant commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codspeed-hq Bot commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging #9784 will degrade performances by 4.89%

Summary

Benchmarks breakdown

Uh oh!

socket-security Bot commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hanseltime commented Dec 7, 2024

Uh oh!

kdy1 Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kdy1 left a comment

Choose a reason for hiding this comment

Uh oh!

socket-security Bot commented Dec 9, 2024

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

hanseltime commented Dec 6, 2024 •

edited by kdy1

Loading

changeset-bot Bot commented Dec 6, 2024 •

edited

Loading

CLAassistant commented Dec 6, 2024 •

edited

Loading

codspeed-hq Bot commented Dec 6, 2024 •

edited

Loading

socket-security Bot commented Dec 6, 2024 •

edited

Loading

kdy1 Dec 9, 2024 •

edited

Loading