Report selector combinators (#337)

bartveneman · web-flow · commit d810868b0cd5 · 2023-07-31T21:44:44.000+02:00
closes #334
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@projectwallace/css-analyzer",
-  "version": "5.10.1",
+  "version": "5.11.0-alpha.3",
   "author": "Bart Veneman",
   "repository": {
     "type": "git",
diff --git a/src/__fixtures__/bol-com-20190617.json b/src/__fixtures__/bol-com-20190617.json
@@ -57084,6 +57084,17 @@
       },
       "uniquenessRatio": 1,
       "ratio": 0.02534138655462185
+    },
+    "combinators": {
+      "total": 4849,
+      "totalUnique": 4,
+      "unique": {
+        " ": 4139,
+        ">": 588,
+        "+": 43,
+        "~": 79
+      },
+      "uniquenessRatio": 0.0008249123530624871
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/bootstrap-5.0.0.json b/src/__fixtures__/bootstrap-5.0.0.json
@@ -24083,6 +24083,17 @@
       },
       "uniquenessRatio": 0.926829268292683,
       "ratio": 0.014648088603072526
+    },
+    "combinators": {
+      "total": 706,
+      "totalUnique": 4,
+      "unique": {
+        " ": 322,
+        ">": 249,
+        "+": 113,
+        "~": 22
+      },
+      "uniquenessRatio": 0.0056657223796034
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/cnn-20220403.json b/src/__fixtures__/cnn-20220403.json
@@ -153182,6 +153182,17 @@
       },
       "uniquenessRatio": 0.7477477477477478,
       "ratio": 0.005654898364664527
+    },
+    "combinators": {
+      "total": 34225,
+      "totalUnique": 4,
+      "unique": {
+        " ": 32028,
+        "+": 491,
+        "~": 409,
+        ">": 1297
+      },
+      "uniquenessRatio": 0.0001168736303871439
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/css-tricks-20190319.json b/src/__fixtures__/css-tricks-20190319.json
@@ -20584,6 +20584,17 @@
       },
       "uniquenessRatio": 1,
       "ratio": 0.012743926722421346
+    },
+    "combinators": {
+      "total": 2938,
+      "totalUnique": 4,
+      "unique": {
+        " ": 2604,
+        ">": 327,
+        "~": 5,
+        "+": 2
+      },
+      "uniquenessRatio": 0.0013614703880190605
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/facebook-20190319.json b/src/__fixtures__/facebook-20190319.json
@@ -40263,6 +40263,17 @@
       },
       "uniquenessRatio": 1,
       "ratio": 0.0066725978647686835
+    },
+    "combinators": {
+      "total": 1150,
+      "totalUnique": 4,
+      "unique": {
+        " ": 1049,
+        ">": 89,
+        "+": 9,
+        "~": 3
+      },
+      "uniquenessRatio": 0.0034782608695652175
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/gazelle-20210905.json b/src/__fixtures__/gazelle-20210905.json
@@ -94262,6 +94262,17 @@
       },
       "uniquenessRatio": 0.96,
       "ratio": 0.002123502930434044
+    },
+    "combinators": {
+      "total": 16258,
+      "totalUnique": 4,
+      "unique": {
+        " ": 13926,
+        ">": 1647,
+        "+": 643,
+        "~": 42
+      },
+      "uniquenessRatio": 0.00024603272235207283
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/github-20210501.json b/src/__fixtures__/github-20210501.json
@@ -26139,6 +26139,17 @@
       },
       "uniquenessRatio": 0.95,
       "ratio": 0.013249420337860219
+    },
+    "combinators": {
+      "total": 843,
+      "totalUnique": 4,
+      "unique": {
+        " ": 733,
+        ">": 72,
+        "+": 34,
+        "~": 4
+      },
+      "uniquenessRatio": 0.004744958481613286
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/indiatimes-20230219.json b/src/__fixtures__/indiatimes-20230219.json
@@ -54669,6 +54669,17 @@
       },
       "uniquenessRatio": 1,
       "ratio": 0.0006275100401606426
+    },
+    "combinators": {
+      "total": 10557,
+      "totalUnique": 4,
+      "unique": {
+        " ": 10509,
+        "~": 3,
+        ">": 41,
+        "+": 4
+      },
+      "uniquenessRatio": 0.0003788955195604812
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/lego-20190617.json b/src/__fixtures__/lego-20190617.json
@@ -22495,6 +22495,17 @@
       },
       "uniquenessRatio": 1,
       "ratio": 0.014009844755774327
+    },
+    "combinators": {
+      "total": 2162,
+      "totalUnique": 4,
+      "unique": {
+        " ": 2052,
+        "~": 6,
+        ">": 75,
+        "+": 29
+      },
+      "uniquenessRatio": 0.0018501387604070306
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/smashing-magazine-20190319.json b/src/__fixtures__/smashing-magazine-20190319.json
@@ -98346,6 +98346,17 @@
       },
       "uniquenessRatio": 0.42452830188679247,
       "ratio": 0.01815690304898938
+    },
+    "combinators": {
+      "total": 10464,
+      "totalUnique": 4,
+      "unique": {
+        " ": 10018,
+        ">": 251,
+        "+": 177,
+        "~": 18
+      },
+      "uniquenessRatio": 0.00038226299694189603
     }
   },
   "declarations": {
diff --git a/src/__fixtures__/trello-20190617.json b/src/__fixtures__/trello-20190617.json
@@ -40195,6 +40195,17 @@
       },
       "uniquenessRatio": 0.5,
       "ratio": 0.0057107893126657145
+    },
+    "combinators": {
+      "total": 1809,
+      "totalUnique": 4,
+      "unique": {
+        " ": 1413,
+        ">": 224,
+        "+": 10,
+        "~": 162
+      },
+      "uniquenessRatio": 0.002211166390270868
     }
   },
   "declarations": {
diff --git a/src/index.js b/src/index.js
@@ -2,7 +2,7 @@ import parse from 'css-tree/parser'
 import walk from 'css-tree/walker'
 import { calculate } from '@bramus/specificity/core'
 import { isSupportsBrowserhack, isMediaBrowserhack } from './atrules/atrules.js'
-import { getComplexity, isAccessibility } from './selectors/utils.js'
+import { getCombinators, getComplexity, isAccessibility } from './selectors/utils.js'
 import { colorFunctions, colorKeywords, namedColors, systemColors } from './values/colors.js'
 import { destructure, isSystemFont } from './values/destructure-font-shorthand.js'
 import { isValueKeyword } from './values/values.js'
@@ -125,6 +125,7 @@ export function analyze(css, options = {}) {
   let specificities = []
   let ids = new Collection({ useLocations })
   let a11y = new Collection({ useLocations })
+  let combinators = new Collection({ useLocations })
 
   // Declarations
   let uniqueDeclarations = new Set()
@@ -246,14 +247,6 @@ export function analyze(css, options = {}) {
           return this.skip
         }
 
-        let [{ value: specificityObj }] = calculate(node)
-        /** @type {Specificity} */
-        let specificity = [specificityObj.a, specificityObj.b, specificityObj.c]
-
-        if (specificity[0] > 0) {
-          ids.push(selector, node.loc)
-        }
-
         if (isAccessibility(node)) {
           a11y.push(selector, node.loc)
         }
@@ -267,6 +260,12 @@ export function analyze(css, options = {}) {
         uniqueSelectors.add(selector)
         selectorComplexities.push(complexity)
         uniqueSelectorComplexities.push(complexity, node.loc)
+
+        // #region specificity
+        let [{ value: specificityObj }] = calculate(node)
+        /** @type {Specificity} */
+        let specificity = [specificityObj.a, specificityObj.b, specificityObj.c]
+
         uniqueSpecificities.push(specificity[0] + ',' + specificity[1] + ',' + specificity[2], node.loc)
 
         if (maxSpecificity === undefined) {
@@ -290,6 +289,15 @@ export function analyze(css, options = {}) {
         }
 
         specificities.push(specificity)
+        // #endregion
+
+        if (specificity[0] > 0) {
+          ids.push(selector, node.loc)
+        }
+
+        getCombinators(node, function onCombinator(combinator) {
+          combinators.push(combinator.name, combinator.loc)
+        })
 
         // Avoid deeper walking of selectors to not mess with
         // our specificity calculations in case of a selector
@@ -692,7 +700,8 @@ export function analyze(css, options = {}) {
         {
           ratio: ratio(prefixedSelectors.size(), totalSelectors),
         },
-      )
+      ),
+      combinators: combinators.count(),
     },
     declarations: {
       total: totalDeclarations,
diff --git a/src/index.test.js b/src/index.test.js
@@ -239,6 +239,12 @@ Api('handles empty input gracefully', () => {
         "uniquenessRatio": 0,
         "ratio": 0
       },
+      "combinators": {
+        "total": 0,
+        "totalUnique": 0,
+        "unique": {},
+        "uniquenessRatio": 0,
+      },
     },
     "declarations": {
       "total": 0,
diff --git a/src/selectors/selectors.test.js b/src/selectors/selectors.test.js
diff --git a/src/selectors/utils.js b/src/selectors/utils.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@projectwallace/css-analyzer",`
`3`		`- "version": "5.10.1",`
	`3`	`+ "version": "5.11.0-alpha.3",`
`4`	`4`	`"author": "Bart Veneman",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`