feat: warn users when using a beta command

salesforcecli · Mar 24, 2022 · 2cf26f2 · 2cf26f2
1 parent d258ce7
commit 2cf26f2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/messages/messages.md b/messages/messages.md
@@ -73,3 +73,7 @@ Info:
 # actions.tryThis
 
 Try this:
+
+# warning.CommandInBeta
+
+This command is currently in beta. Any aspect of this command can change without advanced notice. Don't use beta commands in your scripts.
diff --git a/src/sfCommand.ts b/src/sfCommand.ts
@@ -194,10 +194,14 @@ export abstract class SfCommand<T> extends Command {
   ): Promise<R> {
     return this.prompter.timedPrompt(questions, ms, initialAnswers);
   }
+
   public async _run<R>(): Promise<R | undefined> {
     if (this.statics.requiresProject) {
       this.project = await this.assignProject();
     }
+    if (this.statics.state === 'beta') {
+      this.warn(messages.getMessage('warning.CommandInBeta'));
+    }
     this.lifecycle.onWarning(async (warning: string) => {
       this.warn(warning);
     });