This extension allows to show different types of notification messages on opening or start editing of a file.
Very useful way to warn a developer when he/she is about to start working with a file that requires extra attention. For example about the change autogenerated code that will be overwritten automatically.
if a file contains a comment with text like:
##INFO information message here
##WARN warning message here
##ERROR error message here
##STATUSBAR message to show in a status bar
it will be show as a message of corresponding type when you open a file. The message will be shown only once per VS code session (unless you specify ALWAYS). i.e. if you close and open the file again, the message will not be shown.
if the comment contains :ALWAYS suffix, the message will be shown on every opening of the file.
if the comment contains :EDIT suffix, the message will be show once per session after you start editing of the file.
if the comment contains :EDIT:ALWAYS suffix, the message will be show every time you reopen the file right after you start editing of the file.
// ##INFO info message here
// ##WARN:ALWAYS warning message here
-- ##ERROR:EDIT edit message here, in modal mode
/* ##STATUSBAR:EDIT:ALWAYS statusbar message here */
Just add the following line to your source code file:
// ##ERROR:ALWAYS This is a test error message that will be shown to anyone who opens the file.
then close and re-open the file.
DevAlert goes live.
Initial release of DevAlert