Update configuration.md

Author: pwelter34

docs/configuration.md

@@ -76,6 +76,8 @@ data:
     propertyNaming: Preserve|Plural|Suffix
     #include XML documentation
     document: false
+    # file header
+    header: // Context header
 
   # entity class file configuration
   entity:
@@ -93,8 +95,10 @@ data:
     mappingAttributes: true
     # Generate class names with prefixed schema name eg. dbo.MyTable = DboMyTable
     prefixWithSchemaName: false
+    # file header
+    header: // Entity header
 
-    # Rename entities and properties with regular expressions
+    # Rename entities and properties with regular expressions.  Matched expressions will be removed
     renaming:
       # list of regular expressions to clean entity names
       entities:
@@ -113,6 +117,8 @@ data:
 
     temporal: false                                 # if temporal table mapping is enabled. Default true
     rowVersion: ByteArray|Long|ULong                # How row versions should be mapped. Default ByteArray
+    # file header
+    header: // Mapping header
 
   # query extension class file configuration
   query:
@@ -123,6 +129,8 @@ data:
     directory: '{Project.Directory}\Data\Queries'   # the mapping class output directory
     #include XML documentation
     document: false
+    # file header
+    header: // Query header
 
 #---------------------------------#
 # model section - controls the optional view model generation
@@ -132,6 +140,9 @@ model:
   shared:
     namespace: '{Project.Namespace}.Domain.Models' # the model class namespace
     directory: '{Project.Directory}\Domain\Models' # the mapping class output directory
+    # file header
+    header: '#pragma warning disable IDE0130 // Namespace does not match folder structure'
+
     # regular expression of entities and properties to exclude in all models
     exclude:
       # list of regular expressions of entity names
@@ -151,6 +162,11 @@ model:
     baseClass: EntityReadModel      # the read model base class
     namespace: '{Project.Namespace}.Domain.Models'
     directory: '{Project.Directory}\Domain\Models'
+    # Multi-line file header
+    header: |
+        // * * * * * * * * * * * *
+        // Read Model File Header
+        // * * * * * * * * * * * *
     exclude:
       entities: []
       properties: []
@@ -161,7 +177,8 @@ model:
     name: '{Entity.Name}CreateModel'    # the create model class name
     baseClass: EntityCreateModel        # the create model base class
     namespace: '{Project.Namespace}.Domain.Models'
-    directory: '{Project.Directory}\Domain\Models'
+    directory: '{Project.Directory}\Domain\Models'    
+    header: '// create model file header' # file header
     exclude:
       entities: []
       properties: []
@@ -173,6 +190,7 @@ model:
     baseClass: EntityUpdateModel        # the update model base class
     namespace: '{Project.Namespace}.Domain.Models'
     directory: '{Project.Directory}\Domain\Models'
+    header: '// update model file header' # file header
     exclude:
       entities: []
       properties: []
@@ -184,6 +202,7 @@ model:
     baseClass: Profile
     namespace: '{Project.Namespace}.Domain.Mapping'
     directory: '{Project.Directory}\Domain\Mapping'
+    header: '// mapper file header' # file header
 
   # FluentValidation class configuration
   validator:
@@ -192,6 +211,8 @@ model:
     baseClass: 'AbstractValidator<{Model.Name}>'
     namespace: '{Project.Namespace}.Domain.Validation'
     directory: '{Project.Directory}\Domain\Validation'
+    header: '// validator file header' # file header
+
 # script templates
 script:
   # collection script template with EntityContext as a variable