| 1 |
- {"version":3,"sources":["../../src/rules/requireDescription.js"],"names":["jsdoc","report","utils","targetTagName","getPreferredTagName","functionExamples","_","filter","tags","tag","isEmpty","forEach","example","exampleContent","compact","name","description","trim","split"],"mappings":";;;;;;;AAAA;;AACA;;;;eAEe,2BAAa,gBAItB;AAAA,MAHJA,KAGI,QAHJA,KAGI;AAAA,MAFJC,MAEI,QAFJA,MAEI;AAAA,MADJC,KACI,QADJA,KACI;AACJ,MAAMC,aAAa,GAAGD,KAAK,CAACE,mBAAN,CAA0B,aAA1B,CAAtB;;AAEA,MAAMC,gBAAgB,GAAGC,gBAAEC,MAAF,CAASP,KAAK,CAACQ,IAAf,EAAqB;AAC5CC,IAAAA,GAAG,EAAEN;AADuC,GAArB,CAAzB;;AAIA,MAAIG,gBAAEI,OAAF,CAAUL,gBAAV,CAAJ,EAAiC;AAC/B,WAAOJ,MAAM,CAAC,oBAAoBE,aAApB,GAAoC,eAArC,CAAb;AACD;;AAED,SAAOG,gBAAEK,OAAF,CAAUN,gBAAV,EAA4B,UAACO,OAAD,EAAa;AAC9C,QAAMC,cAAc,GAAGP,gBAAEQ,OAAF,CAAU,CAACF,OAAO,CAACG,IAAR,GAAe,GAAf,GAAqBH,OAAO,CAACI,WAA9B,EAA2CC,IAA3C,GAAkDC,KAAlD,CAAwD,IAAxD,CAAV,CAAvB;;AAEA,QAAIZ,gBAAEI,OAAF,CAAUG,cAAV,CAAJ,EAA+B;AAC7BZ,MAAAA,MAAM,CAAC,oBAAoBE,aAApB,GAAoC,eAArC,CAAN;AACD;AACF,GANM,CAAP;AAOD,CAtBc,C","sourcesContent":["import _ from 'lodash';\nimport iterateJsdoc from '../iterateJsdoc';\n\nexport default iterateJsdoc(({\n jsdoc,\n report,\n utils\n}) => {\n const targetTagName = utils.getPreferredTagName('description');\n\n const functionExamples = _.filter(jsdoc.tags, {\n tag: targetTagName\n });\n\n if (_.isEmpty(functionExamples)) {\n return report('Missing JSDoc @' + targetTagName + ' declaration.');\n }\n\n return _.forEach(functionExamples, (example) => {\n const exampleContent = _.compact((example.name + ' ' + example.description).trim().split('\\n'));\n\n if (_.isEmpty(exampleContent)) {\n report('Missing JSDoc @' + targetTagName + ' description.');\n }\n });\n});\n"],"file":"requireDescription.js"}
|
