google/closure-compiler

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

Open

#1283 opened on Dec 4, 2015

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

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

Tech stack
javajavascript
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaClosure Compiler architectureScopedAliases pass
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the ScopedAliases pass at src/com/google/javascript/jscomp/ScopedAliases.java. Add a check when an alias is defined via goog.scope that compares the alias name to the last part of the fully qualified name. If they differ, add a warning using the compiler's warning system. Consider existing similar warnings as reference. Test with appropriate unit tests.