google/closure-compiler

Warn if a goog.scope alias uses a different name from the last part of the original name

Open

#1,283 opened on Dec 4, 2015

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Java (1,197 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (7,176 stars)
PR merge metrics
 (Avg merge 3d 4h) (1 merged PR in 30d)

Description

When creating a short alias for some.really.long.name.Foo the alias should almost certainly be Foo. If someone writes

goog.scope(function() {
var Bar = some.really.long.name.Foo;
});

it is surprising and a violation of the style guide. We could probably warn for this pretty easily in the ScopedAliases pass

Contributor guide

Research direction
Examine the ScopedAliases pass (ScopedAliases.java) and add logic to compare the alias variable name with the last part of the fully qualified name, emitting a warning when they do not match.
Tech stack
java
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60