Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: split file system out into create-fs package, with diffCreatedDirectory tester #129

Merged
merged 8 commits into from
Jan 14, 2025

Conversation

JoshuaKGoldberg
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg commented Jan 14, 2025

PR Checklist

Overview

Splits the file system and files creation types into a separate create-fs module. They have a few renames, mostly around switching CreatedFiles to CreatedDirectory.

Adds two important high-level APIs:

  • create-fs > intakeFromDirectory: Reads files from disk into a CreatedDirectory
    • This intentionally doesn't use the ReadingFileSystem type because I don't want to add the concept of fs.stat to that system
  • create-testers > diffCreatedDirectory: Given an actual directory, i.e. from intakeFromDirectory, and a produced Creation, returns an object describing their differences

This is intentionally different from the tester API proposed in #38. I don't feel ready yet to commit to a particular high-level API for repository templates. For now I'd rather provide lower-level pieces and explore using them.

💝

Copy link

vercel bot commented Jan 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
create ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 14, 2025 6:08pm

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.51%. Comparing base (67fbd7a) to head (b8385fb).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #129      +/-   ##
==========================================
+ Coverage   98.35%   98.51%   +0.16%     
==========================================
  Files         174      179       +5     
  Lines        6124     6520     +396     
  Branches      896      961      +65     
==========================================
+ Hits         6023     6423     +400     
+ Misses         98       94       -4     
  Partials        3        3              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JoshuaKGoldberg JoshuaKGoldberg changed the title feat: split file system into create-fs, with diffCreatedDirectory tester feat: split file system out into create-fs package, with diffCreatedDirectory tester Jan 14, 2025
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review January 14, 2025 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant