aws-samples / aws-samples/sample-autonomous-cloud-coding-agents

fix(eslint): support license headers in shebang files without disabling the rule

Aperta
#172 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement tooling
Lingua principale
TypeScript
Stelle
143
Fork
46
Merge medio
3g 10h
PR unite (30g)
24

Descrizione

## Summary

The `eslint-plugin-license-header` rule reports "Superfluous new lines before license header" on files that start with a shebang (`#!/usr/bin/env node`) followed by the license comment. The current workaround disables the rule entirely for `src/bin/**/*.ts` — this hides the problem instead of fixing it.

## Problem

`cli/src/bin/bgagent.ts` starts with:
```typescript
#!/usr/bin/env node

/**
* MIT No Attribution
* ...
*/
```

The license-header plugin expects the license comment at line 1. The shebang line + blank line before it triggers "superfluous new lines." The `--fix` option can't resolve this because removing the shebang would break the executable.

## Current workaround (PR #171)

```javascript
// eslint.config.mjs
{
files: ['src/bin/**/*.ts'],
rules: { 'license-header/header': 'off' },
}
```

This means shebang files have NO license header enforcement — a file could lose its header and ESLint wouldn't catch it.

## Desired behavior

The license-header rule should:
1. Recognize shebangs as valid preamble before the license header
2. Still enforce that the license header appears immediately after the shebang (with at most one blank line separator)

## Options

1. **Upstream fix**: File an issue/PR on `eslint-plugin-license-header` to support shebang-aware header detection
2. **Custom rule**: Write a project-local rule that handles shebangs (more maintenance)
3. **Different plugin**: Evaluate alternatives (e.g., `eslint-plugin-header`) that may already handle shebangs
4. **Plugin configuration**: Check if `eslint-plugin-license-header` has an option for allowed preamble patterns (shebangs, `@ts-check`, etc.)

## Related

- PR #171 — ESLint 10 migration (introduced the workaround)
- #169 — ESLint 10 upgrade issue

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da eslint.config.mjs e cli/src/bin/bgagent.ts, quindi esamina PR #171 e il comportamento di eslint-plugin-license-header in relazione agli shebang. Verifica se il plugin supporta un preambolo consentito; in caso contrario, confronta le opzioni upstream-fix, custom-rule e alternative-plugin. Il lavoro è completato quando i file con shebang mantengono i propri header eseguibili, mentre gli header di licenza continuano a essere obbligatori immediatamente dopo, con al massimo una riga vuota.

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

Valutazione

Stack tecnologico
eslint, typescript
Ambito
developer-experience, tooling
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.