96 lines
3.4 KiB
JavaScript
96 lines
3.4 KiB
JavaScript
|
"use strict";
|
||
|
|
|
||
|
|
Object.defineProperty(exports, "__esModule", {
|
||
|
|
value: true
|
||
|
|
});
|
||
|
|
exports["default"] = void 0;
|
||
|
|
var _jsxAstUtils = require("jsx-ast-utils");
|
||
|
|
var _arrayPrototype = _interopRequireDefault(require("array.prototype.flatmap"));
|
||
|
|
var _schemas = require("../util/schemas");
|
||
|
|
var _getElementType = _interopRequireDefault(require("../util/getElementType"));
|
||
|
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
||
|
|
/**
|
||
|
|
* @fileoverview <audio> and <video> elements must have a <track> for captions.
|
||
|
|
* @author Ethan Cohen
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
// Rule Definition
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
var errorMessage = 'Media elements such as <audio> and <video> must have a <track> for captions.';
|
||
|
|
var MEDIA_TYPES = ['audio', 'video'];
|
||
|
|
var schema = (0, _schemas.generateObjSchema)({
|
||
|
|
audio: _schemas.arraySchema,
|
||
|
|
video: _schemas.arraySchema,
|
||
|
|
track: _schemas.arraySchema
|
||
|
|
});
|
||
|
|
var isMediaType = function isMediaType(context, type) {
|
||
|
|
var options = context.options[0] || {};
|
||
|
|
return MEDIA_TYPES.concat((0, _arrayPrototype["default"])(MEDIA_TYPES, function (mediaType) {
|
||
|
|
return options[mediaType];
|
||
|
|
})).some(function (typeToCheck) {
|
||
|
|
return typeToCheck === type;
|
||
|
|
});
|
||
|
|
};
|
||
|
|
var isTrackType = function isTrackType(context, type) {
|
||
|
|
var options = context.options[0] || {};
|
||
|
|
return ['track'].concat(options.track || []).some(function (typeToCheck) {
|
||
|
|
return typeToCheck === type;
|
||
|
|
});
|
||
|
|
};
|
||
|
|
var _default = exports["default"] = {
|
||
|
|
meta: {
|
||
|
|
docs: {
|
||
|
|
url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/media-has-caption.md',
|
||
|
|
description: 'Enforces that `<audio>` and `<video>` elements must have a `<track>` for captions.'
|
||
|
|
},
|
||
|
|
schema: [schema]
|
||
|
|
},
|
||
|
|
create: function create(context) {
|
||
|
|
var elementType = (0, _getElementType["default"])(context);
|
||
|
|
return {
|
||
|
|
JSXElement: function JSXElement(node) {
|
||
|
|
var element = node.openingElement;
|
||
|
|
var type = elementType(element);
|
||
|
|
if (!isMediaType(context, type)) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
var mutedProp = (0, _jsxAstUtils.getProp)(element.attributes, 'muted');
|
||
|
|
var mutedPropVal = (0, _jsxAstUtils.getLiteralPropValue)(mutedProp);
|
||
|
|
if (mutedPropVal === true) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
// $FlowFixMe https://github.com/facebook/flow/issues/1414
|
||
|
|
var trackChildren = node.children.filter(function (child) {
|
||
|
|
if (child.type !== 'JSXElement') {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
// $FlowFixMe https://github.com/facebook/flow/issues/1414
|
||
|
|
return isTrackType(context, elementType(child.openingElement));
|
||
|
|
});
|
||
|
|
if (trackChildren.length === 0) {
|
||
|
|
context.report({
|
||
|
|
node: element,
|
||
|
|
message: errorMessage
|
||
|
|
});
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
var hasCaption = trackChildren.some(function (track) {
|
||
|
|
var kindProp = (0, _jsxAstUtils.getProp)(track.openingElement.attributes, 'kind');
|
||
|
|
var kindPropValue = (0, _jsxAstUtils.getLiteralPropValue)(kindProp) || '';
|
||
|
|
return kindPropValue.toLowerCase() === 'captions';
|
||
|
|
});
|
||
|
|
if (!hasCaption) {
|
||
|
|
context.report({
|
||
|
|
node: element,
|
||
|
|
message: errorMessage
|
||
|
|
});
|
||
|
|
}
|
||
|
|
}
|
||
|
|
};
|
||
|
|
}
|
||
|
|
};
|
||
|
|
module.exports = exports.default;
|