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

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

Offen
#172 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement tooling
Vorherrschende Sprache
TypeScript
Sterne
143
Forks
46
Ø Merge
3 T. 10 Std.
Gemergte PRs (30 T.)
24

Beschreibung

## 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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit eslint.config.mjs und cli/src/bin/bgagent.ts, prüfe dann PR #171 sowie das Verhalten von eslint-plugin-license-header im Umgang mit Shebangs. Prüfe, ob das Plugin eine erlaubte Präambel unterstützt; vergleiche andernfalls die Optionen upstream-fix, custom-rule und alternative-plugin. Die Aufgabe ist abgeschlossen, wenn Dateien mit Shebangs ihre ausführbaren Header behalten, während Lizenz-Header weiterhin direkt danach mit höchstens einer Leerzeile erzwungen werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
eslint, typescript
Bereich
developer-experience, tooling
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.