Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated messages. Refactored runLinter() method

  • Loading branch information...
commit bf439a334651d4708c8c0e1c16995c6728a7d532 1 parent 26acfcf
@arthurakay authored
View
2  docs/data.js
@@ -1 +1 @@
-Docs = {"data":{"search":[{"meta":{"author":["Arthur Kay (http://www.akawebdesign.com)"]},"fullName":"LintRoller","url":"#!/api/LintRoller","sort":1,"icon":"icon-singleton","name":"LintRoller"},{"meta":{"private":true},"fullName":"LintRoller.files","url":"#!/api/LintRoller-property-files","sort":3,"icon":"icon-property","name":"files"},{"meta":{"private":true},"fullName":"LintRoller.linters","url":"#!/api/LintRoller-property-linters","sort":3,"icon":"icon-property","name":"linters"},{"meta":{"private":true},"fullName":"LintRoller.announceErrors","url":"#!/api/LintRoller-method-announceErrors","sort":3,"icon":"icon-method","name":"announceErrors"},{"meta":{"private":true},"fullName":"LintRoller.announceSuccess","url":"#!/api/LintRoller-method-announceSuccess","sort":3,"icon":"icon-method","name":"announceSuccess"},{"meta":{"private":true},"fullName":"LintRoller.applyLintOptions","url":"#!/api/LintRoller-method-applyLintOptions","sort":3,"icon":"icon-method","name":"applyLintOptions"},{"meta":{"private":true},"fullName":"LintRoller.getFiles","url":"#!/api/LintRoller-method-getFiles","sort":3,"icon":"icon-method","name":"getFiles"},{"meta":{},"fullName":"LintRoller.init","url":"#!/api/LintRoller-method-init","sort":3,"icon":"icon-method","name":"init"},{"meta":{"private":true},"fullName":"LintRoller.initConfigs","url":"#!/api/LintRoller-method-initConfigs","sort":3,"icon":"icon-method","name":"initConfigs"},{"meta":{"private":true},"fullName":"LintRoller.lintFiles","url":"#!/api/LintRoller-method-lintFiles","sort":3,"icon":"icon-method","name":"lintFiles"},{"meta":{"private":true},"fullName":"LintRoller.log","url":"#!/api/LintRoller-method-log","sort":3,"icon":"icon-method","name":"log"},{"meta":{"private":true},"fullName":"LintRoller.logToFile","url":"#!/api/LintRoller-method-logToFile","sort":3,"icon":"icon-method","name":"logToFile"},{"meta":{"private":true},"fullName":"LintRoller.parseTree","url":"#!/api/LintRoller-method-parseTree","sort":3,"icon":"icon-method","name":"parseTree"},{"meta":{"private":true},"fullName":"LintRoller.runJSHint","url":"#!/api/LintRoller-method-runJSHint","sort":3,"icon":"icon-method","name":"runJSHint"},{"meta":{"private":true},"fullName":"LintRoller.runJSLint","url":"#!/api/LintRoller-method-runJSLint","sort":3,"icon":"icon-method","name":"runJSLint"},{"meta":{},"fullName":"LintRoller.exclusions","url":"#!/api/LintRoller-cfg-exclusions","sort":3,"icon":"icon-cfg","name":"exclusions"},{"meta":{},"fullName":"LintRoller.filepaths","url":"#!/api/LintRoller-cfg-filepaths","sort":3,"icon":"icon-cfg","name":"filepaths"},{"meta":{},"fullName":"LintRoller.jsHint","url":"#!/api/LintRoller-cfg-jsHint","sort":3,"icon":"icon-cfg","name":"jsHint"},{"meta":{},"fullName":"LintRoller.jsLint","url":"#!/api/LintRoller-cfg-jsLint","sort":3,"icon":"icon-cfg","name":"jsLint"},{"meta":{},"fullName":"LintRoller.logFile","url":"#!/api/LintRoller-cfg-logFile","sort":3,"icon":"icon-cfg","name":"logFile"},{"meta":{},"fullName":"LintRoller.stopOnFirstError","url":"#!/api/LintRoller-cfg-stopOnFirstError","sort":3,"icon":"icon-cfg","name":"stopOnFirstError"},{"meta":{},"fullName":"LintRoller.verbose","url":"#!/api/LintRoller-cfg-verbose","sort":3,"icon":"icon-cfg","name":"verbose"}],"showPrintButton":false,"examples":[],"guides":[],"source":true,"stats":[],"touchExamplesUi":false,"tests":false,"videos":[],"classes":[{"private":null,"extends":null,"icon":"icon-singleton","name":"LintRoller"}],"signatures":[{"key":"abstract","short":"ABS","long":"abstract"},{"key":"deprecated","short":"DEP","long":"deprecated"},{"key":"preventable","short":"PREV","long":"preventable"},{"key":"private","short":"PRI","long":"private"},{"key":"protected","short":"PRO","long":"protected"},{"key":"readonly","short":"R O","long":"readonly"},{"key":"removed","short":"REM","long":"removed"},{"key":"required","short":"REQ","long":"required"},{"key":"static","short":"STA","long":"static"},{"key":"template","short":"TMP","long":"template"}],"localStorageDb":"docs"}};
+Docs = {"data":{"search":[{"meta":{"author":["Arthur Kay (http://www.akawebdesign.com)"]},"fullName":"LintRoller","url":"#!/api/LintRoller","sort":1,"icon":"icon-singleton","name":"LintRoller"},{"meta":{"private":true},"fullName":"LintRoller.files","url":"#!/api/LintRoller-property-files","sort":3,"icon":"icon-property","name":"files"},{"meta":{"private":true},"fullName":"LintRoller.linters","url":"#!/api/LintRoller-property-linters","sort":3,"icon":"icon-property","name":"linters"},{"meta":{"private":true},"fullName":"LintRoller.announceErrors","url":"#!/api/LintRoller-method-announceErrors","sort":3,"icon":"icon-method","name":"announceErrors"},{"meta":{"private":true},"fullName":"LintRoller.announceSuccess","url":"#!/api/LintRoller-method-announceSuccess","sort":3,"icon":"icon-method","name":"announceSuccess"},{"meta":{"private":true},"fullName":"LintRoller.applyLintOptions","url":"#!/api/LintRoller-method-applyLintOptions","sort":3,"icon":"icon-method","name":"applyLintOptions"},{"meta":{"private":true},"fullName":"LintRoller.getFiles","url":"#!/api/LintRoller-method-getFiles","sort":3,"icon":"icon-method","name":"getFiles"},{"meta":{},"fullName":"LintRoller.init","url":"#!/api/LintRoller-method-init","sort":3,"icon":"icon-method","name":"init"},{"meta":{"private":true},"fullName":"LintRoller.initConfigs","url":"#!/api/LintRoller-method-initConfigs","sort":3,"icon":"icon-method","name":"initConfigs"},{"meta":{"private":true},"fullName":"LintRoller.lintFiles","url":"#!/api/LintRoller-method-lintFiles","sort":3,"icon":"icon-method","name":"lintFiles"},{"meta":{"private":true},"fullName":"LintRoller.log","url":"#!/api/LintRoller-method-log","sort":3,"icon":"icon-method","name":"log"},{"meta":{"private":true},"fullName":"LintRoller.logToFile","url":"#!/api/LintRoller-method-logToFile","sort":3,"icon":"icon-method","name":"logToFile"},{"meta":{"private":true},"fullName":"LintRoller.parseTree","url":"#!/api/LintRoller-method-parseTree","sort":3,"icon":"icon-method","name":"parseTree"},{"meta":{"private":true},"fullName":"LintRoller.runJSHint","url":"#!/api/LintRoller-method-runJSHint","sort":3,"icon":"icon-method","name":"runJSHint"},{"meta":{"private":true},"fullName":"LintRoller.runJSLint","url":"#!/api/LintRoller-method-runJSLint","sort":3,"icon":"icon-method","name":"runJSLint"},{"meta":{"private":true},"fullName":"LintRoller.setLinters","url":"#!/api/LintRoller-method-setLinters","sort":3,"icon":"icon-method","name":"setLinters"},{"meta":{},"fullName":"LintRoller.exclusions","url":"#!/api/LintRoller-cfg-exclusions","sort":3,"icon":"icon-cfg","name":"exclusions"},{"meta":{},"fullName":"LintRoller.filepaths","url":"#!/api/LintRoller-cfg-filepaths","sort":3,"icon":"icon-cfg","name":"filepaths"},{"meta":{},"fullName":"LintRoller.jsHint","url":"#!/api/LintRoller-cfg-jsHint","sort":3,"icon":"icon-cfg","name":"jsHint"},{"meta":{},"fullName":"LintRoller.jsLint","url":"#!/api/LintRoller-cfg-jsLint","sort":3,"icon":"icon-cfg","name":"jsLint"},{"meta":{},"fullName":"LintRoller.logFile","url":"#!/api/LintRoller-cfg-logFile","sort":3,"icon":"icon-cfg","name":"logFile"},{"meta":{},"fullName":"LintRoller.stopOnFirstError","url":"#!/api/LintRoller-cfg-stopOnFirstError","sort":3,"icon":"icon-cfg","name":"stopOnFirstError"},{"meta":{},"fullName":"LintRoller.verbose","url":"#!/api/LintRoller-cfg-verbose","sort":3,"icon":"icon-cfg","name":"verbose"},{"meta":{},"fullName":"LintRoller.util","url":"#!/api/LintRoller.util","sort":1,"icon":"icon-singleton","name":"util"},{"meta":{"private":true},"fullName":"LintRoller.util.findLintErrors","url":"#!/api/LintRoller.util-method-findLintErrors","sort":3,"icon":"icon-method","name":"findLintErrors"},{"meta":{"private":true},"fullName":"LintRoller.util.fixOffendingFiles","url":"#!/api/LintRoller.util-method-fixOffendingFiles","sort":3,"icon":"icon-method","name":"fixOffendingFiles"},{"meta":{"private":true},"fullName":"LintRoller.util.getLintOptions","url":"#!/api/LintRoller.util-method-getLintOptions","sort":3,"icon":"icon-method","name":"getLintOptions"},{"meta":{"private":true},"fullName":"LintRoller.util.init","url":"#!/api/LintRoller.util-method-init","sort":3,"icon":"icon-method","name":"init"},{"meta":{"private":true},"fullName":"LintRoller.util.locateOffenders","url":"#!/api/LintRoller.util-method-locateOffenders","sort":3,"icon":"icon-method","name":"locateOffenders"},{"meta":{},"fullName":"LintRoller.util.replaceTabsWithSpaces","url":"#!/api/LintRoller.util-method-replaceTabsWithSpaces","sort":3,"icon":"icon-method","name":"replaceTabsWithSpaces"}],"showPrintButton":false,"examples":[],"guides":[],"source":true,"stats":[],"touchExamplesUi":false,"tests":false,"videos":[],"classes":[{"private":null,"extends":null,"icon":"icon-singleton","name":"LintRoller"},{"private":null,"extends":null,"icon":"icon-singleton","name":"LintRoller.util"}],"signatures":[{"key":"abstract","short":"ABS","long":"abstract"},{"key":"deprecated","short":"DEP","long":"deprecated"},{"key":"preventable","short":"PREV","long":"preventable"},{"key":"private","short":"PRI","long":"private"},{"key":"protected","short":"PRO","long":"protected"},{"key":"readonly","short":"R O","long":"readonly"},{"key":"removed","short":"REM","long":"removed"},{"key":"required","short":"REQ","long":"required"},{"key":"static","short":"STA","long":"static"},{"key":"template","short":"TMP","long":"template"}],"localStorageDb":"docs"}};
View
3  docs/index.html
@@ -27,11 +27,12 @@
<div id='categories-content' style='display:none'>
<div class='section'>
-<h1>Others...</h1>
+<h1>LintRoller</h1>
<div class='left-column'>
<h3>Others...</h3>
<div class='links'>
<a href="#!/api/LintRoller" rel="LintRoller" class="docClass">LintRoller</a>
+<a href="#!/api/LintRoller.util" rel="LintRoller.util" class="docClass">LintRoller.util</a>
</div>
</div>
<div class='middle-column'>
View
2  docs/output/LintRoller.js
@@ -1 +1 @@
-Ext.data.JsonP.LintRoller({"mixedInto":[],"mixins":[],"code_type":"assignment","inheritable":false,"parentMixins":[],"meta":{"author":["Arthur Kay (http://www.akawebdesign.com)"]},"uses":[],"aliases":{},"superclasses":[],"html":"<div><pre class=\"hierarchy\"><h4>Files</h4><div class='dependency'><a href='source/LintRoller.html#LintRoller' target='_blank'>LintRoller.js</a></div></pre><div class='doc-contents'><p>@version 2.0.0</p>\n\n<p>GitHub Project: https://github.com/arthurakay/PhantomLint</p>\n</div><div class='members'><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-cfg'>Config options</h3><div class='subsection'><div id='cfg-exclusions' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-exclusions' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-exclusions' class='name expandable'>exclusions</a><span> : Array</span></div><div class='description'><div class='short'>REQUIRED. ...</div><div class='long'><p>REQUIRED. An array of relative filepaths to the folders containing JS files that should NOT be linted</p>\n</div></div></div><div id='cfg-filepaths' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-filepaths' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-filepaths' class='name expandable'>filepaths</a><span> : Array</span></div><div class='description'><div class='short'>REQUIRED. ...</div><div class='long'><p>REQUIRED. An array of relative filepaths to the folders containing JS files</p>\n</div></div></div><div id='cfg-jsHint' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-jsHint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-jsHint' class='name expandable'>jsHint</a><span> : Object</span></div><div class='description'><div class='short'>An object containing an \"options\" property (False to disable usage.). ...</div><div class='long'><p>An object containing an \"options\" property (False to disable usage.).</p>\n\n<ul>\n<li>\"options\" is an object containing the optional lint flags.</li>\n</ul>\n\n<p>Defaults to: <code>{options: {}}</code></p></div></div></div><div id='cfg-jsLint' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-jsLint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-jsLint' class='name expandable'>jsLint</a><span> : Object</span></div><div class='description'><div class='short'>An object containing an \"options\" property (False to disable usage.). ...</div><div class='long'><p>An object containing an \"options\" property (False to disable usage.).</p>\n\n<ul>\n<li>\"options\" is an object containing the optional lint flags.</li>\n</ul>\n\n<p>Defaults to: <code>{options: {nomen: true, plusplus: true, sloppy: true, vars: true, white: true, undef: true, node: true, browser: true, stupid: true}}</code></p></div></div></div><div id='cfg-logFile' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-logFile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-logFile' class='name expandable'>logFile</a><span> : String</span></div><div class='description'><div class='short'>A relative filepath to where error messages will be logged. ...</div><div class='long'><p>A relative filepath to where error messages will be logged.</p>\n<p>Defaults to: <code>&quot;error_log.txt&quot;</code></p></div></div></div><div id='cfg-stopOnFirstError' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-stopOnFirstError' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-stopOnFirstError' class='name expandable'>stopOnFirstError</a><span> : Boolean</span></div><div class='description'><div class='short'>True to stop linting your code when the first error is encountered. ...</div><div class='long'><p>True to stop linting your code when the first error is encountered.</p>\n<p>Defaults to: <code>true</code></p></div></div></div><div id='cfg-verbose' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-verbose' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-verbose' class='name expandable'>verbose</a><span> : Boolean</span></div><div class='description'><div class='short'>True to show verbose ouput in the terminal. ...</div><div class='long'><p>True to show verbose ouput in the terminal.</p>\n<p>Defaults to: <code>true</code></p></div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-property'>Properties</h3><div class='subsection'><div id='property-files' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-property-files' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-property-files' class='name expandable'>files</a><span> : Array</span><strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>[]</code></p></div></div></div><div id='property-linters' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-property-linters' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-property-linters' class='name expandable'>linters</a><span> : Array</span><strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>[]</code></p></div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-method'>Methods</h3><div class='subsection'><div id='method-announceErrors' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-announceErrors' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-announceErrors' class='name expandable'>announceErrors</a>( <span class='pre'>Object errorList</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>errorList</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-announceSuccess' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-announceSuccess' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-announceSuccess' class='name expandable'>announceSuccess</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div><div id='method-applyLintOptions' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-applyLintOptions' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-applyLintOptions' class='name expandable'>applyLintOptions</a>( <span class='pre'>Object linter, Object options</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>linter</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>options</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-getFiles' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-getFiles' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-getFiles' class='name expandable'>getFiles</a>( <span class='pre'>Object path</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>path</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-init' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-init' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-init' class='name expandable'>init</a>( <span class='pre'>Object config</span> )</div><div class='description'><div class='short'>Call this method to de-lint your JavaScript codebase. ...</div><div class='long'><p>Call this method to de-lint your JavaScript codebase.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>config</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-initConfigs' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-initConfigs' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-initConfigs' class='name expandable'>initConfigs</a>( <span class='pre'>Object config</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>config</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-lintFiles' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-lintFiles' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-lintFiles' class='name expandable'>lintFiles</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div><div id='method-log' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-log' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-log' class='name expandable'>log</a>( <span class='pre'>Object msg, Object override</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>msg</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>override</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-logToFile' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-logToFile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-logToFile' class='name expandable'>logToFile</a>( <span class='pre'>Object errorList</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>errorList</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-parseTree' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-parseTree' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-parseTree' class='name expandable'>parseTree</a>( <span class='pre'>Object pathConfig</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>pathConfig</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-runJSHint' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-runJSHint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-runJSHint' class='name expandable'>runJSHint</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div><div id='method-runJSLint' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-runJSLint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-runJSLint' class='name expandable'>runJSLint</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div></div></div></div></div>","subclasses":[],"members":{"event":[],"property":[{"meta":{"private":true},"owner":"LintRoller","tagname":"property","name":"files","id":"property-files"},{"meta":{"private":true},"owner":"LintRoller","tagname":"property","name":"linters","id":"property-linters"}],"css_var":[],"method":[{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"announceErrors","id":"method-announceErrors"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"announceSuccess","id":"method-announceSuccess"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"applyLintOptions","id":"method-applyLintOptions"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"getFiles","id":"method-getFiles"},{"meta":{},"owner":"LintRoller","tagname":"method","name":"init","id":"method-init"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"initConfigs","id":"method-initConfigs"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"lintFiles","id":"method-lintFiles"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"log","id":"method-log"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"logToFile","id":"method-logToFile"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"parseTree","id":"method-parseTree"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"runJSHint","id":"method-runJSHint"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"runJSLint","id":"method-runJSLint"}],"css_mixin":[],"cfg":[{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"exclusions","id":"cfg-exclusions"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"filepaths","id":"cfg-filepaths"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"jsHint","id":"cfg-jsHint"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"jsLint","id":"cfg-jsLint"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"logFile","id":"cfg-logFile"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"stopOnFirstError","id":"cfg-stopOnFirstError"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"verbose","id":"cfg-verbose"}]},"html_meta":{"author":null},"tagname":"class","extends":null,"name":"LintRoller","alternateClassNames":[],"inheritdoc":null,"component":false,"singleton":true,"id":"class-LintRoller","statics":{"property":[],"event":[],"css_var":[],"method":[],"css_mixin":[],"cfg":[]},"requires":[],"files":[{"href":"LintRoller.html#LintRoller","filename":"LintRoller.js"}]});
+Ext.data.JsonP.LintRoller({"mixedInto":[],"mixins":[],"code_type":"assignment","inheritable":false,"parentMixins":[],"meta":{"author":["Arthur Kay (http://www.akawebdesign.com)"]},"uses":[],"aliases":{},"superclasses":[],"html":"<div><pre class=\"hierarchy\"><h4>Files</h4><div class='dependency'><a href='source/LintRoller.html#LintRoller' target='_blank'>LintRoller.js</a></div></pre><div class='doc-contents'><p>@version 2.0.0</p>\n\n<p>GitHub Project: https://github.com/arthurakay/LintRoller</p>\n</div><div class='members'><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-cfg'>Config options</h3><div class='subsection'><div id='cfg-exclusions' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-exclusions' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-exclusions' class='name expandable'>exclusions</a><span> : Array</span></div><div class='description'><div class='short'>REQUIRED. ...</div><div class='long'><p>REQUIRED. An array of relative filepaths to the folders containing JS files that should NOT be linted</p>\n</div></div></div><div id='cfg-filepaths' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-filepaths' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-filepaths' class='name expandable'>filepaths</a><span> : Array</span></div><div class='description'><div class='short'>REQUIRED. ...</div><div class='long'><p>REQUIRED. An array of relative filepaths to the folders containing JS files</p>\n</div></div></div><div id='cfg-jsHint' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-jsHint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-jsHint' class='name expandable'>jsHint</a><span> : Object</span></div><div class='description'><div class='short'>An object containing an \"options\" property (False to disable usage.). ...</div><div class='long'><p>An object containing an \"options\" property (False to disable usage.).</p>\n\n<ul>\n<li>\"options\" is an object containing the optional lint flags.</li>\n</ul>\n\n<p>Defaults to: <code>{lib: null, options: {}}</code></p></div></div></div><div id='cfg-jsLint' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-jsLint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-jsLint' class='name expandable'>jsLint</a><span> : Object</span></div><div class='description'><div class='short'>An object containing an \"options\" property (False to disable usage.). ...</div><div class='long'><p>An object containing an \"options\" property (False to disable usage.).</p>\n\n<ul>\n<li>\"options\" is an object containing the optional lint flags.</li>\n</ul>\n\n<p>Defaults to: <code>{lib: null, options: {nomen: true, plusplus: true, sloppy: true, vars: true, white: true, undef: true, node: true, browser: true, stupid: true}}</code></p></div></div></div><div id='cfg-logFile' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-logFile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-logFile' class='name expandable'>logFile</a><span> : String</span></div><div class='description'><div class='short'>A relative filepath to where error messages will be logged. ...</div><div class='long'><p>A relative filepath to where error messages will be logged.</p>\n<p>Defaults to: <code>&quot;error_log.txt&quot;</code></p></div></div></div><div id='cfg-stopOnFirstError' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-stopOnFirstError' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-stopOnFirstError' class='name expandable'>stopOnFirstError</a><span> : Boolean</span></div><div class='description'><div class='short'>True to stop linting your code when the first error is encountered. ...</div><div class='long'><p>True to stop linting your code when the first error is encountered.</p>\n<p>Defaults to: <code>true</code></p></div></div></div><div id='cfg-verbose' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-cfg-verbose' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-cfg-verbose' class='name expandable'>verbose</a><span> : Boolean</span></div><div class='description'><div class='short'>True to show verbose ouput in the terminal. ...</div><div class='long'><p>True to show verbose ouput in the terminal.</p>\n<p>Defaults to: <code>true</code></p></div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-property'>Properties</h3><div class='subsection'><div id='property-files' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-property-files' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-property-files' class='name expandable'>files</a><span> : Array</span><strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>[]</code></p></div></div></div><div id='property-linters' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-property-linters' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-property-linters' class='name expandable'>linters</a><span> : Array</span><strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<p>Defaults to: <code>[]</code></p></div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-method'>Methods</h3><div class='subsection'><div id='method-announceErrors' class='member first-child not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-announceErrors' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-announceErrors' class='name expandable'>announceErrors</a>( <span class='pre'>Object errorList</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>errorList</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-announceSuccess' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-announceSuccess' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-announceSuccess' class='name expandable'>announceSuccess</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div><div id='method-applyLintOptions' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-applyLintOptions' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-applyLintOptions' class='name expandable'>applyLintOptions</a>( <span class='pre'>Object linter, Object options</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>linter</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>options</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-getFiles' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-getFiles' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-getFiles' class='name expandable'>getFiles</a>( <span class='pre'>Object path</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>path</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-init' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-init' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-init' class='name expandable'>init</a>( <span class='pre'>Object config</span> )</div><div class='description'><div class='short'>Call this method to de-lint your JavaScript codebase. ...</div><div class='long'><p>Call this method to de-lint your JavaScript codebase.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>config</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-initConfigs' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-initConfigs' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-initConfigs' class='name expandable'>initConfigs</a>( <span class='pre'>Object config</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>config</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-lintFiles' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-lintFiles' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-lintFiles' class='name expandable'>lintFiles</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div><div id='method-log' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-log' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-log' class='name expandable'>log</a>( <span class='pre'>Object msg, Object override</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>msg</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>override</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-logToFile' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-logToFile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-logToFile' class='name expandable'>logToFile</a>( <span class='pre'>Object errorList</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>errorList</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-parseTree' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-parseTree' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-parseTree' class='name expandable'>parseTree</a>( <span class='pre'>Object pathConfig</span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>pathConfig</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-runJSHint' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-runJSHint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-runJSHint' class='name expandable'>runJSHint</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div><div id='method-runJSLint' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-runJSLint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-runJSLint' class='name expandable'>runJSLint</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div><div id='method-setLinters' class='member not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='LintRoller'>LintRoller</span><br/><a href='source/LintRoller.html#LintRoller-method-setLinters' target='_blank' class='view-source'>view source</a></div><a href='#!/api/LintRoller-method-setLinters' class='name expandable'>setLinters</a>( <span class='pre'></span> )<strong class='private signature'>private</strong></div><div class='description'><div class='short'> ...</div><div class='long'>\n</div></div></div></div></div></div></div>","subclasses":[],"members":{"event":[],"property":[{"meta":{"private":true},"owner":"LintRoller","tagname":"property","name":"files","id":"property-files"},{"meta":{"private":true},"owner":"LintRoller","tagname":"property","name":"linters","id":"property-linters"}],"css_var":[],"method":[{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"announceErrors","id":"method-announceErrors"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"announceSuccess","id":"method-announceSuccess"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"applyLintOptions","id":"method-applyLintOptions"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"getFiles","id":"method-getFiles"},{"meta":{},"owner":"LintRoller","tagname":"method","name":"init","id":"method-init"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"initConfigs","id":"method-initConfigs"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"lintFiles","id":"method-lintFiles"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"log","id":"method-log"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"logToFile","id":"method-logToFile"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"parseTree","id":"method-parseTree"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"runJSHint","id":"method-runJSHint"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"runJSLint","id":"method-runJSLint"},{"meta":{"private":true},"owner":"LintRoller","tagname":"method","name":"setLinters","id":"method-setLinters"}],"css_mixin":[],"cfg":[{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"exclusions","id":"cfg-exclusions"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"filepaths","id":"cfg-filepaths"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"jsHint","id":"cfg-jsHint"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"jsLint","id":"cfg-jsLint"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"logFile","id":"cfg-logFile"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"stopOnFirstError","id":"cfg-stopOnFirstError"},{"meta":{},"owner":"LintRoller","tagname":"cfg","name":"verbose","id":"cfg-verbose"}]},"html_meta":{"author":null},"tagname":"class","extends":null,"name":"LintRoller","alternateClassNames":[],"inheritdoc":null,"component":false,"singleton":true,"id":"class-LintRoller","statics":{"property":[],"event":[],"css_var":[],"method":[],"css_mixin":[],"cfg":[]},"requires":[],"files":[{"href":"LintRoller.html#LintRoller","filename":"LintRoller.js"}]});
View
101 docs/source/LintRoller.html
@@ -37,17 +37,13 @@
THE SOFTWARE.
*/
-var fs = require('fs'),
- JSLINT = require('jslint'),
- JSHINT = require('jshint').JSHINT;
-
<span id='LintRoller'>/**
</span> * @class LintRoller
* @author Arthur Kay (http://www.akawebdesign.com)
* @singleton
* @version 2.0.0
*
- * GitHub Project: https://github.com/arthurakay/PhantomLint
+ * GitHub Project: https://github.com/arthurakay/LintRoller
*/
LintRoller = {
<span id='LintRoller-cfg-filepaths'> /**
@@ -79,6 +75,8 @@
* - &quot;options&quot; is an object containing the optional lint flags.
*/
jsLint : {
+ lib : null,
+
options : {
nomen : true, //if names may have dangling _
plusplus : true, //if increment/decrement should be allowed
@@ -100,6 +98,8 @@
*
*/
jsHint : {
+ lib : null,
+
options : {
}
@@ -118,20 +118,6 @@
//APPLY CONFIG OPTIONS
this.initConfigs(config);
- if (this.jsLint) {
- this.log('Loading JSLint... ', true);
- this.linters.push(JSLINT);
- }
-
- if (this.jsHint) {
- this.log('Loading JSHint... ', true);
- this.linters.push(JSHINT);
- }
-
- if (!JSLINT &amp;&amp; !JSHINT) {
- process.exit(1);
- }
-
this.parseTree(config.filepaths);
this.log('\nFilesystem has been parsed. Looping through available files...');
@@ -181,6 +167,27 @@
}
}
+
+ this.setLinters();
+ },
+
+<span id='LintRoller-method-setLinters'> /**
+</span> * @private
+ */
+ setLinters : function () {
+ if (this.jsLint) {
+ this.log('Loading JSLint... ', true);
+ this.linters.push(this.jsLint.lib);
+ }
+
+ if (this.jsHint) {
+ this.log('Loading JSHint... ', true);
+ this.linters.push(this.jsHint.lib);
+ }
+
+ if (this.linters.length === 0) {
+ process.exit(1);
+ }
},
<span id='LintRoller-method-applyLintOptions'> /**
@@ -224,7 +231,7 @@
</span> * @private
*/
getFiles : function (path) {
- var tree = fs.readdirSync(path);
+ var tree = this.fs.readdirSync(path);
this.log('\nFILES FOUND AT PATH: ' + path);
this.log(tree);
@@ -275,7 +282,7 @@
var spacer = ' ',
childPath, childTree;
- var stats = fs.statSync(currPath + list[x]);
+ var stats = this.fs.statSync(currPath + list[x]);
if (stats.isFile()) {
this.log(spacer + list[x] + ' IS A FILE');
@@ -331,19 +338,19 @@
for (x; x &lt; this.linters.length; x++) {
linter = this.linters[x];
- if (linter === JSLINT) {
+ if (linter === this.jsLint.lib) {
this.log('Running JSLint against code...', false);
jsLintErrors = this.runJSLint();
errors += jsLintErrors.length;
- jsLintErrors.splice(0,0, '=============== Running JSLint... ===============\n\n');
+ jsLintErrors.splice(0, 0, '=============== Running JSLint... ===============\n\n');
}
- else if (linter === JSHINT) {
+ else if (linter === this.jsHint.lib) {
this.log('Running JSHint against code...', false);
jsHintErrors = this.runJSHint();
errors += jsHintErrors.length;
- jsHintErrors.splice(0,0, '=============== Running JSHint... ===============\n\n');
+ jsHintErrors.splice(0, 0, '=============== Running JSHint... ===============\n\n');
}
}
@@ -365,16 +372,16 @@
for (j; j &lt; this.files.length; j++) {
file = this.files[j];
- js = fs.readFileSync(file, 'utf8');
+ js = this.fs.readFileSync(file, 'utf8');
var i = 0,
- result = JSLINT(js, this.jsLint.options),
- totalErrors = JSLINT.errors.length,
+ result = this.jsLint.lib(js, this.jsLint.options),
+ totalErrors = this.jsLint.lib.errors.length,
error;
if (!result) {
for (i; i &lt; totalErrors; i++) {
- error = JSLINT.errors[i];
+ error = this.jsLint.lib.errors[i];
if (error) {
errorList.push(
@@ -412,16 +419,16 @@
for (j; j &lt; this.files.length; j++) {
file = this.files[j];
- js = fs.readFileSync(file, 'utf8');
+ js = this.fs.readFileSync(file, 'utf8');
var i = 0,
- result = JSHINT.jshint(js, this.jsHint.options),
- totalErrors = JSHINT.errors.length,
+ result = this.jsHint.lib.jshint(js, this.jsHint.options),
+ totalErrors = this.jsHint.lib.errors.length,
error;
if (!result) {
for (i; i &lt; totalErrors; i++) {
- error = JSHINT.errors[i];
+ error = this.jsHint.lib.errors[i];
if (error) {
errorList.push(
@@ -452,20 +459,20 @@
</span> * @private
*/
logToFile : function (errorList) {
- this.log('\nWriting ' + ((errorList.length - this.linters.length ) / 6) + ' errors to new log file.', true);
+ this.log('\nWriting ' + ((errorList.length - this.linters.length ) / 6) + ' errors to new log file.', true);
var header = 'LintRoller : Output for ' + new Date() + '\n\n';
errorList.splice(0, 0, header);
var output = errorList.join().replace(/,/g, '\n');
- fs.writeFileSync(this.logFile, output);
+ this.fs.writeFileSync(this.logFile, output);
},
- clearLogFile : function() {
+ clearLogFile : function () {
try {
this.log('\nDeleting old log file...', true);
- fs.unlinkSync(this.logFile);
+ this.fs.unlinkSync(this.logFile);
this.log('Done.', true);
}
catch (err) {
@@ -481,8 +488,28 @@
console.log(msg);
}
}
+
};
+var initModules = function (me) {
+ //filesystem API
+ me.fs = require('fs');
+
+ if (me.jsLint) {
+ me.jsLint.lib = require('jslint');
+ }
+
+ if (me.jsHint) {
+ me.jsHint.lib = require('jshint').JSHINT;
+ }
+
+ //other utilities
+ var util = require('./util');
+ me.util = util.init(me);
+};
+
+initModules(LintRoller);
+
module.exports = LintRoller;</pre>
</body>
</html>
View
2  generate_docs.sh
@@ -4,4 +4,4 @@ echo 'Removing old duckumentation...'
rm -rf docs
echo 'Hatching new duckumentation...'
-jsduck LintRoller.js --output docs --title 'LintRoller API Docs'
+jsduck --config=jsduck.json
View
9 jsduck.json
@@ -0,0 +1,9 @@
+{
+ "--title" : "LintRoller API Docs",
+ "--output" : "docs",
+
+ "--" : [
+ "src/LintRoller.js",
+ "src/util.js"
+ ]
+}
View
60 src/LintRoller.js
@@ -24,7 +24,7 @@
* @class LintRoller
* @author Arthur Kay (http://www.akawebdesign.com)
* @singleton
- * @version 2.0.0
+ * @version 2.1.0
*
* GitHub Project: https://github.com/arthurakay/LintRoller
*/
@@ -323,14 +323,14 @@ LintRoller = {
if (linter === this.jsLint.lib) {
this.log('Running JSLint against code...', false);
- jsLintErrors = this.runJSLint();
+ jsLintErrors = this.runLinter(this.jsLint);
errors += jsLintErrors.length;
jsLintErrors.splice(0, 0, '=============== Running JSLint... ===============\n\n');
}
else if (linter === this.jsHint.lib) {
this.log('Running JSHint against code...', false);
- jsHintErrors = this.runJSHint();
+ jsHintErrors = this.runLinter(this.jsHint);
errors += jsHintErrors.length;
jsHintErrors.splice(0, 0, '=============== Running JSHint... ===============\n\n');
@@ -347,7 +347,7 @@ LintRoller = {
/**
* @private
*/
- runJSLint : function () {
+ runLinter : function (linter) {
var j = 0,
errorList = [],
file, js;
@@ -358,13 +358,13 @@ LintRoller = {
js = this.fs.readFileSync(file, 'utf8');
var i = 0,
- result = this.jsLint.lib(js, this.jsLint.options),
- totalErrors = this.jsLint.lib.errors.length,
+ result = linter.lib(js, linter.options),
+ totalErrors = linter.lib.errors.length,
error;
if (!result) {
for (i; i < totalErrors; i++) {
- error = this.jsLint.lib.errors[i];
+ error = linter.lib.errors[i];
if (error) {
errorList.push(
@@ -391,52 +391,6 @@ LintRoller = {
return errorList;
},
- /**
- * @private
- */
- runJSHint : function () {
- var j = 0,
- errorList = [],
- file, js;
-
- for (j; j < this.files.length; j++) {
-
- file = this.files[j];
- js = this.fs.readFileSync(file, 'utf8');
-
- var i = 0,
- result = this.jsHint.lib.jshint(js, this.jsHint.options),
- totalErrors = this.jsHint.lib.errors.length,
- error;
-
- if (!result) {
- for (i; i < totalErrors; i++) {
- error = this.jsHint.lib.errors[i];
-
- if (error) {
- errorList.push(
- file,
- ' Line #: ' + error.line,
- ' Char #: ' + error.character,
- ' Reason: ' + error.reason,
- '',
- ''
- );
-
- if (this.stopOnFirstError) {
- break;
- }
- }
- }
-
- if (this.stopOnFirstError && errorList.length > 0) {
- this.announceErrors(errorList);
- }
- }
- }
-
- return errorList;
- },
/**
* @private
View
21 src/util.js
@@ -1,6 +1,8 @@
/**
+ * @class LintRoller.util
+ * @singleton
*
- * @type {Object}
+ * Some additional utilities for cleaning up JavaScript lint.
*/
util = {
@@ -14,8 +16,10 @@ util = {
/**
+ * A utility that will eliminate all "Mixed spaces with tabs." warnings by replacing tab characters with spaces.
*
- * @param spacingChars {int} The number of spaces to replace a tab
+ * @param {Object} config A configuration object
+ * @param {Number} spacingChars The number of spaces to replace a tab
*/
replaceTabsWithSpaces : function (config, spacingChars) {
this.parent.initConfigs(config);
@@ -30,10 +34,19 @@ util = {
this.parent.log(
'Found ' + offendingFiles.length +
' files matching the error "' + msg +
- '" between ' + this.parent.linters.length + ' linters.',
+ '" between ' + this.parent.linters.length + ' linters.\n',
true
);
+ if (offendingFiles.length === 0) {
+ this.parent.log(
+ 'LintRoller has found 0 offending files. Your usage of tabs/spaces is acceptable!\n',
+ true
+ );
+
+ process.exit(0);
+ }
+
try {
this.fixOffendingFiles(offendingFiles, spacingChars);
}
@@ -47,7 +60,7 @@ util = {
}
this.parent.log(
- 'LintRoller has attempted to replace all tabs with ' + spacingChars + ' spaces.',
+ 'LintRoller has attempted to replace all tabs with ' + spacingChars + ' spaces.\n',
true
);
Please sign in to comment.
Something went wrong with that request. Please try again.