fix(cli): mute interactions on non tty sessions

Signed-off-by: Cory Rylan <crylan@nvidia.com>

Author: coryrylan

projects/cli/src/index.test.ts

@@ -25,6 +25,11 @@ describe('index', () => {
 expect(output).toContain('nve <cmd> [args]');
 });
 
+it('should hide the banner when output is not interactive',()=>{
+expect(output).not.toContain('░██████████');
+expect(output).toContain('@nvidia-elements/cli');
+});
+
 it('should provide api.list',()=>{
 expect(output).toContain('nve api.list [format]');
 });
@@ -163,7 +168,7 @@ describe('index', () => {
 it('should reject array arguments that exceed the schema limit',()=>{
 constresult=spawnSync(
 process.execPath,
-['dist/index.js','api.get','nve-card','nve-input','nve-button','nve-badge','nve-alert','nve-link'],
+['dist/index.js','api.get','nve-card','nve-input','nve-button','nve-badge'],
 {
 timeout: 10000,
 encoding: 'utf-8',
@@ -173,7 +178,7 @@ describe('index', () => {
 );
 
 expect(result.status).toBe(1);
-expect(result.stderr).toContain('api.get accepts at most 5 names.');
+expect(result.stderr).toContain('api.get accepts at most 3 names.');
 });
 });
 

projects/cli/src/index.ts

@@ -11,7 +11,15 @@ import { hideBin } from 'yargs/helpers';
 import{performance}from'perf_hooks';
 import{typeManagedToolMethod,tools,ToolSupport,typeSchema}from'@internals/tools';
 import{installNve}from'./install.js';
-import{banner,colors,exitWithCompleteToolResult,exitWithToolError,getArgValue,runAsyncTool}from'./utils.js';
+import{
+banner,
+colors,
+exitWithCompleteToolResult,
+exitWithToolError,
+getArgValue,
+isInteractiveTerminal,
+runAsyncTool
+}from'./utils.js';
 import{notifyIfUpdateAvailable}from'./update.js';
 
 exportconstVERSION='0.0.0';
@@ -76,7 +84,9 @@ yargsInstance.command(
 awaitexitWithToolError(result,message);
 }
 }else{
-constgreeting=colors.complete(`\x1b[?7l\n${JSON.parse(banner)}\n\n`);
+constgreeting=isInteractiveTerminal(process.stdout)
+ ? colors.complete(`\x1b[?7l\n${JSON.parse(banner)}\n\n`)
+ : '';
 console.log(
 `${greeting}${colors.complete(`@nvidia-elements/cli (${BUILD_SHA})`)}\n\n${awaityargsInstance.getHelp()}`
 );

projects/cli/src/utils.test.ts

@@ -38,16 +38,24 @@ vi.mock('@inquirer/prompts', () => ({
 }));
 
 describe('utils',()=>{
+conststderrIsTTYDescriptor=Object.getOwnPropertyDescriptor(process.stderr,'isTTY');
+
 beforeEach(()=>{
 vi.clearAllMocks();
 vi.spyOn(console,'log').mockImplementation(()=>{});
 vi.spyOn(process,'exit').mockImplementation(()=>{
 thrownewError('process.exit called');
 });
+Object.defineProperty(process.stderr,'isTTY',{value: true,configurable: true});
 });
 
 afterEach(()=>{
 vi.restoreAllMocks();
+if(stderrIsTTYDescriptor){
+Object.defineProperty(process.stderr,'isTTY',stderrIsTTYDescriptor);
+}else{
+deleteprocess.stderr.isTTY;
+}
 });
 
 describe('constants',()=>{
@@ -93,7 +101,7 @@ describe('utils', () => {
 
 it('should return different messages on multiple calls',()=>{
 constmessages=newSet();
-// Call multiple times to increase chance of getting different messages
+// Call repeatedly to increase the chance of getting different messages
 for(leti=0;i<10;i++){
 messages.add(getSpinnerProgressMessage());
 }
@@ -126,6 +134,16 @@ describe('utils', () => {
 deleteprocess.env.CI;
 });
 
+it('should run function without spinner when stderr is not a TTY',async()=>{
+Object.defineProperty(process.stderr,'isTTY',{value: false,configurable: true});
+constargs={};
+constresult=awaitrunAsyncTool(args,mockFn);
+
+expect(result).toBe('test result');
+expect(mockFn).toHaveBeenCalledWith(args);
+expect(ora).not.toHaveBeenCalled();
+});
+
 it('should run function without spinner when start flag is true',async()=>{
 constargs={start: true};
 constresult=awaitrunAsyncTool(args,mockFn);

projects/cli/src/utils.ts

@@ -44,12 +44,20 @@ export function getSpinnerProgressMessage() {
 returnmessages[Math.floor(Math.random()*messages.length)];
 }
 
+exportfunctionisInteractiveTerminal(stream: NodeJS.WriteStream){
+returnBoolean(stream.isTTY)&&!process.env.CI;
+}
+
+functionshouldShowInteractiveProgress(args: Record<string,unknown>,options: RunAsyncToolOptions){
+return(options.interactiveProgress??true)&&isInteractiveTerminal(process.stderr)&&!args.start&&!args.log;
+}
+
 exportasyncfunctionrunAsyncTool(
 args: Record<string,unknown>,
 fn: ManagedToolMethod<unknown>,
 options: RunAsyncToolOptions={}
 ){
-constisInteractive=(options.interactiveProgress??true)&&!args.start&&!args.log&&!process.env.CI;
+constisInteractive=shouldShowInteractiveProgress(args,options);
 letspinner: Ora|undefined;
 
 conststartTime=Date.now();