Skip to content

Ignore sentence terminators inside quotes when applying the 'BeginDocumentationCommentWithOneLineSummary' option. #687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 4, 2024
Merged

Ignore sentence terminators inside quotes when applying the 'BeginDocumentationCommentWithOneLineSummary' option. #687

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4e6eaa
Ignore sentence terminators inside quotes when applying the 'BeginDoc…
TTOzzi Feb 2, 2024
a8ab390
Add examples for single smart qoutes and double straight quotes
TTOzzi Feb 4, 2024
c0a3702
Migrate deprecated NSLinguisticTagger API to Natural Language framework
TTOzzi Feb 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Sources/SwiftFormat/Rules/BeginDocumentationCommentWithOneLineSummary.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,14 @@ public final class BeginDocumentationCommentWithOneLineSummary: SyntaxLintRule {
in: text.startIndex..<text.endIndex,
scheme: NSLinguisticTagScheme.lexicalClass.rawValue,
tokenRanges: &tokenRanges)
var isInsideQuotes = false
let sentenceTerminatorIndices = tags.enumerated().filter {
$0.element == "SentenceTerminator"
if $0.element == "OpenQuote" {
isInsideQuotes = true
} else if $0.element == "CloseQuote" {
isInsideQuotes = false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to point out that this won't handle nested quotes correctly, but it looks like the Foundation API itself doesn't categorize them correctly either:

func tags(_ text: String) {
  var tokenRanges = [Range<String.Index>]()
  let tags = text.linguisticTags(in: text.startIndex..<text.endIndex, scheme: NSLinguisticTagScheme.lexicalClass.rawValue, tokenRanges: &tokenRanges)
  print(Array(tags))
}
tags("\"Hello 'world'\"")
// ["OpenQuote", "Interjection", "Whitespace", "OpenQuote", "Noun", "CloseQuote", "OpenQuote"]

So an attempt to increment/decrement a nested quote count won't work as intended. In other words, I wanted to point it out but you don't need to change anything.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is entirely dependent on the behavior of the Foundation API.
And since linguisticTags is a deprecated API, it's unlikely that we'll see any improvements to it 🤔

The replacement, NaturalLanguage, works the same as linguisticTags, but I've migrated to it in case it's improved in the future.

}
return !isInsideQuotes && $0.element == "SentenceTerminator"
}.map {
tokenRanges[$0.offset].lowerBound
}
Expand Down
20 changes: 20 additions & 0 deletions Tests/SwiftFormatTests/Rules/BeginDocumentationCommentWithOneLineSummaryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,24 @@ final class BeginDocumentationCommentWithOneLineSummaryTests: LintOrFormatRuleTe
)
#endif
}

func testSentenceTerminationInsideQuotes() {
assertLint(
BeginDocumentationCommentWithOneLineSummary.self,
"""
/// Creates an instance with the same raw value as `x` failing iff `x.kind != Subject.kind`.
struct TestBackTick {}

/// A set of `Diagnostic` that can answer the question 'was there an error?' in O(1).
struct TestSingleQuotes {}

/// A set of `Diagnostic` that can answer the question “was there an error?” in O(1).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both this example and the one below use smart quotes. Can you add one with regular ASCII (straight) double quotes?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I'll add it!

struct TestDoubleQuotes {}

/// A set of `Diagnostic` that can answer the question “was there
/// an error?” in O(1).
struct TestTwoLinesDoubleQuotes {}
"""
)
}
}