werk85 / fp-ts-std

The missing pseudo-standard library for fp-ts.

fp-ts-std

The missing pseudo-standard library for fp-ts. Supports both the web and Node.

Documentation: samhh.github.io/fp-ts-std

For DOM bindings, check out dom-ts.

Installation

The library is available on the npm registry under the same package name: fp-ts-std

fp-ts, newtype-ts, and monocle-ts are listed as peer dependencies.

Some of the more commonly needed functions from fp-ts-contrib are duplicated here.

Objectives

fp-ts-std aims to achieve the following objectives:

• Flesh out what fp-ts is missing
• Fill in the gaps between fp-ts and Ramda
• Wrap JS APIs to be friendly, so that you never have to interact with null or undefined, or worry about a function throwing again

Ethos

fp-ts-std strives to adhere to the following principles:

• Strict type-safety wherever possible, with risks well documented
• All functions are curried
• Functions are data-last as a rule
• Functions are total unless explicitly prefixed with "unsafe" (with the exception of the Debug module)
• Impure functions are appropriately signed with the IO and Task types
• Lean towards Haskell naming conventions and idioms with an eye to fp-ts norms

Additionally, fp-ts-std enforces 100% testing coverage, and just about everything is documented with examples. (That said, any improvement to the documentation is welcome, either by suggestion or PR!)

Contributing

Unreleased work is commit to the develop branch. master is the release branch and whence the documentation is generated.

All modules and exports must be annotated with JSDoc. This information is used to generate documentation. Simple, illustratory tests can also be included and will be checked during docs generation. For more information, see docs-ts.

Publishing

Only the owner of this repository can publish, but this is still useful to document each for my memory, for any contributors, and for anyone who seeks to use this repo as a template for their own library.

Files are built into dist/, however we'd prefer if consumers didn't have to import from <package>/dist/<module>, so we copy the npm manifest into the aforementioned subdirectory and publish against that. The npm manifest at the root of this repo has "private": true set to prevent accidentally publishing with the prefix.

The process for publishing is thus as follows:

1. Increment the version in the npm manifest.
2. Run $ yarn prepub, which handles the npm manifest fiddling described above.
3. Run $ yarn publish dist/, and repeat the version in the npm manifest when prompted.