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

Default folder structure #37

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

andreasWallner
Copy link

@andreasWallner andreasWallner commented Dec 9, 2023

Why switch back to the standard sbt folder structure:

  • While we can easily change the folder name for the source files, it's not done for tests
  • We differ from sbt related documentation, with no real advantage (except having a flatter folder structure)
  • Confuses some (badly written) plugins/tools

Remove notes on custom folder layout from documentation for similar reasons. If someone really wants to do
that we don't want to need to support this.

Opened this as a draft since I'm seeing weird dependency errors after the move that I don't yet understand
EDIT: was caused by old files, everything works after a git clean -fdx

TODO:
If we agree on this, add an example for a test case via scalatest

While we can easily change the source folder
there is no such property for the test folder.
It raises questions and the custom folder structure is
IMO not worth it (deviating from normal sbt documentation
like https://www.scala-sbt.org/1.x/docs/Directories.html)
@andreasWallner andreasWallner marked this pull request as ready for review December 9, 2023 15:08
@Dolu1990
Copy link
Member

Hi,

What's about :

The main idea is to provide a template that people can then stretch to their usual flow / structure (not forcing them to follow the SBT way), and so, reduce frictions

@andreasWallner
Copy link
Author

That's what I meant when I wrote "it's not done for tests" - yes we can (and should at least) fix that but:
tbh. I don't see much advantage in promoting a non standard layout - it only makes it harder for new users since most common SBT info/tutorials won't apply (and we have to provide docs for our customizations), and users will as a starting point just copy this repo and go with it.

Or did we have many users in the past that asked about how to configure some custom folder structure? None of the examples that I've seen recently did any changes, all were sticking to what is in the template.

In any case, we should do either of the two options ;-)

@Dolu1990
Copy link
Member

Or did we have many users in the past that asked about how to configure some custom folder structure?

Kinda, some people get the thing and want to fit in their own flow / folder structure which are often specific.

  • the default deeeeepness SBT folder structure scaring people away XD

It is always hard to know if they are a "noisy minority" or the "silent majority", so hard to tell what should be the default to fit as well as possible

In any case, we should do either of the two options ;-)

Yes right, like having the "Compile / scalaSource := baseDirectory.value / "hw" / "spinal"," commented in the build.sbt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants