test: assert config edits hold their invariants across config shapes

Author: danielroe

packages/nuxt-cli/test/unit/utils/config-property.spec.ts

@@ -0,0 +1,179 @@
+import{mkdir,mkdtemp,readFile,realpath,symlink,writeFile}from'node:fs/promises'
+import{tmpdir}from'node:os'
+import{fileURLToPath}from'node:url'
+
+import{dirname,join}from'pathe'
+import{parseSync}from'rolldown/utils'
+import{afterAll,afterEach,describe,expect,it,vi}from'vitest'
+
+import{addNuxtConfigEntries,readNuxtConfig,removeNuxtConfigEntries}from'../../../src/utils/config'
+
+constrolldownPath=dirname(fileURLToPath(import.meta.resolve('rolldown/package.json')))
+
+interfaceShape{
+name: string
+source: string
+modules: string[]
+}
+
+constWRAPPERS: [name: string,wrap: (object: string)=>string][]=[
+['defineNuxtConfig',object=>`export default defineNuxtConfig(${object})`],
+['plain object',object=>`export default ${object}`],
+['satisfies',object=>`export default defineNuxtConfig(${object}) satisfies NuxtConfig`],
+['as const',object=>`export default defineNuxtConfig(${object}) as NuxtConfig`],
+]
+
+constENTRIES: [name: string,entries: string[],modules: string[]][]=[
+['no modules key',[],[]],
+['empty array',[],[]],
+['one entry',['@nuxt/eslint'],['@nuxt/eslint']],
+['three entries',['@nuxt/eslint','@nuxt/image','@nuxt/fonts'],['@nuxt/eslint','@nuxt/image','@nuxt/fonts']],
+['array-form entry',['[\'@nuxt/image\', { quality: 80 }]'],['@nuxt/image']],
+['mixed entries',['@nuxt/eslint','[\'@nuxt/image\', { quality: 80 }]'],['@nuxt/eslint','@nuxt/image']],
+]
+
+constLAYOUTS: [name: string,render: (entries: string[],quote: string,indent: string,trailingComma: boolean)=>string][]=[
+['inline',(entries,quote,_indent,trailingComma)=>`[${entries.map(entry=>quoted(entry,quote)).join(', ')}${entries.length&&trailingComma ? ',' : ''}]`],
+['multi-line',(entries,quote,indent,trailingComma)=>entries.length===0
+ ? '[]'
+ : `[\n${entries.map(entry=>`${indent}${indent}${quoted(entry,quote)}`).join(',\n')}${trailingComma ? ',' : ''}\n${indent}]`],
+]
+
+functionquoted(entry: string,quote: string): string{
+returnentry.startsWith('[') ? entry.replaceAll('\'',quote) : `${quote}${entry}${quote}`
+}
+
+function*shapes(): Generator<Shape>{
+for(const[wrapperName,wrap]ofWRAPPERS){
+for(const[entriesName,entries,modules]ofENTRIES){
+for(const[layoutName,render]ofLAYOUTS){
+for(constquoteof['\'','"']){
+for(constindentof[' ',' ','\t']){
+for(consttrailingCommaof[true,false]){
+consthasKey=entriesName!=='no modules key'
+constbody=[
+`${indent}ssr: true,`,
+hasKey ? `${indent}modules: ${render(entries,quote,indent,trailingComma)},` : '',
+`${indent}// keep me`,
+`${indent}devtools: { enabled: true },`,
+].filter(Boolean).join('\n')
+yield{
+name: `${wrapperName} / ${entriesName} / ${layoutName} / ${quote==='\'' ? 'single' : 'double'} / ${indent==='\t' ? 'tab' : `${indent.length} spaces`} / ${trailingComma ? 'trailing comma' : 'no trailing comma'}`,
+source: `${wrap(`{\n${body}\n}`)}\n`,
+ modules,
+}
+}
+}
+}
+}
+}
+}
+}
+
+/** Read the `modules` list straight from the parser, independently of the editor. */
+functionreadModules(source: string): string[]{
+const{ program, errors }=parseSync('nuxt.config.ts',source)
+if(errors.length){
+thrownewError(`config no longer parses: ${JSON.stringify(errors[0])}`)
+}
+constexported=(program.bodyasany[]).find(node=>node.type==='ExportDefaultDeclaration')
+letobject=exported?.declaration
+while(object&&['TSAsExpression','TSSatisfiesExpression','ParenthesizedExpression'].includes(object.type)){
+object=object.expression
+}
+if(object?.type==='CallExpression'){
+object=object.arguments[0]
+}
+constproperty=(object?.propertiesasany[]|undefined)?.find(entry=>entry.type==='Property'&&entry.key?.name==='modules')
+if(!property){
+return[]
+}
+return(property.value.elementsasany[]).map((element)=>{
+consttarget=element?.type==='ArrayExpression' ? element.elements[0] : element
+returntarget?.valueasstring
+})
+}
+
+constdirectories: string[]=[]
+
+asyncfunctioncreateProject(parser: boolean): Promise<string>{
+constcwd=awaitrealpath(awaitmkdtemp(join(tmpdir(),'nuxi-config-property-')))
+directories.push(cwd)
+if(parser){
+awaitmkdir(join(cwd,'node_modules'),{recursive: true})
+awaitsymlink(rolldownPath,join(cwd,'node_modules/rolldown'),'dir')
+}
+returncwd
+}
+
+afterEach(()=>{
+vi.unstubAllEnvs()
+})
+
+afterAll(async()=>{
+const{ rm }=awaitimport('node:fs/promises')
+awaitPromise.all(directories.splice(0).map(directory=>rm(directory,{recursive: true,force: true})))
+})
+
+describe.each([
+['scanner',false],
+['parser',true],
+])('config editing invariants (%s)',(engine,useParser)=>{
+it('should preserve the module list through an add and a remove',async()=>{
+if(!useParser){
+vi.stubEnv('NUXT_CLI_PARSER','scanner')
+}
+constcwd=awaitcreateProject(useParser)
+constfile=join(cwd,'nuxt.config.ts')
+constrefused: string[]=[]
+letchecked=0
+
+for(constshapeofshapes()){
+awaitwriteFile(file,shape.source,'utf8')
+
+letconfig
+try{
+config=awaitreadNuxtConfig(cwd)
+awaitaddNuxtConfigEntries(config!,{modules: ['@nuxt/test-utils','@nuxt/eslint']})
+}
+catch(error){
+refused.push(`${shape.name}: ${(errorasError).message}`)
+expect(awaitreadFile(file,'utf8'),shape.name).toBe(shape.source)
+continue
+}
+
+constadded=[...newSet([...shape.modules,'@nuxt/test-utils','@nuxt/eslint'])]
+constafterAdd=awaitreadFile(file,'utf8')
+expect(readModules(afterAdd),`add: ${shape.name}`).toEqual(added)
+expect(afterAdd,`add: ${shape.name}`).toContain('// keep me')
+expect(afterAdd,`add: ${shape.name}`).toContain('ssr: true')
+
+awaitremoveNuxtConfigEntries((awaitreadNuxtConfig(cwd))!,{modules: ['@nuxt/test-utils','@nuxt/fonts']})
+
+constafterRemove=awaitreadFile(file,'utf8')
+expect(readModules(afterRemove),`remove: ${shape.name}`).toEqual(added.filter(name=>name!=='@nuxt/test-utils'&&name!=='@nuxt/fonts'))
+expect(afterRemove,`remove: ${shape.name}`).toContain('devtools: { enabled: true }')
+checked++
+}
+
+expect(checked,`${engine} refusals: ${refused.join('\n')}`).toBeGreaterThan(0)
+expect(refused).toEqual([])
+},60_000)
+
+it('should keep CRLF endings and a nested array entry intact',async()=>{
+if(!useParser){
+vi.stubEnv('NUXT_CLI_PARSER','scanner')
+}
+constcwd=awaitcreateProject(useParser)
+constfile=join(cwd,'nuxt.config.ts')
+constsource='export default defineNuxtConfig({\r\n modules: [\r\n [\'@nuxt/image\', { quality: 80 }],\r\n ],\r\n})\r\n'
+awaitwriteFile(file,source,'utf8')
+
+awaitaddNuxtConfigEntries((awaitreadNuxtConfig(cwd))!,{modules: ['@nuxt/fonts']})
+
+constafter=awaitreadFile(file,'utf8')
+expect(after.split('\n').every(line=>line===''||line.endsWith('\r'))).toBe(true)
+expect(after).toContain('{ quality: 80 }')
+expect(readModules(after)).toEqual(['@nuxt/image','@nuxt/fonts'])
+})
+})