readme

Author: goswinr

.gitignore

@@ -11,4 +11,7 @@ ts/
 # FSharp.Formatting
 .fsdocs/
 output/
-tmp/
+tmp/
+
+# will be generated by after build action:
+Docs/index.md

Docs/content/fsdocs-theme.css

@@ -0,0 +1,5 @@
+code>span>span {
+    color: rgb(133, 133, 133);
+    /* font-weight: bold; */
+};
+

README.md

@@ -9,12 +9,25 @@
 [![license](https://img.shields.io/github/license/goswinr/Dicts)](LICENSE.md)
 ![code size](https://img.shields.io/github/languages/code-size/goswinr/Dicts.svg)
 
+
 This F# library provides:
+
 - A dedicated `Dict<'T>` type. It is a thin wrapper around `Dictionary<'T>` with more functionality and nicer Error messages.
-- A `DefaultDict<'T>` type. It works like [Python's' defaultdict](https://docs.python.org/3/library/collections.html#collections.defaultdict).\
+
+- A `DefaultDict<'T>` type. It works like [Python's' defaultdict](https://docs.python.org/3/library/collections.html#collections.defaultdict).<br>
 By providing a default function in the constructor it will always return a value for any key.
+
 - Extension methods for working with the `IDictionary<'T>` interface.
 
+It also works in JS and TS with [Fable](https://fable.io/).
+
+This library was designed for use with F# scripting.
+Functions and methods never return null.
+Only functions starting with `try...` will return an F# Option.
+Otherwise when a function fails on invalid input it will throw a descriptive exception.
+
+I was always annoyed that a KeyNotFoundExceptions does not include the actual bad key nor a pretty printed dictionary.
+This library fixes that in `iDictionary.Get`, `iDictionary.Set` and other item access functions.
 
 ### Example
 

Src/DefaultDict.fs

@@ -126,6 +126,7 @@ type DefaultDict<'K,'V when 'K:equality > private (defaultOfKeyFun: 'K -> 'V, ba
         toString baseDic k v
 
     /// A string representation of the DefaultDict including the count of entries and the first 5 entries.
+    /// When used in Fable this member is inlined for reflection to work.
     #if FABLE_COMPILER
     member inline _.AsString =  // inline needed for Fable reflection
     #else
@@ -144,6 +145,7 @@ type DefaultDict<'K,'V when 'K:equality > private (defaultOfKeyFun: 'K -> 'V, ba
 
     /// A string representation of the DefaultDict including the count of entries
     /// and the specified amount of entries.
+    /// When used in Fable this member is inlined for reflection to work.
     #if FABLE_COMPILER
     member inline _.ToString(entriesToPrint) =  // inline needed for Fable reflection
     #else

Src/Dict.fs

@@ -201,6 +201,7 @@ type Dict<'K,'V when 'K:equality > private (dic : Dictionary<'K,'V>) =
 
 
     /// A string representation of the Dict including the count of entries and the first 5 entries.
+    /// When used in Fable this member is inlined for reflection to work.
     #if FABLE_COMPILER
     member inline _.AsString =  // inline needed for Fable reflection
     #else
@@ -219,6 +220,7 @@ type Dict<'K,'V when 'K:equality > private (dic : Dictionary<'K,'V>) =
 
     /// A string representation of the Dict including the count of entries
     /// and the specified amount of entries.
+    /// /// When used in Fable this member is inlined for reflection to work.
     #if FABLE_COMPILER
     member inline _.ToString(entriesToPrint) =  // inline needed for Fable reflection
     #else

Src/Dicts.fsproj

@@ -69,4 +69,10 @@
     <Compile Include="Dict.fs" />
     <Compile Include="DefaultDict.fs" />
   </ItemGroup>
+
+  <Target Name="CopyReadmeToDocs" AfterTargets="Build">
+    <!-- for fsdocs to build locally -->
+    <Copy SourceFiles="../README.md" DestinationFiles="../Docs/index.md" ContinueOnError="false"/>
+  </Target>
+
 </Project>

Src/IDictionary.fs

@@ -84,7 +84,11 @@ module ExtensionsIDictionary =
 
 
         /// A string representation of the IDictionary including the count of entries and the first 5 entries.
-        member inline this.AsString =  // inline needed for Fable
+        #if FABLE_COMPILER
+        member inline this.AsString =  // inline needed for Fable reflection
+        #else
+        member this.AsString =  // on .NET inline fails because it's using internal DefaultDictUtil
+        #endif
             let b = Text.StringBuilder()
             let c = this.Count
             b.Append(toString this) |> ignore
@@ -97,7 +101,11 @@ module ExtensionsIDictionary =
 
         /// A string representation of the IDictionary including the count of entries
         /// and the specified amount of entries.
-        member inline this.ToString(entriesToPrint) = // inline needed for Fable
+        #if FABLE_COMPILER
+        member inline this.ToString(entriesToPrint) =  // inline needed for Fable reflection
+        #else
+        member this.ToString(entriesToPrint) = // on .NET inline fails because it's using internal DefaultDictUtil
+        #endif
             let b = Text.StringBuilder()
             let c = this.Count
             b.Append(toString this) |> ignore