| | | 1 | | // Copyright DotNet API Diff Project Contributors - SPDX Identifier: MIT |
| | | 2 | | using System.Text.Json.Serialization; |
| | | 3 | | |
| | | 4 | | namespace DotNetApiDiff.Models.Configuration; |
| | | 5 | | |
| | | 6 | | /// <summary> |
| | | 7 | | /// Configuration for defining what constitutes breaking changes |
| | | 8 | | /// </summary> |
| | | 9 | | public class BreakingChangeRules |
| | | 10 | | { |
| | | 11 | | /// <summary> |
| | | 12 | | /// Whether removing a public type is considered a breaking change |
| | | 13 | | /// </summary> |
| | | 14 | | [JsonPropertyName("treatTypeRemovalAsBreaking")] |
| | 328 | 15 | | public bool TreatTypeRemovalAsBreaking { get; set; } = true; |
| | | 16 | | |
| | | 17 | | /// <summary> |
| | | 18 | | /// Whether removing a public member is considered a breaking change |
| | | 19 | | /// </summary> |
| | | 20 | | [JsonPropertyName("treatMemberRemovalAsBreaking")] |
| | 325 | 21 | | public bool TreatMemberRemovalAsBreaking { get; set; } = true; |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// Whether changing a member's signature is considered a breaking change |
| | | 25 | | /// </summary> |
| | | 26 | | [JsonPropertyName("treatSignatureChangeAsBreaking")] |
| | 328 | 27 | | public bool TreatSignatureChangeAsBreaking { get; set; } = true; |
| | | 28 | | |
| | | 29 | | /// <summary> |
| | | 30 | | /// Whether reducing a member's accessibility is considered a breaking change |
| | | 31 | | /// </summary> |
| | | 32 | | [JsonPropertyName("treatReducedAccessibilityAsBreaking")] |
| | 308 | 33 | | public bool TreatReducedAccessibilityAsBreaking { get; set; } = true; |
| | | 34 | | |
| | | 35 | | /// <summary> |
| | | 36 | | /// Whether adding an interface to a type is considered a breaking change |
| | | 37 | | /// </summary> |
| | | 38 | | [JsonPropertyName("treatAddedInterfaceAsBreaking")] |
| | 308 | 39 | | public bool TreatAddedInterfaceAsBreaking { get; set; } = false; |
| | | 40 | | |
| | | 41 | | /// <summary> |
| | | 42 | | /// Whether removing an interface from a type is considered a breaking change |
| | | 43 | | /// </summary> |
| | | 44 | | [JsonPropertyName("treatRemovedInterfaceAsBreaking")] |
| | 308 | 45 | | public bool TreatRemovedInterfaceAsBreaking { get; set; } = true; |
| | | 46 | | |
| | | 47 | | /// <summary> |
| | | 48 | | /// Whether changing a parameter name is considered a breaking change |
| | | 49 | | /// </summary> |
| | | 50 | | [JsonPropertyName("treatParameterNameChangeAsBreaking")] |
| | 308 | 51 | | public bool TreatParameterNameChangeAsBreaking { get; set; } = false; |
| | | 52 | | |
| | | 53 | | /// <summary> |
| | | 54 | | /// Whether adding an optional parameter is considered a breaking change |
| | | 55 | | /// </summary> |
| | | 56 | | [JsonPropertyName("treatAddedOptionalParameterAsBreaking")] |
| | 308 | 57 | | public bool TreatAddedOptionalParameterAsBreaking { get; set; } = false; |
| | | 58 | | |
| | | 59 | | /// <summary> |
| | | 60 | | /// Whether adding a new member is considered a breaking change |
| | | 61 | | /// </summary> |
| | | 62 | | [JsonPropertyName("treatAddedMemberAsBreaking")] |
| | 323 | 63 | | public bool TreatAddedMemberAsBreaking { get; set; } = false; |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// Whether adding a new type is considered a breaking change |
| | | 67 | | /// </summary> |
| | | 68 | | [JsonPropertyName("treatAddedTypeAsBreaking")] |
| | 326 | 69 | | public bool TreatAddedTypeAsBreaking { get; set; } = false; |
| | | 70 | | |
| | | 71 | | /// <summary> |
| | | 72 | | /// Creates a default set of breaking change rules |
| | | 73 | | /// </summary> |
| | | 74 | | /// <returns>A default set of breaking change rules</returns> |
| | | 75 | | public static BreakingChangeRules CreateDefault() |
| | 82 | 76 | | { |
| | 82 | 77 | | return new BreakingChangeRules |
| | 82 | 78 | | { |
| | 82 | 79 | | TreatTypeRemovalAsBreaking = true, |
| | 82 | 80 | | TreatMemberRemovalAsBreaking = true, |
| | 82 | 81 | | TreatSignatureChangeAsBreaking = true, |
| | 82 | 82 | | TreatReducedAccessibilityAsBreaking = true, |
| | 82 | 83 | | TreatAddedInterfaceAsBreaking = false, |
| | 82 | 84 | | TreatRemovedInterfaceAsBreaking = true, |
| | 82 | 85 | | TreatParameterNameChangeAsBreaking = false, |
| | 82 | 86 | | TreatAddedOptionalParameterAsBreaking = false, |
| | 82 | 87 | | TreatAddedMemberAsBreaking = false, |
| | 82 | 88 | | TreatAddedTypeAsBreaking = false |
| | 82 | 89 | | }; |
| | 82 | 90 | | } |
| | | 91 | | } |