no-foo.md

Disallow using foo (test/no-foo)

💼 This rule is enabled in the ✅ recommended config.

🔧 This rule is automatically fixable by the --fix CLI option.

⚙️ This rule is configurable.

💭 This rule requires type information.

❗ This rule identifies problems that could cause errors or unexpected behavior.

Rule details

Description of the rule would normally go here.

Examples

Examples would normally go here.

Options

Name	Description	Type	Choices	Default	Required	Deprecated
bar	Choose how to use the rule.	String	always, never	always	Yes
foo	Enable some kind of behavior.	Boolean		false		Yes

For the purpose of this example, below is the meta.schema that would generate the above rule options table:

[{
    "type": "object",
    "properties": {
        "foo": {
            "type": "boolean",
            "description": "Enable some kind of behavior.",
            "deprecated": true,
            "default": false
        },
        "bar": {
            "description": "Choose how to use the rule.",
            "type": "string",
            "enum": ["always", "never"],
            "default": "always"
        }
    },
    "required": ["bar"],
    "additionalProperties": false
}]