Initial implementation of swift-format. #1
Conversation
Co-authored-by: Alexander Lash <abl@users.noreply.github.com> Co-authored-by: Alfredo Delli Bovi <alfredo.dellibovi@gmail.com> Co-authored-by: Andrés Tamez Hdz <andres.96hdz@hotmail.com> Co-authored-by: Austin Belknap <dabelknap@users.noreply.github.com> Co-authored-by: Harlan Haskins <harlanhaskins@users.noreply.github.com> Co-authored-by: Lauren White <lauren5826@gmail.com> Co-authored-by: Tony Allevato <allevato@google.com> Co-authored-by: Yuta Saito <kateinoigakukun@gmail.com>
Co-Authored-By: Dave Abrahams <dabrahams@apple.com>
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| public enum SwiftFormatError: Error { |
| outputStream.write(printer.prettyPrint()) | ||
| } | ||
|
|
||
| // TODO: Add an overload of `format` that takes the source text directly. |
There was a problem hiding this comment.
Will we start using bugs.swift.org for swift-format bugs? If so, it'd be nice to file this and link to it in the TODO.
There was a problem hiding this comment.
Yes, we have a swift-format component there now, and I have a ton of things to file 😰
| public let fileURL: URL | ||
|
|
||
| /// Indicates whether the file imports XCTest, and is test code | ||
| public var importsXCTest: Bool |
There was a problem hiding this comment.
Any chance this can be an enum with three cases (or a Bool??) It'd be nice to avoid two separate Bool vars.
There was a problem hiding this comment.
Updated to use an enum.
| self.importsXCTest = false | ||
| self.didSetImportsXCTest = false | ||
| self.sourceLocationConverter = SourceLocationConverter(file: fileURL.path, source: sourceText) | ||
| let syntax = try! SyntaxParser.parse(source: sourceText) |
There was a problem hiding this comment.
If this is going to try!, we should probably document that sourceText must be valid source, or convert this to a throw-ing method.
There was a problem hiding this comment.
This initializer was only used by tests, but I refactored the call sites a bit to remove it completely.
| } | ||
|
|
||
| public func visit(_ node: SwitchStmtSyntax) -> SyntaxVisitorContinueKind { | ||
| guard let switchIndentation = node.leadingTrivia?.numberOfSpaces else { |
There was a problem hiding this comment.
Should this also handle tabs?
There was a problem hiding this comment.
I think this rule can be removed now that we have the whitespace linter implemented; I'll need to verify.
| for line in comments.dropFirst(numOfOneSentenceLines) { | ||
| let trimmedLine = line.trimmingCharacters(in: .whitespaces) | ||
|
|
||
| if trimmedLine.starts(with: "- Parameters") { |
There was a problem hiding this comment.
SourceKit should really have routines for parsing these doc comments directly. If not, we should add them. @nkcsgexi do you think that's possible?
There was a problem hiding this comment.
We're planning to use cmark to parse doc comments (and potentially reflow them to fit line limits, since cmark can also re-render them, but that will require some changes to cmark itself to preserve the original markup). I don't know if it would make sense to move that into swift-syntax eventually, though, or to expose it in _InternalSyntaxParser.
| /// Format: Enum cases with empty parentheses will have their parentheses removed. | ||
| /// | ||
| /// - SeeAlso: https://google.github.io/swift#enum-cases | ||
| public final class NoEmptyAssociatedValues: SyntaxFormatRule { |
There was a problem hiding this comment.
I think this rule can be deleted since it's no longer valid given some of the SE-155 changes have landed.
| /// initializer will yield a lint error. | ||
| /// | ||
| /// - SeeAlso: https://google.github.io/swift#initializers-2 | ||
| public struct UseSynthesizedInitializer: SyntaxLintRule { |
There was a problem hiding this comment.
This may need to be revisited given SE-0242
Sources/swift-format/Run.swift
Outdated
| return 1 | ||
| } catch { | ||
| // Workaround: we're unable to directly catch unknownTokenKind errors due to access | ||
| // restrictions. TODO: this can be removed when we update to Swift 5.0. |
There was a problem hiding this comment.
Can this be removed?
| /// A syntax visitor that delegates to individual rules for linting. | ||
| /// | ||
| /// This file will be extended with `visit` methods in Pipelines+Generated.swift. | ||
| struct LintPipeline: SyntaxVisitor { |
There was a problem hiding this comment.
With the way you setup the pipeline it's probably better to switch this to an overridable class by making it a subclass of newly introduced SyntaxVisitorBase but this can be done as follow-up later on.
No description provided.