Add linter for incorrect feature statuses

scripts/fix/feature-status.js

@@ -0,0 +1,135 @@
+/* This file is a part of @mdn/browser-compat-data
+ * See LICENSE file for more information. */
+
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const { platform } = require('os');
+
+const { IS_WINDOWS } = require('../../test/utils.js');
+
+/**
+ * Return a new feature object whose status properties have been adjusted according to a few predefined rules.
+ *
+ * @param {string} key The key in the object
+ * @param {*} value The value of the key
+ *
+ * @returns {*} The new value
+ */
+const fixStatus = (key, value) => {
+  const compat = value?.__compat;
+  if (compat) {
+    if (compat.spec_url && compat.status.standard_track === false) {
+      compat.status.standard_track = true;
+    }
+    if (compat.status.experimental) {
+      const browserSupport = new Set();
+
+      for (const [browser, support] of Object.entries(compat.support)) {
+        // Consider only the first part of an array statement.
+        const statement = Array.isArray(support) ? support[0] : support;
+        // Ignore anything behind flag, prefix or alternative name
+        if (statement.flags || statement.prefix || statement.alternative_name) {
+          continue;
+        }
+        if (statement.version_added && !statement.version_removed) {
+          browserSupport.add(browser);
+        }
+      }
+
+      // Now check which of Blink, Gecko and WebKit support it.
+
+      const engineSupport = new Set();
+
+      for (const browser of browserSupport) {
+        const currentRelease = Object.values(browsers[browser].releases).find(
+          (r) => r.status === 'current',
+        );
+        const engine = currentRelease.engine;
+        engineSupport.add(engine);
+      }
+
+      let engineCount = 0;
+      for (const engine of ['Blink', 'Gecko', 'WebKit']) {
+        if (engineSupport.has(engine)) {
+          engineCount++;
+        }
+      }
+
+      if (engineCount > 1) {
+        compat.status.experimental = false;
+      }
+    }
+  }
+
+  return value;
+};
+
+/**
+ * @param {string} filename
+ */
+const fixStatusFromFile = (filename) => {
+  let actual = fs.readFileSync(filename, 'utf-8').trim();
+  let expected = JSON.stringify(JSON.parse(actual, fixStatus), null, 2);
+
+  if (IS_WINDOWS) {
+    // prevent false positives from git.core.autocrlf on Windows
+    actual = actual.replace(/\r/g, '');
+    expected = expected.replace(/\r/g, '');
+  }
+
+  if (actual !== expected) {
+    fs.writeFileSync(filename, expected + '\n', 'utf-8');
+  }
+};
+
+if (require.main === module) {
+  /**
+   * @param {string[]} files
+   */
+  function load(...files) {
+    for (let file of files) {
+      if (file.indexOf(__dirname) !== 0) {
+        file = path.resolve(__dirname, '..', file);
+      }
+
+      if (!fs.existsSync(file)) {
+        continue; // Ignore non-existent files
+      }
+
+      if (fs.statSync(file).isFile()) {
+        if (path.extname(file) === '.json') {
+          fixStatusFromFile(file);
+        }
+
+        continue;
+      }
+
+      const subFiles = fs.readdirSync(file).map((subfile) => {
+        return path.join(file, subfile);
+      });
+
+      load(...subFiles);
+    }
+  }
+
+  if (process.argv[2]) {
+    load(process.argv[2]);
+  } else {
+    load(
+      'api',
+      'css',
+      'html',
+      'http',
+      'svg',
+      'javascript',
+      'mathml',
+      'test',
+      'webdriver',
+      'webextensions',
+    );
+  }
+}
+
+module.exports = fixStatusFromFile;

scripts/fix/index.js

@@ -8,6 +8,7 @@ const path = require('path');
 const fixBrowserOrder = require('./browser-order');
 const fixFeatureOrder = require('./feature-order');
 const fixLinks = require('./links');
+const fixFeatureStatus = require('./feature-status');
 
 /**
  * Recursively load one or more files and/or directories passed as arguments and perform automatic fixes.
@@ -31,6 +32,7 @@ function load(...files) {
         fixBrowserOrder(file);
         fixFeatureOrder(file);
         fixLinks(file);
+        fixFeatureStatus(file);
       }
 
       continue;

test/lint.js

@@ -18,6 +18,7 @@ const {
   testPrefix,
   testRealValues,
   testSchema,
+  testStatus,
   testStyle,
   testVersions,
 } = require('./linter/index.js');
@@ -68,6 +69,7 @@ function load(...files) {
           hasRealValueErrors = false,
           hasPrefixErrors = false,
           hasDescriptionsErrors = false,
+          hasStatusErrors = false,
           hasNotesErrors = false;
         const relativeFilePath = path.relative(process.cwd(), file);
 
@@ -109,6 +111,7 @@ function load(...files) {
             hasRealValueErrors = testRealValues(file);
             hasPrefixErrors = testPrefix(file);
             hasDescriptionsErrors = testDescriptions(file);
+            hasStatusErrors = testStatus(file);
             hasNotesErrors = testNotes(file);
           }
         } catch (e) {
@@ -128,6 +131,7 @@ function load(...files) {
           hasRealValueErrors,
           hasPrefixErrors,
           hasDescriptionsErrors,
+          hasStatusErrors,
           hasNotesErrors,
         ].some((x) => !!x);
 

test/linter/index.js

@@ -12,6 +12,7 @@ const testNotes = require('./test-notes.js');
 const testPrefix = require('./test-prefix.js');
 const testRealValues = require('./test-real-values.js');
 const testSchema = require('./test-schema.js');
+const testStatus = require('./test-status.js');
 const testStyle = require('./test-style.js');
 const testVersions = require('./test-versions.js');
 
@@ -25,6 +26,7 @@ module.exports = {
   testPrefix,
   testRealValues,
   testSchema,
+  testStatus,
   testStyle,
   testVersions,
 };

test/linter/test-status.js

@@ -0,0 +1,106 @@
+/* This file is a part of @mdn/browser-compat-data
+ * See LICENSE file for more information. */
+
+'use strict';
+
+const chalk = require('chalk');
+const { Logger } = require('../utils.js');
+
+const { browsers } = require('../../index.js');
+
+/**
+ * @typedef {import('../../types').Identifier} Identifier
+ */
+
+/**
+ * @param {Identifier} data
+ * @param {Logger} logger
+ * @param {string} path
+ */
+function checkStatus(data, logger, path = '') {
+  const compat = data.__compat;
+  if (compat?.status) {
+    if (compat.spec_url && compat.status.standard_track === false) {
+      logger.error(
+        chalk`{red → {bold ${path}} is marked as {bold non-standard}, but has a {bold spec_url}}`,
+      );
+    }
+    if (compat.status.experimental && compat.status.deprecated) {
+      logger.error(
+        chalk`{red → Unexpected simultaneous experimental and deprecated status in {bold ${path}}}`,
+      );
+    }
+    if (compat.status.experimental) {
+      // Check if experimental should be false (code copied from migration 007)
+
+      const browserSupport = new Set();
+
+      for (const [browser, support] of Object.entries(compat.support)) {
+        // Consider only the first part of an array statement.
+        const statement = Array.isArray(support) ? support[0] : support;
+        // Ignore anything behind flag, prefix or alternative name
+        if (statement.flags || statement.prefix || statement.alternative_name) {
+          continue;
+        }
+        if (statement.version_added && !statement.version_removed) {
+          browserSupport.add(browser);
+        }
+      }
+
+      // Now check which of Blink, Gecko and WebKit support it.
+
+      const engineSupport = new Set();
+
+      for (const browser of browserSupport) {
+        const currentRelease = Object.values(browsers[browser].releases).find(
+          (r) => r.status === 'current',
+        );
+        const engine = currentRelease.engine;
+        engineSupport.add(engine);
+      }
+
+      let engineCount = 0;
+      for (const engine of ['Blink', 'Gecko', 'WebKit']) {
+        if (engineSupport.has(engine)) {
+          engineCount++;
+        }
+      }
+
+      if (engineCount > 1) {
+        logger.error(
+          chalk`{red → Experimental should be set to {bold false} for {bold ${path}} as the feature is supported in multiple browser engines.}`,
+        );
+      }
+    }
+  }
+
+  // Check children
+  for (const member in data) {
+    if (member === '__compat') {
+      continue;
+    }
+    checkStatus(
+      data[member],
+      logger,
+      path && path.length > 0 ? `${path}.${member}` : member,
+    );
+  }
+}
+
+/**
+ * @param {string} filename
+ * @returns {boolean} If the file contains errors
+ */
+function testStatus(filename) {
+  /** @type {Identifier} */
+  const data = require(filename);
+
+  const logger = new Logger('Feature Status');
+
+  checkStatus(data, logger);
+
+  logger.emit();
+  return logger.hasErrors();
+}
+
+module.exports = testStatus;