Add allowTestedProperty option to property rules (#241)

Author: ota-meshi

docs/index.md

@@ -138,3 +138,43 @@ For example:
     // }
 }
 ```
+
+### The `allowTestedProperty` mode
+
+This plugin has rules to report forbidden property accesses.
+These rules report all forbidden property accesses by default, but if you want to allow existence-tested properties in your scripts, you can use the `allowTestedProperty` mode.
+
+<eslint-playground type="good">
+
+```ts
+/*eslint es-x/no-string-prototype-trimstart-trimend: [error, { aggressive: true, allowTestedProperty: true }], es-x/no-string-prototype-trimleft-trimright: [error, { aggressive: true, allowTestedProperty: true }],  */
+function trimEnd(str) {
+    if (String.prototype.trimEnd) {
+        return str.trimEnd();
+    }
+    if (String.prototype.trimRight) {
+        return str.trimRight();
+    }
+    return str.replace(/\s+$/, "");
+}
+```
+
+</eslint-playground>
+
+If you configured the `allowTestedProperty` mode, this plugin will allow the use of tested properties.
+For example:
+
+```json
+{
+    "plugins": ["es-x"],
+    "rules": {
+        "es-x/no-string-prototype-trimstart-trimend": "error",
+        "es-x/no-string-prototype-trimleft-trimright": "error"
+    },
+
+    // `settings['es-x'].allowTestedProperty = true` means the allowTestedProperty mode.
+    "settings": {
+        "es-x": { "allowTestedProperty": true }
+    }
+}
+```

docs/rules/no-array-from.md

@@ -24,6 +24,28 @@ const array = Array.from("hello")
 
 </eslint-playground>
 
+## 🔧 Options
+
+This rule has an option.
+
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-from": [
+      "error",
+      {
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
+```
+
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in [eslint-plugin-es] v1.2.0.

docs/rules/no-array-isarray.md

@@ -24,6 +24,28 @@ var array = Array.isArray(obj)
 
 </eslint-playground>
 
+## 🔧 Options
+
+This rule has an option.
+
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-isarray": [
+      "error",
+      {
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
+```
+
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in [eslint-plugin-es] v3.0.0.

docs/rules/no-array-of.md

@@ -24,6 +24,28 @@ const array = Array.of(1, 2, 3)
 
 </eslint-playground>
 
+## 🔧 Options
+
+This rule has an option.
+
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-of": [
+      "error",
+      {
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
+```
+
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in [eslint-plugin-es] v1.2.0.

docs/rules/no-array-prototype-at.md

@@ -30,16 +30,30 @@ This rule is silent by default because it's hard to know types. You need to conf
 
 This rule has an option.
 
-```yaml
-rules:
-  es-x/no-array-prototype-at: [error, { aggressive: false }]
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-prototype-at": [
+      "error",
+      {
+        "aggressive": false,
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
 ```
 
 ### aggressive: boolean
 
 Configure the aggressive mode for only this rule.
 This is prior to the `settings['es-x'].aggressive` setting.
 
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in v8.0.0.

docs/rules/no-array-prototype-copywithin.md

@@ -30,16 +30,30 @@ foo.copyWithin(0, 1, 2)
 
 This rule has an option.
 
-```yaml
-rules:
-  es-x/no-array-prototype-copywithin: [error, { aggressive: false }]
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-prototype-copywithin": [
+      "error",
+      {
+        "aggressive": false,
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
 ```
 
 ### aggressive: boolean
 
 Configure the aggressive mode for only this rule.
 This is prior to the `settings['es-x'].aggressive` setting.
 
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in [eslint-plugin-es] v5.0.0.

docs/rules/no-array-prototype-entries.md

@@ -30,16 +30,30 @@ foo.entries()
 
 This rule has an option.
 
-```yaml
-rules:
-  es-x/no-array-prototype-entries: [error, { aggressive: false }]
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-prototype-entries": [
+      "error",
+      {
+        "aggressive": false,
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
 ```
 
 ### aggressive: boolean
 
 Configure the aggressive mode for only this rule.
 This is prior to the `settings['es-x'].aggressive` setting.
 
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in [eslint-plugin-es] v5.0.0.

docs/rules/no-array-prototype-every.md

@@ -30,16 +30,30 @@ foo.every(e => e !== 0)
 
 This rule has an option.
 
-```yaml
-rules:
-  es-x/no-array-prototype-every: [error, { aggressive: false }]
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-prototype-every": [
+      "error",
+      {
+        "aggressive": false,
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
 ```
 
 ### aggressive: boolean
 
 Configure the aggressive mode for only this rule.
 This is prior to the `settings['es-x'].aggressive` setting.
 
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in [eslint-plugin-es] v5.0.0.

docs/rules/no-array-prototype-fill.md

@@ -30,16 +30,30 @@ foo.fill(0)
 
 This rule has an option.
 
-```yaml
-rules:
-  es-x/no-array-prototype-fill: [error, { aggressive: false }]
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-prototype-fill": [
+      "error",
+      {
+        "aggressive": false,
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
 ```
 
 ### aggressive: boolean
 
 Configure the aggressive mode for only this rule.
 This is prior to the `settings['es-x'].aggressive` setting.
 
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in [eslint-plugin-es] v5.0.0.

docs/rules/no-array-prototype-filter.md

@@ -30,16 +30,30 @@ foo.filter(e => e !== 0)
 
 This rule has an option.
 
-```yaml
-rules:
-  es-x/no-array-prototype-filter: [error, { aggressive: false }]
+```jsonc
+{
+  "rules": {
+    "es-x/no-array-prototype-filter": [
+      "error",
+      {
+        "aggressive": false,
+        "allowTestedProperty": false
+      }
+    ]
+  }
+}
 ```
 
 ### aggressive: boolean
 
 Configure the aggressive mode for only this rule.
 This is prior to the `settings['es-x'].aggressive` setting.
 
+### allowTestedProperty: boolean
+
+Configure the allowTestedProperty mode for only this rule.
+This is prior to the `settings['es-x'].allowTestedProperty` setting.
+
 ## 🚀 Version
 
 This rule was introduced in [eslint-plugin-es] v5.0.0.