fix(app-config-writer): extra leading comma in eslint.config.mjs when .eslintrc.json only extends fiori-tools plugin

Aperta Adatta ai principianti
  • Qualcosa non va?
#4,792 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
eslint, typescript
Ambito
tooling

Direzione di ricerca

Inizia da src/eslint-config/convert.ts, concentrandoti su injectFioriToolsIntoMigratedConfig e sull’output di un array vuoto prodotto dal comando di migrazione. Riproduci il comando con il .eslintrc.json fornito, quindi esegui il test di regressione disponibile sul branch fix/convert-cmd; il lavoro è completato quando l’eslint.config.mjs generato è valido sia per array vuoti sia per array non vuoti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Description

When running npx --yes @sap-ux/create@latest convert eslint-config --config recommended-for-s4hana on a project whose .eslintrc.json only extends the fiori-tools plugin (no other rules or plugins), the generated eslint.config.mjs contains an invalid leading comma:

import fioriTools from '@sap-ux/eslint-plugin-fiori-tools';
import { defineConfig } from "eslint/config";
export default defineConfig([,
    ...fioriTools.configs['recommended-for-s4hana'],
]);

Root Cause

Package: @sap-ux/app-config-writer — src/eslint-config/convert.ts

The injectFioriToolsIntoMigratedConfig function always prepends a , before the spread entry:

content =
    content.slice(0, lastBracketIndex) +
    `,\n    ...fioriTools.configs['${config}'],\n` +
    content.slice(lastBracketIndex);

When .eslintrc.json only extends plugin:@sap-ux/eslint-plugin-fiori-tools/*, removeFioriToolsFromExistingConfig strips that entry, leaving { "root": true }. The root property has no flat-config equivalent, so @eslint/migrate-config produces an empty array:

import { defineConfig } from "eslint/config";
export default defineConfig([]);

Injecting ,\n ... before ]); into an empty array produces the invalid [, syntax.

Reproducing Input

.eslintrc.json:

{
  "extends": "plugin:@sap-ux/eslint-plugin-fiori-tools/defaultJS",
  "root": true
}

Fix

Detect an empty array before injecting and omit the leading comma:

const beforeBracket = content.slice(0, lastBracketIndex);
const isEmptyArray = /\[\s*$/.test(beforeBracket);
const separator = isEmptyArray ? '' : ',';
content =
    beforeBracket +
    `${separator}\n    ...fioriTools.configs['${config}'],\n` +
    content.slice(lastBracketIndex);

A fix with a regression test is available on branch fix/convert-cmd.

Lingua principale
TypeScript
Stelle
161
Fork
72
Merge medio
4g 15h
PR unite (30g)
64

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di SAP/open-ux-tools

Tutte le issue di SAP/open-ux-tools

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.