@creedengo/eslint-plugin/lib/rules/avoid-autoplay.js

JavaScript linter of creedengo project

/*
 * creedengo JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
 * Copyright © 2023 Green Code Initiative (https://green-code-initiative.org)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

"use strict";

/** @type {import("eslint").Rule.RuleModule} */
module.exports = {
  meta: {
    type: "suggestion",
    docs: {
      description: "Avoid autoplay for videos and audio content",
      category: "eco-design",
      recommended: "warn",
    },
    messages: {
      NoAutoplay: "Avoid autoplay for video and audio elements.",
      EnforcePreloadNone: "Set preload='none' for video and audio elements.",
      NoAutoplayAndEnforcePreloadNone:
        "Avoid autoplay and set preload='none' for video and audio elements.",
    },
    schema: [],
  },
  create(context) {
    return {
      JSXOpeningElement(node) {
        if (node.name.name === "video" || node.name.name === "audio") {
          const autoplayAttr = node.attributes.find(
            (attr) => attr.name?.name.toLowerCase() === "autoplay",
          );
          const preloadAttr = node.attributes.find(
            (attr) => attr.name?.name.toLowerCase() === "preload",
          );
          if (
            autoplayAttr &&
            (!preloadAttr || preloadAttr.value.value !== "none")
          ) {
            context.report({
              node: autoplayAttr || preloadAttr,
              messageId: "NoAutoplayAndEnforcePreloadNone",
            });
          } else {
            if (autoplayAttr) {
              context.report({
                node: autoplayAttr,
                messageId: "NoAutoplay",
              });
            }

            if (!preloadAttr || preloadAttr.value.value !== "none") {
              context.report({
                node: preloadAttr || node,
                messageId: "EnforcePreloadNone",
              });
            }
          }
        }
      },
    };
  },
};