Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@ms-cloudpack/task-reporter
Advanced tools
A library for standardizing how tasks are logged to the console.
const taskReporter = new TaskReporter({
productName: `Foobar`,
version: `1.2.3`,
description: `running tasks with ${bold(`15`)} workers`,
showStarted: false,
showPending: true,
showCompleted: true,
showSummary: true,
showTaskDetails: true,
});
runTask
method:await taskReporter.runTask(`build something`, async () => {
// ...do async things.
return {
status: 'fail' // default: 'complete'
message: 'optional message',
details: 'optional details',
extended: 'optional debugging info'
}
});
2b. For tasks that may not be easily encapsulated within a wrapper function, you can use the addtask
method:
const task = taskReporter.addTask(`build something`, /* initially idle */ true);
// When you are starting the task, you can call start:
try {
task.start();
} finally {
task.complete({ status: 'complete' /* etc */ });
}
// Fail example, with provide details:
import { bulletedList } from '@ms-cloudpack/task-reporter';
task.complete({
status: 'fail',
message: 'Reason',
details: bulletedList(['Name: value', 'Errors:', ['sub-bullet things', 'etc'], 'Warnings', ['warn1', etc]]),
});
For formatting details, a variety of style helpers can be imported.
import { cyan, bold, red } from '@ms-cloudpack/task-reporter';
task.complete('fail', { message: cyan(bold(`I am an ${red(`error`)}`)) });
reporter.complete('reason')
to end task logging:// You can instruct the reporter to complete when all tasks are done.
reporter.completeWhenTasksDone();
// Or, you can manually tell it to complete at any point. For example, you may want to complete things when the
// users hits ctrl-c. Prematurely completing means pending tasks will be skipped and running tasks will be aborted.
process.on('SIGINT', () => {
reporter.complete('User hit Ctrl-C');
});
FAQs
Helpers for logging tasks to the console.
We found that @ms-cloudpack/task-reporter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.