/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed default value of parameter '{0}' in {1} which may cause an unintentional behavioral change in code. The value was changed from '{2}' to '{3}'.",
FormatItem.ParameterName(NewParameter, StyleFlags.Italics),
FormatItem.ParameterizedItemName(NewParameterizedItem, StyleFlags.Bold),
FormatItem.DefaultParameterValue(OldParameter, StyleFlags.Italics),
FormatItem.DefaultParameterValue(NewParameter, StyleFlags.Italics));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed the ref or out modifier of parameter '{0}' in {1} which will cause invocations to not compile.",
FormatItem.ParameterName(NewParameter, StyleFlags.Italics),
FormatItem.ParameterizedItemName(NewParameterizedItem, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Removed override of abstract {0} {1} in {2} which may derived classes to not compile.",
FormatItem.MemberKind(OldMemberOverride),
FormatItem.MemberName(OldMemberOverride, StyleFlags.Italics),
FormatItem.MemberName(NewType, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Added a new abstract {0} {1} which will cause derived classes to not compile.",
FormatItem.MemberKind(NewMember),
FormatItem.MemberName(NewMember, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Removed the equivalent to assembly {0} in the new version, which will cause projects referencing the assembly to not compile.",
FormatItem.AssemblyName(OldAssembly, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Removed implementation of interface {0} from {1} which may cause code using the {2} to not compile.",
FormatItem.MemberName(OldInterfaceType, StyleFlags.Italics),
FormatItem.MemberName(NewType, StyleFlags.Bold),
FormatItem.MemberKind(NewType));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed constraints for the generic type parameter {0} in {1} {2} which may cause constructions of the entity to not compile.",
FormatItem.MemberName(NewGenericParameter, StyleFlags.Italics),
FormatItem.MemberKind(NewGenericParameter.GenericDeclaringMember),
FormatItem.MemberName(NewGenericParameter.GenericDeclaringMember, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Added or removed the static modifier of {0} {1} which may cause code using the {0} to not compile.",
FormatItem.MemberKind(NewMember),
FormatItem.MemberName(NewMember, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed read-write field {0} to read-only which will cause writes to the field to not compile.",
FormatItem.MemberName(NewField, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed non-static sealed class {0} to static which will cause instantiations of the sealed class to not compile.",
FormatItem.MemberName(NewType, StyleFlags.Bold));
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed accessibility of {0} from public to protected which may cause code to not compile.",
FormatItem.MemberName(NewMember, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Added a new interface {0} {1} which will cause implementing types to not compile.",
FormatItem.MemberKind(NewMember),
FormatItem.MemberName(NewMember, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Added a new base interface {1} to {0} which will cause implementing types to not compile.",
FormatItem.MemberName(NewType, StyleFlags.Bold),
FormatItem.MemberName(NewInterfaceType, StyleFlags.Italics));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed the name of a parameter from '{0}' to '{1}' in {2} which will cause named arguments in invocations to not compile.",
FormatItem.ParameterName(OldParameter, StyleFlags.Italics),
FormatItem.ParameterName(NewParameter, StyleFlags.Italics),
FormatItem.ParameterizedItemName(NewParameterizedItem, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed variance (in or out modifier) for the generic type parameter {0} in {1} {2} which may cause implicit conversions of the {1} to not compile.",
FormatItem.MemberName(NewGenericParameter, StyleFlags.Italics),
FormatItem.MemberKind(NewGenericParameter.GenericDeclaringMember),
FormatItem.MemberName(NewGenericParameter.GenericDeclaringMember, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed the type of parameter '{0}' in {1} in a way which may cause invocations to not compile. Type was changed from {2} to {3}.",
FormatItem.ParameterName(NewParameter, StyleFlags.Italics),
FormatItem.ParameterizedItemName(NewParameterizedItem, StyleFlags.Bold),
FormatItem.TypedItemTypeName(OldParameter, StyleFlags.Italics),
FormatItem.TypedItemTypeName(NewParameter, StyleFlags.Italics));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed virtual {0} {1} to non-virtual which will cause derived classes overriding the {0} to not compile.",
FormatItem.MemberKind(NewMember),
FormatItem.MemberName(NewMember, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed the base sealed class of {0} to something not derived from the previous base sealed class which may cause code using the sealed class to not compile. The base sealed class was changed from {1} to {2}.",
FormatItem.MemberName(NewType, StyleFlags.Bold),
FormatItem.MemberName(OldType.BaseType, StyleFlags.Italics),
FormatItem.MemberName(NewType.BaseType, StyleFlags.Italics));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed the type of {0} {1} in a way which may cause code using the {0} to not compile. Type was changed from {2} to {3}.",
FormatItem.TypedItemKind(NewTypedItem),
FormatItem.TypedItemName(NewTypedItem, StyleFlags.Bold),
FormatItem.TypedItemTypeName(OldTypedItem, StyleFlags.Italics),
FormatItem.TypedItemTypeName(NewTypedItem, StyleFlags.Italics));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Removed the 'this' modifier from the first parameter of {0} which will cause code using the method as an extension method to not compile.",
FormatItem.MemberName(NewMethod, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed the parameter count of {0} in a way which may cause invocations to not compile. Previous declaration was {1}.",
FormatItem.ParameterizedItemName(NewParameterizedItem, StyleFlags.Bold),
FormatItem.ParameterizedItemName(OldParameterizedItem, StyleFlags.Italics));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Removed {0} {1} which will cause code using the {0} to not compile.",
FormatItem.MemberKind(OldMember),
FormatItem.MemberName(OldMember, StyleFlags.Bold));
/// <summary> /// Formats a message explaining the breaking change using the specified formatter. /// </summary> public abstract void FormatMessage(IBreakingChangeFormatter formatter);
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Removed or changed the visibility of the get or set accessor of {0} {1} which may code using the {0} to not compile.",
FormatItem.MemberKind(NewProperty),
FormatItem.MemberName(NewProperty, StyleFlags.Bold));
/// <inheritdoc/>
public override void FormatMessage(IBreakingChangeFormatter formatter) =>
formatter.AppendFormat("Changed sealed class {0} from unsealed to sealed which will cause derived classes to not compile.",
FormatItem.MemberName(NewType, StyleFlags.Bold));
