feature-sliced / steiger

Universal file structure and project architecture linter
https://www.npmjs.com/package/steiger
MIT License
48 stars 3 forks source link

Throw an exception if a non-existent folder is provided as an FSD root. #58

Open daniilsapa opened 1 month ago

daniilsapa commented 1 month ago

Right now it just says that no problems were found. But it seems the tool should exit with an error in this case, so the user can understand that they misconfigured the tool early.

Screenshot 2024-07-16 at 19 59 55
illright commented 1 month ago

Indeed, that should be fixed! Ideally, we would also scan the folders around a given path in case it's a typo of 1-2 characters, and we could offer a suggestion to auto-correct the path

daniilsapa commented 1 month ago

Yes, I like the idea of scanning the folders and suggesting corrections to the path. It would be convenient and would improve DX. But I think it's a nice-to-have at the project's current stage. I propose to go with throwing the error first and simultaneously create an issue for the auto-correction enhancement, so we can revisit it later when more high-priority tasks are done.