|
1 |
- {"version":3,"sources":["../../src/rules/checkParamNames.js"],"names":["validateParameterNames","targetTagName","allowExtraTrailingParamDocs","checkDestructured","checkRestProperty","checkTypesRegex","disableExtraPropertyReporting","enableFixer","functionParameterNames","jsdoc","_jsdocNode","utils","report","paramTags","Object","entries","tags","filter","tag","paramTagsNonNested","name","includes","dotted","some","index","tagsIndex","dupeTagInfo","find","tgsIndex","tg","idx","reportJSDoc","removeTag","functionParameterName","Array","isArray","type","search","parameterName","names","properties","hasPropertyRest","rests","annotationParamName","undefined","trim","tagName","expectedNames","map","actualNames","paramTag","actualTypes","missingProperties","notCheckingNames","forEach","notCheckingName","startsWith","actualNameIdx","findIndex","actualName","comparePaths","missingIndex","pathDoesNotBeginWith","line","source","number","length","push","tagPlacement","hasMissing","missingProperty","extraProperties","match","prop","split","extraProperty","funcParamName","item","join","validateParameterNamesDeep","_allowExtraTrailingParamDocs","jsdocParameterNames","lastRealParameter","jsdocParameterName","isPropertyPath","pathRootNodeName","slice","indexOf","endsWith","context","jsdocNode","checkTypesPattern","useDefaultObjectProperties","options","getRegexFromString","jsdocParameterNamesDeep","getJsdocTagsDeep","getFunctionParameterNames","getPreferredTagName","isError","meta","docs","description","url","fixable","schema","additionalProperties"],"mappings":";;;;;;;AAAA;;;;AAEA,MAAMA,sBAAsB,GAAG,CAC7BC,aAD6B,EAE7BC,2BAF6B,EAG7BC,iBAH6B,EAI7BC,iBAJ6B,EAK7BC,eAL6B,EAM7BC,6BAN6B,EAO7BC,WAP6B,EAQ7BC,sBAR6B,EAQWC,KARX,EAQkBC,UARlB,EAQ8BC,KAR9B,EAQqCC,MARrC,KAS1B;AACH,QAAMC,SAAS,GAAGC,MAAM,CAACC,OAAP,CAAeN,KAAK,CAACO,IAArB,EAA2BC,MAA3B,CAAkC,CAAC,GAAGC,GAAH,CAAD,KAAa;AAC/D,WAAOA,GAAG,CAACA,GAAJ,KAAYjB,aAAnB;AACD,GAFiB,CAAlB;AAGA,QAAMkB,kBAAkB,GAAGN,SAAS,CAACI,MAAV,CAAiB,CAAC,GAAGC,GAAH,CAAD,KAAa;AACvD,WAAO,CAACA,GAAG,CAACE,IAAJ,CAASC,QAAT,CAAkB,GAAlB,CAAR;AACD,GAF0B,CAA3B;AAIA,MAAIC,MAAM,GAAG,CAAb;AAEA,SAAOT,SAAS,CAACU,IAAV,CAAe,CAAC,GAAGL,GAAH,CAAD,EAAUM,KAAV,KAAoB;AACxC,QAAIC,SAAJ;AACA,UAAMC,WAAW,GAAGb,SAAS,CAACc,IAAV,CAAe,CAAC,CAACC,QAAD,EAAWC,EAAX,CAAD,EAAiBC,GAAjB,KAAyB;AAC1DL,MAAAA,SAAS,GAAGG,QAAZ;AAEA,aAAOC,EAAE,CAACT,IAAH,KAAYF,GAAG,CAACE,IAAhB,IAAwBU,GAAG,KAAKN,KAAvC;AACD,KAJmB,CAApB;;AAKA,QAAIE,WAAJ,EAAiB;AACff,MAAAA,KAAK,CAACoB,WAAN,CAAmB,cAAa9B,aAAc,KAAIiB,GAAG,CAACE,IAAK,GAA3D,EAA+DM,WAAW,CAAC,CAAD,CAA1E,EAA+EnB,WAAW,GAAG,MAAM;AACjGI,QAAAA,KAAK,CAACqB,SAAN,CAAgBP,SAAhB;AACD,OAFyF,GAEtF,IAFJ;AAIA,aAAO,IAAP;AACD;;AACD,QAAIP,GAAG,CAACE,IAAJ,CAASC,QAAT,CAAkB,GAAlB,CAAJ,EAA4B;AAC1BC,MAAAA,MAAM;AAEN,aAAO,KAAP;AACD;;AAED,UAAMW,qBAAqB,GAAGzB,sBAAsB,CAACgB,KAAK,GAAGF,MAAT,CAApD;;AAEA,QAAI,CAACW,qBAAL,EAA4B;AAC1B,UAAI/B,2BAAJ,EAAiC;AAC/B,eAAO,KAAP;AACD;;AAEDU,MAAAA,MAAM,CACH,IAAGX,aAAc,KAAIiB,GAAG,CAACE,IAAK,kDAD3B,EAEJ,IAFI,EAGJF,GAHI,CAAN;AAMA,aAAO,IAAP;AACD;;AAED,QAAIgB,KAAK,CAACC,OAAN,CAAcF,qBAAd,CAAJ,EAA0C;AACxC,UAAI,CAAC9B,iBAAL,EAAwB;AACtB,eAAO,KAAP;AACD;;AACD,UAAIe,GAAG,CAACkB,IAAJ,IAAYlB,GAAG,CAACkB,IAAJ,CAASC,MAAT,CAAgBhC,eAAhB,MAAqC,CAAC,CAAtD,EAAyD;AACvD,eAAO,KAAP;AACD;;AAED,YAAM,CAACiC,aAAD,EAAgB;AACpBC,QAAAA,KAAK,EAAEC,UADa;AACDC,QAAAA,eADC;AACgBC,QAAAA,KADhB;AACuBC,QAAAA;AADvB,OAAhB,IAEDV,qBAFL;;AAGA,UAAIU,mBAAmB,KAAKC,SAA5B,EAAuC;AACrC,cAAMxB,IAAI,GAAGF,GAAG,CAACE,IAAJ,CAASyB,IAAT,EAAb;;AACA,YAAIzB,IAAI,KAAKuB,mBAAb,EAAkC;AAChC/B,UAAAA,MAAM,CAAE,IAAGX,aAAc,KAAImB,IAAK,oCAAmCuB,mBAAoB,GAAnF,EAAuF,IAAvF,EAA6FzB,GAA7F,CAAN;AACD;AACF;;AACD,YAAM4B,OAAO,GAAGR,aAAa,KAAKM,SAAlB,GAA8B1B,GAAG,CAACE,IAAJ,CAASyB,IAAT,EAA9B,GAAgDP,aAAhE;AACA,YAAMS,aAAa,GAAGP,UAAU,CAACQ,GAAX,CAAgB5B,IAAD,IAAU;AAC7C,eAAQ,GAAE0B,OAAQ,IAAG1B,IAAK,EAA1B;AACD,OAFqB,CAAtB;AAGA,YAAM6B,WAAW,GAAGpC,SAAS,CAACmC,GAAV,CAAc,CAAC,GAAGE,QAAH,CAAD,KAAkB;AAClD,eAAOA,QAAQ,CAAC9B,IAAT,CAAcyB,IAAd,EAAP;AACD,OAFmB,CAApB;AAGA,YAAMM,WAAW,GAAGtC,SAAS,CAACmC,GAAV,CAAc,CAAC,GAAGE,QAAH,CAAD,KAAkB;AAClD,eAAOA,QAAQ,CAACd,IAAhB;AACD,OAFmB,CAApB;AAIA,YAAMgB,iBAAiB,GAAG,EAA1B;AACA,YAAMC,gBAAgB,GAAG,EAAzB;AAEAN,MAAAA,aAAa,CAACO,OAAd,CAAsB,CAAClC,IAAD,EAAOU,GAAP,KAAe;AACnC,YAAIuB,gBAAgB,CAAC9B,IAAjB,CAAuBgC,eAAD,IAAqB;AAC7C,iBAAOnC,IAAI,CAACoC,UAAL,CAAgBD,eAAhB,CAAP;AACD,SAFG,CAAJ,EAEI;AACF;AACD;;AACD,cAAME,aAAa,GAAGR,WAAW,CAACS,SAAZ,CAAuBC,UAAD,IAAgB;AAC1D,iBAAOhD,KAAK,CAACiD,YAAN,CAAmBxC,IAAnB,EAAyBuC,UAAzB,CAAP;AACD,SAFqB,CAAtB;;AAGA,YAAIF,aAAa,KAAK,CAAC,CAAvB,EAA0B;AACxB,cAAI,CAACrD,iBAAD,IAAsBsC,KAAK,CAACZ,GAAD,CAA/B,EAAsC;AACpC;AACD;;AACD,gBAAM+B,YAAY,GAAGZ,WAAW,CAACS,SAAZ,CAAuBC,UAAD,IAAgB;AACzD,mBAAOhD,KAAK,CAACmD,oBAAN,CAA2B1C,IAA3B,EAAiCuC,UAAjC,CAAP;AACD,WAFoB,CAArB;AAGA,gBAAMI,IAAI,GAAG7C,GAAG,CAAC8C,MAAJ,CAAW,CAAX,EAAcC,MAAd,GAAuB,CAAvB,IAA4BJ,YAAY,GAAG,CAAC,CAAhB,GAAoBA,YAApB,GAAmCZ,WAAW,CAACiB,MAA3E,CAAb;AACAd,UAAAA,iBAAiB,CAACe,IAAlB,CAAuB;AACrB/C,YAAAA,IADqB;AAErBgD,YAAAA,YAAY,EAAE;AACZL,cAAAA,IAAI,EAAEA,IAAI,KAAK,CAAT,GAAa,CAAb,GAAiBA;AADX;AAFO,WAAvB;AAMD,SAdD,MAcO,IAAIZ,WAAW,CAACM,aAAD,CAAX,CAA2BpB,MAA3B,CAAkChC,eAAlC,MAAuD,CAAC,CAAxD,IAA6D8C,WAAW,CAACM,aAAD,CAAX,KAA+B,EAAhG,EAAoG;AACzGJ,UAAAA,gBAAgB,CAACc,IAAjB,CAAsB/C,IAAtB;AACD;AACF,OA1BD;AA4BA,YAAMiD,UAAU,GAAGjB,iBAAiB,CAACc,MAArC;;AACA,UAAIG,UAAJ,EAAgB;AACdjB,QAAAA,iBAAiB,CAACE,OAAlB,CAA0B,CAAC;AAACc,UAAAA,YAAD;AAAehD,UAAAA,IAAI,EAAEkD;AAArB,SAAD,KAA2C;AACnE1D,UAAAA,MAAM,CAAE,YAAWX,aAAc,KAAIqE,eAAgB,GAA/C,EAAmD,IAAnD,EAAyDF,YAAzD,CAAN;AACD,SAFD;AAGD;;AAED,UAAI,CAAC3B,eAAD,IAAoBrC,iBAAxB,EAA2C;AACzC,cAAMmE,eAAe,GAAG,EAAxB;AACAtB,QAAAA,WAAW,CAACK,OAAZ,CAAoB,CAAClC,IAAD,EAAOU,GAAP,KAAe;AACjC,gBAAM0C,KAAK,GAAGpD,IAAI,CAACoC,UAAL,CAAgBtC,GAAG,CAACE,IAAJ,CAASyB,IAAT,KAAkB,GAAlC,CAAd;;AACA,cACE2B,KAAK,IAAI,CAACzB,aAAa,CAACxB,IAAd,CACRZ,KAAK,CAACiD,YAAN,CAAmBxC,IAAnB,CADQ,CAAV,IAEK,CAACT,KAAK,CAACiD,YAAN,CAAmBxC,IAAnB,EAAyBF,GAAG,CAACE,IAA7B,CAFN,KAGC,CAACd,6BAAD,IAAkCkC,UAAU,CAACjB,IAAX,CAAiBkD,IAAD,IAAU;AAC3D,mBAAOA,IAAI,CAACC,KAAL,CAAW,GAAX,EAAgBR,MAAhB,IAA0B9C,IAAI,CAACsD,KAAL,CAAW,GAAX,EAAgBR,MAAhB,GAAyB,CAA1D;AACD,WAFkC,CAHnC,CADF,EAOE;AACAK,YAAAA,eAAe,CAACJ,IAAhB,CAAqB,CAAC/C,IAAD,EAAOP,SAAS,CAACiB,GAAD,CAAT,CAAe,CAAf,CAAP,CAArB;AACD;AACF,SAZD;;AAaA,YAAIyC,eAAe,CAACL,MAApB,EAA4B;AAC1BK,UAAAA,eAAe,CAACjB,OAAhB,CAAwB,CAAC,CAACqB,aAAD,EAAgB9C,EAAhB,CAAD,KAAyB;AAC/CjB,YAAAA,MAAM,CAAE,IAAGX,aAAc,KAAI0E,aAAc,uBAAsBzD,GAAG,CAACE,IAAK,EAApE,EAAuE,IAAvE,EAA6ES,EAA7E,CAAN;AACD,WAFD;AAIA,iBAAO,IAAP;AACD;AACF;;AAED,aAAOwC,UAAP;AACD;;AAED,QAAIO,aAAJ;;AACA,QAAI,OAAO3C,qBAAP,KAAiC,QAArC,EAA+C;AAC7C,YAAM;AAACb,QAAAA;AAAD,UAASa,qBAAf;AACA2C,MAAAA,aAAa,GAAGxD,IAAhB;AACD,KAHD,MAGO;AACLwD,MAAAA,aAAa,GAAG3C,qBAAhB;AACD;;AAED,QAAI2C,aAAa,KAAK1D,GAAG,CAACE,IAAJ,CAASyB,IAAT,EAAtB,EAAuC;AACrC;AACA,YAAMI,WAAW,GAAG9B,kBAAkB,CAAC6B,GAAnB,CAAuB,CAAC,GAAG;AAAC5B,QAAAA;AAAD,OAAH,CAAD,KAAgB;AACzD,eAAOA,IAAI,CAACyB,IAAL,EAAP;AACD,OAFmB,CAApB;AAGA,YAAME,aAAa,GAAGvC,sBAAsB,CAACwC,GAAvB,CAA2B,CAAC6B,IAAD,EAAO/C,GAAP,KAAe;AAAA;;AAC9D,YAAI+C,IAAJ,aAAIA,IAAJ,yBAAIA,IAAI,CAAG,CAAH,CAAR,mCAAI,OAAWtC,KAAf,EAAsB;AACpB,iBAAOU,WAAW,CAACnB,GAAD,CAAlB;AACD;;AAED,eAAO+C,IAAP;AACD,OANqB,EAMnBC,IANmB,CAMd,IANc,CAAtB;AAQAlE,MAAAA,MAAM,CACH,aAAYX,aAAc,iBAAgB8C,aAAc,WAAUE,WAAW,CAAC6B,IAAZ,CAAiB,IAAjB,CAAuB,IADtF,EAEJ,IAFI,EAGJ5D,GAHI,CAAN;AAMA,aAAO,IAAP;AACD;;AAED,WAAO,KAAP;AACD,GAhKM,CAAP;AAiKD,CApLD;;AAsLA,MAAM6D,0BAA0B,GAAG,CACjC9E,aADiC,EACT+E,4BADS,EAEjCC,mBAFiC,EAEIxE,KAFJ,EAEWG,MAFX,KAG9B;AACH,MAAIsE,iBAAJ;AAEA,SAAOD,mBAAmB,CAAC1D,IAApB,CAAyB,CAAC;AAACH,IAAAA,IAAI,EAAE+D,kBAAP;AAA2BrD,IAAAA;AAA3B,GAAD,KAAqC;AACnE,UAAMsD,cAAc,GAAGD,kBAAkB,CAAC9D,QAAnB,CAA4B,GAA5B,CAAvB;;AAEA,QAAI+D,cAAJ,EAAoB;AAClB,UAAI,CAACF,iBAAL,EAAwB;AACtBtE,QAAAA,MAAM,CAAE,IAAGX,aAAc,uBAAsBkF,kBAAmB,uCAA5D,EAAoG,IAApG,EAA0G1E,KAAK,CAACO,IAAN,CAAWc,GAAX,CAA1G,CAAN;AAEA,eAAO,IAAP;AACD;;AAED,UAAIuD,gBAAgB,GAAGF,kBAAkB,CAACG,KAAnB,CAAyB,CAAzB,EAA4BH,kBAAkB,CAACI,OAAnB,CAA2B,GAA3B,CAA5B,CAAvB;;AAEA,UAAIF,gBAAgB,CAACG,QAAjB,CAA0B,IAA1B,CAAJ,EAAqC;AACnCH,QAAAA,gBAAgB,GAAGA,gBAAgB,CAACC,KAAjB,CAAuB,CAAvB,EAA0B,CAAC,CAA3B,CAAnB;AACD;;AAED,UAAID,gBAAgB,KAAKH,iBAAzB,EAA4C;AAC1CtE,QAAAA,MAAM,CACH,IAAGX,aAAc,uBAAsBkF,kBAAmB,uBAAsBE,gBAAiB,KAAlG,GACC,iDAAgDH,iBAAkB,KAF/D,EAGJ,IAHI,EAIJzE,KAAK,CAACO,IAAN,CAAWc,GAAX,CAJI,CAAN;AAOA,eAAO,IAAP;AACD;AACF,KAvBD,MAuBO;AACLoD,MAAAA,iBAAiB,GAAGC,kBAApB;AACD;;AAED,WAAO,KAAP;AACD,GA/BM,CAAP;AAgCD,CAtCD;;eAwCe,2BAAa,CAAC;AAC3BM,EAAAA,OAD2B;AAE3BhF,EAAAA,KAF2B;AAG3BiF,EAAAA,SAH2B;AAI3B9E,EAAAA,MAJ2B;AAK3BD,EAAAA;AAL2B,CAAD,KAMtB;AACJ,QAAM;AACJT,IAAAA,2BADI;AAEJC,IAAAA,iBAAiB,GAAG,IAFhB;AAGJC,IAAAA,iBAAiB,GAAG,KAHhB;AAIJuF,IAAAA,iBAAiB,GAAG,gEAJhB;AAKJpF,IAAAA,WAAW,GAAG,KALV;AAMJqF,IAAAA,0BAA0B,GAAG,KANzB;AAOJtF,IAAAA,6BAA6B,GAAG;AAP5B,MAQFmF,OAAO,CAACI,OAAR,CAAgB,CAAhB,KAAsB,EAR1B;AAUA,QAAMxF,eAAe,GAAGM,KAAK,CAACmF,kBAAN,CAAyBH,iBAAzB,CAAxB;AAEA,QAAMI,uBAAuB,GAAGpF,KAAK,CAACqF,gBAAN,CAAuB,OAAvB,CAAhC;;AACA,MAAI,CAACD,uBAAuB,CAAC7B,MAA7B,EAAqC;AACnC;AACD;;AACD,QAAM1D,sBAAsB,GAAGG,KAAK,CAACsF,yBAAN,CAAgCL,0BAAhC,CAA/B;AACA,QAAM3F,aAAa,GAAGU,KAAK,CAACuF,mBAAN,CAA0B;AAACpD,IAAAA,OAAO,EAAE;AAAV,GAA1B,CAAtB;AACA,QAAMqD,OAAO,GAAGnG,sBAAsB,CACpCC,aADoC,EAEpCC,2BAFoC,EAGpCC,iBAHoC,EAIpCC,iBAJoC,EAKpCC,eALoC,EAMpCC,6BANoC,EAOpCC,WAPoC,EAQpCC,sBARoC,EASpCC,KAToC,EAS7BiF,SAT6B,EASlB/E,KATkB,EASXC,MATW,CAAtC;;AAYA,MAAIuF,OAAO,IAAI,CAAChG,iBAAhB,EAAmC;AACjC;AACD;;AAED4E,EAAAA,0BAA0B,CACxB9E,aADwB,EACTC,2BADS,EAExB6F,uBAFwB,EAGxBtF,KAHwB,EAGjBG,MAHiB,CAA1B;AAKD,CA9Cc,EA8CZ;AACDwF,EAAAA,IAAI,EAAE;AACJC,IAAAA,IAAI,EAAE;AACJC,MAAAA,WAAW,EAAE,gFADT;AAEJC,MAAAA,GAAG,EAAE;AAFD,KADF;AAKJC,IAAAA,OAAO,EAAE,MALL;AAMJC,IAAAA,MAAM,EAAE,CACN;AACEC,MAAAA,oBAAoB,EAAE,KADxB;AAEElE,MAAAA,UAAU,EAAE;AACVtC,QAAAA,2BAA2B,EAAE;AAC3BkC,UAAAA,IAAI,EAAE;AADqB,SADnB;AAIVjC,QAAAA,iBAAiB,EAAE;AACjBiC,UAAAA,IAAI,EAAE;AADW,SAJT;AAOVhC,QAAAA,iBAAiB,EAAE;AACjBgC,UAAAA,IAAI,EAAE;AADW,SAPT;AAUVuD,QAAAA,iBAAiB,EAAE;AACjBvD,UAAAA,IAAI,EAAE;AADW,SAVT;AAaV9B,QAAAA,6BAA6B,EAAE;AAC7B8B,UAAAA,IAAI,EAAE;AADuB,SAbrB;AAgBV7B,QAAAA,WAAW,EAAE;AACX6B,UAAAA,IAAI,EAAE;AADK,SAhBH;AAmBVwD,QAAAA,0BAA0B,EAAE;AAC1BxD,UAAAA,IAAI,EAAE;AADoB;AAnBlB,OAFd;AAyBEA,MAAAA,IAAI,EAAE;AAzBR,KADM,CANJ;AAmCJA,IAAAA,IAAI,EAAE;AAnCF;AADL,CA9CY,C","sourcesContent":["import iterateJsdoc from '../iterateJsdoc';\n\nconst validateParameterNames = (\n targetTagName : string,\n allowExtraTrailingParamDocs: boolean,\n checkDestructured : boolean,\n checkRestProperty : boolean,\n checkTypesRegex : RegExp,\n disableExtraPropertyReporting,\n enableFixer: boolean,\n functionParameterNames : Array<string>, jsdoc, _jsdocNode, utils, report,\n) => {\n const paramTags = Object.entries(jsdoc.tags).filter(([, tag]) => {\n return tag.tag === targetTagName;\n });\n const paramTagsNonNested = paramTags.filter(([, tag]) => {\n return !tag.name.includes('.');\n });\n\n let dotted = 0;\n\n return paramTags.some(([, tag], index) => {\n let tagsIndex;\n const dupeTagInfo = paramTags.find(([tgsIndex, tg], idx) => {\n tagsIndex = tgsIndex;\n\n return tg.name === tag.name && idx !== index;\n });\n if (dupeTagInfo) {\n utils.reportJSDoc(`Duplicate @${targetTagName} \"${tag.name}\"`, dupeTagInfo[1], enableFixer ? () => {\n utils.removeTag(tagsIndex);\n } : null);\n\n return true;\n }\n if (tag.name.includes('.')) {\n dotted++;\n\n return false;\n }\n\n const functionParameterName = functionParameterNames[index - dotted];\n\n if (!functionParameterName) {\n if (allowExtraTrailingParamDocs) {\n return false;\n }\n\n report(\n `@${targetTagName} \"${tag.name}\" does not match an existing function parameter.`,\n null,\n tag,\n );\n\n return true;\n }\n\n if (Array.isArray(functionParameterName)) {\n if (!checkDestructured) {\n return false;\n }\n if (tag.type && tag.type.search(checkTypesRegex) === -1) {\n return false;\n }\n\n const [parameterName, {\n names: properties, hasPropertyRest, rests, annotationParamName,\n }] = functionParameterName;\n if (annotationParamName !== undefined) {\n const name = tag.name.trim();\n if (name !== annotationParamName) {\n report(`@${targetTagName} \"${name}\" does not match parameter name \"${annotationParamName}\"`, null, tag);\n }\n }\n const tagName = parameterName === undefined ? tag.name.trim() : parameterName;\n const expectedNames = properties.map((name) => {\n return `${tagName}.${name}`;\n });\n const actualNames = paramTags.map(([, paramTag]) => {\n return paramTag.name.trim();\n });\n const actualTypes = paramTags.map(([, paramTag]) => {\n return paramTag.type;\n });\n\n const missingProperties = [];\n const notCheckingNames = [];\n\n expectedNames.forEach((name, idx) => {\n if (notCheckingNames.some((notCheckingName) => {\n return name.startsWith(notCheckingName);\n })) {\n return;\n }\n const actualNameIdx = actualNames.findIndex((actualName) => {\n return utils.comparePaths(name)(actualName);\n });\n if (actualNameIdx === -1) {\n if (!checkRestProperty && rests[idx]) {\n return;\n }\n const missingIndex = actualNames.findIndex((actualName) => {\n return utils.pathDoesNotBeginWith(name, actualName);\n });\n const line = tag.source[0].number - 1 + (missingIndex > -1 ? missingIndex : actualNames.length);\n missingProperties.push({\n name,\n tagPlacement: {\n line: line === 0 ? 1 : line,\n },\n });\n } else if (actualTypes[actualNameIdx].search(checkTypesRegex) === -1 && actualTypes[actualNameIdx] !== '') {\n notCheckingNames.push(name);\n }\n });\n\n const hasMissing = missingProperties.length;\n if (hasMissing) {\n missingProperties.forEach(({tagPlacement, name: missingProperty}) => {\n report(`Missing @${targetTagName} \"${missingProperty}\"`, null, tagPlacement);\n });\n }\n\n if (!hasPropertyRest || checkRestProperty) {\n const extraProperties = [];\n actualNames.forEach((name, idx) => {\n const match = name.startsWith(tag.name.trim() + '.');\n if (\n match && !expectedNames.some(\n utils.comparePaths(name),\n ) && !utils.comparePaths(name)(tag.name) &&\n (!disableExtraPropertyReporting || properties.some((prop) => {\n return prop.split('.').length >= name.split('.').length - 1;\n }))\n ) {\n extraProperties.push([name, paramTags[idx][1]]);\n }\n });\n if (extraProperties.length) {\n extraProperties.forEach(([extraProperty, tg]) => {\n report(`@${targetTagName} \"${extraProperty}\" does not exist on ${tag.name}`, null, tg);\n });\n\n return true;\n }\n }\n\n return hasMissing;\n }\n\n let funcParamName;\n if (typeof functionParameterName === 'object') {\n const {name} = functionParameterName;\n funcParamName = name;\n } else {\n funcParamName = functionParameterName;\n }\n\n if (funcParamName !== tag.name.trim()) {\n // Todo: Improve for array or object child items\n const actualNames = paramTagsNonNested.map(([, {name}]) => {\n return name.trim();\n });\n const expectedNames = functionParameterNames.map((item, idx) => {\n if (item?.[1]?.names) {\n return actualNames[idx];\n }\n\n return item;\n }).join(', ');\n\n report(\n `Expected @${targetTagName} names to be \"${expectedNames}\". Got \"${actualNames.join(', ')}\".`,\n null,\n tag,\n );\n\n return true;\n }\n\n return false;\n });\n};\n\nconst validateParameterNamesDeep = (\n targetTagName : string, _allowExtraTrailingParamDocs: boolean,\n jsdocParameterNames : Array<string>, jsdoc, report : Function,\n) => {\n let lastRealParameter;\n\n return jsdocParameterNames.some(({name: jsdocParameterName, idx}) => {\n const isPropertyPath = jsdocParameterName.includes('.');\n\n if (isPropertyPath) {\n if (!lastRealParameter) {\n report(`@${targetTagName} path declaration (\"${jsdocParameterName}\") appears before any real parameter.`, null, jsdoc.tags[idx]);\n\n return true;\n }\n\n let pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.'));\n\n if (pathRootNodeName.endsWith('[]')) {\n pathRootNodeName = pathRootNodeName.slice(0, -2);\n }\n\n if (pathRootNodeName !== lastRealParameter) {\n report(\n `@${targetTagName} path declaration (\"${jsdocParameterName}\") root node name (\"${pathRootNodeName}\") ` +\n `does not match previous real parameter name (\"${lastRealParameter}\").`,\n null,\n jsdoc.tags[idx],\n );\n\n return true;\n }\n } else {\n lastRealParameter = jsdocParameterName;\n }\n\n return false;\n });\n};\n\nexport default iterateJsdoc(({\n context,\n jsdoc,\n jsdocNode,\n report,\n utils,\n}) => {\n const {\n allowExtraTrailingParamDocs,\n checkDestructured = true,\n checkRestProperty = false,\n checkTypesPattern = '/^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$/',\n enableFixer = false,\n useDefaultObjectProperties = false,\n disableExtraPropertyReporting = false,\n } = context.options[0] || {};\n\n const checkTypesRegex = utils.getRegexFromString(checkTypesPattern);\n\n const jsdocParameterNamesDeep = utils.getJsdocTagsDeep('param');\n if (!jsdocParameterNamesDeep.length) {\n return;\n }\n const functionParameterNames = utils.getFunctionParameterNames(useDefaultObjectProperties);\n const targetTagName = utils.getPreferredTagName({tagName: 'param'});\n const isError = validateParameterNames(\n targetTagName,\n allowExtraTrailingParamDocs,\n checkDestructured,\n checkRestProperty,\n checkTypesRegex,\n disableExtraPropertyReporting,\n enableFixer,\n functionParameterNames,\n jsdoc, jsdocNode, utils, report,\n );\n\n if (isError || !checkDestructured) {\n return;\n }\n\n validateParameterNamesDeep(\n targetTagName, allowExtraTrailingParamDocs,\n jsdocParameterNamesDeep,\n jsdoc, report,\n );\n}, {\n meta: {\n docs: {\n description: 'Ensures that parameter names in JSDoc match those in the function declaration.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n allowExtraTrailingParamDocs: {\n type: 'boolean',\n },\n checkDestructured: {\n type: 'boolean',\n },\n checkRestProperty: {\n type: 'boolean',\n },\n checkTypesPattern: {\n type: 'string',\n },\n disableExtraPropertyReporting: {\n type: 'boolean',\n },\n enableFixer: {\n type: 'boolean',\n },\n useDefaultObjectProperties: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"file":"checkParamNames.js"}
|
