221 lines
5.0 KiB
HTML
221 lines
5.0 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='UTF-8'>
|
|
<title>CoffeeScript API Documentation</title>
|
|
<script src='../javascript/application.js'></script>
|
|
<script src='../javascript/search.js'></script>
|
|
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
|
|
</head>
|
|
<body>
|
|
<div id='base' data-path='../'></div>
|
|
<div id='header'>
|
|
<div id='menu'>
|
|
<a href='../extra/README.md.html' title='Yatta'>
|
|
Yatta
|
|
</a>
|
|
»
|
|
<a href='../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>ASTLinter</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
ASTLinter
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>node_modules/gulp-coffeelint/node_modules/coffeelint/src/ast_linter.coffee</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Inherits:</td>
|
|
<td>
|
|
<a href='../class/BaseLinter.html'>BaseLinter</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>A class that performs static analysis of the abstract
|
|
syntax tree.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#acceptRule-dynamic'>
|
|
#
|
|
(void)
|
|
<b>acceptRule</b><span>(rule)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
This uses lintAST instead of lintNode because I think it makes it a bit more clear that the rule needs to walk the AST on its own.
|
|
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#lint-dynamic'>
|
|
#
|
|
(void)
|
|
<b>lint</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#_parseCoffeeScriptError-dynamic'>
|
|
#
|
|
(void)
|
|
<b>_parseCoffeeScriptError</b><span>(coffeeError)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>
|
|
<small>Inherited Method Summary</small>
|
|
<h3 class='inherited'>
|
|
Methods inherited from
|
|
<a href='../class/BaseLinter.html'>BaseLinter</a>
|
|
</h3>
|
|
<p class='inherited'>
|
|
<a href='../class/BaseLinter.html#isObject-dynamic'>#isObject</a>
|
|
<a href='../class/BaseLinter.html#createError-dynamic'>#createError</a>
|
|
<a href='../class/BaseLinter.html#acceptRule-dynamic'>#acceptRule</a>
|
|
<a href='../class/BaseLinter.html#setupRules-dynamic'>#setupRules</a>
|
|
<a href='../class/BaseLinter.html#normalizeResult-dynamic'>#normalizeResult</a>
|
|
</p>
|
|
</h2>
|
|
<h2>Constructor Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='constructor-dynamic'>
|
|
#
|
|
(void)
|
|
<b>constructor</b><span>(source, config, rules, CoffeeScript)</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='acceptRule-dynamic'>
|
|
#
|
|
(void)
|
|
<b>acceptRule</b><span>(rule)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>This uses lintAST instead of lintNode because I think it makes it a bit
|
|
more clear that the rule needs to walk the AST on its own.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='lint-dynamic'>
|
|
#
|
|
(void)
|
|
<b>lint</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='_parseCoffeeScriptError-dynamic'>
|
|
#
|
|
(void)
|
|
<b>_parseCoffeeScriptError</b><span>(coffeeError)</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
August 12, 14 06:33:02 by
|
|
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
|
Codo
|
|
</a>
|
|
2.0.9
|
|
✲
|
|
Press H to see the keyboard shortcuts
|
|
✲
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
|
✲
|
|
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
|
|
</div>
|
|
<iframe id='search_frame'></iframe>
|
|
<div id='fuzzySearch'>
|
|
<input type='text'>
|
|
<ol></ol>
|
|
</div>
|
|
<div id='help'>
|
|
<p>
|
|
Quickly fuzzy find classes, mixins, methods, file:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>T</span>
|
|
Open fuzzy finder dialog
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
Control the navigation frame:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>L</span>
|
|
Toggle list view
|
|
</li>
|
|
<li>
|
|
<span>C</span>
|
|
Show class list
|
|
</li>
|
|
<li>
|
|
<span>I</span>
|
|
Show mixin list
|
|
</li>
|
|
<li>
|
|
<span>F</span>
|
|
Show file list
|
|
</li>
|
|
<li>
|
|
<span>M</span>
|
|
Show method list
|
|
</li>
|
|
<li>
|
|
<span>E</span>
|
|
Show extras list
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
You can focus and blur the search input:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>S</span>
|
|
Focus search input
|
|
</li>
|
|
<li>
|
|
<span>Esc</span>
|
|
Blur search input
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html> |