forked from public/fvtt-cthulhu-eternal
128 lines
3.6 KiB
JavaScript
128 lines
3.6 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 }; }
|
|
// eslint-disable-next-line complexity
|
|
var _default = exports.default = (0, _iterateJsdoc.default)(({
|
|
context,
|
|
jsdoc,
|
|
report,
|
|
info: {
|
|
lastIndex
|
|
},
|
|
utils
|
|
}) => {
|
|
const {
|
|
match
|
|
} = context.options[0] || {};
|
|
if (!match) {
|
|
report('Rule `no-restricted-syntax` is missing a `match` option.');
|
|
return;
|
|
}
|
|
const {
|
|
allowName,
|
|
disallowName,
|
|
replacement,
|
|
tags = ['*']
|
|
} = match[( /** @type {import('../iterateJsdoc.js').Integer} */lastIndex)];
|
|
const allowNameRegex = allowName && utils.getRegexFromString(allowName);
|
|
const disallowNameRegex = disallowName && utils.getRegexFromString(disallowName);
|
|
let applicableTags = jsdoc.tags;
|
|
if (!tags.includes('*')) {
|
|
applicableTags = utils.getPresentTags(tags);
|
|
}
|
|
let reported = false;
|
|
for (const tag of applicableTags) {
|
|
const allowed = !allowNameRegex || allowNameRegex.test(tag.name);
|
|
const disallowed = disallowNameRegex && disallowNameRegex.test(tag.name);
|
|
const hasRegex = allowNameRegex || disallowNameRegex;
|
|
if (hasRegex && allowed && !disallowed) {
|
|
continue;
|
|
}
|
|
if (!hasRegex && reported) {
|
|
continue;
|
|
}
|
|
const fixer = () => {
|
|
for (const src of tag.source) {
|
|
if (src.tokens.name) {
|
|
src.tokens.name = src.tokens.name.replace(disallowNameRegex, replacement);
|
|
break;
|
|
}
|
|
}
|
|
};
|
|
let {
|
|
message
|
|
} = match[( /** @type {import('../iterateJsdoc.js').Integer} */lastIndex)];
|
|
if (!message) {
|
|
if (hasRegex) {
|
|
message = disallowed ? `Only allowing names not matching \`${disallowNameRegex}\` but found "${tag.name}".` : `Only allowing names matching \`${allowNameRegex}\` but found "${tag.name}".`;
|
|
} else {
|
|
message = `Prohibited context for "${tag.name}".`;
|
|
}
|
|
}
|
|
utils.reportJSDoc(message, hasRegex ? tag : null,
|
|
// We could match up
|
|
disallowNameRegex && replacement !== undefined ? fixer : null, false, {
|
|
// Could also supply `context`, `comment`, `tags`
|
|
allowName,
|
|
disallowName,
|
|
name: tag.name
|
|
});
|
|
if (!hasRegex) {
|
|
reported = true;
|
|
}
|
|
}
|
|
}, {
|
|
matchContext: true,
|
|
meta: {
|
|
docs: {
|
|
description: 'Reports the name portion of a JSDoc tag if matching or not matching a given regular expression.',
|
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-name.md#repos-sticky-header'
|
|
},
|
|
fixable: 'code',
|
|
schema: [{
|
|
additionalProperties: false,
|
|
properties: {
|
|
match: {
|
|
additionalProperties: false,
|
|
items: {
|
|
properties: {
|
|
allowName: {
|
|
type: 'string'
|
|
},
|
|
comment: {
|
|
type: 'string'
|
|
},
|
|
context: {
|
|
type: 'string'
|
|
},
|
|
disallowName: {
|
|
type: 'string'
|
|
},
|
|
message: {
|
|
type: 'string'
|
|
},
|
|
tags: {
|
|
items: {
|
|
type: 'string'
|
|
},
|
|
type: 'array'
|
|
}
|
|
},
|
|
type: 'object'
|
|
},
|
|
type: 'array'
|
|
}
|
|
},
|
|
required: ['match'],
|
|
type: 'object'
|
|
}],
|
|
type: 'suggestion'
|
|
}
|
|
});
|
|
module.exports = exports.default;
|
|
//# sourceMappingURL=matchName.cjs.map
|