Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janhancic/exterminateglobals.js
Exterminate unwanted JavaScript globals!
https://github.com/janhancic/exterminateglobals.js
Last synced: 22 days ago
JSON representation
Exterminate unwanted JavaScript globals!
- Host: GitHub
- URL: https://github.com/janhancic/exterminateglobals.js
- Owner: janhancic
- License: mit
- Created: 2013-09-09T20:12:50.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-10-25T09:02:25.000Z (about 8 years ago)
- Last Synced: 2024-04-14T19:15:47.141Z (7 months ago)
- Language: JavaScript
- Homepage: janhancic.github.io/ExterminateGlobals.JS
- Size: 165 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Exterminate Globals!
/
___
D>=G===' '.
|======|
|======|
)--/]IIIIII]
|_______|
C O O O D
C O O O D
C O O O D
C__O__O__O__D
[_____________]
# ExterminateGlobals.JS (v2.3.0)
Quickly discover if your JS code is leaking any unwanted globals (we all miss a `var` now and then).
## How to use
Include the `src/ExterminateGlobals.js` or `build/ExterminateGlobals.min.js` file in your HTML and call `ExterminateGlobals.startCollecting()` before any other JavaScript code gets included or executed. Then call `ExterminateGlobals.collect();` after all JavaScript has finished executing (you can of course do that manually, from the console). This will then generate a nice report in your browser's console:
After that start hunting down your unwanted globals and exterminate them.
### What if I have known globals?
Not to worry, the `ExterminateGlobals.startCollecting()`, as its first argument, accepts an array of names (strings) of known globals which will be ignored when generating the report.
### Can I use this to monitor any other object?
Why of course, just pass the object you want to monitor as the second argument to `ExterminateGlobals.startCollecting()`.
## Advanced usage
Besides `startCollecting()` and `collect()` the `ExterminateGlobals` also contains a constructor function `GlobalsCollector` (which the convenience functions startCollecting&collect use internally). This means you can monitor multiple objects at the same time or just obtain the list of unwanted globals as an array instead of printing everything out to the console.
Usage example:
```javascript
var globalsCollector = new ExterminateGlobals.GlobalsCollector( ['$', 'jQuery'], myObject);
globalsCollector.startCollecting();
// your code here
var unwantedGlobals = globalsCollector.collect();
globalsCollector.print(); // pass ExterminateGlobals.PRINT_COMPACT for more compact report
```
## Breaking when code writes a unwanted global
If you use the `ExterminateGlobals.GlobalsCollector` directly you get one extra feature. If you call `saveUnwantedGlobals(true)` on your object before you start collecting the globals, it will save the list of found globals to `localStorage`. Then if you refresh the page and start collecting again, `GlobalsCollector` will insert break points which will get hit whenever your code is writing to a global variable. This makes finding globals even easier, as you are shown directly where in your code you've made a mistake.
Look at the `ExterminateGlobals.js` file for full API documentation.
## Tests
[Jasmine](https://jasmine.github.io/) is used for testing. To run the tests just load the `spec/SpecRunner.html` file in your browser.
## Test report
Tests pass in the following browsers:
- Google Chrome v31.0.1636.0 dev, OS X
- Apple Safari v6.0.5, OS X
- Mozilla Firefox v24.0, OS X
## License
Licensed under MIT. See `LICENSE.md` file for details.
[](https://bitdeli.com/free "Bitdeli Badge")
[](https://codeclimate.com/github/janhancic/ExterminateGlobals.JS)