这是indexloc提供的服务，不要输入任何密码
Skip to content

feat(ecmascript): support configurable emotion options #4458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 5, 2023
Merged

feat(ecmascript): support configurable emotion options #4458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99624bb
feat(ecmascript): support configurable emotion options
kwonoj Apr 4, 2023
67c88c7
test(snapshot): update fixtures
kwonoj Apr 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions crates/turbopack-ecmascript/src/transform/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,12 @@ pub enum EcmascriptInputTransform {
ClientDirective(StringVc),
CommonJs,
Custom(CustomTransformVc),
Emotion,
Emotion {
#[serde(default)]
sourcemap: bool,
Copy link
Contributor

@jridgewell jridgewell Apr 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just always enable the sourcemap?

Copy link
Contributor Author

@kwonoj kwonoj Apr 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for now, this inherits what next.config.js allow to configure. I hope to simplify / consolidate but thinking about feature parity to existing next.js configs we may need to expose.

label_format: OptionStringVc,
auto_label: Option<bool>,
},
PresetEnv(EnvironmentVc),
React {
#[serde(default)]
Expand Down Expand Up @@ -174,10 +179,24 @@ impl EcmascriptInputTransform {
Some(comments.clone()),
));
}
EcmascriptInputTransform::Emotion => {
EcmascriptInputTransform::Emotion {
sourcemap,
label_format,
auto_label,
} => {
let options = swc_emotion::EmotionOptions {
// this should be always enabled if match arrives here:
// since moduleoptions expect to push emotion transform only if
// there are valid, enabled config values.
enabled: Some(true),
sourcemap: Some(*sourcemap),
label_format: label_format.await?.clone_value(),
auto_label: *auto_label,
..Default::default()
};
let p = std::mem::replace(program, Program::Module(Module::dummy()));
*program = p.fold_with(&mut swc_emotion::emotion(
Default::default(),
options,
Path::new(file_name_str),
source_map.clone(),
comments.clone(),
Expand Down
11 changes: 9 additions & 2 deletions crates/turbopack-tests/tests/snapshot.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ use turbo_tasks_memory::MemoryBackend;
use turbopack::{
condition::ContextCondition,
ecmascript::EcmascriptModuleAssetVc,
module_options::{JsxTransformOptions, JsxTransformOptionsVc, ModuleOptionsContext},
module_options::{
EmotionTransformOptions, EmotionTransformOptionsVc, JsxTransformOptions,
JsxTransformOptionsVc, ModuleOptionsContext,
},
resolve_options_context::ResolveOptionsContext,
transition::TransitionsByNameVc,
ModuleAssetContextVc,
Expand Down Expand Up @@ -193,7 +196,11 @@ async fn run_test(resource: &str) -> Result<FileSystemPathVc> {
enable_jsx: Some(JsxTransformOptionsVc::cell(JsxTransformOptions {
..Default::default()
})),
enable_emotion: true,
enable_emotion: Some(EmotionTransformOptionsVc::cell(EmotionTransformOptions {
enabled: true,
sourcemap: Some(false),
..Default::default()
})),
enable_styled_components: true,
preset_env_versions: Some(env),
rules: vec![(
Expand Down
5 changes: 2 additions & 3 deletions ...motion/output/crates_turbopack-tests_tests_snapshot_emotion_emotion_input_index_b53fce.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions ...on/output/crates_turbopack-tests_tests_snapshot_emotion_emotion_input_index_b53fce.js.map
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 19 additions & 3 deletions crates/turbopack/src/module_options/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ impl ModuleOptionsVc {
) -> Result<ModuleOptionsVc> {
let ModuleOptionsContext {
enable_jsx,
enable_emotion,
ref enable_emotion,
enable_react_refresh,
enable_styled_jsx,
enable_styled_components,
Expand Down Expand Up @@ -96,8 +96,24 @@ impl ModuleOptionsVc {
if enable_styled_jsx {
transforms.push(EcmascriptInputTransform::StyledJsx);
}
if enable_emotion {
transforms.push(EcmascriptInputTransform::Emotion);
if let Some(enable_emotion) = enable_emotion {
let emotion_transform = enable_emotion.await?;
if emotion_transform.enabled {
transforms.push(EcmascriptInputTransform::Emotion {
sourcemap: emotion_transform.sourcemap.unwrap_or(false),
label_format: OptionStringVc::cell(emotion_transform.label_format.clone()),
auto_label: if let Some(auto_label) = emotion_transform.auto_label.as_ref() {
match auto_label {
EmotionLabelKind::Always => Some(true),
EmotionLabelKind::Never => Some(false),
// [TODO]: this is not correct coerece, need to be fixed
EmotionLabelKind::DevOnly => None,
}
} else {
None
},
});
}
}
if enable_styled_components {
transforms.push(EcmascriptInputTransform::StyledComponents);
Expand Down
34 changes: 33 additions & 1 deletion crates/turbopack/src/module_options/module_options_context.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,38 @@ impl Default for TypescriptTransformOptionsVc {
}
}

#[derive(Clone, PartialEq, Eq, Debug, TraceRawVcs, Serialize, Deserialize)]
pub enum EmotionLabelKind {
DevOnly,
Always,
Never,
}

//[TODO]: need to support importmap, there are type mismatch between
//[TODO]: next.config.js to swc's emotion options
#[turbo_tasks::value(shared)]
#[derive(Default, Clone, Debug)]
pub struct EmotionTransformOptions {
pub enabled: bool,
Copy link
Contributor

@jridgewell jridgewell Apr 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need an enabled if the enable_emotion if this is only used inside an Option wrapper? Shouldn't the Some(EmotionTransformOptions) imply that it is enabled?

Copy link
Contributor Author

@kwonoj kwonoj Apr 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's how I started, and then ends up this was somewhat more ergonomics when try to read next.config.js, we have couple of conditions

  1. if compiler option non-exists - None
  2. if exists, somehow user configures emotion: false or emotion: {enabled :false}

and having Option was easier to gracefully read & create config value among those conditions. It is possible to argue who would do 2 (if you specifiy compiler option, explicitly disabling it is non common) but that's certainly possible case if someone relies on some dynamic evaluation based on env / fn.

pub sourcemap: Option<bool>,
pub label_format: Option<String>,
pub auto_label: Option<EmotionLabelKind>,
}

#[turbo_tasks::value_impl]
impl EmotionTransformOptionsVc {
#[turbo_tasks::function]
pub fn default() -> Self {
Self::cell(Default::default())
}
}

impl Default for EmotionTransformOptionsVc {
fn default() -> Self {
Self::default()
}
}

impl WebpackLoadersOptions {
pub fn is_empty(&self) -> bool {
self.extension_to_loaders.is_empty()
Expand Down Expand Up @@ -117,7 +149,7 @@ pub struct ModuleOptionsContext {
#[serde(default)]
pub enable_jsx: Option<JsxTransformOptionsVc>,
#[serde(default)]
pub enable_emotion: bool,
pub enable_emotion: Option<EmotionTransformOptionsVc>,
#[serde(default)]
pub enable_react_refresh: bool,
#[serde(default)]
Expand Down