noJsRestrictedProperties

JavaScript (and super languages)

Summary

Diagnostic Category: lint/nursery/noJsRestrictedProperties
This rule doesn’t have a fix.
The default severity of this rule is warning.
Sources:
- Same as no-restricted-properties

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "noJsRestrictedProperties": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow specific object properties.

This rule lets you ban property access for exact object/property pairs, all properties on a given object, or a property name everywhere except for a short allowlist of objects.

It also reports restricted properties when they appear in object destructuring.

This rule requires explicit configuration to specify which properties are restricted, so it does not report anything by default.

Examples

Exact object/property restriction

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "noJsRestrictedProperties": {
6
          "level": "on",
7
          "options": {
8
            "entries": [
9
              {
10
                "object": "require",
11
                "property": "ensure",
12
                "message": "Use dynamic import() instead."
13
              }
14
            ]
15
          }
16
        }
17
      }
18
    }
19
  }
20
}

In this example, the rule reports the access of the ensure property on the require object, and emits the message “Use dynamic import() instead.”:

1
require.ensure("./entry")

code-block.js:1:9 lint/nursery/noJsRestrictedProperties ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Do not use ‘require.ensure’.
  
  > 1 │ require.ensure(”./entry”)
      │         ^^^^^^
    2 │ 
  
  ℹ Use dynamic import() instead.
  
  ℹ Remove this usage to comply with the project’s guidelines.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

Property-wide restriction with an allowlist

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "noJsRestrictedProperties": {
6
          "level": "on",
7
          "options": {
8
            "entries": [
9
              {
10
                "property": "__defineGetter__",
11
                "message": "Use Object.defineProperty() instead.",
12
                "allowObjects": [
13
                  "Object"
14
                ]
15
              }
16
            ]
17
          }
18
        }
19
      }
20
    }
21
  }
22
}

In this example, the rule reports any access to the property __defineGetter__, except for Object object, and it emits the message “Use Object.defineProperty() instead.”:

1
foo.__defineGetter__

code-block.js:1:5 lint/nursery/noJsRestrictedProperties ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Do not use property ‘__defineGetter__’.
  
  > 1 │ foo.__defineGetter__
      │     ^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Use Object.defineProperty() instead.
  
  ℹ Property ‘__defineGetter__’ is only allowed on these objects: Object.
  
  ℹ Remove this usage to comply with the project’s guidelines.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

1
Object.__defineGetter__

Object-wide restriction with allowed exceptions

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "noJsRestrictedProperties": {
6
          "level": "on",
7
          "options": {
8
            "entries": [
9
              {
10
                "object": "arguments",
11
                "message": "Avoid accessing arbitrary arguments properties.",
12
                "allowProperties": [
13
                  "length"
14
                ]
15
              }
16
            ]
17
          }
18
        }
19
      }
20
    }
21
  }
22
}

In the following example, when the rule encounters the object arguments, it reports all properties except for length with the message “Avoid accessing arbitrary arguments properties.”:

1
arguments.callee

code-block.js:1:11 lint/nursery/noJsRestrictedProperties ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Do not access properties on ‘arguments’.
  
  > 1 │ arguments.callee
      │           ^^^^^^
    2 │ 
  
  ℹ Avoid accessing arbitrary arguments properties.
  
  ℹ Only these properties are allowed on ‘arguments’: length.
  
  ℹ Remove this usage to comply with the project’s guidelines.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

1
arguments.length

Options

`entries`

An array of restricted object/property combinations. Depending on the provided options, each entry can:

Restrict a specific property on a specific object.
Restrict all properties on a specific object except for an allowlist of properties.
Restrict a specific property everywhere except for an allowlist of objects.
Provide a custom message to include in the diagnostic when the restriction is violated.

`entries[].object`

The object for which the restriction applies. If not provided, the restriction applies to all objects. If combined with property, it restricts only that property on the specified object.

`entries[].property`

The property for which the restriction applies. If not provided, the restriction applies to all properties. If combined with object, it restricts that property only on that object.

`entries[].allowObjects`

When restricting a property, an optional allowlist of objects that are exempt from the restriction. Only applicable when property is provided and object is not provided.

It conflicts with allowProperties.

`entries[].allowProperties`

When restricting an object, an optional allowlist of properties that are exempt from the restriction. Only applicable when object is provided and property is not provided.

It conflicts with allowObjects.

`entries[].message`

An optional custom message to include in the diagnostic when this restriction is violated. If not provided, a default message will be used.

Use this to give context and explain why the property is restricted, and to suggest an alternative.