From 7531cf060d841a4fe14089f84f4035c4c150a8d5 Mon Sep 17 00:00:00 2001
From: Daniel Slepov <danil.slepov@gmail.com>
Date: Wed, 6 Dec 2023 11:13:55 +0500
Subject: [PATCH] docs: property `allowRules`

---
 packages/critters/README.md      | 4 ++--
 packages/critters/src/index.d.ts | 1 +
 packages/critters/src/index.js   | 1 +
 3 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/packages/critters/README.md b/packages/critters/README.md
index 061186f..8143583 100644
--- a/packages/critters/README.md
+++ b/packages/critters/README.md
@@ -71,7 +71,7 @@ module.exports = {
 +    new Critters({
 +      // optional configuration
 +      preload: 'swap',
-+      includeSelectors: [/^\.btn/, '.banner'],
++      allowRules: [/^\.btn/, '.banner'],
 +    })
   ]
 }
@@ -116,7 +116,7 @@ All optional. Pass them to `new Critters({ ... })`.
 - `compress` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Compress resulting critical CSS _(default: `true`)_
 - `logLevel` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Controls [log level](#loglevel) of the plugin _(default: `"info"`)_
 - `logger` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Provide a custom logger interface [logger](#logger)
-- `includeSelectors` **[RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp)** | **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Provide a list of selectors that should be included in the critical CSS. Accepts both RegExp and string.
+- `allowRules` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp)** | **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** Provide a list of selectors that should be included in the critical CSS. Accepts both RegExp and string.
 
 ### Include/exclude rules
 
diff --git a/packages/critters/src/index.d.ts b/packages/critters/src/index.d.ts
index 546339c..664c178 100644
--- a/packages/critters/src/index.d.ts
+++ b/packages/critters/src/index.d.ts
@@ -57,6 +57,7 @@ export interface Options {
   logLevel?: 'info' | 'warn' | 'error' | 'trace' | 'debug' | 'silent';
   reduceInlineStyles?: boolean;
   logger?: Logger;
+  allowRules?: (string | RegExp)[]
 }
 
 export interface Logger {
diff --git a/packages/critters/src/index.js b/packages/critters/src/index.js
index 82051b4..2e0630c 100644
--- a/packages/critters/src/index.js
+++ b/packages/critters/src/index.js
@@ -110,6 +110,7 @@ import { createLogger } from './util';
  * @property {Boolean} compress     Compress resulting critical CSS _(default: `true`)_
  * @property {String} logLevel      Controls {@link LogLevel log level} of the plugin _(default: `"info"`)_
  * @property {object} logger        Provide a custom logger interface {@link Logger logger}
+ * @property {(String|RegExp)[]} allowRules Provide a list of selectors that should be included in the critical CSS. Accepts both RegExp and string.
  */
 
 export default class Critters {