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
Copy file name to clipboardExpand all lines: Docs/Introduction/Commands/Overview.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,28 @@
1
1
# CodeFactory Commands
2
2
When working with CodeFactory you always start with commands.
3
3
Commands are the trigger point where all CodeFactory functionality starts from.
4
-
As of this release of CodeFactory all commands are triggered from context menus on individual nodes within solution explorer. As per the name a command following a command exection pattern.
5
-
This is made up of two methods that are raised from internal events that occur within Visual Studio itself. These events are trigged when a selected solution explorers item content menu is opened.
6
-
The following explain the two methods their goal and the different type of commands that are supported in CodeFactory.
4
+
Currently all commands are triggered from context menus on individual nodes within solution explorer. Each ommand is made up of two methods that are raised from internal events that occur within Visual Studio itself. These events are trigged when a selected solution explorers item content menu is opened.
5
+
The following describes the two methods, their goals and the different type of commands that are supported in CodeFactory.
7
6
8
7
## Command Result
9
8
Whenever a command is executed a real time data model is generated based on the type of Visual Studio object that has been selected. The data model is regenerated each time the target command is executed.
10
9
11
10
## Enable Command
12
11
When a command is first loaded it sends the command result to the enable method on the command.
13
-
This method is called to allow the author of the command to determine if the command should be enabled to be used.
14
-
This was added to allow the author to control execution of automation.
15
-
You may only want automation to be enabled based on a target condition.
12
+
This method is called to allow the author of the command to determine if the command should be visible to the automation user for use.
13
+
This feature exists in order to allow automation authors to control execution of automation by hiding or showing commands on the context menu as they desire.
14
+
16
15
This is controlled by simply returning a true or false value to determine if the command should be accessible.
17
16
If enabled is true the command will show up in the context menu.
18
-
The developer in Visual Studio will then trigger the command to execute by selecting the context menu item.
17
+
The developer in Visual Studio can then trigger the command to execute by selecting the context menu item.
19
18
20
19
## Execute Command
21
-
Once the developer selects a command to be executed Visual Studio will trigger the execute method of the command itself.
20
+
Once the developer selects a command to be executed Visual Studio will run the execute method of the command itself.
22
21
Like before a real time data model is passed to the execute method.
23
-
This is where the automation process starts and whatever functionality has been assigned will executed at this time.
22
+
This is where the automation process starts and whatever functionality has been authored will executed at this time.
24
23
25
24
## Solution Explore Commands
26
-
CodeFactory current supports the trigger of commands from the solution explorer window in Visual Studio.
25
+
CodeFactory current supports the trigger of commands from the Solution Explorer window in Visual Studio.
27
26
The following are the supported Solution Explorer nodes that will CodeFactory Automation.
28
27
29
28
- Solution Command - Generates a Solutiuon data model
Copy file name to clipboardExpand all lines: Docs/Introduction/Data Models/Overview.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,15 @@
1
1
# CodeFactory DataModels
2
-
The primary strength of CodeFactory is its ability to generate real time data models directly from the Visual Studio environment.
2
+
The primary strength of CodeFactory is its ability to generate real time data models directly from your project/solution artifacts within the Visual Studio environment.
3
3
This ability makes it possible to do design time automation when delivering software. In this section we will provide a brief overview of the data models that are generated dynamically by the CodeFactory platform. These data models are used throughout the automation process.
4
4
5
5
## Data Models
6
-
All data models are plain old CLR objects or POCO's for short. Each data model is implemented as an immutable data class. This approach is used since an change to the underlying data model requires a complete regeneration of the data model from the visual studio environment to make sure you have the latest version of all data.
7
-
8
-
Data model generation is either triggered during the trigger of a new automation process, or from various CodeFactory API calls that will request new copies of data models.
6
+
All data models are plain old CLR objects or POCO's for short. Each data model is implemented as an immutable data class. This approach is used since a change to the underlying data model requires a complete regeneration of the data model from the visual studio environment to make sure you have the latest version of all data. For example, making a change to a C# class object would force CodeFactory to regenerate a data model of that file/class object.
9
7
8
+
Data model generation is either triggered during the execution of a new automation process, or from various CodeFactory API calls that will request new copies of data models.
10
9
11
10
## Solution Explorer Models (Project System)
12
11
The following models are directly generated off the legacy and new project systems that are hosted by Visual Studio.
13
-
The overview of each data model is designed to provide an overview of capabilties. It will not list every single data element or function. See help docs for the full description if each data model.
12
+
The overview of each data model is designed to provide an overview of capabilties. The examples here are not complete and only show partial functionality for the purpose of explanation. Please see our help docs for the full description if each data model.
14
13
15
14
### Solution
16
15
Data model that represents the loaded solution. This provides the location of the solution as well as access to the projects in the solution.
@@ -37,8 +36,8 @@ The C# source document project system access as well as full access to the C# so
37
36
CodeFactory has access to the C# language compiler and can dynamically generate data models the represent the C# based source code.
38
37
CodeFactory provides direct access all the way down to member and type level data.
39
38
In addition, will give you direct access to the raw source code at the target object level.
40
-
The following are the data models that are generated whenever either accessing from source code files, or from directly referenced assemblies.
41
-
The overview of each data model is designed to provide an overview of capabilties. It will not list every single data element or function. See help docs for the full description if each data model.
39
+
The following data models are generated whenever you are accessing from source code files, or from directly referenced assemblies.
40
+
The overview of each data model is designed to provide an example of capabilties and does not list every single data element or function. Please see our help docs for the full description if each data model.
42
41
43
42
### Soure Code
44
43
The source code data model provides access to all elements that were compiled from the source code document. This includes the following.
Copy file name to clipboardExpand all lines: Docs/Introduction/Environment/Overview.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
-
# CodeFactory Environment
2
-
CodeFactory is a collection of automation tools that are designed to be used in a native IDE enviornment.
3
-
The integration into the IDE environment is based on the fact that CodeFactory is a design time based tool.
4
-
In this section we will focus on how CodeFactory integrates into the IDE.
1
+
# CodeFactory Ecosystem
2
+
CodeFactory is a collection of automation tools that are designed to be used in a native IDE(Integrated-Development-Environment).
3
+
The decision to integrate into the IDE is based on the fact that CodeFactory is a design time tool - meaning that no extra code artifacts or runtimes are required to be added to your final solution codebase.
5
4
6
-
Through out the life of this product more then one IDE will be supported in future releases. Which is why CodeFactory is always named after the platform it is hosted on.
5
+
Throughout the life of CodeFctory more then one IDE will be supported in future releases. Which is why CodeFactory is always named after the platform it is hosted on.
7
6
7
+
In this section we will focus on how CodeFactory integrates into the IDE.
8
8
9
9
## CodeFactory for Visual Studio
10
10
CodeFactory for Visual Studio is an extension of the Visual Studio IDE.
11
11
CodeFactory was designed to run as an internal service inside Visual Studio just like Razor, C#, or any number of other services that are part of Visual Studio.
12
-
This means that once installed CodeFactory is always on and will automatically execute automation that is loaded when a solution is loaded.
12
+
This means that once installed CodeFactory is always 'on' and will automatically load automation commands for use when a solution is loaded.
13
13
14
14
## CFX - Code Factory Extension
15
-
CodeFactory automation is saved as complete package in a single file called a CodeFactory extension.
15
+
A CodeFactory automation project is saved as complete package in a single file called a CodeFactory extension (*.cfx).
16
16
This uses a similar approach as word with DOCX or Excel with XSLX files.
17
-
The CodeFactory extension or CFX is a file that gets put in the root of the solution folder.
18
-
Once the solution is opened in Visual Studio it will automatically load the automation and make it avaiable to the solution.
17
+
All it takes is to copy a CodeFactory extension, or CFX, file into the root of the your solutions folder.
18
+
Once the solution is opened in Visual Studio it will automatically load the automation and make it avaiable for use.
19
19
20
20
## CodeFactory SDK
21
21
All automation for CodeFactory was designed and delivered using the CodeFactory SDK.
Copy file name to clipboardExpand all lines: Docs/Introduction/Overview.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,15 @@
1
1
# Overview of CodeFactory
2
-
This provides an overview of the different capabilities and parts of the CodeFactory environment.
3
-
Each target area will provide a clear overview of target set of capabilites as well as guidance.
2
+
This describes the different capabilities and parts of the CodeFactory ecosystem. Each area will provide a clear overview of target set of capabilites as well as guidance.
4
3
5
-
This overview is designed to be read either top down or jump to the topic that interests you.
4
+
This guide is designed to be read either top down or jump to the topic that interests you.
6
5
7
6
## CodeFactory for VisualStudio
8
7
Review of the CodeFactory environment and how it integrates with Visual Studio.
9
8
10
9
[Link Here]
11
10
12
11
## CodeFactory Platform
13
-
Review of the different parts of the CodeFactory platform itself. These are used to drive CodeFactory also used in authoring CodeFactory automation.
12
+
Review of the different parts of the CodeFactory platform itself. This decsribes what is used to drive CodeFactory also used in authoring CodeFactory automation.
Copy file name to clipboardExpand all lines: README.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,14 @@
2
2
3
3
# What is CodeFactory?
4
4
5
-
CodeFactory is real time software delivery tool that natively runs inside of Visual Studio. The focus of CodeFactory is to increase the delivery velocity of applications being built new or uplift of projects to other technologies.
5
+
CodeFactory is real time software delivery tool that natively runs inside of Visual Studio. The focus of CodeFactory is to increase the delivery velocity of building new applications or the uplift/refactor of projects to other technologies.
6
6
7
7
## Automation of Construction Delivery Patterns
8
-
One of the core goals of CodeFactory is to use application source code within the application as a data model.
9
-
This is a similar concept to ORM mapping based tools.
8
+
One of the core features of CodeFactory is to use your application source code as a data model. This is a similar concept to ORM mapping based tools.
10
9
11
-
This allows for the implementation of development patterns to auto generate common application code developers have to build by hand. The following are common usage scenarios, but by no means the only scenarios in use.
10
+
This allows for the implementation of development patterns which can then auto generate common application code that developers would otherwise have to build by hand. The following common usage scenarios showcase this concept. These are by no means the only scenarios in available.
12
11
13
-
- Bounds checking in methods
12
+
-Adding/Creating Bounds checking in methods
14
13
- Implementation of exception handling logic
15
14
- Implementation of standard logging
16
15
- Automation of dependency injection
@@ -20,7 +19,7 @@ This allows for the implementation of development patterns to auto generate comm
20
19
- Auto generation and mapping of logic between service technolgoies and consumers
21
20
22
21
## Automation of Technology Transformation
23
-
Due to the design of CodeFactories SDK the tooling is very helpful in transformation of existing functionality of application to be lifted into new technology implementation. The following are common usage scenarios for technology transformation, like about these are not the only scenarios for usage.
22
+
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 Patterns above are not the only scenarios for usage.
24
23
25
24
- Read ORM based data classes and transform into POCO's or to other ORM based implementations
26
25
- Read data classes and generate interface definitions for all classes
@@ -30,13 +29,13 @@ Due to the design of CodeFactories SDK the tooling is very helpful in transforma
30
29
- Migration Mapping of logic from one system to another (Example using UI dialogs to select where logic comes from and where it goes in a new system)
31
30
32
31
## Designed for Different Delivery Approaches
33
-
The CodeFactory tool directly integrates into the Solution Explorer in 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, like the others above not the only approaches that can be taken.
32
+
CodeFactory directly integrates into the Solution Explorer in 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.
34
33
35
34
### Contract Driven Approach
36
35
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.
37
36
38
37
### UI Driven Approach
39
-
User Interface dialogs are triggered and questions are asked which generates the impementation of new or uplift of application logic.
38
+
User Interface dialogs are defined and triggered as a part of an automation command and questions are asked which generates the impementation of new or uplift of application logic.
40
39
41
40
### Event Driven Approach
42
41
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.
@@ -48,20 +47,18 @@ Logic is run that will rebuild the definition of a target artifact. This is a co
48
47
This is the most common which uses a number of the above approaches together to meet a development teams delivery needs.
49
48
50
49
## Zero Touch Delivery Tool
51
-
CodeFactory runs inside of visual studio itself. Which means it acts more like a behind the scene compiler.
52
-
CodeFactory is a design time tool and has no application runtime capabilties.
53
-
This means there is no application libraries or technologies that have to be included inside the application you are delivering.
54
-
Any artificates that are generated by CodeFactory appear to be standard developer hand written code.
50
+
CodeFactory runs inside of visual studio itself and it acts more like a behind the scenes compiler. CodeFactory is a design time tool and has no application runtime capabilties. This means there is 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.
55
51
56
52
## Designed to Build Team Customized Delivery
57
53
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 taken advantage of by delivery teams.
58
54
CodeFactory releases a standard set of automation libraries fully implemented.
59
55
The goal of these libraries is to provide standard guidance scenarios.
60
56
Alot of teams will want to extend and change the guidance. Which is exactly what this tool is designed for.
61
57
62
-
The following are the core tooling capabilities of CodeFactory
58
+
The following are the core capabilities of CodeFactory
59
+
63
60
### Solution and Project Management
64
-
Direct access to the solution and project system hosted in visual studio. This will include access and partial management of the following items.
61
+
Direct access to the solution and project system hosted inside of visual studio. This will include access and partial management of the following items.
65
62
66
63
- Solution
67
64
- Solution Folders
@@ -78,6 +75,7 @@ Direct access to any document that is hosted in the solution this will include t
78
75
- Add/remove/replace content at target locations within the document
79
76
- Add new documents
80
77
- Remove documents
78
+
81
79
### C# Source Code Model Generation
82
80
CodeFactory builds real time data models of C# code files. The models provide access to the following information
0 commit comments