Using the Generator SDK

After reading this document you will know how-to download, install and use the CodeSmith Generator SDK in your applications. This document will also demonstrate the most common uses of the CodeSmith Generator API:

• Compiling a template
• Retrieving compile errors
• Creating a new template instance
• Filling in template metadata
• Rendering a template

Download

After logging into your account, visit the following downloads section to download the latest version of CodeSmith Generator.

Installing the license

A license key file will be emailed to you after you purchase the SDK license from the online store. This license file needs to meet one of the following criteria:

• Embed the license file into your application as an embedded resource in the assembly that calls the CodeSmith.Engine.
• Place the license file into the same directory as your application.
• Specify a license key via the Generator:License environment variable or in code via the CodeSmithLicense.SetLicenseKey(key) method. We only recommend this for build/web servers as this will overwrite any locally defined licenses.

Creating a new project

In order to use the CodeSmith Generator SDK you will need to create a new .Net 4.6.2 or newer project. In the example below, we will be creating a new console application.

Adding project references

Next, you are required to reference the following NuGet packages:

• CodeSmith.Generator

public static void Main() {
    string path = System.IO.Path.Combine(AppDomain.CurrentDomain.BaseDirectory, @"..\..\StoredProcedures.cst");
    var engine = new TemplateEngine(new DefaultEngineHost(System.IO.Path.GetDirectoryName(path)));

    CompileTemplateResult result = engine.Compile(path);
    if (result.Errors.Count == 0) {
        var database = new DatabaseSchema(new SqlSchemaProvider(), @"Server=.;Database=PetShop;Integrated Security=True;");
        TableSchema table = database.Tables["Inventory"];

        CodeTemplate template = result.CreateTemplateInstance();
        template.SetProperty("SourceTable", table);
        template.SetProperty("IncludeDrop", false);
        template.SetProperty("InsertPrefix", "Insert");
        template.Render(Console.Out);
    } else {
        foreach (var error in result.Errors)
            Console.Error.WriteLine(error.ToString());
    }
    
    Console.WriteLine("\r\nPress any key to continue.");
    Console.ReadKey();
}