pve-eslint/eslint/docs/rules/no-tabs.md
Dominik Csapak eb39fafa4f first commit
includes a (minimal) working wrapper

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2020-04-06 15:06:03 +02:00

62 lines
1.2 KiB
Markdown

# disallow all tabs (no-tabs)
Some style guides don't allow the use of tab characters at all, including within comments.
## Rule Details
This rule looks for tabs anywhere inside a file: code, comments or anything else.
Examples of **incorrect** code for this rule:
```js
var a \t= 2;
/**
* \t\t it's a test function
*/
function test(){}
var x = 1; // \t test
```
Examples of **correct** code for this rule:
```js
var a = 2;
/**
* it's a test function
*/
function test(){}
var x = 1; // test
```
### Options
This rule has an optional object option with the following properties:
* `allowIndentationTabs` (default: false): If this is set to true, then the rule will not report tabs used for indentation.
#### allowIndentationTabs
Examples of **correct** code for this rule with the `allowIndentationTabs: true` option:
```js
/* eslint no-tabs: ["error", { allowIndentationTabs: true }] */
function test() {
\tdoSomething();
}
\t// comment with leading indentation tab
```
## When Not To Use It
If you have established a standard where having tabs is fine, then you can disable this rule.
## Compatibility
* **JSCS**: [disallowTabs](https://jscs-dev.github.io/rule/disallowTabs)