From 05a467494b5d27143df39733f7a9ee1266ddcff1 Mon Sep 17 00:00:00 2001 From: David Anson Date: Sat, 24 Aug 2024 22:20:04 -0700 Subject: [PATCH] Update README.md to say explicitly that all rules are enabled by default. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index dd9de037f..6572bb603 100644 --- a/README.md +++ b/README.md @@ -354,16 +354,16 @@ Type: `Object` mapping `String` to `Boolean | Object` Configures the rules to use. -Object keys are rule names or aliases and values are the rule's configuration. +Object keys are rule names/aliases; object values are the rule's configuration. The value `false` disables a rule, `true` enables its default configuration, -and passing an object customizes its settings. Setting the special `default` -rule to `true` or `false` includes/excludes all rules by default. Enabling -or disabling a tag name (ex: `whitespace`) affects all rules having that -tag. - -The `default` rule is applied first, then keys are processed in order -from top to bottom with later values overriding earlier ones. Keys -(including rule names, aliases, tags, and `default`) are not case-sensitive. +and passing an object value customizes that rule. Setting the special `default` +rule to `true` or `false` includes/excludes all rules by default. In the absence +of a configuration object, all rules are enabled. Enabling or disabling a tag +name (ex: `whitespace`) affects all rules having that tag. + +The `default` rule is applied first, then keys are processed in order from top +to bottom with later values overriding earlier ones. Keys (including rule names, +aliases, tags, and `default`) are not case-sensitive. Example: