File: BasicFormat.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (100 lines) | stat: -rw-r--r-- 3,317 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import ArgumentParser
import SwiftBasicFormat
import SwiftDiagnostics
import SwiftParser
import SwiftParserDiagnostics
import SwiftSyntax

struct BasicFormat: ParsableCommand, ParseCommand {
  enum Error: Swift.Error, CustomStringConvertible {
    case unknownSyntaxNodeType(nodeType: String, parsableTypes: [String])

    var description: String {
      switch self {
      case .unknownSyntaxNodeType(nodeType: let nodeType, parsableTypes: let parsableTypes):
        return """
          '\(nodeType)' is not a SwiftSyntax node type that conforms to SyntaxParsable. Possible options are:
          \(parsableTypes.map {" - \($0)" }.joined(separator: "\n"))
          """
      }
    }
  }

  static var configuration = CommandConfiguration(
    commandName: "basic-format",
    abstract: "Format a source file using BasicFormat"
  )

  @OptionGroup
  var arguments: ParseArguments

  @Option(help: "The number of spaces to use for indentation")
  var indentationWidth: Int = 4

  @Option(help: "The type that the node should be parsed as")
  var nodeType: String = "SourceFileSyntax"

  func run() throws {
    guard case .choices(let choices) = Syntax.structure else {
      fatalError("Expected `Syntax.structure` to be the `choices` case")
    }

    let parsableMetatypes = choices.compactMap { (choice) -> SyntaxParseable.Type? in
      guard case .node(let nodeType) = choice else {
        return nil
      }
      return nodeType as? SyntaxParseable.Type
    }
    let parsableMetatypesByName = Dictionary(
      parsableMetatypes.map {
        (String(reflecting: $0).replacingOccurrences(of: "SwiftSyntax.", with: ""), $0)
      },
      uniquingKeysWith: { l, r in l }
    )

    guard let parseType = parsableMetatypesByName[nodeType] else {
      throw Error.unknownSyntaxNodeType(nodeType: nodeType, parsableTypes: parsableMetatypesByName.keys.sorted())
    }

    let tree = try sourceFileContents.withUnsafeBufferPointer { sourceBuffer in
      var parser = Parser(sourceBuffer)
      return parseType.parse(from: &parser)
    }

    let resultTree: Syntax
    if foldSequences {
      resultTree = foldAllSequences(tree).0
    } else {
      resultTree = Syntax(tree)
    }

    if resultTree.hasError {
      let diags = ParseDiagnosticsGenerator.diagnostics(for: tree)
      printerr(
        """
        Source input contained syntax errors. Formatting might be incorrect due to these errors:
        \(DiagnosticsFormatter(colorize: TerminalHelper.isConnectedToTerminal).annotatedSource(tree: tree, diags: diags))
        ----------------------------------------
        """
      )
    }

    let formattedTree = resultTree.formatted(
      using: SwiftBasicFormat.BasicFormat(indentationWidth: .spaces(indentationWidth))
    )

    print(formattedTree.description)
  }
}