111 lines
2.5 KiB
JavaScript
Executable file
111 lines
2.5 KiB
JavaScript
Executable file
"use strict";
|
|
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.default = void 0;
|
|
|
|
var _lodash = _interopRequireDefault(require("lodash"));
|
|
|
|
var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc"));
|
|
|
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
|
|
var _default = (0, _iterateJsdoc.default)(({
|
|
context,
|
|
jsdoc,
|
|
report,
|
|
utils
|
|
}) => {
|
|
if (utils.avoidDocs()) {
|
|
return;
|
|
}
|
|
|
|
const {
|
|
exemptNoArguments = false
|
|
} = context.options[0] || {};
|
|
const targetTagName = 'example';
|
|
|
|
const functionExamples = _lodash.default.filter(jsdoc.tags, {
|
|
tag: targetTagName
|
|
});
|
|
|
|
if (!functionExamples.length) {
|
|
if (exemptNoArguments && utils.isIteratingFunction() && !utils.hasParams()) {
|
|
return;
|
|
}
|
|
|
|
utils.reportJSDoc(`Missing JSDoc @${targetTagName} declaration.`, null, () => {
|
|
if (!jsdoc.tags) {
|
|
jsdoc.tags = [];
|
|
}
|
|
|
|
const line = jsdoc.tags.length ? jsdoc.tags[jsdoc.tags.length - 1].line + 1 : 0;
|
|
jsdoc.tags.push({
|
|
description: '',
|
|
line,
|
|
name: '',
|
|
optional: false,
|
|
tag: targetTagName,
|
|
type: ''
|
|
});
|
|
});
|
|
return;
|
|
}
|
|
|
|
functionExamples.forEach(example => {
|
|
const exampleContent = _lodash.default.compact(`${example.name} ${example.description}`.trim().split('\n'));
|
|
|
|
if (!exampleContent.length) {
|
|
report(`Missing JSDoc @${targetTagName} description.`);
|
|
}
|
|
});
|
|
}, {
|
|
contextDefaults: true,
|
|
meta: {
|
|
docs: {
|
|
description: 'Requires that all functions have examples.',
|
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-example'
|
|
},
|
|
fixable: 'code',
|
|
schema: [{
|
|
additionalProperties: false,
|
|
properties: {
|
|
checkConstructors: {
|
|
default: true,
|
|
type: 'boolean'
|
|
},
|
|
checkGetters: {
|
|
default: false,
|
|
type: 'boolean'
|
|
},
|
|
checkSetters: {
|
|
default: false,
|
|
type: 'boolean'
|
|
},
|
|
contexts: {
|
|
items: {
|
|
type: 'string'
|
|
},
|
|
type: 'array'
|
|
},
|
|
exemptedBy: {
|
|
items: {
|
|
type: 'string'
|
|
},
|
|
type: 'array'
|
|
},
|
|
exemptNoArguments: {
|
|
default: false,
|
|
type: 'boolean'
|
|
}
|
|
},
|
|
type: 'object'
|
|
}],
|
|
type: 'suggestion'
|
|
}
|
|
});
|
|
|
|
exports.default = _default;
|
|
module.exports = exports.default;
|
|
//# sourceMappingURL=requireExample.js.map
|