directory modelling suggestion

[entunidotdeb]

proposing something like this (or better & complete) to have all properties of directory like includeHiddenFiles, maxDepth etc. ik this is quite a big change and would not be backward compatible but i guess worth to include something similar.
your thoughts on this? @AvdLee

[wetransferplatform]

	Messages
📖	View more details on Bitrise
📖	DiagnosticsTests: Executed 33 tests (0 failed, 0 retried, 0 skipped) in 0.482 seconds

SwiftLint found issues

Severity	File	Reason
Warning	DirectoryTreeReporter.swift:18	Lines should not have trailing whitespace. (trailing_whitespace)
Warning	DirectoryTreeReporter.swift:78	Lines should not have trailing whitespace. (trailing_whitespace)

Code Coverage Report

Name	Coverage
Diagnostics	70.42%	⚠️

Generated by 🚫 Danger Swift against 105b104

[BasThomas]

Thanks for this, @entunidotdeb! Can you provide a bit more rationale for this change?

to have all properties of directory like includeHiddenFiles, maxDepth etc

What makes this an improvement over the current API, for example?

Also given that this would break the API, it'd technically require a major version bump, so that's at least something to keep in mind.

[entunidotdeb]

@BasThomas so currently for a client to have multiple doc reports of different maxDepth, includeHiddenFiles and other properties, client would have to create multiple instances of DirectoryTreesReporter. Even then client would have no option to specifically set maxDepth for a group out of the nested Group/Directory Tree. How about client has option to customize the Directory specific props instead of the DirectoryTreesReporter props ?

multiple DirectoryTreesReporter would lead to multiple DiagnosticsChapter

[BasThomas]

Gotcha, thanks!

[AvdLee]

Thanks a lot for your contribution! I like the change. I do believe we can improve this implementation by adding a deprecated initializer for the current implementation, so we allow our users to gracefully migrate.

[entunidotdeb]

@AvdLee @BasThomas
I have updated this PR with new init for DirectoryTreeReporter and deprecating the earlier init.
you may review and suggest changes if needed.

[AvdLee]

Thanks, we're getting closer! Just a few points left 💪

[AvdLee]

@entunidotdeb the code looks great, but it seems that tests are failing. Did you manage to run tests successfully locally?

[entunidotdeb]

@entunidotdeb the code looks great, but it seems that tests are failing. Did you manage to run tests successfully locally?

@AvdLee yes sir

[github-actions]

This PR is stale because it has been open for 30 days with no activity. Remove the Stale label or comment or this will be closed in 10 days.

[AvdLee]

@entunidotdeb our repository requires signed commits. Would it be possible for you to enable signed commits and recommit using the following command:

 git rebase --exec 'git commit --amend --no-edit -n -S' -i develop
 git push --force

You can read more about setting up signed commits here.

[AvdLee]

@entunidotdeb we're almost there! Your commits are signed but unverified:

You can learn more about that here: https://docs.github.com/en/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits

[entunidotdeb]

@AvdLee Done

[raphkoebraam]

Thanks for going over the comments @entunidotdeb! 🚀

[entunidotdeb]

Thanks for going over the comments @entunidotdeb! 🚀

[AvdLee]

@entunidotdeb congrats with your successful contribution! Thanks again for setting up signed commits 🙏

[entunidotdeb]

Thank you @AvdLee for suggestions on PR, approval and merge.
Thanks @peagasilva for approval.

[wetransferplatform]

Congratulations! 🎉 This was released as part of Release 4.3.1 🚀

Generated by GitBuddy