File: ArgumentParser%2BMDoc.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-- 2,810 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
//===----------------------------------------------------------*- swift -*-===//
//
// This source file is part of the Swift Argument Parser open source project
//
// Copyright (c) 2021 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
//
//===----------------------------------------------------------------------===//

import ArgumentParser
import ArgumentParserToolInfo

extension CommandInfoV0 {
  func manualPageFileName(section: Int) -> String {
    manualPageTitle + ".\(section)"
  }

  var manualPageDocumentTitle: String {
    let parts = (superCommands ?? []) + [commandName]
    return parts.joined(separator: ".").uppercased()
  }

  var manualPageTitle: String {
    let parts = (superCommands ?? []) + [commandName]
    return parts.joined(separator: ".")
  }

  var manualPageName: String {
    let parts = (superCommands ?? []) + [commandName]
    return parts.joined(separator: " ")
  }
}

extension ArgumentInfoV0 {
  // ArgumentInfoV0 value name as MDoc with "..." appended if the argument is
  // repeating.
  var manualPageValueName: MDocASTNode {
    var valueName = valueName ?? ""
    if isRepeating {
      valueName += "..."
    }
    // FIXME: MDocMacro.Emphasis?
    return MDocMacro.CommandArgument(arguments: [valueName])
  }

  // ArgumentDefinition formatted as MDoc for use in a description section.
  var manualPageDescription: MDocASTNode {
    // names.partitioned.map(\.manualPage).interspersed(with: ",")
    var synopses = (names ?? []).partitioned
      .flatMap { [$0.manualPage, ","] }
    synopses = synopses.dropLast()

    switch kind {
    case .positional:
      return manualPageValueName
    case .option:
      return MDocMacro.CommandOption(options: synopses)
        .withUnsafeChildren(nodes: [manualPageValueName])
    case .flag:
      return MDocMacro.CommandOption(options: synopses)
    }
  }
}

extension ArgumentInfoV0.NameInfoV0 {
  // Name formatted as MDoc.
  var manualPage: MDocASTNode {
    switch kind {
    case .long:
      return "-\(name)"
    case .short:
      return name
    case .longWithSingleDash:
      return name
    }
  }
}

extension Array where Element == ParsableCommand.Type {
  var commandNames: [String] {
    var commandNames = [String]()
    if let superName = first?.configuration._superCommandName {
      commandNames.append(superName)
    }
    commandNames.append(contentsOf: map { $0._commandName })
    return commandNames
  }
}

extension BidirectionalCollection where Element == ArgumentInfoV0.NameInfoV0 {
  var preferredName: Element? {
    first { $0.kind != .short } ?? first
  }

  var partitioned: [Element] {
    filter { $0.kind == .short } + filter { $0.kind != .short }
  }
}