forked from public/fvtt-cthulhu-eternal
131 lines
3.5 KiB
JavaScript
131 lines
3.5 KiB
JavaScript
"use strict";
|
|
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.default = void 0;
|
|
var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
|
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
// We could disallow raw gt, quot, and apos, but allow for parity; but we do
|
|
// not allow hex or decimal character references
|
|
const htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\S)/u;
|
|
const markdownRegex = /(?<!\\)(`+)([^`]+)\1(?!`)/u;
|
|
|
|
/**
|
|
* @param {string} desc
|
|
* @returns {string}
|
|
*/
|
|
const htmlReplacer = desc => {
|
|
return desc.replaceAll(new RegExp(htmlRegex, 'gu'), _ => {
|
|
if (_ === '<') {
|
|
return '<';
|
|
}
|
|
return '&';
|
|
});
|
|
};
|
|
|
|
/**
|
|
* @param {string} desc
|
|
* @returns {string}
|
|
*/
|
|
const markdownReplacer = desc => {
|
|
return desc.replaceAll(new RegExp(markdownRegex, 'gu'), (_, backticks, encapsed) => {
|
|
const bookend = '`'.repeat(backticks.length);
|
|
return `\\${bookend}${encapsed}${bookend}`;
|
|
});
|
|
};
|
|
var _default = exports.default = (0, _iterateJsdoc.default)(({
|
|
context,
|
|
jsdoc,
|
|
utils
|
|
}) => {
|
|
const {
|
|
escapeHTML,
|
|
escapeMarkdown
|
|
} = context.options[0] || {};
|
|
if (!escapeHTML && !escapeMarkdown) {
|
|
context.report({
|
|
loc: {
|
|
end: {
|
|
column: 1,
|
|
line: 1
|
|
},
|
|
start: {
|
|
column: 1,
|
|
line: 1
|
|
}
|
|
},
|
|
message: 'You must include either `escapeHTML` or `escapeMarkdown`'
|
|
});
|
|
return;
|
|
}
|
|
const {
|
|
descriptions
|
|
} = utils.getDescription();
|
|
if (escapeHTML) {
|
|
if (descriptions.some(desc => {
|
|
return htmlRegex.test(desc);
|
|
})) {
|
|
const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);
|
|
utils.reportJSDoc('You have unescaped HTML characters < or &', {
|
|
line
|
|
}, () => {}, true);
|
|
return;
|
|
}
|
|
for (const tag of jsdoc.tags) {
|
|
if ( /** @type {string[]} */utils.getTagDescription(tag, true).some(desc => {
|
|
return htmlRegex.test(desc);
|
|
})) {
|
|
const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) + tag.source[0].number;
|
|
utils.reportJSDoc('You have unescaped HTML characters < or & in a tag', {
|
|
line
|
|
}, () => {}, true);
|
|
}
|
|
}
|
|
return;
|
|
}
|
|
if (descriptions.some(desc => {
|
|
return markdownRegex.test(desc);
|
|
})) {
|
|
const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);
|
|
utils.reportJSDoc('You have unescaped Markdown backtick sequences', {
|
|
line
|
|
}, () => {}, true);
|
|
return;
|
|
}
|
|
for (const tag of jsdoc.tags) {
|
|
if ( /** @type {string[]} */utils.getTagDescription(tag, true).some(desc => {
|
|
return markdownRegex.test(desc);
|
|
})) {
|
|
const line = utils.setTagDescription(tag, markdownRegex, markdownReplacer) + tag.source[0].number;
|
|
utils.reportJSDoc('You have unescaped Markdown backtick sequences in a tag', {
|
|
line
|
|
}, () => {}, true);
|
|
}
|
|
}
|
|
}, {
|
|
iterateAllJsdocs: true,
|
|
meta: {
|
|
docs: {
|
|
description: '',
|
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header'
|
|
},
|
|
fixable: 'code',
|
|
schema: [{
|
|
additionalProperties: false,
|
|
properties: {
|
|
// Option properties here (or remove the object)
|
|
escapeHTML: {
|
|
type: 'boolean'
|
|
},
|
|
escapeMarkdown: {
|
|
type: 'boolean'
|
|
}
|
|
},
|
|
type: 'object'
|
|
}],
|
|
type: 'suggestion'
|
|
}
|
|
});
|
|
module.exports = exports.default;
|
|
//# sourceMappingURL=textEscaping.cjs.map
|