VarName is not defined, please fix or add /*global

Question

Objective

Stop Cloud9 IDE from giving me the warning message.

Background

I am coding JavaScript using the Cloud9 IDE, and wherever I use a class from another file (in the same folder) I get the warning message:

VarName is not defined, please fix or add /*global VarName*/

Now this bugs me and I want to fix it.

The obvious solution would be to just add the comment /*global VarName*/ and be done with it, but I don't believe this is a good practice.

What I tried

After researching, I came across the JavaScript import functionality. In theory, this would allow me to do something like import "myOtherJsFile" and be done with it.

This would be a good standardized solution for the problem, as many other languages take the same approach.

Problem

However, even after adding the said line, I still get the warning. It wont go away.

Questions

1. Am I doing something wrong?
2. Is there a way to remove the warning without adding comments to my code?
3. Is there another way of achieving my objective?

Answer 1

After creating a thread on the official forums I am now confident enough to post here what I learned.

Summary

There were discussed four ways of solving the problem:

1. Disable the variable warnings withing the project
2. Creating an .eslintrc file with all the globals
3. Use of import and export
4. Adding the comment /*global varName*/ at the top of the file

Solution 1

To avoid the message one can simply turn off the "mark undefined variables" option in the project settings.

Although this solution will work, it will simply stop marking all undefined variables, even the ones you want it to mark. For this reason, I don't recommend this approach.

Solution 2

One can also create an .eslintrc think file with all the globals, like the following:

{
    "globals": {
        "var1": true,
        "var2": false
    }
}

More information on configuration: http://eslint.org/docs/user-guide/configuring

The problem with this approach is that every time you create, delete or change a global variable, you have to update the global variables file.

This can quickly become cumbersome and I am not even going to discuss the maintenance impacts on big projects, which would soon become a nightmare.

The way I see it, a techy solution, but not practical.

Solution 3

The preferred solution, as it relies solely on JavaScript and is very similar to the import and export functionalities on other languages.

The problem with this approach however, is that at the time of writing of the answer, no browser supports either the export nor the import keywords:

• https://developer.mozilla.org/en/docs/web/javascript/reference/statements/import
• https://developer.mozilla.org/en/docs/web/javascript/reference/statements/export

In the future this may change, but for now it is as it is, so we cannot use this solution either.

Solution 4

By exclusion of parts, since solutions one and two are either prone to huge side effects or either have huge scaling problems, this is the solution I will be using for the time being.

It has no side effects, scales very well due to its independence regarding other files and most importantly, once solution 3 becomes available to use, it will be very easy to simply replace the comments with a call to the import keyword.

Conclusion

For the time being, solution 4 is the best practice. However, once browsers add support for solution 3, that should be used instead of solution 4.

Credits

Special thanks to Harutyun Amirjanyan for his tenacity, patience and guidance in helping me solve this issue.

Answer 2

Another possible method, similar to Solution 1 is to go to the "Hints and Warnings" section in the project settings and under "Ignore messages matching Regex" type

.* is not defined; please fix or add /\*global

This regex will match those annoying messages but also allows the error-checker to catch other undefined variables that just don't have that particular message.

(Of course, this is only better than other proposed solutions if Cloud9 does have other warnings for undefined variables that aren't in that form.)