How to tell JSLint / JSHint what global variables are already defined

Question

In my project we have some global variables that work as containers:

MyProject.MyFreature.someFunction = function() { ... }

So then I use that script across the site and JSLint / JSHint complains about that:

'MyProject' is not defined

I know that I can go to every JavaScript file and add the comment /*global MyProject*/ on top of it. But I'm looking a way to define that comment in some sort of config file so I don't have to go file by file adding this comment.

Some kind on option in the config/jshint.yml would be nice.

Are you using the web applications (e.g. http://www.jshint.com/) or are you running them with node? — RobH, Jul 17 '13 at 20:44
I'm using to run as a task with rake. Actually I'm using the jshint_on_rails — Emiliano Zilocchi, Jul 17 '13 at 21:12
That explains the 'config/jshint.yml' file that I hadn't heard of. — RobH, Jul 17 '13 at 21:13

score 87 · Accepted Answer · answered Jul 17 '13 at 20:48

87

For JSHint you can create .jshintrc to your project directory with

{
  "globals": { "MyProject": true }
}

answered Jul 17 '13 at 20:48

esamatti

18,293
11
75
82

2

Thanks. But since I'm using jshint_on_rails, I can just set this option: predef: 'MyProject' on config/jshint.yml – Emiliano Zilocchi Jul 17 '13 at 20:55
You should have mentioned that in your question :) – esamatti Jul 17 '13 at 20:56
You are right, I missed that part. I will have in mind for the next time. Thanks – Emiliano Zilocchi Jul 19 '13 at 13:06
12

Just a small note on using this: put `false` for libraries like `angular` and `$`. But put this on `true` for globals you want to redefine yourself, like `myApp`. – polyclick Jan 23 '14 at 14:31

score 63 · Answer 2 · answered Oct 03 '15 at 08:48

63

This is only for globals

/* global MyProject */

In your case you need

/* exported MyProject */

answered Oct 03 '15 at 08:48

zevero

2,312
21
12

1

this is a good answer if you're working with one JavaScript file, thanks! – Aug 18 '18 at 22:32

talemyn · Answer 3 · 2013-07-17T20:49:27.817

4

JSLint has a textarea below the options that says predefine global variables here in it. Just add the variable names in there before running the check.

JSHint doesn't allow you to add global variables, but you can uncheck the When variable is undefined option to suppress that warning.

The JSHint library also has parameters for globals, if you run it as a library . . . details in here: http://jshint.com/docs/

edited Jul 17 '13 at 20:49

answered Jul 17 '13 at 20:41

talemyn

7,822
4
31
52

It doesn't sound like they're using the web interface - `But I'm looking a way to define that comment in some sort of config file so I don't have to go file by file adding this comment.` and `Some kind on option in the config/jshint.yml would be nice` – Ian Jul 17 '13 at 20:46
1

I've just found it, the 'predef' attribute under config/jshint.yml. it's a comma separated attribute. Thanks! – Emiliano Zilocchi Jul 17 '13 at 20:47
1

Worth mentioning `predef` [exists in JSLint too](https://github.com/douglascrockford/JSLint/blob/master/jslint.js#L37). – ruffin Jul 18 '13 at 01:24
Given Visual Studio 2013 with Web Essentials and a conventional hierarchy of solution folder and project sub-folders, you can put it in the solution root folder. – George Jan 18 '14 at 15:24
Undeserved downvotes. The question did not make it clear that Rails was being used until after this answer was left. +1 – superluminary Mar 04 '14 at 16:32

How to tell JSLint / JSHint what global variables are already defined

3 Answers3

Linked

Related