Skip to content

docs(traverse): tidy doc comments for TraverseCtx::is_static #7267

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
graphite-app merged 1 commit into from
Nov 13, 2024
Merged

docs(traverse): tidy doc comments for TraverseCtx::is_static #7267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions crates/oxc_traverse/src/context/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,12 +545,12 @@ impl<'a> TraverseCtx<'a> {

/// Determine whether evaluating the specific input `node` is a consequenceless reference.
///
/// I.E evaluating it won't result in potentially arbitrary code from being ran. The following are
/// allowed and determined not to cause side effects:
/// i.e. evaluating it won't result in potentially arbitrary code from being run.
/// The following are allowed and determined not to cause side effects:
///
/// - `this` expressions
/// - `super` expressions
/// - Bound identifiers
/// - Bound identifiers which are not mutated
///
/// This is a shortcut for `ctx.scoping.is_static`.
#[inline]
Expand Down
9 changes: 3 additions & 6 deletions crates/oxc_traverse/src/context/scoping.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,18 +353,15 @@ impl TraverseScoping {

/// Determine whether evaluating the specific input `node` is a consequenceless reference.
///
/// I.E evaluating it won't result in potentially arbitrary code from being ran. The following are
/// allowed and determined not to cause side effects:
/// i.e. evaluating it won't result in potentially arbitrary code from being run.
/// The following are allowed and determined not to cause side effects:
///
/// - `this` expressions
/// - `super` expressions
/// - Bound identifiers
/// - Bound identifiers which are not mutated
///
/// Based on Babel's `scope.isStatic` logic.
/// <https://github.com/babel/babel/blob/419644f27c5c59deb19e71aaabd417a3bc5483ca/packages/babel-traverse/src/scope/index.ts#L557>
///
/// # Panics
/// Can only panic if [`IdentifierReference`] does not have a reference_id, which it always should.
#[inline]
pub fn is_static(&self, expr: &Expression) -> bool {
match expr {
Expand Down