123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128 |
- "use strict";
-
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = void 0;
-
- var _semver = _interopRequireDefault(require("semver"));
-
- var _spdxExpressionParse = _interopRequireDefault(require("spdx-expression-parse"));
-
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc"));
-
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
- var _default = (0, _iterateJsdoc.default)(({
- utils,
- report,
- context
- }) => {
- const options = context.options[0] || {};
- const {
- allowedLicenses = null,
- allowedAuthors = null,
- numericOnlyVariation = false,
- licensePattern = '/([^\n\r]*)/gu'
- } = options;
- utils.forEachPreferredTag('version', (jsdocParameter, targetTagName) => {
- const version = utils.getTagDescription(jsdocParameter).trim();
-
- if (!version) {
- report(`Missing JSDoc @${targetTagName} value.`, null, jsdocParameter);
- } else if (!_semver.default.valid(version)) {
- report(`Invalid JSDoc @${targetTagName}: "${utils.getTagDescription(jsdocParameter)}".`, null, jsdocParameter);
- }
- });
-
- if (numericOnlyVariation) {
- utils.forEachPreferredTag('variation', (jsdocParameter, targetTagName) => {
- const variation = utils.getTagDescription(jsdocParameter).trim();
-
- if (!variation) {
- report(`Missing JSDoc @${targetTagName} value.`, null, jsdocParameter);
- } else if (!Number.isInteger(Number(variation)) || Number(variation) <= 0) {
- report(`Invalid JSDoc @${targetTagName}: "${utils.getTagDescription(jsdocParameter)}".`, null, jsdocParameter);
- }
- });
- }
-
- utils.forEachPreferredTag('since', (jsdocParameter, targetTagName) => {
- const version = utils.getTagDescription(jsdocParameter).trim();
-
- if (!version) {
- report(`Missing JSDoc @${targetTagName} value.`, null, jsdocParameter);
- } else if (!_semver.default.valid(version)) {
- report(`Invalid JSDoc @${targetTagName}: "${utils.getTagDescription(jsdocParameter)}".`, null, jsdocParameter);
- }
- });
- utils.forEachPreferredTag('license', (jsdocParameter, targetTagName) => {
- const licenseRegex = utils.getRegexFromString(licensePattern, 'g');
- const match = utils.getTagDescription(jsdocParameter).match(licenseRegex);
- const license = match && match[1] || match[0];
-
- if (!license.trim()) {
- report(`Missing JSDoc @${targetTagName} value.`, null, jsdocParameter);
- } else if (allowedLicenses) {
- if (allowedLicenses !== true && !allowedLicenses.includes(license)) {
- report(`Invalid JSDoc @${targetTagName}: "${license}"; expected one of ${allowedLicenses.join(', ')}.`, null, jsdocParameter);
- }
- } else {
- try {
- (0, _spdxExpressionParse.default)(license);
- } catch {
- report(`Invalid JSDoc @${targetTagName}: "${license}"; expected SPDX expression: https://spdx.org/licenses/.`, null, jsdocParameter);
- }
- }
- });
- utils.forEachPreferredTag('author', (jsdocParameter, targetTagName) => {
- const author = utils.getTagDescription(jsdocParameter).trim();
-
- if (!author) {
- report(`Missing JSDoc @${targetTagName} value.`, null, jsdocParameter);
- } else if (allowedAuthors && !allowedAuthors.includes(author)) {
- report(`Invalid JSDoc @${targetTagName}: "${utils.getTagDescription(jsdocParameter)}"; expected one of ${allowedAuthors.join(', ')}.`, null, jsdocParameter);
- }
- });
- }, {
- iterateAllJsdocs: true,
- meta: {
- docs: {
- description: 'This rule checks the values for a handful of tags: `@version`, `@since`, `@license` and `@author`.',
- url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-values'
- },
- schema: [{
- additionalProperties: false,
- properties: {
- allowedAuthors: {
- items: {
- type: 'string'
- },
- type: 'array'
- },
- allowedLicenses: {
- anyOf: [{
- items: {
- type: 'string'
- },
- type: 'array'
- }, {
- type: 'boolean'
- }]
- },
- licensePattern: {
- type: 'string'
- },
- numericOnlyVariation: {
- type: 'boolean'
- }
- },
- type: 'object'
- }],
- type: 'suggestion'
- }
- });
-
- exports.default = _default;
- module.exports = exports.default;
- //# sourceMappingURL=checkValues.js.map
|