123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = void 0;
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.js"));
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
- const middleAsterisksBlockWS = /^([\t ]|\*(?!\*))+/u;
- const middleAsterisksNoBlockWS = /^\*+/u;
- const endAsterisksSingleLineBlockWS = /\*((?:\*|(?: |\t))*)\*$/u;
- const endAsterisksMultipleLineBlockWS = /((?:\*|(?: |\t))*)\*$/u;
- const endAsterisksSingleLineNoBlockWS = /\*(\**)\*$/u;
- const endAsterisksMultipleLineNoBlockWS = /(\**)\*$/u;
- var _default = exports.default = (0, _iterateJsdoc.default)(({
- context,
- jsdoc,
- utils
- }) => {
- const {
- allowWhitespace = false,
- preventAtEnd = true,
- preventAtMiddleLines = true
- } = context.options[0] || {};
- const middleAsterisks = allowWhitespace ? middleAsterisksNoBlockWS : middleAsterisksBlockWS;
- // eslint-disable-next-line complexity -- Todo
- jsdoc.source.some(({
- tokens,
- number
- }) => {
- const {
- delimiter,
- tag,
- name,
- type,
- description,
- end,
- postDelimiter
- } = tokens;
- if (preventAtMiddleLines && !end && !tag && !type && !name && (!allowWhitespace && middleAsterisks.test(description) || allowWhitespace && middleAsterisks.test(postDelimiter + description))) {
- // console.log('description', JSON.stringify(description));
- const fix = () => {
- tokens.description = description.replace(middleAsterisks, '');
- };
- utils.reportJSDoc('Should be no multiple asterisks on middle lines.', {
- line: number
- }, fix, true);
- return true;
- }
- if (!preventAtEnd || !end) {
- return false;
- }
- const isSingleLineBlock = delimiter === '/**';
- const delim = isSingleLineBlock ? '*' : delimiter;
- const endAsterisks = allowWhitespace ? isSingleLineBlock ? endAsterisksSingleLineNoBlockWS : endAsterisksMultipleLineNoBlockWS : isSingleLineBlock ? endAsterisksSingleLineBlockWS : endAsterisksMultipleLineBlockWS;
- const endingAsterisksAndSpaces = (allowWhitespace ? postDelimiter + description + delim : description + delim).match(endAsterisks);
- if (!endingAsterisksAndSpaces || !isSingleLineBlock && endingAsterisksAndSpaces[1] && !endingAsterisksAndSpaces[1].trim()) {
- return false;
- }
- const endFix = () => {
- if (!isSingleLineBlock) {
- tokens.delimiter = '';
- }
- tokens.description = (description + delim).replace(endAsterisks, '');
- };
- utils.reportJSDoc('Should be no multiple asterisks on end lines.', {
- line: number
- }, endFix, true);
- return true;
- });
- }, {
- iterateAllJsdocs: true,
- meta: {
- docs: {
- description: '',
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-multi-asterisks.md#repos-sticky-header'
- },
- fixable: 'code',
- schema: [{
- additionalProperties: false,
- properties: {
- allowWhitespace: {
- type: 'boolean'
- },
- preventAtEnd: {
- type: 'boolean'
- },
- preventAtMiddleLines: {
- type: 'boolean'
- }
- },
- type: 'object'
- }],
- type: 'suggestion'
- }
- });
- module.exports = exports.default;
- //# sourceMappingURL=noMultiAsterisks.js.map
|