Merge branch 'main' into repo-assist/fix-issue-1632-dtd-processing-parameter-b6794c39a31ef477

Author: dsyme

.github/aw/actions-lock.json

@@ -29,6 +29,16 @@
       "repo": "github/gh-aw/actions/setup",
       "version": "v0.49.7",
       "sha": "0ea0cf123dda697de607a0cd6e3315746680eb86"
+    },
+    "github/gh-aw/actions/setup@v0.50.0": {
+      "repo": "github/gh-aw/actions/setup",
+      "version": "v0.50.0",
+      "sha": "8624e99d3979177875f082b4959b14da951d9ffe"
+    },
+    "github/gh-aw/actions/setup@v0.50.1": {
+      "repo": "github/gh-aw/actions/setup",
+      "version": "v0.50.1",
+      "sha": "fad43e3c91a4e1d43e458f68e96574127934e7d1"
     }
   }
 }

.github/workflows/repo-assist.lock.yml

@@ -74,7 +74,7 @@ tools:
   bash: true
   repo-memory: true
 
-source: githubnext/agentics/workflows/repo-assist.md@b0e9cfd3a20372ce7fe0462bb7bbca2272df4a88
+source: githubnext/agentics/workflows/repo-assist.md@b87234850bf9664d198f28a02df0f937d0447295
 ---
 
 # Repo Assist

.github/workflows/repo-assist.md

@@ -475,9 +475,21 @@ transformed the dataset to be smaller.
 *)
 
 (**
+## Using CSV provider in a library
+
+When using `CsvProvider` in a library that others will reference, the sample file must be
+embedded in the compiled assembly. See the step-by-step guide in
+[Using JSON provider in a library](JsonProvider.html#jsonlib) — the same `EmbeddedResource`
+parameter and naming convention applies to `CsvProvider`.
+
+In brief, for a file `data/sample.csv` in a library `MyLib`:
+1. Mark the file as `<EmbeddedResource>` in the `.fsproj`
+2. Use `EmbeddedResource="MyLib, MyLib.data.sample.csv"` in the type provider declaration
+
 ## Related articles
 
- * [Using JSON provider in a library](JsonProvider.html#jsonlib) also applies to CSV type provider
+ * [Using JSON provider in a library](JsonProvider.html#jsonlib) — includes step-by-step
+   `EmbeddedResource` guide that applies to all type providers
  * [CSV Parser](CsvFile.html) - provides more information about
    working with CSV documents dynamically.
  * [API Reference: CsvProvider type provider](../reference/fsharp-data-csvprovider.html)

docs/library/CsvProvider.fsx

@@ -462,8 +462,26 @@ access the sample JSON. This works fine when the sample is specified inline, but
 the sample is specified as a local file (unless you distribute the samples with your library).
 
 For this reason, the JSON provider lets you specify samples as embedded resources using the
-static parameter `EmbeddedResource` (don't forget then to [include the file](https://docs.microsoft.com/en-us/visualstudio/ide/build-actions) as EmbeddedResource in the
-project file). If you are building a library `MyLib.dll`, you can write:
+static parameter `EmbeddedResource`. When this parameter is set, the type provider at design time
+reads the sample from the local path, but at runtime (when the library is loaded by a consumer)
+it reads the sample from the embedded resource in the compiled assembly.
+
+### Step-by-step guide
+
+**Step 1**: Mark your sample file as an embedded resource in the `.fsproj` file:
+
+```xml
+<ItemGroup>
+  <EmbeddedResource Include="data/worldbank.json" />
+</ItemGroup>
+```
+
+**Step 2**: Use the `EmbeddedResource` static parameter. The value must be
+`"AssemblyName, AssemblyName.dotted.path.to.file.json"` where:
+- `AssemblyName` is the name of your library assembly (without `.dll`)
+- The file path uses **dots** (not slashes) as separators, prefixed with `AssemblyName`
+
+So for a file `data/worldbank.json` in a library `MyLib`, the value is:
 
 *)
 type WB =
@@ -480,6 +498,14 @@ to load `MyLib.dll` and locate the sample `worldbank.json` as a resource of the
 this succeeds, it does not attempt to find the local file and so your library can be used
 without providing a local copy of the sample JSON files.
 
+> **Common pitfall**: If you get a cryptic error where the type provider interprets the file path
+> as the CSV/JSON content itself (resulting in a single-column type named after the path), you
+> have likely forgotten to add the `EmbeddedResource` parameter, or the assembly name or resource
+> path in the parameter value is incorrect.
+>
+> To verify the embedded resource name, you can inspect the compiled `.dll` using a tool such as
+> `ildasm`, `dotnet-ildasm`, or ILSpy and look at the `.mresource` entries.
+
 ## Related articles
 
  * [JSON Parser](JsonValue.html) - provides more information about

docs/library/JsonProvider.fsx

@@ -27,15 +27,19 @@ module internal CsvTypeBuilder =
             ProvidedParameter: ProvidedParameter
         }
 
-    let generateTypes asm ns typeName (missingValuesStr, cultureStr) inferredFields =
+    let generateTypes asm ns typeName (missingValuesStr, cultureStr) useOriginalNames inferredFields =
 
         let fields =
             inferredFields
             |> List.mapi (fun index field ->
                 let typ, typWithoutMeasure, conv, convBack =
                     ConversionsGenerator.convertStringValue missingValuesStr cultureStr field
 
-                let propertyName = NameUtils.capitalizeFirstLetter field.Name
+                let propertyName =
+                    if useOriginalNames then
+                        field.Name
+                    else
+                        NameUtils.capitalizeFirstLetter field.Name
 
                 let prop =
                     ProvidedProperty(
@@ -58,11 +62,17 @@ module internal CsvTypeBuilder =
                         | _ -> Expr.TupleGet(rowVarExpr, index)
                     )
 
+                let paramName =
+                    if useOriginalNames then
+                        field.Name
+                    else
+                        NameUtils.niceCamelName propertyName
+
                 { TypeForTuple = typWithoutMeasure
                   ProvidedProperty = prop
                   Convert = convert
                   ConvertBack = convertBack
-                  ProvidedParameter = ProvidedParameter(NameUtils.niceCamelName propertyName, typ) })
+                  ProvidedParameter = ProvidedParameter(paramName, typ) })
 
         // The erased row type will be a tuple of all the field types (without the units of measure).  If there is a single column then it is just the column type.
         let rowErasedType =

src/FSharp.Data.DesignTime/Csv/CsvGenerator.fs

@@ -57,6 +57,7 @@ type public CsvProvider(cfg: TypeProviderConfig) as this =
         let resource = args.[15] :?> string
         let preferDateOnly = args.[16] :?> bool
         let strictBooleans = args.[17] :?> bool
+        let useOriginalNames = args.[18] :?> bool
 
         // This provider already has a schema mechanism, so let's disable inline schemas.
         let inferenceMode = InferenceMode'.ValuesOnly
@@ -130,7 +131,7 @@ type public CsvProvider(cfg: TypeProviderConfig) as this =
 
             let csvType, csvErasedType, rowType, stringArrayToRow, rowToStringArray =
                 inferredFields
-                |> CsvTypeBuilder.generateTypes asm ns typeName (missingValuesStr, cultureStr)
+                |> CsvTypeBuilder.generateTypes asm ns typeName (missingValuesStr, cultureStr) useOriginalNames
 
             let stringArrayToRowVar = Var("stringArrayToRow", stringArrayToRow.Type)
             let rowToStringArrayVar = Var("rowToStringArray", rowToStringArray.Type)
@@ -239,7 +240,8 @@ type public CsvProvider(cfg: TypeProviderConfig) as this =
           ProvidedStaticParameter("ResolutionFolder", typeof<string>, parameterDefaultValue = "")
           ProvidedStaticParameter("EmbeddedResource", typeof<string>, parameterDefaultValue = "")
           ProvidedStaticParameter("PreferDateOnly", typeof<bool>, parameterDefaultValue = false)
-          ProvidedStaticParameter("StrictBooleans", typeof<bool>, parameterDefaultValue = false) ]
+          ProvidedStaticParameter("StrictBooleans", typeof<bool>, parameterDefaultValue = false)
+          ProvidedStaticParameter("UseOriginalNames", typeof<bool>, parameterDefaultValue = false) ]
 
     let helpText =
         """<summary>Typed representation of a CSV file.</summary>
@@ -264,7 +266,8 @@ type public CsvProvider(cfg: TypeProviderConfig) as this =
            <param name='EmbeddedResource'>When specified, the type provider first attempts to load the sample from the specified resource 
               (e.g. 'MyCompany.MyAssembly, resource_name.csv'). This is useful when exposing types generated by the type provider.</param>
            <param name='PreferDateOnly'>When true on .NET 6+, date-only strings are inferred as DateOnly and time-only strings as TimeOnly. Defaults to false for backward compatibility.</param>
-           <param name='StrictBooleans'>When true, only <c>true</c> and <c>false</c> (case-insensitive) are inferred as boolean. Values such as <c>0</c>, <c>1</c>, <c>yes</c>, and <c>no</c> are treated as integers or strings respectively. Defaults to false.</param>"""
+           <param name='StrictBooleans'>When true, only <c>true</c> and <c>false</c> (case-insensitive) are inferred as boolean. Values such as <c>0</c>, <c>1</c>, <c>yes</c>, and <c>no</c> are treated as integers or strings respectively. Defaults to false.</param>
+           <param name='UseOriginalNames'>When true, CSV column header names are used as-is for generated property names instead of being normalized (e.g. capitalizing the first letter). Defaults to false.</param>"""
 
     do csvProvTy.AddXmlDoc helpText
     do csvProvTy.DefineStaticParameters(parameters, buildTypes)

src/FSharp.Data.DesignTime/Csv/CsvProvider.fs

@@ -30,13 +30,26 @@ type internal JsonGenerationContext =
       PreferDictionaries: bool
       GenerateConstructors: bool
       InferenceMode: InferenceMode'
-      UnitsOfMeasureProvider: IUnitsOfMeasureProvider }
+      UnitsOfMeasureProvider: IUnitsOfMeasureProvider
+      UseOriginalNames: bool }
 
     static member Create
-        (cultureStr, tpType, unitsOfMeasureProvider, inferenceMode, ?uniqueNiceName, ?typeCache, ?preferDictionaries)
-        =
+        (
+            cultureStr,
+            tpType,
+            unitsOfMeasureProvider,
+            inferenceMode,
+            ?uniqueNiceName,
+            ?typeCache,
+            ?preferDictionaries,
+            ?useOriginalNames
+        ) =
+        let useOriginalNames = defaultArg useOriginalNames false
+
         let uniqueNiceName =
-            defaultArg uniqueNiceName (NameUtils.uniqueGenerator NameUtils.nicePascalName)
+            defaultArg
+                uniqueNiceName
+                (NameUtils.uniqueGenerator (if useOriginalNames then id else NameUtils.nicePascalName))
 
         let typeCache = defaultArg typeCache (Dictionary())
         let preferDictionaries = defaultArg preferDictionaries false
@@ -49,7 +62,8 @@ type internal JsonGenerationContext =
             preferDictionaries,
             true,
             inferenceMode,
-            unitsOfMeasureProvider
+            unitsOfMeasureProvider,
+            useOriginalNames
         )
 
     static member Create
@@ -61,7 +75,8 @@ type internal JsonGenerationContext =
             preferDictionaries,
             generateConstructors,
             inferenceMode,
-            unitsOfMeasureProvider
+            unitsOfMeasureProvider,
+            useOriginalNames
         ) =
         { CultureStr = cultureStr
           TypeProviderType = tpType
@@ -73,7 +88,8 @@ type internal JsonGenerationContext =
           PreferDictionaries = preferDictionaries
           GenerateConstructors = generateConstructors
           InferenceMode = inferenceMode
-          UnitsOfMeasureProvider = unitsOfMeasureProvider }
+          UnitsOfMeasureProvider = unitsOfMeasureProvider
+          UseOriginalNames = useOriginalNames }
 
     member x.MakeOptionType(typ: Type) =
         typedefof<option<_>>.MakeGenericType typ
@@ -376,7 +392,13 @@ module JsonTypeBuilder =
                 ctx.TypeProviderType.AddMember(objectTy)
 
                 // to nameclash property names
-                let makeUnique = NameUtils.uniqueGenerator NameUtils.nicePascalName
+                let nicePropertyName =
+                    if ctx.UseOriginalNames then
+                        id
+                    else
+                        NameUtils.nicePascalName
+
+                let makeUnique = NameUtils.uniqueGenerator nicePropertyName
                 makeUnique "JsonValue" |> ignore
 
                 let inferedKeyValueType =
@@ -600,7 +622,13 @@ module JsonTypeBuilder =
 
                               prop.Name,
                               [ ProvidedProperty(name, convertedType, getterCode = getter) ],
-                              ProvidedParameter(NameUtils.niceCamelName name, replaceJDocWithJValue ctx convertedType) ]
+                              ProvidedParameter(
+                                  (if ctx.UseOriginalNames then
+                                       name
+                                   else
+                                       NameUtils.niceCamelName name),
+                                  replaceJDocWithJValue ctx convertedType
+                              ) ]
 
                     let names, properties, parameters = List.unzip3 members
                     let properties = properties |> List.concat

src/FSharp.Data.DesignTime/Json/JsonGenerator.fs

@@ -58,6 +58,7 @@ type public JsonProvider(cfg: TypeProviderConfig) as this =
         let inferenceMode = args.[9] :?> InferenceMode
         let schema = args.[10] :?> string
         let preferDateOnly = args.[11] :?> bool
+        let useOriginalNames = args.[12] :?> bool
 
         let inferenceMode =
             InferenceMode'.FromPublicApi(inferenceMode, inferTypesFromValues)
@@ -117,7 +118,8 @@ type public JsonProvider(cfg: TypeProviderConfig) as this =
                     tpType,
                     unitsOfMeasureProvider,
                     inferenceMode,
-                    ?preferDictionaries = Some preferDictionaries
+                    ?preferDictionaries = Some preferDictionaries,
+                    ?useOriginalNames = Some useOriginalNames
                 )
 
             let result = JsonTypeBuilder.generateJsonType ctx false false rootName inferedType
@@ -164,7 +166,8 @@ type public JsonProvider(cfg: TypeProviderConfig) as this =
               parameterDefaultValue = InferenceMode.BackwardCompatible
           )
           ProvidedStaticParameter("Schema", typeof<string>, parameterDefaultValue = "")
-          ProvidedStaticParameter("PreferDateOnly", typeof<bool>, parameterDefaultValue = false) ]
+          ProvidedStaticParameter("PreferDateOnly", typeof<bool>, parameterDefaultValue = false)
+          ProvidedStaticParameter("UseOriginalNames", typeof<bool>, parameterDefaultValue = false) ]
 
     let helpText =
         """<summary>Typed representation of a JSON document.</summary>
@@ -188,7 +191,8 @@ type public JsonProvider(cfg: TypeProviderConfig) as this =
               | ValuesAndInlineSchemasOverrides -> Same as ValuesAndInlineSchemasHints, but value inferred types are ignored when an inline schema is present.
            </param>
            <param name='Schema'>Location of a JSON Schema file or a string containing a JSON Schema document. When specified, Sample and SampleIsList must not be used.</param>
-           <param name='PreferDateOnly'>When true on .NET 6+, date-only strings (e.g. "2023-01-15") are inferred as DateOnly and time-only strings as TimeOnly. Defaults to false for backward compatibility.</param>"""
+           <param name='PreferDateOnly'>When true on .NET 6+, date-only strings (e.g. "2023-01-15") are inferred as DateOnly and time-only strings as TimeOnly. Defaults to false for backward compatibility.</param>
+           <param name='UseOriginalNames'>When true, JSON property names are used as-is for generated property names instead of being normalized to PascalCase. Defaults to false.</param>"""
 
     do jsonProvTy.AddXmlDoc helpText
     do jsonProvTy.DefineStaticParameters(parameters, buildTypes)