@optique/core 1.0.0-dev.1239 → 1.0.0-dev.1242
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/doc.cjs +35 -2
- package/dist/doc.js +35 -2
- package/package.json +1 -1
package/dist/doc.cjs
CHANGED
|
@@ -79,9 +79,42 @@ function formatDocPage(programName, page, options = {}) {
|
|
|
79
79
|
if (options.maxWidth != null) {
|
|
80
80
|
const hasEntries = page.sections.some((s) => s.entries.length > 0);
|
|
81
81
|
const hasContent = (msg) => Array.isArray(msg) && msg.length > 0;
|
|
82
|
-
const needsDescColumn = hasEntries && page.sections.some((s) => s.entries.some((e) => hasContent(e.description) || options.showDefault &&
|
|
83
|
-
|
|
82
|
+
const needsDescColumn = hasEntries && page.sections.some((s) => s.entries.some((e) => hasContent(e.description) || options.showDefault && e.default != null || options.showChoices && e.choices != null));
|
|
83
|
+
let minDescWidth = 1;
|
|
84
|
+
if (needsDescColumn) {
|
|
85
|
+
if (options.showDefault && page.sections.some((s) => s.entries.some((e) => e.default != null))) {
|
|
86
|
+
const prefix = typeof options.showDefault === "object" ? options.showDefault.prefix ?? " [" : " [";
|
|
87
|
+
const suffix = typeof options.showDefault === "object" ? options.showDefault.suffix ?? "]" : "]";
|
|
88
|
+
const hasEmptyDefault = page.sections.some((s) => s.entries.some((e) => e.default != null && Array.isArray(e.default) && e.default.length === 0));
|
|
89
|
+
minDescWidth = Math.max(minDescWidth, hasEmptyDefault ? prefix.length + suffix.length : prefix.length);
|
|
90
|
+
}
|
|
91
|
+
if (options.showChoices && page.sections.some((s) => s.entries.some((e) => e.choices != null))) {
|
|
92
|
+
const prefix = typeof options.showChoices === "object" ? options.showChoices.prefix ?? " (" : " (";
|
|
93
|
+
const suffix = typeof options.showChoices === "object" ? options.showChoices.suffix ?? ")" : ")";
|
|
94
|
+
const label = typeof options.showChoices === "object" ? options.showChoices.label ?? "choices: " : "choices: ";
|
|
95
|
+
const hasEmptyChoices = page.sections.some((s) => s.entries.some((e) => e.choices != null && Array.isArray(e.choices) && e.choices.length === 0));
|
|
96
|
+
minDescWidth = Math.max(minDescWidth, hasEmptyChoices ? prefix.length + label.length + suffix.length : prefix.length + label.length);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
const splitEntryMin = termIndent + 2 + Math.max(2, 2 * minDescWidth - 1);
|
|
100
|
+
const fixedEntryMin = termIndent + 2 + termWidth + minDescWidth;
|
|
101
|
+
const entryMin = needsDescColumn ? Math.min(splitEntryMin, fixedEntryMin) : hasEntries ? termIndent + 1 : 1;
|
|
102
|
+
const usageMin = page.usage != null ? 8 + programName.length : 1;
|
|
103
|
+
let sectionMin = 1;
|
|
104
|
+
if (page.examples != null) sectionMin = Math.max(sectionMin, 9);
|
|
105
|
+
if (page.author != null) sectionMin = Math.max(sectionMin, 7);
|
|
106
|
+
if (page.bugs != null) sectionMin = Math.max(sectionMin, 5);
|
|
107
|
+
const minWidth = Math.max(entryMin, usageMin, sectionMin);
|
|
84
108
|
if (options.maxWidth < minWidth) throw new RangeError(`maxWidth must be at least ${minWidth}, got ${options.maxWidth}.`);
|
|
109
|
+
if (needsDescColumn && minDescWidth > 1) {
|
|
110
|
+
const avail = options.maxWidth - termIndent - 2;
|
|
111
|
+
const effTW = avail >= termWidth + 1 ? termWidth : Math.max(1, Math.floor(avail / 2));
|
|
112
|
+
const descW = avail - effTW;
|
|
113
|
+
if (descW < minDescWidth) {
|
|
114
|
+
const needed = termIndent + termWidth + 2 + minDescWidth;
|
|
115
|
+
throw new RangeError(`maxWidth must be at least ${needed}, got ${options.maxWidth}.`);
|
|
116
|
+
}
|
|
117
|
+
}
|
|
85
118
|
}
|
|
86
119
|
let effectiveTermWidth;
|
|
87
120
|
if (options.maxWidth == null) effectiveTermWidth = termWidth;
|
package/dist/doc.js
CHANGED
|
@@ -79,9 +79,42 @@ function formatDocPage(programName, page, options = {}) {
|
|
|
79
79
|
if (options.maxWidth != null) {
|
|
80
80
|
const hasEntries = page.sections.some((s) => s.entries.length > 0);
|
|
81
81
|
const hasContent = (msg) => Array.isArray(msg) && msg.length > 0;
|
|
82
|
-
const needsDescColumn = hasEntries && page.sections.some((s) => s.entries.some((e) => hasContent(e.description) || options.showDefault &&
|
|
83
|
-
|
|
82
|
+
const needsDescColumn = hasEntries && page.sections.some((s) => s.entries.some((e) => hasContent(e.description) || options.showDefault && e.default != null || options.showChoices && e.choices != null));
|
|
83
|
+
let minDescWidth = 1;
|
|
84
|
+
if (needsDescColumn) {
|
|
85
|
+
if (options.showDefault && page.sections.some((s) => s.entries.some((e) => e.default != null))) {
|
|
86
|
+
const prefix = typeof options.showDefault === "object" ? options.showDefault.prefix ?? " [" : " [";
|
|
87
|
+
const suffix = typeof options.showDefault === "object" ? options.showDefault.suffix ?? "]" : "]";
|
|
88
|
+
const hasEmptyDefault = page.sections.some((s) => s.entries.some((e) => e.default != null && Array.isArray(e.default) && e.default.length === 0));
|
|
89
|
+
minDescWidth = Math.max(minDescWidth, hasEmptyDefault ? prefix.length + suffix.length : prefix.length);
|
|
90
|
+
}
|
|
91
|
+
if (options.showChoices && page.sections.some((s) => s.entries.some((e) => e.choices != null))) {
|
|
92
|
+
const prefix = typeof options.showChoices === "object" ? options.showChoices.prefix ?? " (" : " (";
|
|
93
|
+
const suffix = typeof options.showChoices === "object" ? options.showChoices.suffix ?? ")" : ")";
|
|
94
|
+
const label = typeof options.showChoices === "object" ? options.showChoices.label ?? "choices: " : "choices: ";
|
|
95
|
+
const hasEmptyChoices = page.sections.some((s) => s.entries.some((e) => e.choices != null && Array.isArray(e.choices) && e.choices.length === 0));
|
|
96
|
+
minDescWidth = Math.max(minDescWidth, hasEmptyChoices ? prefix.length + label.length + suffix.length : prefix.length + label.length);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
const splitEntryMin = termIndent + 2 + Math.max(2, 2 * minDescWidth - 1);
|
|
100
|
+
const fixedEntryMin = termIndent + 2 + termWidth + minDescWidth;
|
|
101
|
+
const entryMin = needsDescColumn ? Math.min(splitEntryMin, fixedEntryMin) : hasEntries ? termIndent + 1 : 1;
|
|
102
|
+
const usageMin = page.usage != null ? 8 + programName.length : 1;
|
|
103
|
+
let sectionMin = 1;
|
|
104
|
+
if (page.examples != null) sectionMin = Math.max(sectionMin, 9);
|
|
105
|
+
if (page.author != null) sectionMin = Math.max(sectionMin, 7);
|
|
106
|
+
if (page.bugs != null) sectionMin = Math.max(sectionMin, 5);
|
|
107
|
+
const minWidth = Math.max(entryMin, usageMin, sectionMin);
|
|
84
108
|
if (options.maxWidth < minWidth) throw new RangeError(`maxWidth must be at least ${minWidth}, got ${options.maxWidth}.`);
|
|
109
|
+
if (needsDescColumn && minDescWidth > 1) {
|
|
110
|
+
const avail = options.maxWidth - termIndent - 2;
|
|
111
|
+
const effTW = avail >= termWidth + 1 ? termWidth : Math.max(1, Math.floor(avail / 2));
|
|
112
|
+
const descW = avail - effTW;
|
|
113
|
+
if (descW < minDescWidth) {
|
|
114
|
+
const needed = termIndent + termWidth + 2 + minDescWidth;
|
|
115
|
+
throw new RangeError(`maxWidth must be at least ${needed}, got ${options.maxWidth}.`);
|
|
116
|
+
}
|
|
117
|
+
}
|
|
85
118
|
}
|
|
86
119
|
let effectiveTermWidth;
|
|
87
120
|
if (options.maxWidth == null) effectiveTermWidth = termWidth;
|