supernets/hardlounge
supernets/hardlounge
4
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Slightly improve the changelog script, by splitting uncategorized items

Browse Source 
I have more substantial ideas for future changelogs, but this already helped me for v2.7.0 changelog, and it is as far as I can go without editing the changelogs themselves. Stay tuned.
This commit is contained in:
Jérémie Astori 2018-01-22 22:50:26 -05:00
parent c809d4beaf
commit befafade31
No known key found for this signature in database
GPG Key ID: B9A4F245CD67BDE8
1 changed files with 38 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
scripts/changelog.js
View File

@ -166,9 +166,7 @@ ${printDependencyList(items.devDependencies)}`}
@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@
@@ UNCATEGORIZED @@ @@ UNCATEGORIZED @@
@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@@@@@@@@
${printUncategorizedList(items.uncategorized)}`;
${printList(items.uncategorized)}
`;
} }
// Returns true if the given version is a pre-release (i.e. 2.0.0-pre.3, // Returns true if the given version is a pre-release (i.e. 2.0.0-pre.3,
@ -467,6 +465,22 @@ function printDependencyList(dependencies) {
).join("\n"); ).join("\n");
} }
function printUncategorizedList(uncategorized) {
return Object.entries(uncategorized).reduce((memo, [label, items]) => {
if (items.length === 0) {
return memo;
}
memo += `
@@@@@ ${label.toUpperCase()}
${printList(items)}
`;
return memo;
}, "");
}
const dependencies = Object.keys(packageJson.dependencies); const dependencies = Object.keys(packageJson.dependencies);
const devDependencies = Object.keys(packageJson.devDependencies); const devDependencies = Object.keys(packageJson.devDependencies);
@ -522,6 +536,14 @@ function isInternal(entry) {
return hasLabelOrAnnotatedComment(entry, "Meta: Internal"); return hasLabelOrAnnotatedComment(entry, "Meta: Internal");
} }
function isBug({labels}) {
return hasLabel(labels, "Type: Bug");
}
function isFeature({labels}) {
return hasLabel(labels, "Type: Feature");
}
// Examples: // Examples:
// Update webpack to the latest version // Update webpack to the latest version
// Update `stylelint` to v1.2.3 // Update `stylelint` to v1.2.3
@ -561,7 +583,13 @@ function parse(entries) {
} else if (isInternal(entry)) { } else if (isInternal(entry)) {
result.internals.push(entry); result.internals.push(entry);
} else { } else {
result.uncategorized.push(entry); if (isFeature(entry)) {
result.uncategorized.feature.push(entry);
} else if (isBug(entry)) {
result.uncategorized.bug.push(entry);
} else {
result.uncategorized.other.push(entry);
}
} }
return result; return result;
}, { }, {
@ -572,7 +600,11 @@ function parse(entries) {
documentation: [], documentation: [],
internals: [], internals: [],
security: [], security: [],
uncategorized: [], uncategorized: {
feature: [],
bug: [],
other: [],
},
unknownDependencies: new Set(), unknownDependencies: new Set(),
}); });
} }
@ -684,7 +716,7 @@ async function addToChangelog(newEntry) {
// Step 3 (optional): Print a list of skipped entries if there are any // Step 3 (optional): Print a list of skipped entries if there are any
if (skipped.length > 0) { if (skipped.length > 0) {
const pad = Math.max(...skipped.map((entry) => (entry.title || entry.messageHeadline).length)); const pad = Math.max(...skipped.map((entry) => (entry.title || entry.messageHeadline).length));
log.warn(`${skipped.length} entries were skipped:`); log.warn(`${skipped.length} ${skipped.length > 1 ? "entries were" : "entry was"} skipped:`);
skipped.forEach((entry) => { skipped.forEach((entry) => {
log.warn(`- ${(entry.title || entry.messageHeadline).padEnd(pad)} ${colors.gray(entry.url)}`); log.warn(`- ${(entry.title || entry.messageHeadline).padEnd(pad)} ${colors.gray(entry.url)}`);
}); });