knuckleswtf / knuckleswtf/scribe
Support wider range of types
- Dominant language
- PHP
- Stars
- 2.3k
- Forks
- 357
- PR merge metrics
- No merged PRs in 30d
Description
> ...rather than restrict the options, we could use Faker as a generator and stick to the types it offers. What particularly frustrated me was that when I renamed the field to "uuid", it generated an example UUID, but when I set the type to "uuid", an example"string" type was provided instead.
_Originally posted by @Jiraiya43 in https://github.com/knuckleswtf/scribe/issues/737#issuecomment-1741552970_
Contributor guide
Research direction
No file, test, or entry point is named. Start by locating how Scribe selects example values for declared types, then review the proposed Faker-based approach and the existing handling of the uuid type. Done means supported types produce appropriate examples, including a UUID for uuid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- laravel, php
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100