eslint-config-isaacscript 3.0.2 → 3.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/base.js +6 -0
- package/jsdoc.js +23 -1
- package/mod.js +13 -1
- package/package.json +1 -1
package/base.js
CHANGED
|
@@ -65,6 +65,12 @@ module.exports = {
|
|
|
65
65
|
*/
|
|
66
66
|
"only-warn",
|
|
67
67
|
|
|
68
|
+
/**
|
|
69
|
+
* Activate the "no-type-assertion" plugin, which allows the "no-type-assertion" rule to be
|
|
70
|
+
* optionally enabled on a per-project basis.
|
|
71
|
+
*/
|
|
72
|
+
"no-type-assertion",
|
|
73
|
+
|
|
68
74
|
/**
|
|
69
75
|
* Activate the "sort-exports" plugin, which allows the "sort-exports" rule to be optionally
|
|
70
76
|
* enabled on a per-project basis.
|
package/jsdoc.js
CHANGED
|
@@ -55,12 +55,19 @@ module.exports = {
|
|
|
55
55
|
// https://typedoc.org/guides/doccomments/
|
|
56
56
|
"category",
|
|
57
57
|
"hidden",
|
|
58
|
-
"notExported",
|
|
58
|
+
"notExported", // From: typedoc-plugin-not-exported
|
|
59
|
+
"rename", // From: typedoc-plugin-rename
|
|
59
60
|
|
|
60
61
|
// Ignore tags used in TypeScriptToLua:
|
|
61
62
|
// https://typescripttolua.github.io/docs/advanced/compiler-annotations
|
|
62
63
|
"noResolution",
|
|
63
64
|
"noSelf",
|
|
65
|
+
"noSelfInFile",
|
|
66
|
+
|
|
67
|
+
// Ignore tags used in ts-json-schema-generator:
|
|
68
|
+
// https://github.com/vega/ts-json-schema-generator
|
|
69
|
+
"minimum",
|
|
70
|
+
"maximum",
|
|
64
71
|
],
|
|
65
72
|
},
|
|
66
73
|
],
|
|
@@ -168,7 +175,22 @@ module.exports = {
|
|
|
168
175
|
],
|
|
169
176
|
|
|
170
177
|
// - jsdoc/require-param-type - Not needed in TypeScript.
|
|
178
|
+
|
|
171
179
|
// - jsdoc/require-param - It's overboard for every function to document every parameter.
|
|
180
|
+
// TODO
|
|
181
|
+
/*
|
|
182
|
+
"jsdoc/require-param": [
|
|
183
|
+
"warn",
|
|
184
|
+
{
|
|
185
|
+
contexts: [
|
|
186
|
+
{
|
|
187
|
+
context: "FunctionDeclaration",
|
|
188
|
+
comment: 'JsdocBlock > JsdocTag[tag="param"]',
|
|
189
|
+
},
|
|
190
|
+
],
|
|
191
|
+
},
|
|
192
|
+
],
|
|
193
|
+
*/
|
|
172
194
|
// - jsdoc/require-property - Probably not needed in TypeScript.
|
|
173
195
|
|
|
174
196
|
/**
|
package/mod.js
CHANGED
|
@@ -3,8 +3,9 @@
|
|
|
3
3
|
module.exports = {
|
|
4
4
|
extends: [
|
|
5
5
|
/**
|
|
6
|
-
* The mod config extends the base configuration:
|
|
6
|
+
* The IsaacScript mod config extends the base configuration:
|
|
7
7
|
* https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
|
|
8
|
+
* (Normal TypeScript projects would just use the base configuration directly.)
|
|
8
9
|
*/
|
|
9
10
|
"./base",
|
|
10
11
|
],
|
|
@@ -99,6 +100,17 @@ module.exports = {
|
|
|
99
100
|
*/
|
|
100
101
|
"@typescript-eslint/no-loop-func": "off",
|
|
101
102
|
|
|
103
|
+
/**
|
|
104
|
+
* Documentation:
|
|
105
|
+
* https://typescript-eslint.io/rules/prefer-literal-enum-member
|
|
106
|
+
*
|
|
107
|
+
* Defined at:
|
|
108
|
+
* https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
|
|
109
|
+
*
|
|
110
|
+
* It is common to initialize enums with the `Isaac.GetEntityVariantByName` method.
|
|
111
|
+
*/
|
|
112
|
+
"@typescript-eslint/prefer-literal-enum-member": "off",
|
|
113
|
+
|
|
102
114
|
/**
|
|
103
115
|
* Documentation:
|
|
104
116
|
* https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/docs/rules/enum-member-number-separation.md
|