apple / apple/swift-argument-parser

Generated output (documentation, shell completion scripts, etc.) sometimes contain suboptimal whitespace

Open
#786 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Swift
Stars
3.8k
Forks
411
Avg merge
7d 13h
Merged PRs (30d)
17

Description

Generated output (documentation, shell completion scripts, etc.) sometimes contain suboptimal whitespace

**ArgumentParser version:** `main`
**Swift version:**

```text
swift-driver version: 1.120.5 Apple Swift version 6.1.2 (swiftlang-6.1.2.1.2 clang-1700.0.13.5)
Target: arm64-apple-macosx15.0
```

### Checklist

- [x] If possible, I've reproduced the issue using the `main` branch of this package
- [x] I've searched for [existing GitHub issues](https://github.com/apple/swift-argument-parser/issues)

### Steps to Reproduce

Search test comparison files in the various `Snapshots` folders to find trailing spaces, or multiple or no newlines at the end of the file.

Once fixed, the new `.editorconfig`s in the `Snapshot` folders can be removed.

### Expected behavior

No trailing spaces. One single newline at the end of every file.

### Actual behavior

Sometimes: trailing spaces, multiple newlines at the end of a file, or no newlines at the end of a file.

@rauhul

Contributor guide

Open the contributing guide

Research direction

Search the test comparison files in the various Snapshots folders for trailing spaces and incorrect final newlines, then trace those outputs to their generators. Confirm generated documentation and shell completion scripts consistently have no trailing spaces and exactly one newline at EOF, and remove the new .editorconfig files from the Snapshot folders once fixed.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell, swift
Domain
cli, documentation, testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.