Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Transitive Dependencies

We strive to ensure that CodeSmith Generator templates are 100% backwards compatible. However, in very rare circumstances we break backwards compatibility to progress the platform. When we do break backwards compatibility, we ensure that the benefits of breaking compatibility greatly out-way the benefits of not breaking compatibility. Please refer to this document when upgrading CodeSmith Generator to ensure that you have the smoothest experience possible.

...

UITypeEditors are marked as deprecated and will be removed in a future version. The property grid component we use is WPF and no longer supports Windows Forms UITypeEditors going forward. Our recommendation is to use the built in property grid editors.

Transitive Dependencies

All transitive dependencies must be added with an assembly directive to the CodeTemplate. The template will fail to compile in certain scenarios like when using the MSBuild integration.

An example of this would be the CodeSmith.BaseTemplates class library references CodeSmith.CustomProperties class library but most existing templates only reference <%@ Assembly Name="CodeSmith.BaseTemplates" %>. The fix is to add all transitive dependencies with an assembly directive <%@ Assembly Name="CodeSmith.CustomProperties" %>.

Upgrading from CodeSmith Generator 6.0

In Generator 6.0, we introduced a new API's to compile templates using TemplateEngine. In Generator 6.5, we made some major improvements to the TemplateEngine, DefaultEngineHost and IEngineHost interface. These changes allowed us to support new features in memory content. It also allowed feature development without breaking the API. The section below covers any breaking changes that were made during these updates.

...

It is recommended to update your existing CodeTemplateCompiler implementation to use TemplateEngine, but this is not required. Please see the SDK documentation for more information.

SchemaExplorer Type Converter changes

...