Design Document

[IMax153]

Welcoming any and all feedback / comments / suggestions for the library!

Take a look at the design document and then leave your feedback below. ⬇️ ⬇️ ⬇️

[IMax153]

One thought that I had for the build script was to avoid specifying an es5 and an es6 directory entirely and instead use the build targets provided to the script to figure out what the output should look like.

Alternatively, the buildTargets option could be removed and the es5 and es6 options could point to respective tsconfig.json files instead of directories. This approach may be better for ensuring that we only have a maximum of two build targets for fp-ts ecosystem libraries (i.e., the es5 and es6 build targets).

[gcanti]

import-path-rewrite: shouldn't be necessary anymore

release: sometimes is useful to change the release tag: for example npm publish --tag=next or npm publish --tag=rc

[waynevanson]

Nice to see this!

1. I think that there should be a dry mode that validates if there will be errors; a linter for fp-ts modules.
   Maybe it could be a command under fp-ts lint
   That way we don't have to wait for the project to build before seeing errors. It's a huge ask.
   In the code I'd assume the validation logic is separate from the code that does the work.

   It could check for the following:

   1. Appropriate tsdoc @ Flag and related comments.
   2. Types resolve for good DX ( StateTask<S, A> over StateT<"Task", S, A>).
   3. Correct casing for file names
   4. Correct export patterns (seems to be lowercase at this stage)
   5. Contains CI for integrated testing
   6. tsconfig.[*].json is correct
   7. 100% test coverage
   8. Appropriate combinators exported

2. The bin name could be fpts or fp-ts rather than fp-ts-scripts to save some keystrokes.