V4 (#88)

Author: antonmedv

.github/workflows/check.yml

@@ -0,0 +1,11 @@
+name: Check
+
+on: [push, pull_request]
+
+jobs:
+  code-style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm i
+      - run: npm run fmt:check

.github/workflows/test.yml

@@ -7,11 +7,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [20.x, 22.x]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm i

README.md

@@ -8,10 +8,10 @@
 
 ## Features
 
-* Generates the **shortest** selector
-* **Unique** selectors per page
-* Stable and **robust** selectors
-* **2kB** minified + gzipped
+* Generates **shortest** CSS selectors.
+* **Unique** CSS selectors per page.
+* Stable and **robust** CSS selectors.
+* Size: **1.5kb** (minified & gzipped).
 
 ## Install
 
@@ -34,52 +34,35 @@ document.addEventListener('click', (event) => {
 An example of a generated selector:
 
 ```css
-.blog > article:nth-child(3) .add-comment
+.blog > article:nth-of-type(3) .add-comment
 ```
 
 ## Configuration
 
 ```js
 const selector = finder(event.target, {
-  root: document.body,          // Root of search, defaults to document.body.
-  idName: (name) => true,       // Check if this ID can be used.
-  className: (name) => true,    // Check if this class name can be used.
-  tagName: (name) => true,      // Check if tag name can be used.
-  attr: (name, value) => false, // Check if attr name can be used.
-  seedMinLength: 1,           
+  root: document.body,
+  timeoutMs: 1000,  
+  seedMinLength: 3,
   optimizedMinLength: 2,
-  threshold: 1000,
-  maxNumberOfTries: 10_000,
-  timeoutMs: undefined,
 });
 ```
 
-### seedMinLength
-
-Minimum length of levels in fining selector. Starts from `1`. 
-For more robust selectors give this param value around 4-5 depending on depth of
-you DOM tree. If finder hits the `root`, this param is ignored.
-
-### optimizedMinLength
+### root
 
-Minimum length for optimising selector. Starts from `2`. 
-For example selector `body > div > div > p` can be optimised to `body p`.
+Defines the root of the search. Defaults to `document.body`.
 
-### threshold
+### timeoutMs
 
-Max number of selectors to check before falling into `nth-child` usage. 
-Checking for uniqueness of selector is very costly operation, if you have DOM 
-tree depth of 5, with 5 classes on each level, that gives you more than 3k 
-selectors to check. Default `1000` is good enough in most cases.  
+Timeout to search for a selector. Defaults to `1000ms`. After the timeout, finder fallbacks to `nth-child` selectors.
 
-### maxNumberOfTries
+### seedMinLength
 
-Max number of tries for the optimization. This is a trade-off between
-optimization and efficiency. Default `10_000` is good enough in most cases.
+Minimum length of levels in fining selector. Defaults to `3`.
 
-### timeoutMs
+### optimizedMinLength
 
-Optional timeout in milliseconds. `undefined` (no timeout) by default. If `timeoutMs: 500` is provided, an error will be thrown if selector generation takes more than 500ms.
+Minimum length for optimising selector. Defaults to `2`.
 
 ## License