2.2.0 • Published 2 years ago

sfdx-notifications v2.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Notifications for SFDX

npm version

Unofficial plugin for SFDX notifications. Adds special hook named "notification" that can be used by other commands to dispatch custom notification.

How to use

If you are using linux, see node-notifier requirements.

Install

sfdx plugins:install sfdx-notifications

Managing notifications

To list all possible commands, use

sfdx notifications

To test if notifications work on your system, use

sfdx notifications:dispatch

You can register notifications for command by using

sfdx notificaitons:register

If you want to stop receiving notifications for command, use

sfdx notifications:unregister

To list registered notifications, use

sfdx notifications:list

Notification hook

From version 2.1.0 onwards, notification hook is supported. It can be used to dispatch custom notifications from plugins.

// Notification supported by [node-notifier](https://www.npmjs.com/package/node-notifier)
const notification = {
	title: "Your custom title",
	message: "Your custom message",
	label: "SFDX",
};
return this.config.runHook("notification", { notification });