Skip to content

Commit 48c299d

Browse files
authored
Update Overview.md
typo/format edits
1 parent be48c3a commit 48c299d

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed
Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
# Source Formatting
2-
One of the core strengths of CodeFactory is how it manages injection of source code. CodeFactory focuses on taking advantage of the capbilities of the IDE that it integrates into.
2+
One of the core strengths of CodeFactory is how it manages injection of source code. CodeFactory focuses on taking advantage of the capabilities of the IDE that it integrates into.
33
This allows for flexibility in managing the creation and formatting of source code.
4-
This seciton we will focus on the goals for formatting and how we accomplish those goals.
4+
This section is focused on the goals for formatting and how to accomplish those goals.
55

66
## Language Agnostic Formatting
77
One of the core goals of CodeFactory is to allow for the usage of data models to define any type of output source code.
8-
With this in mind formatting is agnostic by design.
8+
With this in mind, formatting is agnostic by design.
99
You can read in data models and output any target language or markup of your choice.
1010
The SDK is designed to allow for this flexibility.
11-
In addition, additional extension libraries have been created to assist in formatting and generation of differnt language outputs.
11+
Additionally, extension libraries have been created to assist in formatting and generation of alternate language outputs.
1212

1313
## Document Driven Updates
14-
The CodeFactory platform controls removal, replacement, and injection of source code changes through a document driven approach.
14+
The CodeFactory platform controls removal, replacement, and injection of source code changes through a document-driven approach.
1515
This provides for the greatest flexibility with source code management. Keep in mind that CodeFactory runs as part of Visual Studio itself.
16-
If a delivery team does not like the provided source formatting tools they are welcome to use any tooling they wish.
17-
If the tooling can be called as an external executable or accessed from c# in the .net framework, it can be used with CodeFactory.
16+
If a delivery team does not like the provided source formatting tools, they are able to use any tooling they wish.
17+
If the tooling can be called as an external executable or accessed from c# in the .NET framework, it can be used with CodeFactory.
1818

1919

2020
## Model Based Meta Data
21-
CodeFactory focuses on the auto generation of model based data to be used with software factories in the generation of additional logic.
22-
Out of the box CodeFactory provides the following data model categories to be used with source formatting.
21+
CodeFactory focuses on the auto-generation of model based data to be used with software factories in the generation of additional logic.
22+
CodeFactory provides the following data model categories to be used with source formatting:
2323

2424

2525
### Project Models
2626
Project models build up meta data about the solution, project, folders and documents in Visual Studio.
27-
These models are directly accessed and in som cases used to drive source formatting.
27+
These models are directly accessed and in some cases used to drive source formatting.
2828

2929

3030
### Source Code Models - (C# Language)
@@ -34,41 +34,41 @@ This model data allows developers to use that data and output into any target la
3434

3535
## External Examples Used With Source Formatting
3636
As mentioned above, since CodeFactory runs within the Visual Studio process.
37-
This allows use to access any framework or third party libraries that also do model generation and use them within the scope of CodeFactory.
38-
The following are two examples we have already used to solve automation problems.
37+
This allows users to access any framework or third party libraries that also provide model generation and utilize them within the scope of CodeFactory.
38+
The following are two examples we have already used to solve automation problems:
3939

4040

4141
### HTML Agility Pack
42-
As part of our WebForms to Blazor project we needed a way to load up HTML into a data model and build markup transformations based on the provided html data.
43-
We used the HTML agility pack to read in the HTML data as POCO data classes.
44-
From there were were able to use an adapter pattern to read and transform into Blazor based markup.
45-
Using CodeFactories built in tools to format the source code then inject back into documents.
42+
As part of our WebForms to Blazor project we needed a way to load up HTML into a data model and build markup transformations based on the provided HTML data.
43+
We used the HTML Agility Pack to read in the HTML data as POCO data classes.
44+
From there, we were able to use an adapter pattern to read and transform into Blazor based markup.
45+
Using CodeFactories built-in tools to format the source code then inject back into documents.
4646

4747

4848
### .Net Framework ADO.NET
49-
We needed the ability to read database schema from a database in order to generate and update entities as well as repositories and service classes.
50-
To do this we used the built in functionality of ADO that is included in the .net framework to read the schema and auto generate POCO models to be used in automation.
49+
We needed the ability to read database schemas from a database in order to generate and update entities as well as repositories and service classes.
50+
To do this we used the built-in functionality of ADO that is included in the .NET Framework to read the schema and auto-generate POCO models to be used within automation.
5151

5252

5353
## CodeFactory Formatters
54-
Out of the box CodeFactory has two different source code formatting tools.
54+
Included in CodeFactory are two different source code formatting tools.
5555
Both tools are designed to output the formatted source code to be used with the document driven placement approach used in CodeFactory.
5656
Both formatting solutions are not tied to any target language or markup format.
5757

5858

5959
### T4 Source Factory - Provided Formatter
60-
The T4 formatting tool that is provided with Visual Studio is fully supported with CodeFactory. Target extended logic is include to allow you to inject any data you want into the T4 template.
60+
The T4 formatting tool that is provided with Visual Studio is fully supported by CodeFactory. Target extended logic is included to allow you to inject any data you want into the T4 template.
6161
The T4 template itself is compiled and called in compiled form.
6262
Once data is passed into the T4 template the fully formatted output of the T4 is returned as a string.
63-
This allows for the author to control where the formatted source is injected into the target document.
63+
This allows the author to control where the formatted source is injected into the target document.
6464

6565
### Source Formatter - Provided Formatter
66-
The CodeFactory SDK also has a SourceFormatter class. The source formatter provides extenstions to the existing string builder object.
67-
This will allow for the controlling of identation in the content as its added to the formatter.
68-
It also allows for indendentation a target number of levels deep to full content that is provided to it.
69-
This will also be further extended in time to add additional capabilities.
66+
The CodeFactory SDK also has a SourceFormatter class. The source formatter provides extentions to the existing string builder object.
67+
This allows for the controlling of indentation within the content, as its added to the formatter.
68+
It also allows for indentation a target number of levels deep to full content that is provided to it.
69+
This will also be further extended over time to provide additional capabilities.
7070

7171
## Overview
7272
This link takes you back to the CodeFactory Overview
7373

74-
[CodeFactory Overview](../Overview.md)
74+
[CodeFactory Overview](../Overview.md)

0 commit comments

Comments
 (0)