mirror of
https://github.com/JamesIves/github-pages-deploy-action.git
synced 2023-12-15 20:03:39 +08:00
77 lines
2.2 KiB
JavaScript
77 lines
2.2 KiB
JavaScript
|
"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)(({
|
||
|
jsdoc,
|
||
|
report,
|
||
|
context,
|
||
|
jsdocNode,
|
||
|
sourceCode,
|
||
|
indent
|
||
|
}) => {
|
||
|
let always;
|
||
|
|
||
|
if (!jsdoc.description.trim() || !jsdoc.tags.length) {
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
if (_lodash.default.has(context.options, 0)) {
|
||
|
always = context.options[0] === 'always';
|
||
|
} else {
|
||
|
always = true;
|
||
|
}
|
||
|
|
||
|
const descriptionEndsWithANewline = /\n\r?$/.test(jsdoc.description);
|
||
|
|
||
|
if (always) {
|
||
|
if (!descriptionEndsWithANewline) {
|
||
|
const sourceLines = sourceCode.getText(jsdocNode).split('\n');
|
||
|
const splitDesc = jsdoc.description.split('\n');
|
||
|
const lastDescriptionLine = splitDesc.length - 1;
|
||
|
report('There must be a newline after the description of the JSDoc block.', fixer => {
|
||
|
// Add the new line
|
||
|
const injectedLine = `${indent} *` + (sourceLines[lastDescriptionLine].endsWith('\r') ? '\r' : '');
|
||
|
sourceLines.splice(lastDescriptionLine + 1, 0, injectedLine);
|
||
|
return fixer.replaceText(jsdocNode, sourceLines.join('\n'));
|
||
|
}, {
|
||
|
line: lastDescriptionLine
|
||
|
});
|
||
|
}
|
||
|
} else if (descriptionEndsWithANewline) {
|
||
|
const sourceLines = sourceCode.getText(jsdocNode).split('\n');
|
||
|
const splitDesc = jsdoc.description.split('\n');
|
||
|
const lastDescriptionLine = splitDesc.length - 1;
|
||
|
report('There must be no newline after the description of the JSDoc block.', fixer => {
|
||
|
// Remove the extra line
|
||
|
sourceLines.splice(lastDescriptionLine, 1);
|
||
|
return fixer.replaceText(jsdocNode, sourceLines.join('\n'));
|
||
|
}, {
|
||
|
line: lastDescriptionLine
|
||
|
});
|
||
|
}
|
||
|
}, {
|
||
|
iterateAllJsdocs: true,
|
||
|
meta: {
|
||
|
fixable: 'whitespace',
|
||
|
schema: [{
|
||
|
enum: ['always', 'never'],
|
||
|
type: 'string'
|
||
|
}],
|
||
|
type: 'layout'
|
||
|
},
|
||
|
noTrim: true
|
||
|
});
|
||
|
|
||
|
exports.default = _default;
|
||
|
module.exports = exports.default;
|
||
|
//# sourceMappingURL=newlineAfterDescription.js.map
|