fix(module): keep the closing bracket when removing consecutive inline entries

Author: danielroe

packages/nuxt-cli/src/utils/config.ts

@@ -150,12 +150,14 @@ export async function removeNuxtConfigEntries(config: NuxtConfigFile, entries: C
 continue
 }
 
-edits.push(...doomed.map(element=>buildRemoval(source,array,element)))
+constremovals=doomed.map(element=>buildRemoval(source,array,element,doomed))
 
 constorphanedComma=findOrphanedComma(source,array,doomed)
 if(orphanedComma!==undefined){
-edits.push({start: orphanedComma,end: orphanedComma+1,text: ''})
+removals.push({start: orphanedComma,end: orphanedComma+1,text: ''})
 }
+
+edits.push(...mergeRemovals(removals))
 }
 
 if(!edits.length){
@@ -165,6 +167,27 @@ export async function removeNuxtConfigEntries(config: NuxtConfigFile, entries: C
 awaitwriteFile(config.file,applyEdits(source,edits),'utf8')
 }
 
+/**
+ * Combine deletions that overlap into one range.
+ *
+ * Removing consecutive entries produces ranges that reach over each other,
+ * because each entry takes the separator that attached it to the one before.
+ * Applied separately they would delete text twice over.
+ */
+functionmergeRemovals(removals: Edit[]): Edit[]{
+constsorted=[...removals].sort((a,b)=>a.start-b.start)
+constmerged: Edit[]=[]
+for(constremovalofsorted){
+constprevious=merged.at(-1)
+if(previous&&removal.start<=previous.end){
+previous.end=Math.max(previous.end,removal.end)
+continue
+}
+merged.push({ ...removal})
+}
+returnmerged
+}
+
 /**
  * Offset of a separator that would be left dangling after a removal.
  *
@@ -207,11 +230,20 @@ function readNames(location: ConfigLocation, key: ConfigKey): string[] {
 returnlocation.keys[key].elements.map(element=>element.name).filter((name): name is string=>name!==null)
 }
 
-/** Splice edits into `source`, working backwards so earlier offsets stay valid. */
+/**
+ * Splice edits into `source`, working backwards so earlier offsets stay valid.
+ *
+ * An edit reaching into one that has already been applied is clipped rather than
+ * left to consume the text that moved into its range, which would corrupt the
+ * file rather than simply misplacing a separator.
+ */
 functionapplyEdits(source: string,edits: Edit[]): string{
 letresult=source
+letapplied=source.length
 for(consteditof[...edits].sort((a,b)=>b.start-a.start)){
-result=result.slice(0,edit.start)+edit.text+result.slice(edit.end)
+constend=Math.max(edit.start,Math.min(edit.end,applied))
+result=result.slice(0,edit.start)+edit.text+result.slice(end)
+applied=edit.start
 }
 returnresult
 }
@@ -293,7 +325,7 @@ function buildInsert(source: string, location: ConfigLocation, array: ArrayLocat
 return{start: close,end: close,text: separator+entries.join(', ')}
 }
 
-functionbuildRemoval(source: string,location: ArrayLocation,element: ArrayElement): Edit{
+functionbuildRemoval(source: string,location: ArrayLocation,element: ArrayElement,doomed: ArrayElement[]): Edit{
 letstart=element.start
 letend=element.end
 if(source[end]===','){
@@ -314,8 +346,12 @@ function buildRemoval(source: string, location: ArrayLocation, element: ArrayEle
 end++
 }
 if(source[end]===']'){
+// The separator before the entry goes with it, but only back as far as an
+// entry that is staying: reaching into one that is also being removed would
+// overlap its own edit and swallow the text between them.
 constindex=location.elements.indexOf(element)
-start=location.elements[index-1]?.end??start
+constprevious=location.elements.slice(0,index).filter(candidate=>!doomed.includes(candidate)).at(-1)
+start=previous?.end??start
 }
 elseif(source[end]==='\n'||source[end]==='\r'){
 // The entry ended the line, so take the space that separated it from the

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

@@ -221,6 +221,18 @@ describe.each([
 expect(result).toBe('export default defineNuxtConfig({\n modules: [\n \'b\',\n ],\n})\n')
 })
 
+it('should remove consecutive trailing entries from an inline array',async()=>{
+constresult=awaitremove('export default defineNuxtConfig({ modules: [\'a\', \'b\', \'c\'] })\n',['b','c'])
+
+expect(result).toBe('export default defineNuxtConfig({ modules: [\'a\'] })\n')
+})
+
+it('should remove consecutive trailing entries from an inline array with a trailing comma',async()=>{
+constresult=awaitremove('export default defineNuxtConfig({ modules: [\'a\', \'b\', \'c\',] })\n',['b','c'])
+
+expect(result).toBe('export default defineNuxtConfig({ modules: [\'a\'] })\n')
+})
+
 it('should keep array-form entries that were not named',async()=>{
 constresult=awaitremove('export default defineNuxtConfig({\n modules: [\n [\'a\', { q: 1 }],\n \'b\',\n ],\n})\n',['b'])