Missing explanation of how to construct / inject FileSystem (and others) in runable code
EmanuelKedmi opened this issue · 4 comments
Describe the bug
On first usage of this library, we have the README of the repo as guidance and nothing else.
this readme has example of how to use the abstractions in a class, but no example of how to provide the backing type.
To Reproduce
- In a new project add only TestableIO.System.IO.Abstractions as the readme would suggest
- Create a class like in the example in readme
- Try providing the FileSystem type, it doesnt exist, google searchs seem to indicate it should
Expected behavior
Need add some reference in the README (or add wiki) to the TestableIO.System.IO.Abstractions.Wrappers nuget which adds the relevant classes to actually allow running code and not just tests.
Additional context
Hopefully I have not missed some obvious section in some readme or some other place that mentions this,
though I still think it should be added to README file
Oh, that's a good hint. We should actually suggest adding TestableIO.System.IO.Abstractions.Wrappers in the README.
@fgreinacher :
Shouldn't this issue be automatically closed because of #1014?
Or what is the process for closing issues here?
@fgreinacher :
Shouldn't this issue be automatically closed because of #1014?
Or what is the process for closing issues here?
@vbreuss I don't think GitHub supports the syntax you used in the PR: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword