"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.default = void 0; var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc")); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } const validateParameterNames = (targetTagName, allowExtraTrailingParamDocs, checkDestructured, checkRestProperty, checkTypesRegex, disableExtraPropertyReporting, enableFixer, functionParameterNames, jsdoc, _jsdocNode, utils, report) => { const paramTags = Object.entries(jsdoc.tags).filter(([, tag]) => { return tag.tag === targetTagName; }); const paramTagsNonNested = paramTags.filter(([, tag]) => { return !tag.name.includes('.'); }); let dotted = 0; return paramTags.some(([, tag], index) => { let tagsIndex; const dupeTagInfo = paramTags.find(([tgsIndex, tg], idx) => { tagsIndex = 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; } if (tag.name.includes('.')) { dotted++; return false; } const functionParameterName = functionParameterNames[index - dotted]; if (!functionParameterName) { if (allowExtraTrailingParamDocs) { return false; } report(`@${targetTagName} "${tag.name}" does not match an existing function parameter.`, null, tag); return true; } if (Array.isArray(functionParameterName)) { if (!checkDestructured) { return false; } if (tag.type && tag.type.search(checkTypesRegex) === -1) { return false; } const [parameterName, { names: properties, hasPropertyRest, rests, annotationParamName }] = functionParameterName; if (annotationParamName !== undefined) { const name = tag.name.trim(); if (name !== annotationParamName) { report(`@${targetTagName} "${name}" does not match parameter name "${annotationParamName}"`, null, tag); } } const tagName = parameterName === undefined ? tag.name.trim() : parameterName; const expectedNames = properties.map(name => { return `${tagName}.${name}`; }); const actualNames = paramTags.map(([, paramTag]) => { return paramTag.name.trim(); }); const actualTypes = paramTags.map(([, paramTag]) => { return paramTag.type; }); const missingProperties = []; const notCheckingNames = []; expectedNames.forEach((name, idx) => { if (notCheckingNames.some(notCheckingName => { return name.startsWith(notCheckingName); })) { return; } const actualNameIdx = actualNames.findIndex(actualName => { return utils.comparePaths(name)(actualName); }); if (actualNameIdx === -1) { if (!checkRestProperty && rests[idx]) { return; } const missingIndex = actualNames.findIndex(actualName => { return utils.pathDoesNotBeginWith(name, actualName); }); const line = tag.source[0].number - 1 + (missingIndex > -1 ? missingIndex : actualNames.length); missingProperties.push({ name, tagPlacement: { line: line === 0 ? 1 : line } }); } else if (actualTypes[actualNameIdx].search(checkTypesRegex) === -1 && actualTypes[actualNameIdx] !== '') { notCheckingNames.push(name); } }); const hasMissing = missingProperties.length; if (hasMissing) { missingProperties.forEach(({ tagPlacement, name: missingProperty }) => { report(`Missing @${targetTagName} "${missingProperty}"`, null, tagPlacement); }); } if (!hasPropertyRest || checkRestProperty) { const extraProperties = []; actualNames.forEach((name, idx) => { const match = name.startsWith(tag.name.trim() + '.'); if (match && !expectedNames.some(utils.comparePaths(name)) && !utils.comparePaths(name)(tag.name) && (!disableExtraPropertyReporting || properties.some(prop => { return prop.split('.').length >= name.split('.').length - 1; }))) { extraProperties.push([name, paramTags[idx][1]]); } }); if (extraProperties.length) { extraProperties.forEach(([extraProperty, tg]) => { report(`@${targetTagName} "${extraProperty}" does not exist on ${tag.name}`, null, tg); }); return true; } } return hasMissing; } let funcParamName; if (typeof functionParameterName === 'object') { const { name } = functionParameterName; funcParamName = name; } else { funcParamName = functionParameterName; } if (funcParamName !== tag.name.trim()) { // Todo: Improve for array or object child items const actualNames = paramTagsNonNested.map(([, { name }]) => { return name.trim(); }); const expectedNames = functionParameterNames.map((item, idx) => { var _item$; if (item !== null && item !== void 0 && (_item$ = item[1]) !== null && _item$ !== void 0 && _item$.names) { return actualNames[idx]; } return item; }).join(', '); report(`Expected @${targetTagName} names to be "${expectedNames}". Got "${actualNames.join(', ')}".`, null, tag); return true; } return false; }); }; const validateParameterNamesDeep = (targetTagName, _allowExtraTrailingParamDocs, jsdocParameterNames, jsdoc, report) => { let lastRealParameter; return jsdocParameterNames.some(({ name: jsdocParameterName, idx }) => { const isPropertyPath = jsdocParameterName.includes('.'); if (isPropertyPath) { if (!lastRealParameter) { report(`@${targetTagName} path declaration ("${jsdocParameterName}") appears before any real parameter.`, null, jsdoc.tags[idx]); return true; } let pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.')); if (pathRootNodeName.endsWith('[]')) { pathRootNodeName = pathRootNodeName.slice(0, -2); } if (pathRootNodeName !== lastRealParameter) { report(`@${targetTagName} path declaration ("${jsdocParameterName}") root node name ("${pathRootNodeName}") ` + `does not match previous real parameter name ("${lastRealParameter}").`, null, jsdoc.tags[idx]); return true; } } else { lastRealParameter = jsdocParameterName; } return false; }); }; var _default = (0, _iterateJsdoc.default)(({ context, jsdoc, jsdocNode, report, utils }) => { const { allowExtraTrailingParamDocs, checkDestructured = true, checkRestProperty = false, checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/', enableFixer = false, useDefaultObjectProperties = false, disableExtraPropertyReporting = false } = context.options[0] || {}; const checkTypesRegex = utils.getRegexFromString(checkTypesPattern); const jsdocParameterNamesDeep = utils.getJsdocTagsDeep('param'); if (!jsdocParameterNamesDeep.length) { return; } const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties); const targetTagName = utils.getPreferredTagName({ tagName: 'param' }); const isError = validateParameterNames(targetTagName, allowExtraTrailingParamDocs, checkDestructured, checkRestProperty, checkTypesRegex, disableExtraPropertyReporting, enableFixer, functionParameterNames, jsdoc, jsdocNode, utils, report); if (isError || !checkDestructured) { return; } validateParameterNamesDeep(targetTagName, allowExtraTrailingParamDocs, jsdocParameterNamesDeep, jsdoc, report); }, { meta: { docs: { description: 'Ensures that parameter names in JSDoc match those in the function declaration.', url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names' }, fixable: 'code', schema: [{ additionalProperties: false, properties: { allowExtraTrailingParamDocs: { type: 'boolean' }, checkDestructured: { type: 'boolean' }, checkRestProperty: { type: 'boolean' }, checkTypesPattern: { type: 'string' }, disableExtraPropertyReporting: { type: 'boolean' }, enableFixer: { type: 'boolean' }, useDefaultObjectProperties: { type: 'boolean' } }, type: 'object' }], type: 'suggestion' } }); exports.default = _default; module.exports = exports.default; //# sourceMappingURL=checkParamNames.js.map