You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Guidance provides walk throughs on how to use CodeFactory.
15
-
This section provides step by step instructions on how to different activities in CodeFactory itself.
12
+
## CodeFactory Guidance
13
+
The CodeFactory Guidance documentation provides step-by-step walk throughs and examples on how to use CodeFactory effectively.
16
14
17
15
[CodeFactory Guidance](Docs/Guidance/Overview.md)
18
16
19
17
# What is CodeFactory?
20
18
21
-
CodeFactory is realtime 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.
19
+
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.
22
20
23
21
## Automation of Construction Delivery Patterns
24
-
One of the core features of CodeFactory is its use of your application source code as a data model. This is a similar concept to ORM mapping based tools.
22
+
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.
25
23
26
-
This allows for the implementation of development patterns which can then auto-generate common application code which developers would otherwise have to build by hand. The following common usage scenarios are good examples of this concept, although many other scenarios are feasible.
24
+
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:
27
25
28
26
- Adding/Creating bounds checking within methods
29
27
- Implementation of exception handling logic
30
28
- Implementation of standard logging
31
29
- Automation of dependency injection
32
-
- Auto-creation of different application layers, based on common data models, that can now be identified directly from application source code
33
-
- Auto-generation of data access layers, based on different technologies, that fit the needs of a target delivery pattern
30
+
- Auto-creation of different application layers, based on common data models, which can now be identified directly from application source code
31
+
- Auto-generation of data access layers, based on different technologies, which fit the needs of a target delivery pattern
34
32
- Auto-generation of validation logic based on application source code data
35
33
- Auto-generation and logic mapping between service technologies and consumers
36
34
37
35
## Automation of Technology Transformation
38
-
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 usage scenarios for technology transformation, but like the Construction Delivery Patterns described above, are not the only scenarios for usage.
36
+
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.
39
37
40
38
- Read ORM-based data classes and transform into POCO's or to other ORM based implementations
41
39
- Read data classes and generate interface definitions for all classes
42
40
- Read markup languages and use adapters to transform markup from one implementation into another (Example WebForms to Blazor)
43
41
- Read markup languages and update UI implementation frameworks from one implementation to another (Example Modern UI to BootStrap)
44
-
- Lift and shift of application logic from one platform to another (Example map logic from .net framework to .net standard)
42
+
- Lift and shift of application logic from one platform to another (Example mapping logic from .NET Framework to .NET Standard)
45
43
- 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)
46
44
47
-
## Designed for Different Delivery Approaches
48
-
CodeFactory directly integrates into the Solution Explorer within Visual Studio. This provides flexibility to the delivery team on when to use 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.
45
+
## Designed for a Variety of Delivery Approaches
46
+
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.
49
47
50
-
### ContractDriven Approach
48
+
### Contract-Driven Approach
51
49
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.
52
50
53
-
### UIDriven Approach
51
+
### UI-Driven Approach
54
52
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.
55
53
56
-
### EventDriven Approach
54
+
### Event-Driven Approach
57
55
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.
58
56
59
57
### Rebuild Approach
60
58
Logic is run which will rebuild the definition of a target artifact. This is a common approach with ORM based tools.
61
59
62
60
### Hybrid Approach
63
-
This is the most common use case, which uses a number of the above approaches together to meet a development teams specific delivery needs.
61
+
This is the most common use case, which some combination of the approaches lsited above to meet a development teams specific delivery needs.
64
62
65
-
## ZeroTouch Delivery Tool
66
-
CodeFactory runs inside of the Visual Studio IDE itself, and acts more like a behindthescenes compiler. CodeFactory is a design-time tool and has no application runtime capabilities. This means there are no application libraries or technologies that have to be included inside the application you are delivering. Any artificates that are generated by CodeFactory appear to be standard developer hand-written code.
63
+
## Zero-Touch Delivery Tool
64
+
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.
67
65
68
66
## Designed to Build Team-Customized Delivery
69
67
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.
@@ -93,7 +91,7 @@ Direct access to any document that is hosted within the solution, which includes
93
91
- Remove documents
94
92
95
93
### C# Source Code Model Generation
96
-
CodeFactory builds realtime data models of C# code files. These models provide access to the following information:
94
+
CodeFactory builds real-time data models of C# code files. These models provide access to the following information:
97
95
98
96
- Using statements
99
97
- Namespace definitions
@@ -116,7 +114,7 @@ CodeFactory builds real time data models of C# code files. These models provide
116
114
CodeFactory provides support for formatting of source code regardless of target langauges, including the following:
117
115
118
116
- T4 integration to support the use of T4 formatting files to emit the target source code to be generated
119
-
- Source formatter an internal CodeFactory formatter that provides granular source format editing
117
+
- Source formatter an internal CodeFactory formatter which provides granular source format editing
120
118
121
119
### User Interface Management
122
120
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.
0 commit comments