forked from public/fvtt-cthulhu-eternal
116 lines
3.7 KiB
JavaScript
116 lines
3.7 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 }; }
|
|
/**
|
|
* @param {string} targetTagName
|
|
* @param {boolean} enableFixer
|
|
* @param {import('comment-parser').Block} jsdoc
|
|
* @param {import('../iterateJsdoc.js').Utils} utils
|
|
* @returns {boolean}
|
|
*/
|
|
const validatePropertyNames = (targetTagName, enableFixer, jsdoc, utils) => {
|
|
const propertyTags = Object.entries(jsdoc.tags).filter(([, tag]) => {
|
|
return tag.tag === targetTagName;
|
|
});
|
|
return propertyTags.some(([, tag], index) => {
|
|
/** @type {import('../iterateJsdoc.js').Integer} */
|
|
let tagsIndex;
|
|
const dupeTagInfo = propertyTags.find(([tgsIndex, tg], idx) => {
|
|
tagsIndex = Number(tgsIndex);
|
|
return tg.name === tag.name && idx !== index;
|
|
});
|
|
if (dupeTagInfo) {
|
|
utils.reportJSDoc(`Duplicate @${targetTagName} "${tag.name}"`, dupeTagInfo[1], enableFixer ? () => {
|
|
utils.removeTag(tagsIndex);
|
|
} : null);
|
|
return true;
|
|
}
|
|
return false;
|
|
});
|
|
};
|
|
|
|
/**
|
|
* @param {string} targetTagName
|
|
* @param {{
|
|
* idx: number;
|
|
* name: string;
|
|
* type: string;
|
|
* }[]} jsdocPropertyNames
|
|
* @param {import('comment-parser').Block} jsdoc
|
|
* @param {Function} report
|
|
*/
|
|
const validatePropertyNamesDeep = (targetTagName, jsdocPropertyNames, jsdoc, report) => {
|
|
/** @type {string} */
|
|
let lastRealProperty;
|
|
return jsdocPropertyNames.some(({
|
|
name: jsdocPropertyName,
|
|
idx
|
|
}) => {
|
|
const isPropertyPath = jsdocPropertyName.includes('.');
|
|
if (isPropertyPath) {
|
|
if (!lastRealProperty) {
|
|
report(`@${targetTagName} path declaration ("${jsdocPropertyName}") appears before any real property.`, null, jsdoc.tags[idx]);
|
|
return true;
|
|
}
|
|
let pathRootNodeName = jsdocPropertyName.slice(0, jsdocPropertyName.indexOf('.'));
|
|
if (pathRootNodeName.endsWith('[]')) {
|
|
pathRootNodeName = pathRootNodeName.slice(0, -2);
|
|
}
|
|
if (pathRootNodeName !== lastRealProperty) {
|
|
report(`@${targetTagName} path declaration ("${jsdocPropertyName}") root node name ("${pathRootNodeName}") ` + `does not match previous real property name ("${lastRealProperty}").`, null, jsdoc.tags[idx]);
|
|
return true;
|
|
}
|
|
} else {
|
|
lastRealProperty = jsdocPropertyName;
|
|
}
|
|
return false;
|
|
});
|
|
};
|
|
var _default = exports.default = (0, _iterateJsdoc.default)(({
|
|
context,
|
|
jsdoc,
|
|
report,
|
|
utils
|
|
}) => {
|
|
const {
|
|
enableFixer = false
|
|
} = context.options[0] || {};
|
|
const jsdocPropertyNamesDeep = utils.getJsdocTagsDeep('property');
|
|
if (!jsdocPropertyNamesDeep || !jsdocPropertyNamesDeep.length) {
|
|
return;
|
|
}
|
|
const targetTagName = /** @type {string} */utils.getPreferredTagName({
|
|
tagName: 'property'
|
|
});
|
|
const isError = validatePropertyNames(targetTagName, enableFixer, jsdoc, utils);
|
|
if (isError) {
|
|
return;
|
|
}
|
|
validatePropertyNamesDeep(targetTagName, jsdocPropertyNamesDeep, jsdoc, report);
|
|
}, {
|
|
iterateAllJsdocs: true,
|
|
meta: {
|
|
docs: {
|
|
description: 'Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.',
|
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header'
|
|
},
|
|
fixable: 'code',
|
|
schema: [{
|
|
additionalProperties: false,
|
|
properties: {
|
|
enableFixer: {
|
|
type: 'boolean'
|
|
}
|
|
},
|
|
type: 'object'
|
|
}],
|
|
type: 'suggestion'
|
|
}
|
|
});
|
|
module.exports = exports.default;
|
|
//# sourceMappingURL=checkPropertyNames.cjs.map
|