What is CodeFactory?

CodeFactory is real-time software delivery tool that runs natively inside of Visual Studio. The focus of CodeFactory is to increase the delivery velocity of building new applications and/or uplift/refactor projects to other technologies.

Automation of Construction Delivery Patterns

One of the core features of CodeFactory is its ability to use existing application source code as a data model. This is similar in concept to ORM mapping based tools.

This allows for the consistent implementation of development patterns which can then auto-generate common application code, which developers would otherwise have to build by hand. The following common use case scenarios are good examples of this concept, although many other scenarios are feasible:

  • Adding/Creating bounds checking within methods
  • Implementation of exception handling logic
  • Implementation of standard logging
  • Automation of dependency injection
  • Auto-creation of different application layers, based on common data models, which can now be identified directly from application source code
  • Auto-generation of data access layers, based on different technologies, which fit the needs of a target delivery pattern
  • Auto-generation of validation logic based on application source code data
  • Auto-generation and logic mapping between service technologies and consumers

Automation of Technology Transformation

Due to the way in which the CodeFactory SDK was designed - the tooling is very helpful in transforming existing functionality of an application to a new technology implementation. The following are common use case scenarios for technology transformation, but like the Construction Delivery Patterns described above, the examples are not the only scenarios for usage.

  • Read ORM-based data classes and transform into POCO's or to other ORM based implementations
  • Read data classes and generate interface definitions for all classes
  • Read markup languages and use adapters to transform markup from one implementation into another (Example WebForms to Blazor)
  • Read markup languages and update UI implementation frameworks from one implementation to another (Example Modern UI to BootStrap)
  • Lift and shift of application logic from one platform to another (Example mapping logic from .NET Framework to .NET Standard)
  • Migration Mapping of logic from one system to another (Example using UI dialogs to select where logic comes from and where it belongs in a new system)

Designed for a Variety of Delivery Approaches

CodeFactory directly integrates into the Solution Explorer within Visual Studio. This provides flexibility to the architecture and delivery teams as to when to utilize automation and how that automation should be triggered. The following are a few examples, much like the others above, these are not the only approaches that can be taken.

Contract-Driven Approach

Interfaces are defined and automation triggers when interfaces need to be implemented. Allowing for a interface based design of the system and the core shell of the entire delivery driven by interface implementations.

UI-Driven Approach

User Interface dialogs are defined and triggered as a part of an automation command and questions are asked which generates the implementation of new or uplift of application logic.

Event-Driven Approach

Changes in markup files or .NET application code files like C# will trigger the option to execute automation logic to complete the implementation of logic.

Rebuild Approach

Logic is run which will rebuild the definition of a target artifact. This is a common approach with ORM based tools.

Hybrid Approach

This is the most common use case, which some combination of the approaches lsited above to meet a development teams specific delivery needs.

Zero-Touch Delivery Tool

CodeFactory runs inside of the Visual Studio IDE itself, and behaves like a behind-the-scenes compiler. CodeFactory is a design-time tool and has no application runtime capabilities or dependencies. This means there are no application libraries or technologies that have to be included inside the application you are delivering. Any artifacts that are generated by CodeFactory appear to be standard developer hand-written code.

Designed to Build Team-Customized Delivery

CodeFactory is a team delivery tool, which means there is no one-size-fits-all delivery process. Its a SDK style platform that simplifies the design of automation to be leveraged by delivery teams. CodeFactory releases a standard set of automation libraries fully implemented. The goal of these libraries is to provide standard guidance scenarios. Many teams will want to extend and modify the guidance to match their own design preferences, which is exactly what the CodeFactory SDK is designed for.

The following are the core capabilities of CodeFactory:

Solution and Project Management

Direct access to the solution and project system hosted inside of Visual Studio. This will include access and partial management of the following items:

  • Solutions
  • Solution Folders
  • Projects
  • Project Folders
  • Project Documents
  • C# Source Code Files

Document Management

Direct access to any document that is hosted within the solution, which includes the following:

  • Read all content from any document within the solution
  • Replace any/all content within a document
  • Add/remove/replace content at target locations within a document
  • Add new documents
  • Remove documents

C# Source Code Model Generation

CodeFactory builds real-time data models of C# code files. These models provide access to the following information:

  • Using statements
  • Namespace definitions
  • Attributes
  • Classes
  • Interfaces
  • Structures
  • Delegates
  • Fields
  • Methods
  • Properties
  • Events
  • Type definitions
  • Access to the body of classes, interfaces, structures
  • Access to the body of methods, properties, events
  • Source code management that includes replace, add before, add after, delete on all member objects
  • Source code management that includes replace, add before, add after, delete, beginning, end of all classes,structures, interfaces

Source Formatting

CodeFactory provides support for formatting of source code regardless of target langauges, including the following:

  • T4 integration to support the use of T4 formatting files to emit the target source code to be generated
  • Source formatter an internal CodeFactory formatter which provides granular source format editing

User Interface Management

CodeFactory integrates natively into the Visual Studio IDE, allowing developers to build their own custom dialog windows which display as native windows inside of Visual Studio.

Build Using .Net Technologies for Fast Adoption

CodeFactory was designed to author automation using the C# programming language. All of CodeFactory technologies are written using .NET Framework libraries.

(Note: This is a current limitation of the Visual Studio development environment. As Microsoft provide .NET Core integration into Visual Studio, CodeFactory will update at that time.)

CodeFactory SDK provides a common set of tools for delivery teams to quickly extend and author their own automation for application delivery.