feat: require-baseline rule (#33)

* feat: baseline rule fixes #26 * Add rule options to docs * Omit data file from prettier check * Don't rebuild baseline on every build * Update to check some property values * Nested @supports rules support * Add basic checking for functions * Fix style issues * Fix baseline edge cases * Honor not in @supports * Fix formatting errors * Update docs/rules/baseline.md Co-authored-by: Josh Goldberg ✨ <[email protected]> * Update package.json Co-authored-by: Josh Goldberg ✨ <[email protected]> * Update tools/generate-baseline.js Co-authored-by: Josh Goldberg ✨ <[email protected]> * Add link to baseline docs * Add comment to generate-baseline script * Update prettierignore * Fix colors formatting * Rename baseline -> requirebaseline * Clean up README generation * Fix code style issues * Fix require-baseline rule * Update tools/generate-baseline.js Co-authored-by: Milos Djermanovic <[email protected]> * Update package.json Co-authored-by: Milos Djermanovic <[email protected]> * Update require-baseline docs * Update baseline --------- Co-authored-by: Josh Goldberg ✨ <[email protected]> Co-authored-by: Milos Djermanovic <[email protected]>
eslint · Feb 13, 2025 · c5f66fa · c5f66fa
1 parent ede145c
commit c5f66fa
Show file tree

Hide file tree

Showing 11 changed files with 4,031 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -56,13 +56,14 @@ export default [
 
 <!-- Rule Table Start -->
 
-| **Rule Name**                                                    | **Description**                  | **Recommended** |
-| :--------------------------------------------------------------- | :------------------------------- | :-------------: |
-| [`no-duplicate-imports`](./docs/rules/no-duplicate-imports.md)   | Disallow duplicate @import rules |       yes       |
-| [`no-empty-blocks`](./docs/rules/no-empty-blocks.md)             | Disallow empty blocks            |       yes       |
-| [`no-invalid-at-rules`](./docs/rules/no-invalid-at-rules.md)     | Disallow invalid at-rules        |       yes       |
-| [`no-invalid-properties`](./docs/rules/no-invalid-properties.md) | Disallow invalid properties      |       yes       |
-| [`use-layers`](./docs/rules/use-layers.md)                       | Require use of layers            |       no        |
+| **Rule Name**                                                    | **Description**                      | **Recommended** |
+| :--------------------------------------------------------------- | :----------------------------------- | :-------------: |
+| [`no-duplicate-imports`](./docs/rules/no-duplicate-imports.md)   | Disallow duplicate @import rules     |       yes       |
+| [`no-empty-blocks`](./docs/rules/no-empty-blocks.md)             | Disallow empty blocks                |       yes       |
+| [`no-invalid-at-rules`](./docs/rules/no-invalid-at-rules.md)     | Disallow invalid at-rules            |       yes       |
+| [`no-invalid-properties`](./docs/rules/no-invalid-properties.md) | Disallow invalid properties          |       yes       |
+| [`require-baseline`](./docs/rules/require-baseline.md)           | Enforce the use of baseline features |       yes       |
+| [`use-layers`](./docs/rules/use-layers.md)                       | Require use of layers                |       no        |
 
 <!-- Rule Table End -->
 

diff --git a/docs/rules/require-baseline.md b/docs/rules/require-baseline.md
@@ -0,0 +1,75 @@
+# require-baseline
+
+Enforce the use of baseline features
+
+## Background
+
+[Baseline](https://web.dev/baseline) is an effort by the [W3C WebDX Community Group](https://github.com/web-platform-dx) to document which features are available in four core browsers: Chrome (desktop and Android), Edge, Firefox (desktop and Android), and Safari (macOS and iOS). This data allows developers to choose the technologies that are best supported for their audience. As part of this effort, Baseline tracks which CSS features are available in which browsers.
+
+Features are grouped into three levels:
+
+- **Widely available** features are those supported by all core browsers for at least 30 months.
+- **Newly available** features are those supported by all core browsers for less than 30 months.
+- **Limited availability** features are those supported by some but not all core browsers.
+
+Generally speaking, it's preferable to stick to widely available features to ensure the greatest interoperability across browsers.
+
+## Rule Details
+
+This rule warns when it finds any of the following:
+
+- A CSS property that isn't widely available or otherwise isn't enclosed in a `@supports` block.
+- An at-rule that isn't widely available.
+- A CSS property value that isn't widely available or otherwise isn't enclosed in a `@supports` block (currently limited to identifiers only).
+- A CSS property function that isn't widely available.
+
+The data is provided via the [web-features](https://npmjs.com/package/web-features) package.
+
+Here are some examples:
+
+```css
+/* invalid - accent-color is not widely available */
+a {
+	accent-color: red;
+}
+
+/* invalid - abs is not widely available */
+.box {
+	width: abs(20% - 100px);
+}
+
+/* invalid - property value doesn't match @supports indicator */
+@supports (accent-color: auto) {
+	a {
+		accent-color: abs(20% - 10px);
+	}
+}
+
+/* valid - @supports indicates you're choosing a limited availability property */
+@supports (accent-color: auto) {
+	a {
+		accent-color: auto;
+	}
+}
+
+/* invalid - @supports says that this property isn't available */
+@supports not (accent-color: auto) {
+	a {
+		accent-color: auto;
+	}
+}
+```
+
+### Options
+
+This rule accepts an option object with the following properties:
+
+- `available` (default: `"widely"`) - change to `"newly"` available to allow a larger number of properties and at-rules.
+
+## When Not to Use It
+
+If your web application doesn't target all Baseline browsers then you can safely disable this rule.
+
+## Further Reading
+
+- [How do things become baseline?](https://web.dev/baseline#how-do-things-become-baseline)
diff --git a/package.json b/package.json
@@ -32,11 +32,13 @@
       "prettier --write"
     ],
     "README.md": [
-      "npm run build:update-rules-docs",
-      "prettier --write"
+      "npm run build:update-rules-docs"
     ],
     "!(*.js)": "prettier --write --ignore-unknown",
-    "{src/rules/*.js,tools/update-rules-docs.js}": "npm run build:update-rules-docs"
+    "{src/rules/*.js,tools/update-rules-docs.js}": [
+      "node tools/update-rules-docs.js",
+      "git add README.md"
+    ]
   },
   "repository": {
     "type": "git",
@@ -52,6 +54,7 @@
     "build": "rollup -c && npm run build:dedupe-types && tsc -p tsconfig.esm.json && npm run build:cts",
     "build:readme": "node tools/update-readme.js",
     "build:update-rules-docs": "node tools/update-rules-docs.js",
+    "build:baseline": "node tools/generate-baseline.js",
     "test:jsr": "npx jsr@latest publish --dry-run",
     "pretest": "npm run build",
     "lint": "eslint",
@@ -90,6 +93,7 @@
     "rollup": "^4.16.2",
     "rollup-plugin-copy": "^3.5.0",
     "typescript": "^5.4.5",
+    "web-features": "^2.23.0",
     "yorkie": "^2.0.0"
   },
   "engines": {

diff --git a/src/data/README.md b/src/data/README.md
@@ -0,0 +1,13 @@
+# Data
+
+Some of the files in this directory are auto-generated and should not be modified manually.
+
+## baseline-data.js (autogenerated)
+
+Contains the aggregated data for [baseline](https://web.dev/baseline).
+
+To generate baseline data, run:
+
+```shell
+npm run build:baseline
+```