taidalog / fermata Goto Github PK

• Revise README.
• Update year in License.

There are some incorrect lines.

• l.24 Return type is still Fermata.Errors.Errors though it returns exn.
• l.32 Return type is still Fermata.Errors.Errors though it returns exn.
• l.55 Return type is still Fermata.Errors.Errors though it returns exn.
• l.79 Return type is still Fermata.Errors.Errors though it returns exn.
• l.104 Return type is still Fermata.Errors.Errors though it returns exn.
• l.120 Return type is still Fermata.Errors.Errors though it returns exn.

• #31
• #32
• #33
• Revise README.md.
• Raise version.
  • Top of README.md.
  • Installation (.NET CLI) in README.md.
  • Installation (F# Intaractive) in README.md.
  • <Version> in .fsproj.

• Add <OtherFlags>--allsigs</OtherFlags> to .fsproj, a compiler option to generate a signature file for each source file.
• Do dotnet build to generate signature files.
• Revise the generated signature file if needed.
• Add the signature files to .fsproj.
• Remove <OtherFlags>--allsigs</OtherFlags> from .fsproj because the option overwrote signature files I wrote on build!

Dec in Fermata.RadixConversion module deals with values of type int32, so it should be renamed Dec32 to show that it can't have a value greater than Int32.MaxValue or less than Int32.MinValue.
For the same reason, Bin should be Bin32, and Hex should be Hex32.

• Math.clampGap
• String.rev
• String.chunkBySize
• String.chunkBySizeRight

Validation functions are to be named according to following rules:

• validate function returns Result or Option
• isValid function returns bool

So following actions are needed:

• Rename validate to isValid
• Build validate
• Remake tryToXxx functions

• #21
• Raise version.
• Revise README.

• PackageLicenseExpression
• PackageReadmeFile

• Array.filteri
• List.filteri
• Seq.filteri

F# codes have to be included in a package so that the package can work in a Fable project.

Issues #18 and #19 aim working with Fable, but before doing #18 and #19, there are several things left to be done. So now, for the time being, undo those two issues.

• String.split
• Array.intersection
• List.intersection
• Seq.intersection

Now the validate functions for those modules don't see the length of the input strings, which leads to overflow.
So those functions should have length validation.

Arb is a module for radix conversion with an arbitrary radix.
Arb is also a name of a discriminated union to represent the converted number.
The module provides functions for conversion, such as ofInt and toInt.

• Raise version.
• Revise README.md.

• #35
• #36
• Revise README.md.
• Raise version.
  • Top of README.md.
  • Installation (.NET CLI) in README.md.
  • Installation (F# Intaractive) in README.md.
  • <Version> in .fsproj.

• Array/List/Seq.countWith
• Array/List/Seq.trySkip
• Array/List/Seq.filterIndex

This project is listed in Sergey Tihon's F# Weekly newsletter like this:

taidalog/Fermata: F# miscellaneous library

Could the Fermata's About section be specified a bit more so viewers can see its purpose quickly?

A code formatter is needed.

• Lower version of FSharp.Core to 6.0.1 in order to work in a Fable project.

intersection function in Fermata.Array, Fermata.List andFermata.Seq modules should be renamed after Set.intersect.

• Boundary.clampGap
• Boundary.clamp
• Boundary.gap
• Boundary.between
• Boundary.within
• Boundary.rebound
• Boundary.warp

A code formatter is needed.

Some modules with common names such as List, Array or Seq should be given [<RequireQualifiedAccess>] attribute to avoid name collisions between other modules.

• Array
• List
• Seq
• Bool
• Bound
• RadixConversion
• Regex
• Result
• String
• Tuple
• Validators

• Replace HTML tags with markdown.
• Add links to GitHub and NuGet.
  Repository on GitHub
  NuGet Gallery
• Add "how to install".

• Array.splitWith
• List.splitWith
• Seq.splitWith
• String.splitWith
• Array.padLeft
• Array.padRight
• List.padLeft
• List.padRight
• Seq.padLeft
• Seq.padRight

• CoordinateSystem module
• Cartesian module
• Screen module

Testing is important!

Commonly used validation functions should be given as a module.

Following functions are used often.

• validateNotEmpty
• validateFormat

.NET static methods Int32.Parse and Int32.TryParse are useful. But when it comes to using with Result type, there can be a function that validate a number and returns Result<int, 'Error>.

Now error handling is done with discriminated unions.
But exception is more useful for some reasons:

• exception can be used in the same way as UD.
• exception can stop the program running.

So replace UD with exception and use them. They can be thrown or they can't.

• Revise README.md.
• Raise version.
  • Top of README.md.
  • Installation (.NET CLI) in README.md.
  • Installation (F# Intaractive) in README.md.
  • <Version> in .fsproj.

• #18
• #19

Now Fermata cannot be loaded in a Fable project correctly, which might be caused by lacking .fsi files.

• Set <Copyright>
• Set <RepositoryUrl>
• Set <RepositoryType>

List/Array/Seq.intersection has an issue related to constraints. It can be fixed by adding when 'T: equality.

• Raise version.
• Revise README.md.

There are some incorrect lines.

• l.27 Return type is still Fermata.Errors.Errors though it returns exn.
• l.120 Dec.tryToBin is called in an example for Dec.tryToHex.
• l.128 Dec.tryToBin is called in an example for Dec.tryToHex.
• l.156 Return type is still Fermata.Errors.Errors though it returns exn.
• l.245 Return type is still Fermata.Errors.Errors though it returns exn.

• Raise version.
• Revise README.md.

• Revise README.md.
• Raise version.
  • Top of README.md.
  • Installation (.NET CLI) in README.md.
  • Installation (F# Intaractive) in README.md.
  • <Version> in .fsproj.
• Revise <Description> in .fsproj so viewers can see its purpose quickly.

Dec, Bin and Hex are represented as type of int or string. However, in this way, incorrect values can get into processing. In order to avoid it, there should be DUs for those types of numbers.