17dbfa5..master · SourceDocsSwift

git.iko.soy/SourceDocsSwift

README.md+36

@@ -1,3 +1,39 @@

1# SourceDocsSwift

3Генернирует LaTeX-таблицы всех классов, структур и их полей и методов из проекта Xcode для вставки в техническую документацию.

5+## Установка

7+```bash

8+brew install ilyakooo0/tap/sourceDocsSwift

9+```

10+

11+## Использование

12+

13+```bash

14+sourceDocsSwift -i path/to/XcodePrjectDirectory/ -o path/to/output/doc.tex -s latex -l 1

15+```

16+

17+```bash

18+sourceDocsSwift -s tech -l 2

19+```

20+

21+По умолчанию ищет проект в текущей папке и пишет результат в эту же папку в файл `doc.tex`.

22+

23+В LaTeX документ можно вставить просто положив рядом с щсновным `.tex` документом и вставив в нужное место:

24+

25+```LaTeX

26+\include{doc}

27+```

28+

29+Так же требуется пакет `longtable`. Если в вашем шаблоне этого еще нигде нет, то где-нибудь в преамбуле надо вставить:

30+

31+```LaTeX

32+\usepackage{longtable}

33+```

34+### Параметры

35+

36+- `[-s | --style] [latex | tech]` -- стиль команды самого внешнего уровня

37+- `[-l | --level] [1 | 2 | 3]` -- отступ в уровнях

38+- `[-i | --input] path/to/projectDirectory` -- путь к папке с проектом

39+- `[-o | --output] path/to/output.tex` -- путь к фалу, в который писать результат

SourceDocsSwift/TeXer.swift+50−13

@@ -7,26 +7,26 @@

7//

9struct TeXer {

10− static func convert(objects: [Object]) -> String {

10+ static func convert(objects: [Object], with style: TexType = .laTeX(2)) -> String {

11 return """

12− \\subsection{Описание классов и структур}

12+ \\\(style.section(for: 1)){Описание классов и структур}

14− \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}

14+ \\begin{longtable}{| >{\\raggedright\\arraybackslash}p{0.55\\textwidth} | p{0.4\\textwidth}|}

15 \\hline

16 \\textbf{Класс или стркура} & \\textbf{Описание} \\\\ \\hline

17− \( objects.map {"\\texttt{\($0.declaration)} & \($0.documentation ?? "{\\color{red} TODO}") \\\\ \\hline"} .joined(separator: "\n") )

17+ \( objects.map {"\\texttt{\($0.declaration)} & {\\color{red} TODO} \\\\ \\hline"} .joined(separator: "\n") )

18 \\end{longtable}

19−

20+

21− \\subsection{Описание полей классов и структур}

21+ \\\(style.section(for: 1)){Описание полей классов и структур}

23 \(

24 objects.compactMap {

25 if $0.fields.count > 0 {

26 return """

27− \\subsubsection{\\texttt{\($0.declaration)}}

27+ \\\(style.section(for: 2))*{\\texttt{\($0.declaration)}}

29− \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}

29+ \\begin{longtable}{| >{\\raggedright\\arraybackslash}p{0.55\\textwidth} | p{0.4\\textwidth}|}

30 \\hline

31 \\textbf{Поле} & \\textbf{Описание} \\\\ \\hline

32 \( $0.fields.map {"\\texttt{\($0.declaration.prefix {$0 != "="})} & {\\color{red} TODO} \\\\ \\hline"} .joined(separator: "\n") )

@@ -38,19 +38,19 @@ struct TeXer {

38 }

39 } .joined(separator: "\n")

40 )

41−

41+

42− \\subsection{Описание методов классов и структур}

42+ \\\(style.section(for: 1)){Описание методов классов и структур}

44 \(

45 objects.compactMap {

46 if $0.methods.count > 0 {

47 return """

48− \\subsubsection{\\texttt{\($0.declaration)}}

48+ \\\(style.section(for: 2))*{\\texttt{\($0.declaration)}}

50− \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}

50+ \\begin{longtable}{| >{\\raggedright\\arraybackslash}p{0.55\\textwidth} | p{0.4\\textwidth}|}

51 \\hline

52 \\textbf{Метод} & \\textbf{Описание} \\\\ \\hline

53− \( $0.methods.map {"\\texttt{\($0.declaration)} & \($0.documentation ?? "{\\color{red} TODO}") \\\\ \\hline"} .joined(separator: "\n") )

53+ \( $0.methods.map {"\\texttt{\($0.declaration)} & {\\color{red} TODO} \\\\ \\hline"} .joined(separator: "\n") )

54 \\end{longtable}

56 """

@@ -61,4 +61,41 @@ struct TeXer {

61 )

62 """

63 }

64+

65+ enum TexType {

66+ case techDoc(Int)

67+ case laTeX(Int)

68+

69+ func section(`for` level: Int) -> String {

70+ switch self {

71+ case .laTeX(let i):

72+ return String(repeating: "sub", count: i+level-2).appending("section")

73+ case .techDoc(let i):

74+ switch i+level-2 {

75+ case 0:

76+ return "addition"

77+ default:

78+ return TexType.laTeX(i).section(for: level)

79+ }

80+ }

81+ }

82+ var levelOffset: Int {

83+ get {

84+ switch self {

85+ case .laTeX(let i):

86+ return i

87+ case .techDoc(let i):

88+ return i

89+ }

90+ }

91+ set {

92+ switch self {

93+ case .laTeX(_):

94+ self = .laTeX(newValue)

95+ case .techDoc(_):

96+ self = .techDoc(newValue)

97+ }

98+ }

99+ }

100+ }

64}

101}

SourceDocsSwift/main.swift+59−13

@@ -8,36 +8,76 @@

9import Foundation

11−//let directory = "/Users/ilya/Developer/Dotrix/Dotrix/"

12−//let output = "/Users/ilya/Desktop/foo.tex"

13−

14let args = Array(CommandLine.arguments.dropFirst())

11let args = Array(CommandLine.arguments.dropFirst())

15−let temp = FileManager.default.temporaryDirectory.appendingPathComponent("SourceDocsSwift/build\(Date().timeIntervalSince1970)")

12+//let temp = FileManager.default.temporaryDirectory.appendingPathComponent("SourceDocsSwift/build\(Date().timeIntervalSince1970)", isDirectory: true)

16−

17−print(temp)

19var output = "docs.tex"

14var output = "docs.tex"

20var directory: String?

15var directory: String?

16+var style: TeXer.TexType = .laTeX(2)

22var i = 0

18var i = 0

23while i < args.count {

19while i < args.count {

24 switch args[i] {

20 switch args[i] {

25− case "-o":

21+ case "-o", "--output":

26 if i + 1 < args.count {

22 if i + 1 < args.count {

27 i += 1

23 i += 1

28 output = args[i]

24 output = args[i]

29 }

25 }

30− case "-i":

26+ case "-i", "--input":

31 if i + 1 < args.count {

27 if i + 1 < args.count {

32 i += 1

28 i += 1

33 directory = args[i]

29 directory = args[i]

34 }

30 }

31+ case "-s", "--style":

32+ if i + 1 < args.count {

33+ i += 1

34+ switch args[i].lowercased() {

35+ case "latex", "xetex", "tex":

36+ style = .laTeX(style.levelOffset)

37+ case "tech", "techdoc", "techdocs":

38+ style = .techDoc(style.levelOffset)

39+ default:

40+ print("""

41+ That is not a valid style.

42+

43+ Valid styles are:

44+ latex

45+ techdoc

46+ """)

47+ exit(1)

48+ }

49+ }

50+ case "-l", "--level":

51+ if i + 1 < args.count {

52+ i += 1

53+ guard let l = Int(args[i]) else {

54+ print("""

55+ That is not a valid int.

56+ """)

57+ exit(1)

58+ }

59+ if l < 1 {

60+ print("""

61+ Level must be greater or equal to 1.

62+ """)

63+ exit(1)

64+ }

65+ style.levelOffset = l

66+ }

35 default:

67 default:

36 break

68 break

37 }

69 }

38 i += 1

70 i += 1

39}

71}

73+var outputIsDirectory: ObjCBool = false

74+

75+FileManager.default.fileExists(atPath: output, isDirectory: &outputIsDirectory)

76+

77+if outputIsDirectory.boolValue {

78+ output.append("/docs.tex")

79+}

80+

41let decoder = JSONDecoder()

81let decoder = JSONDecoder()

43guard let xcbTagetData = Shell.launch(executable: "/usr/bin/xcodebuild", arguments: ["-list", "-json"], launchDirectory: directory) else {

83guard let xcbTagetData = Shell.launch(executable: "/usr/bin/xcodebuild", arguments: ["-list", "-json"], launchDirectory: directory) else {

@@ -59,8 +99,8 @@ let targets = xcbResponse.targets

59var files: [String: [Object]] = [:]

99var files: [String: [Object]] = [:]

100

61for target in targets {

101for target in targets {

62− try? FileManager.default.removeItem(at: temp)

102+// try? FileManager.default.removeItem(at: temp)

63− guard let skResponseData = Shell.launch(executable: "/usr/local/bin/sourcekitten", arguments: ["doc", "--", "-target", target, "CONFIGURATION_BUILD_DIR=\(temp)"], launchDirectory: directory) else {

103+ guard let skResponseData = Shell.launch(executable: "/usr/local/bin/sourcekitten", arguments: ["doc", "--", "-target", target], launchDirectory: directory) else {

64 print("""

104 print("""

65 Make sure sourcekitten is installed

105 Make sure sourcekitten is installed

106

@@ -80,9 +120,15 @@ for target in targets {

120

121

122

83−let tex = TeXer.convert(objects: files.flatMap {$0.value})

123+let tex = TeXer.convert(objects: files.flatMap {$0.value}, with: style)

84−

124+do {

85−try? tex.write(toFile: output, atomically: true, encoding: .utf8)

125+ try tex.write(toFile: output, atomically: true, encoding: .utf8)

126+} catch {

127+ print("""

128+ There was an error writing the outuput file.

129+ """)

130+ exit(1)

131+}

132

87print("""

133print("""

88+-------+

134+-------+