mirror of
https://git.proxmox.com/git/pve-eslint
synced 2025-10-10 15:02:55 +00:00
eb39fafa4f
includes a (minimal) working wrapper Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
# spaced-line-comment: enforce consistent spacing after `//` in line comments
|
|
|
|
(removed) This rule was **removed** in ESLint v1.0 and **replaced** by the [spaced-comment](spaced-comment.md) rule.
|
|
|
|
Some style guides require or disallow a whitespace immediately after the initial `//` of a line comment.
|
|
Whitespace after the `//` makes it easier to read text in comments.
|
|
On the other hand, commenting out code is easier without having to put a whitespace right after the `//`.
|
|
|
|
|
|
## Rule Details
|
|
|
|
This rule will enforce consistency of spacing after the start of a line comment `//`.
|
|
|
|
This rule takes two arguments. If the first is `"always"` then the `//` must be followed by at least once whitespace.
|
|
If `"never"` then there should be no whitespace following.
|
|
The default is `"always"`.
|
|
|
|
The second argument is an object with one key, `"exceptions"`.
|
|
The value is an array of string patterns which are considered exceptions to the rule.
|
|
It is important to note that the exceptions are ignored if the first argument is `"never"`.
|
|
Exceptions cannot be mixed.
|
|
|
|
Examples of **incorrect** code for this rule:
|
|
|
|
```js
|
|
// When ["never"]
|
|
// This is a comment with a whitespace at the beginning
|
|
```
|
|
|
|
```js
|
|
//When ["always"]
|
|
//This is a comment with no whitespace at the beginning
|
|
var foo = 5;
|
|
```
|
|
|
|
```js
|
|
// When ["always",{"exceptions":["-","+"]}]
|
|
//------++++++++
|
|
// Comment block
|
|
//------++++++++
|
|
```
|
|
|
|
Examples of **correct** code for this rule:
|
|
|
|
```js
|
|
// When ["always"]
|
|
// This is a comment with a whitespace at the beginning
|
|
var foo = 5;
|
|
```
|
|
|
|
```js
|
|
//When ["never"]
|
|
//This is a comment with no whitespace at the beginning
|
|
var foo = 5;
|
|
```
|
|
|
|
```js
|
|
// When ["always",{"exceptions":["-"]}]
|
|
//--------------
|
|
// Comment block
|
|
//--------------
|
|
```
|
|
|
|
```js
|
|
// When ["always",{"exceptions":["-+"]}]
|
|
//-+-+-+-+-+-+-+
|
|
// Comment block
|
|
//-+-+-+-+-+-+-+
|
|
```
|
|
|
|
## Related Rules
|
|
|
|
* [spaced-comment](spaced-comment.md)
|