fthomas / fthomas/refined

Reduce API surface

Open
#386 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Scala
Stars
1.7k
Forks
152
Avg merge
1h 20m
Merged PRs (30d)
6

Description

In #382 I expressed concerns about adding a variant of the `validate` method that doesn't require a full refined type, because I feel the current API surface is already quite large and the library provides sometimes more than one way to do things (especially with the addition of companions for refined types, see #369). It would be nice if we could reduce the API surface and make it more approachable.

This issue is about collecting weak spots in the API and things we can improve.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the concerns in #382 and the companion additions mentioned in #369, then inventory the public API for redundant or weak spots. This issue names no files or tests, and its completion criteria are limited to collecting weak spots and identifying improvements.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.