smithy-lang/smithy-swift

Rename module to `Smithy`

Closed this issue ยท 1 comments

Community Note

  • Please vote on this issue by adding a ๐Ÿ‘ reaction to the original issue to help the community and maintainers prioritize this request
  • Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
  • If you are interested in working on this issue, please leave a comment

Describe the Feature

The current name of the module defined by this package (ClientRuntime) is not sufficiently descriptive to the developer, because it does not indicate to the developer that the module is associated with the Smithy project. The nondescript module name ClientRuntime also raises the possibility of namespace collisions with other packages which may also define a ClientRuntime. For this reason, I propose to rename the module to Smithy.

The name of the published library is also ClientRuntime, but I think it is OK to keep that name for the published library if we change the module name: we would be able to reference the Smithy client runtime by either ClientRuntime (if no namespace collisions exist) or by the fully-qualified identifier Smithy.ClientRuntime when needed.

This will cause a breaking change to packages that are dependent upon this package (Package.swift files and import statements may have to be adjusted), but I believe this is appropriate prior to the 1.0 release, and worth the breakage.

Is your Feature Request related to a problem?

Making this name change will result in easier-to-read code, and prevent namespace collisions with other packages.

Closing, as this should be addressed holistically with the names of other packages, perhaps as part of reference architecture implementation.