dan/oxc
1
0
Fork 0
mirror of https://github.com/danbulant/oxc synced 2026-05-24 12:21:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(transformer/class-properties): clarify doc comments (#7914)

Browse source 
Use `prop` for property name in comments, to match everywhere else in this transform.
This commit is contained in:
overlookmotel 2024-12-15 14:54:47 +00:00
parent 544ffbf6c7
commit 1317c00a5d
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
crates/oxc_transformer/src/es2022/class_properties/prop_decl.rs
View file

@ -16,7 +16,7 @@ use super::{
// Instance properties // Instance properties
impl<'a, 'ctx> ClassProperties<'a, 'ctx> { impl<'a, 'ctx> ClassProperties<'a, 'ctx> {
/// Convert instance property to initialization expression. /// Convert instance property to initialization expression.
/// Property `foo = 123;` -> Expression `this.foo = 123` or `_defineProperty(this, "foo", 123)`. /// Property `prop = 123;` -> Expression `this.prop = 123` or `_defineProperty(this, "prop", 123)`.
pub(super) fn convert_instance_property( pub(super) fn convert_instance_property(
&mut self, &mut self,
prop: &mut PropertyDefinition<'a>, prop: &mut PropertyDefinition<'a>,
@ -82,14 +82,14 @@ impl<'a, 'ctx> ClassProperties<'a, 'ctx> {
// Static properties // Static properties
impl<'a, 'ctx> ClassProperties<'a, 'ctx> { impl<'a, 'ctx> ClassProperties<'a, 'ctx> {
/// Convert static property to initialization expression. /// Convert static property to initialization expression.
/// Property `static foo = 123;` -> Expression `C.foo = 123` or `_defineProperty(C, "foo", 123)`. /// Property `static prop = 123;` -> Expression `C.prop = 123` or `_defineProperty(C, "prop", 123)`.
pub(super) fn convert_static_property( pub(super) fn convert_static_property(
&mut self, &mut self,
prop: &mut PropertyDefinition<'a>, prop: &mut PropertyDefinition<'a>,
ctx: &mut TraverseCtx<'a>, ctx: &mut TraverseCtx<'a>,
) { ) {
// Get value, and transform it to replace `this` with reference to class name, // Get value, and transform it to replace `this` with reference to class name,
// and transform class property accesses (`object.#prop`) // and transform class fields (`object.#prop`)
let value = match &mut prop.value { let value = match &mut prop.value {
Some(value) => { Some(value) => {
self.transform_static_initializer(value, ctx); self.transform_static_initializer(value, ctx);
@ -201,7 +201,7 @@ impl<'a, 'ctx> ClassProperties<'a, 'ctx> {
// Used for both instance and static properties // Used for both instance and static properties
impl<'a, 'ctx> ClassProperties<'a, 'ctx> { impl<'a, 'ctx> ClassProperties<'a, 'ctx> {
/// `assignee.foo = value` or `_defineProperty(assignee, "foo", value)` /// `assignee.prop = value` or `_defineProperty(assignee, "prop", value)`
fn create_init_assignment( fn create_init_assignment(
&mut self, &mut self,
prop: &mut PropertyDefinition<'a>, prop: &mut PropertyDefinition<'a>,
@ -211,15 +211,15 @@ impl<'a, 'ctx> ClassProperties<'a, 'ctx> {
ctx: &mut TraverseCtx<'a>, ctx: &mut TraverseCtx<'a>,
) -> Expression<'a> { ) -> Expression<'a> {
if self.set_public_class_fields { if self.set_public_class_fields {
// `assignee.foo = value` // `assignee.prop = value`
self.create_init_assignment_loose(prop, value, assignee, is_static, ctx) self.create_init_assignment_loose(prop, value, assignee, is_static, ctx)
} else { } else {
// `_defineProperty(assignee, "foo", value)` // `_defineProperty(assignee, "prop", value)`
self.create_init_assignment_not_loose(prop, value, assignee, ctx) self.create_init_assignment_not_loose(prop, value, assignee, ctx)
} }
} }
/// `this.foo = value` or `_Class.foo = value` /// `this.prop = value` or `_Class.prop = value`
fn create_init_assignment_loose( fn create_init_assignment_loose(
&mut self, &mut self,
prop: &mut PropertyDefinition<'a>, prop: &mut PropertyDefinition<'a>,
@ -261,7 +261,7 @@ impl<'a, 'ctx> ClassProperties<'a, 'ctx> {
) )
} }
/// `_defineProperty(this, "foo", value)` or `_defineProperty(_Class, "foo", value)` /// `_defineProperty(this, "prop", value)` or `_defineProperty(_Class, "prop", value)`
fn create_init_assignment_not_loose( fn create_init_assignment_not_loose(
&mut self, &mut self,
prop: &mut PropertyDefinition<'a>, prop: &mut PropertyDefinition<'a>,