Repository navigation
BULLETIN 202508-01: Type naming convention #17
matthew25187
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Warning
This bulletin concerns breaking changes that may impact your application code. If you are using an affected package, you may need to update your application after upgrading your package reference to the affected versions listed below.
Introduction
The naming of standards-based types has been applied inconsistently across the various packages that comprise the Data Standardizer project. To avoid problems this issue may cause with the future expansion of standards-based support, it has been decided to apply a naming convention to types that implement standards.
Change
The naming convention that will now apply to standards-based types will mean that type names have a prefix conforming to the following rules:
Iso6093NumberIn this example, types related to the implementation of the ISO 6093 standard would have names starting with the prefix
Iso6093Number.For enum types, they will be "renamed" in a two-stage process.
If the type is supporting an enum or implements some other aspect of a standard, the type may be renamed to a name that has a compliant prefix.
The intention is that, for the most part, you should be able to continue to use the enums you have already deployed in your application code without change until such time as you are able to update these references.
Which packages will be affected
Some packages will not be affected, either because they don't include standards support or because their standards-based types already have names with these prefixes.
Packages that have types that will need to change include:
What do I need to do
You can continue to use the current packages as long as you need and no changes will be required to your application. If, however, you upgrade your package references to newer versions including these changes, your code should continue to work as-is if you've only made use of the enums directly or the extension methods for them. If your code references any of the other types — like the metadata attributes, for example — you will need to update your application code to use the new type names.
Tip
You can use an alias to create a local or global name for a type imported from one of the Data Standardizer packages.
For example, if you are currently using the
Iso4217currency enum, a type that has been replaced by the newIso4217Currencyenum in the new version of the DataStandardizer.ISO4217 package, then you could create an alias for the currency type like so:The
IsoCurrencyalias can then be used in your code where you want to use an instance of the currency type. When you update the DataStandardizer.ISO4217 package reference and the new enum becomes available, you only need to change the type reference in the alias declaration for all uses of theIsoCurrencyalias to then make use of the new enum.It is strongly recommended that you update your application code to use the new type names sooner rather than later. This will reduce or eliminate friction when you choose to update your package references later.
All reactions