274 lines
6.3 KiB
HTML
274 lines
6.3 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'>Indentation</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
Indentation
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>node_modules/gulp-coffeelint/node_modules/coffeelint/src/rules/indentation.coffee</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Variables Summary</h2>
|
|
<dl class='constants'>
|
|
<dt id='rule-variable'>
|
|
rule
|
|
=
|
|
</dt>
|
|
<dd>
|
|
<pre><code class='coffeescript'>{
|
|
name: 'indentation',
|
|
value: 2,
|
|
level: 'error',
|
|
message: 'Line contains inconsistent indentation',
|
|
description: "This rule imposes a standard number of spaces to be used for\nindentation. Since whitespace is significant in CoffeeScript, it's\ncritical that a project chooses a standard indentation format and\nstays consistent. Other roads lead to darkness. <pre> <code>#\nEnabling this option will prevent this ugly\n###\nbut otherwise valid CoffeeScript.\n###\ntwoSpaces = () ->\n fourSpaces = () ->\n eightSpaces = () ->\n 'this is valid CoffeeScript'\n\n</code>\n</pre>\nTwo space indentation is enabled by default."
|
|
}</code></pre>
|
|
|
|
</dd>
|
|
<dt id='tokens-variable'>
|
|
tokens
|
|
=
|
|
</dt>
|
|
<dd>
|
|
<pre><code class='coffeescript'>['INDENT', '[', ']', '.']</code></pre>
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#lintToken-dynamic'>
|
|
#
|
|
(void)
|
|
<b>lintToken</b><span>(token, tokenApi)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Return an error if the given indentation token is not correct.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#inArray-dynamic'>
|
|
#
|
|
(void)
|
|
<b>inArray</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Return true if the current token is inside of an array.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#lintArray-dynamic'>
|
|
#
|
|
(void)
|
|
<b>lintArray</b><span>(token)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Lint the given array token.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#handleChain-dynamic'>
|
|
#
|
|
(void)
|
|
<b>handleChain</b><span>(tokenApi, expected)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#getCorrectIndent-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getCorrectIndent</b><span>(tokenApi)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Returns a corrected INDENT value if the current line is part of a chained call.
|
|
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Constructor Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='constructor-dynamic'>
|
|
#
|
|
(void)
|
|
<b>constructor</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='lintToken-dynamic'>
|
|
#
|
|
(void)
|
|
<b>lintToken</b><span>(token, tokenApi)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Return an error if the given indentation token is not correct.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='inArray-dynamic'>
|
|
#
|
|
(void)
|
|
<b>inArray</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Return true if the current token is inside of an array.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='lintArray-dynamic'>
|
|
#
|
|
(void)
|
|
<b>lintArray</b><span>(token)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Lint the given array token.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='handleChain-dynamic'>
|
|
#
|
|
(void)
|
|
<b>handleChain</b><span>(tokenApi, expected)</span>
|
|
<br>
|
|
</p>
|
|
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='getCorrectIndent-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getCorrectIndent</b><span>(tokenApi)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Returns a corrected INDENT value if the current line is part of
|
|
a chained call. Otherwise returns original INDENT value.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</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> |