FilesExpand file tree

develop

/

ReleaseNotesParser.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

156 lines (129 loc) · 4.75 KB

develop

/

ReleaseNotesParser.cs

Copy path

Top

File metadata and controls

• Code
• Blame

156 lines (129 loc) · 4.75 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

// Licensed to the .NET Foundation under one or more agreements.

// The .NET Foundation licenses this file to you under the MIT license.

// See the LICENSE file in the project root for more information.

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text.RegularExpressions;

using Cake.Core;

namespace Cake.Common

{

/// <summary>

/// The release notes parser.

/// </summary>

public sealed class ReleaseNotesParser

{

private readonly Regex _versionRegex;

/// <summary>

/// Initializes a new instance of the <see cref="ReleaseNotesParser"/> class.

/// </summary>

public ReleaseNotesParser()

{

_versionRegex = new Regex(@"([0-9]+\.)+[0-9]+");

}

/// <summary>

/// Parses all release notes.

/// </summary>

/// <param name="content">The content.</param>

/// <returns>All release notes.</returns>

public IReadOnlyList<ReleaseNotes> Parse(string content)

{

if (content == null)

{

throw new ArgumentNullException(nameof(content));

}

var lines = content.SplitLines();

if (lines.Length > 0)

{

var line = lines[0].Trim();

if (line.StartsWith("#", StringComparison.OrdinalIgnoreCase))

{

return ParseComplexFormat(lines);

}

if (line.StartsWith("*", StringComparison.OrdinalIgnoreCase))

{

return ParseSimpleFormat(lines);

}

}

throw new CakeException("Unknown release notes format.");

}

private IReadOnlyList<ReleaseNotes> ParseComplexFormat(string[] lines)

{

var lineIndex = 0;

var result = new List<ReleaseNotes>();

while (true)

{

if (lineIndex >= lines.Length)

{

break;

}

// Parse header.

var versionResult = _versionRegex.Match(lines[lineIndex]);

if (!versionResult.Success)

{

throw new CakeException("Could not parse version from release notes header.");

}

// Create release notes.

var version = Version.Parse(versionResult.Value);

var rawVersionLine = lines[lineIndex];

// Increase the line index.

lineIndex++;

// Parse content.

var notes = new List<string>();

while (true)

{

// Sanity checks.

if (lineIndex >= lines.Length)

{

break;

}

if (lines[lineIndex].StartsWith("#", StringComparison.OrdinalIgnoreCase))

{

break;

}

// Get the current line.

var line = (lines[lineIndex] ?? string.Empty).Trim('*').Trim();

if (!string.IsNullOrWhiteSpace(line))

{

notes.Add(line);

}

lineIndex++;

}

result.Add(new ReleaseNotes(version, notes, rawVersionLine));

}

return result.OrderByDescending(x => x.Version).ToArray();

}

private IReadOnlyList<ReleaseNotes> ParseSimpleFormat(string[] lines)

{

var lineIndex = 0;

var result = new List<ReleaseNotes>();

while (true)

{

if (lineIndex >= lines.Length)

{

break;

}

// Trim the current line.

var line = (lines[lineIndex] ?? string.Empty).Trim('*', ' ');

if (string.IsNullOrWhiteSpace(line))

{

lineIndex++;

continue;

}

// Parse header.

var versionResult = _versionRegex.Match(line);

if (!versionResult.Success)

{

throw new CakeException("Could not parse version from release notes header.");

}

var version = Version.Parse(versionResult.Value);

// Parse the description.

line = line.Substring(versionResult.Length).Trim('-', ' ');

// Add the release notes to the result.

result.Add(new ReleaseNotes(version, new[] { line }, line));

lineIndex++;

}

return result.OrderByDescending(x => x.Version).ToArray();

}

}

}