Skip to content

Feature type placeholders #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 16, 2024
Merged

Feature type placeholders #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8543df7
Add placeholder to buildJsdocLine
ZashIn Jun 8, 2024
c20163d
Refactor: replace JsdocBuilder.repeat with string.padRight.
ZashIn Jun 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 18 additions & 30 deletions src/JsdocBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,25 +574,36 @@ export class JsdocBuilder {
* @param {boolean} [line.align=true] whether to align `tag`, `value`, `name`, and `description`.
*/
private buildJsdocLine(tag = '', {value = '', wrapper = '{}', name = '', description = '', align = true}: JSDocLine = {}) {
let open = '', close = '', line = '';
let open = '', close = '';
if (wrapper) {
const middle = wrapper.length / 2;
open = wrapper.substring(0, middle);
close = wrapper.substring(middle);
}
this.jsdoc.appendText(' *');
if (tag) {
line += ` @${tag}`;
if (value) {
line += ` ${this.repeat(+align && getConfig('tagValueColumnStart', 0) - line.length)}${open}${value}${close}`;
let line = ` @${tag}`,
offset = 0;
if (value === '*') {
// Add line with `${open}${value}${close}` until open wrapper, add value as placeholder.
line = `${line.padEnd(+align && getConfig('tagValueColumnStart', 0))} ${this.sanitize(open)}`;
this.jsdoc.appendText(this.sanitize(line));
this.jsdoc.appendPlaceholder(value);
// Reset, add close wrapper and continue with offset.
offset = line.length;
line = close;
} else if (value) {
line = `${line.padEnd(+align && getConfig('tagValueColumnStart', 0))} ${open}${value}${close}`;
}
if (name) {
line += ` ${this.repeat(+align && getConfig('tagNameColumnStart', 0) - line.length)}${name}`;
line = `${line.padEnd(+align && getConfig('tagNameColumnStart', 0) - offset)} ${name}`;
}
if (description) {
line += ` ${this.repeat(+align && getConfig('tagDescriptionColumnStart', 0) - line.length)}${description}`;
line = `${line.padEnd(+align && getConfig('tagDescriptionColumnStart', 0) - offset)} ${description}`;
}
this.jsdoc.appendText(this.sanitize(line));
}
this.jsdoc.appendText(` *${this.sanitize(line)}\n`);
this.jsdoc.appendText('\n');
if (value && wrapper === '{}') {
// Remove '\' that comes from .appendText() escaping '}'.
const backslashIndex = this.jsdoc.value.indexOf('\\');
Expand Down Expand Up @@ -732,29 +743,6 @@ export class JsdocBuilder {
);
}

/**
* Repeats the given pattern for the given times.
*
* @private
* @param {number} times
* @param {string} [pattern=' ']
* @returns {string}
*/
private repeat(times: number, pattern = ' '): string {
if (times >= 1) {
let count = times, sequence = pattern, result = '';
while (count > 1) {
if (count & 1) {
result += sequence;
}
count >>= 1;
sequence += sequence;
}
return result + sequence;
}
return '';
}

/**
* Sanitizes possibly multiline values for JSDoc.
*
Expand Down