test: assert nuxt info reports config keys without their values

Author: danielroe

packages/nuxt-cli/test/unit/commands/info-run.spec.ts

@@ -0,0 +1,93 @@
+import{mkdtemp,rm,writeFile}from'node:fs/promises'
+import{tmpdir}from'node:os'
+importprocessfrom'node:process'
+
+import{runCommand}from'citty'
+import{join}from'pathe'
+import{afterEach,beforeEach,describe,expect,it,vi}from'vitest'
+
+importinfofrom'../../../src/commands/info'
+import{render,screen}from'../../utils/terminal'
+
+vi.mock('tinyclip',()=>({writeText: ()=>Promise.reject(newError('no clipboard'))}))
+
+letcwd: string
+
+beforeEach(async()=>{
+cwd=awaitmkdtemp(join(tmpdir(),'nuxt-info-'))
+})
+
+afterEach(async()=>{
+awaitrm(cwd,{recursive: true,force: true})
+})
+
+asyncfunctionrunInfo(): Promise<string>{
+constterminal=awaitrender(()=>runCommand(info,{rawArgs: [`--cwd=${cwd}`]}))
+returnscreen(terminal)
+}
+
+asyncfunctionrunInfoJSON(): Promise<any>{
+letstdout=''
+vi.spyOn(process.stdout,'write').mockImplementation((chunk: any)=>{
+stdout+=String(chunk)
+returntrue
+})
+awaitrunCommand(info,{rawArgs: [`--cwd=${cwd}`,'--json']})
+returnJSON.parse(stdout)
+}
+
+describe('info command',()=>{
+it('should report the config keys without their values',async()=>{
+awaitwriteFile(join(cwd,'package.json'),JSON.stringify({name: 'app',private: true}))
+awaitwriteFile(join(cwd,'nuxt.config.mjs'),`export default {
+ runtimeConfig: { apiSecret: 'super-secret-token' },
+ devServer: { host: '10.0.0.1' },
+ }`)
+
+constoutput=awaitrunInfo()
+
+expect(output).toContain('runtimeConfig')
+expect(output).not.toContain('super-secret-token')
+expect(output).not.toContain('10.0.0.1')
+})
+
+it('should not print environment variables',async()=>{
+vi.stubEnv('NUXT_SECRET_TOKEN','env-secret-value')
+awaitwriteFile(join(cwd,'package.json'),JSON.stringify({name: 'app',private: true}))
+
+constoutput=awaitrunInfo()
+
+expect(output).not.toContain('env-secret-value')
+vi.unstubAllEnvs()
+})
+
+it('should list the modules a config declares',async()=>{
+awaitwriteFile(join(cwd,'package.json'),JSON.stringify({name: 'app',private: true}))
+awaitwriteFile(join(cwd,'nuxt.config.mjs'),`export default { modules: ['@nuxt/image'] }`)
+
+constoutput=awaitrunInfo()
+
+expect(output).toContain('@nuxt/image')
+})
+
+it('should keep a comma in a config key or module path as one `--json` entry',async()=>{
+awaitwriteFile(join(cwd,'package.json'),JSON.stringify({name: 'app',private: true}))
+awaitwriteFile(join(cwd,'nuxt.config.mjs'),`export default {
+ modules: ['./modules/a, b.ts'],
+ 'weird, key': true,
+ }`)
+
+constpayload=awaitrunInfoJSON()
+
+expect(payload.config).toContain('weird, key')
+expect(payload.modules).toEqual(['./modules/a, b.ts'])
+})
+
+it('should still report on a project with no config',async()=>{
+awaitwriteFile(join(cwd,'package.json'),JSON.stringify({name: 'app',private: true}))
+
+constoutput=awaitrunInfo()
+
+expect(output).toContain('Nuxt version')
+})
+})