Skip to content

Commit a9c7954

Browse files
mysticateamysticatea
committed
Chore: fix coding style
1 parent e9bee55 commit a9c7954

29 files changed

+466
-612
lines changed

‎.eslintignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/node_modules
2+
!.eslintrc.js

‎.eslintrc.js

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @author Toru Nagashima <https://github.com/mysticatea>
3+
* See LICENSE file in root directory for full license.
4+
*/
5+
"use strict"
6+
7+
const { version } = require("./package.json")
8+
9+
module.exports = {
10+
extends: ["plugin:mysticatea/es2015", "plugin:mysticatea/+eslint-plugin"],
11+
overrides: [
12+
{
13+
files: ["**/rules/**"],
14+
rules: {
15+
"mysticatea/eslint-plugin/require-meta-docs-url": [
16+
"error",
17+
{
18+
pattern: `https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/v${version}/docs/rules/{{name}}.md`,
19+
},
20+
],
21+
},
22+
},
23+
],
24+
}

‎.eslintrc.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎index.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
/**
2-
* @author Toru Nagashima
3-
* @copyright 2016 Toru Nagashima. All rights reserved.
4-
* See LICENSE file in root directory for full license.
5-
*/
1+
/** DON'T EDIT THIS FILE WHICH WAS CREATED BY 'scripts/generate-index.js'. */
62
"use strict"
73

84
module.exports = {

‎lib/disabled-area.js

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,14 @@
11
/**
2-
* @author Toru Nagashima
3-
* @copyright 2016 Toru Nagashima. All rights reserved.
2+
* @author Toru Nagashima <https://github.com/mysticatea>
43
* See LICENSE file in root directory for full license.
54
*/
65
"use strict"
76

8-
//------------------------------------------------------------------------------
9-
// Requirements
10-
//------------------------------------------------------------------------------
11-
127
const utils = require("./utils")
13-
14-
//------------------------------------------------------------------------------
15-
// Helpers
16-
//------------------------------------------------------------------------------
17-
188
const COMMENT_DIRECTIVE = /^\s*(eslint-(?:en|dis)able(?:(?:-next)?-line)?)\s*(?:(\S|\S[\s\S]*\S)\s*)?$/
199
const DELIMITER = /[\s,]+/g
2010
const pool = new WeakMap()
2111

22-
//------------------------------------------------------------------------------
23-
// Exports
24-
//------------------------------------------------------------------------------
25-
2612
module.exports = class DisabledArea {
2713
/**
2814
* Get singleton instance for the given source code.
@@ -78,8 +64,7 @@ module.exports = class DisabledArea {
7864
reported: false,
7965
})
8066
}
81-
}
82-
else {
67+
} else {
8368
if (this._getArea(null, location) != null) {
8469
this.duplicateDisableDirectives.push({ comment, ruleId: null })
8570
}
@@ -115,7 +100,11 @@ module.exports = class DisabledArea {
115100
for (let i = this.areas.length - 1; i >= 0; --i) {
116101
const area = this.areas[i]
117102

118-
if (area.end === null && area.kind === kind && area.ruleId === ruleId) {
103+
if (
104+
area.end === null &&
105+
area.kind === kind &&
106+
area.ruleId === ruleId
107+
) {
119108
relatedDisableDirectives.add(area.comment)
120109
area.end = location
121110
used = true
@@ -126,8 +115,7 @@ module.exports = class DisabledArea {
126115
this.unusedEnableDirectives.push({ comment, ruleId })
127116
}
128117
}
129-
}
130-
else {
118+
} else {
131119
let used = false
132120

133121
for (let i = this.areas.length - 1; i >= 0; --i) {
@@ -145,7 +133,10 @@ module.exports = class DisabledArea {
145133
}
146134
}
147135

148-
this.numberOfRelatedDisableDirectives.set(comment, relatedDisableDirectives.size)
136+
this.numberOfRelatedDisableDirectives.set(
137+
comment,
138+
relatedDisableDirectives.size
139+
)
149140
}
150141

151142
/**
@@ -160,7 +151,8 @@ module.exports = class DisabledArea {
160151
for (let i = this.areas.length - 1; i >= 0; --i) {
161152
const area = this.areas[i]
162153

163-
if ((area.ruleId === null || area.ruleId === ruleId) &&
154+
if (
155+
(area.ruleId === null || area.ruleId === ruleId) &&
164156
utils.lte(area.start, location) &&
165157
(area.end === null || utils.lte(location, area.end))
166158
) {
@@ -189,19 +181,22 @@ module.exports = class DisabledArea {
189181

190182
if (comment.type === "Block" && kind === "eslint-disable") {
191183
this._disable(comment, comment.loc.start, ruleIds, "block")
192-
}
193-
else if (comment.type === "Block" && kind === "eslint-enable") {
184+
} else if (comment.type === "Block" && kind === "eslint-enable") {
194185
this._enable(comment, comment.loc.start, ruleIds, "block")
195-
}
196-
else if (comment.type === "Line" && kind === "eslint-disable-line") {
186+
} else if (
187+
comment.type === "Line" &&
188+
kind === "eslint-disable-line"
189+
) {
197190
const line = comment.loc.start.line
198191
const start = { line, column: 0 }
199192
const end = { line: line + 1, column: -1 }
200193

201194
this._disable(comment, start, ruleIds, "line")
202195
this._enable(comment, end, ruleIds, "line")
203-
}
204-
else if (comment.type === "Line" && kind === "eslint-disable-next-line") {
196+
} else if (
197+
comment.type === "Line" &&
198+
kind === "eslint-disable-next-line"
199+
) {
205200
const line = comment.loc.start.line
206201
const start = { line: line + 1, column: 0 }
207202
const end = { line: line + 2, column: -1 }

‎lib/rules/disable-enable-pair.js

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,39 @@
11
/**
2-
* @author Toru Nagashima
3-
* @copyright 2016 Toru Nagashima. All rights reserved.
2+
* @author Toru Nagashima <https://github.com/mysticatea>
43
* See LICENSE file in root directory for full license.
54
*/
65
"use strict"
76

8-
//------------------------------------------------------------------------------
9-
// Requirements
10-
//------------------------------------------------------------------------------
11-
127
const DisabledArea = require("../disabled-area")
138
const utils = require("../utils")
149

15-
//------------------------------------------------------------------------------
16-
// Rule Definition
17-
//------------------------------------------------------------------------------
18-
1910
module.exports = {
2011
meta: {
2112
docs: {
22-
description: "requires a `eslint-enable` comment for every `eslint-disable` comment",
13+
description:
14+
"requires a `eslint-enable` comment for every `eslint-disable` comment",
2315
category: "Best Practices",
2416
recommended: true,
25-
url: utils.getDocsUrl("disable-enable-pair"),
17+
url:
18+
"https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/v2.0.2/docs/rules/disable-enable-pair.md",
2619
},
27-
fixable: false,
28-
schema: [{
29-
type: "object",
30-
properties: {
31-
allowWholeFile: {
32-
type: "boolean",
20+
fixable: null,
21+
schema: [
22+
{
23+
type: "object",
24+
properties: {
25+
allowWholeFile: {
26+
type: "boolean",
27+
},
3328
},
29+
additionalProperties: false,
3430
},
35-
additionalProperties: false,
36-
}],
31+
],
3732
},
3833

3934
create(context) {
40-
const allowWholeFile = context.options[0] && context.options[0].allowWholeFile
35+
const allowWholeFile =
36+
context.options[0] && context.options[0].allowWholeFile
4137
const sourceCode = context.getSourceCode()
4238
const disabledArea = DisabledArea.get(sourceCode)
4339

@@ -51,15 +47,18 @@ module.exports = {
5147
if (area.end != null) {
5248
continue
5349
}
54-
if (allowWholeFile && utils.lte(area.start, node.loc.start)) {
50+
if (
51+
allowWholeFile &&
52+
utils.lte(area.start, node.loc.start)
53+
) {
5554
continue
5655
}
5756

5857
context.report({
5958
loc: utils.toRuleIdLocation(area.comment, area.ruleId),
60-
message: (area.ruleId) ?
61-
"Requires 'eslint-enable' directive for '{{ruleId}}'." :
62-
"Requires 'eslint-enable' directive.",
59+
message: area.ruleId
60+
? "Requires 'eslint-enable' directive for '{{ruleId}}'."
61+
: "Requires 'eslint-enable' directive.",
6362
data: area,
6463
})
6564
}

‎lib/rules/no-aggregating-enable.js

Lines changed: 29 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,46 @@
11
/**
2-
* @author Toru Nagashima
3-
* @copyright 2016 Toru Nagashima. All rights reserved.
2+
* @author Toru Nagashima <https://github.com/mysticatea>
43
* See LICENSE file in root directory for full license.
54
*/
65
"use strict"
76

8-
//------------------------------------------------------------------------------
9-
// Requirements
10-
//------------------------------------------------------------------------------
11-
127
const DisabledArea = require("../disabled-area")
138
const utils = require("../utils")
149

15-
//------------------------------------------------------------------------------
16-
// Rule Definition
17-
//------------------------------------------------------------------------------
18-
19-
/**
20-
* Creates AST event handlers for no-aggregating-enable.
21-
*
22-
* @param {RuleContext} context - The rule context.
23-
* @returns {object} AST event handlers.
24-
*/
25-
function create(context) {
26-
const sourceCode = context.getSourceCode()
27-
const disabledArea = DisabledArea.get(sourceCode)
28-
29-
return {
30-
Program() {
31-
for (const entry of disabledArea.numberOfRelatedDisableDirectives) {
32-
const comment = entry[0]
33-
const count = entry[1]
34-
35-
if (count >= 2) {
36-
context.report({
37-
loc: utils.toForceLocation(comment.loc),
38-
message: "This `eslint-enable` comment affects {{count}} `eslint-disable` comments. An `eslint-enable` comment should be for an `eslint-disable` comment.",
39-
data: { count },
40-
})
41-
}
42-
}
43-
},
44-
}
45-
}
46-
4710
module.exports = {
48-
create,
4911
meta: {
5012
docs: {
51-
description: "disallows `eslint-enable` comments for multiple `eslint-disable` comments",
13+
description:
14+
"disallows `eslint-enable` comments for multiple `eslint-disable` comments",
5215
category: "Best Practices",
5316
recommended: true,
54-
url: utils.getDocsUrl("no-aggregating-enable"),
17+
url:
18+
"https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/v2.0.2/docs/rules/no-aggregating-enable.md",
5519
},
56-
fixable: false,
20+
fixable: null,
5721
schema: [],
5822
},
23+
24+
create(context) {
25+
const sourceCode = context.getSourceCode()
26+
const disabledArea = DisabledArea.get(sourceCode)
27+
28+
return {
29+
Program() {
30+
for (const entry of disabledArea.numberOfRelatedDisableDirectives) {
31+
const comment = entry[0]
32+
const count = entry[1]
33+
34+
if (count >= 2) {
35+
context.report({
36+
loc: utils.toForceLocation(comment.loc),
37+
message:
38+
"This `eslint-enable` comment affects {{count}} `eslint-disable` comments. An `eslint-enable` comment should be for an `eslint-disable` comment.",
39+
data: { count },
40+
})
41+
}
42+
}
43+
},
44+
}
45+
},
5946
}

‎lib/rules/no-duplicate-disable.js

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,22 @@
11
/**
2-
* @author Toru Nagashima
3-
* @copyright 2016 Toru Nagashima. All rights reserved.
2+
* @author Toru Nagashima <https://github.com/mysticatea>
43
* See LICENSE file in root directory for full license.
54
*/
65
"use strict"
76

8-
//------------------------------------------------------------------------------
9-
// Requirements
10-
//------------------------------------------------------------------------------
11-
127
const DisabledArea = require("../disabled-area")
138
const utils = require("../utils")
149

15-
//------------------------------------------------------------------------------
16-
// Rule Definition
17-
//------------------------------------------------------------------------------
18-
1910
module.exports = {
2011
meta: {
2112
docs: {
2213
description: "disallows duplicate `eslint-disable` comments",
2314
category: "Best Practices",
2415
recommended: true,
25-
url: utils.getDocsUrl("no-duplicate-disable"),
16+
url:
17+
"https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/v2.0.2/docs/rules/no-duplicate-disable.md",
2618
},
27-
fixable: false,
19+
fixable: null,
2820
schema: [],
2921
},
3022

@@ -37,9 +29,9 @@ module.exports = {
3729
for (const item of disabledArea.duplicateDisableDirectives) {
3830
context.report({
3931
loc: utils.toRuleIdLocation(item.comment, item.ruleId),
40-
message: (item.ruleId) ?
41-
"'{{ruleId}}' rule has been disabled already." :
42-
"ESLint rules have been disabled already.",
32+
message: item.ruleId
33+
? "'{{ruleId}}' rule has been disabled already."
34+
: "ESLint rules have been disabled already.",
4335
data: item,
4436
})
4537
}

0 commit comments

Comments
 (0)