Formatting results in duplicated top-level documentation

[tothambrus11]

Hi, thanks for developing this tool. I have encountered a bug that I cannot seem to fix.

When I run swift-format using the following command, all of my top-level documentation comments are duplicated to all of the top-level declarations that previously had documentation comments.

swift run swift-format --in-place -r --configuration .swift-format.json -p Sources Tests Package.swift

My .swift-format.json:

{
    "fileScopedDeclarationPrivacy": {
        "accessLevel": "private"
    },
    "indentation": {
        "spaces": 2
    },
    "indentConditionalCompilationBlocks": true,
    "indentSwitchCaseLabels": false,
    "lineBreakAroundMultilineExpressionChainComponents": false,
    "lineBreakBeforeControlFlowKeywords": false,
    "lineBreakBeforeEachArgument": false,
    "lineBreakBeforeEachGenericRequirement": false,
    "lineLength": 100,
    "maximumBlankLines": 1,
    "prioritizeKeepingFunctionOutputTogether": false,
    "respectsExistingLineBreaks": true,
    "rules": {
        "AllPublicDeclarationsHaveDocumentation": false,
        "AlwaysUseLowerCamelCase": true,
        "AmbiguousTrailingClosureOverload": true,
        "BeginDocumentationCommentWithOneLineSummary": false,
        "DoNotUseSemicolons": true,
        "DontRepeatTypeInStaticProperties": true,
        "FileScopedDeclarationPrivacy": true,
        "FullyIndirectEnum": true,
        "GroupNumericLiterals": true,
        "IdentifiersMustBeASCII": true,
        "NeverForceUnwrap": false,
        "NeverUseForceTry": false,
        "NeverUseImplicitlyUnwrappedOptionals": false,
        "NoAccessLevelOnExtensionDeclaration": true,
        "NoAssignmentInExpressions": true,
        "NoBlockComments": true,
        "NoCasesWithOnlyFallthrough": true,
        "NoEmptyTrailingClosureParentheses": true,
        "NoLabelsInCasePatterns": true,
        "NoLeadingUnderscores": false,
        "NoParensAroundConditions": true,
        "NoVoidReturnOnFunctionSignature": true,
        "OneCasePerLine": true,
        "OneVariableDeclarationPerLine": true,
        "OnlyOneTrailingClosureArgument": true,
        "OrderedImports": true,
        "ReturnVoidInsteadOfEmptyTuple": true,
        "UseEarlyExits": false,
        "UseLetInEveryBoundCaseVariable": false,
        "UseShorthandTypeNames": true,
        "UseSingleLinePropertyGetter": true,
        "UseSynthesizedInitializer": true,
        "UseTripleSlashForDocumentationComments": true,
        "UseWhereClausesInForLoops": false,
        "ValidateDocumentationComments": false
    },
    "spacesAroundRangeFormationOperators": true,
    "tabWidth": 8,
    "version": 1
}

I used the following version inside my Package.swift:

    .package(url: "https://github.com/apple/swift-format", branch: "release/5.9"),

[ahoppen]

Synced to Apple’s issue tracker as rdar://127941004

[tothambrus11]

I figured out the root issue that caused this bug: I had the git config core.autocrlf turned on in WSL, so my line endings were not the same as the tool expected, even inside devcontainers (maybe it inherited some git configurations?). It would be nice if the tool either gave errors about this or it was able to handle both CRLF and LF line endings correctly. Once I turned off core.autocrlf, the problem went away.