Enable including test scope inputs when publishing

[majk-p]

Version(s) 1.6.1

Describe the bug
When packaging sources with scala-cli publish, sources within test directories are omitted even when they contain regular sources that are not tests. This can lead to missing classes in published jars.

Additionally, this behavior is not documented under https://scala-cli.virtuslab.org/docs/commands/publishing/publish

To Reproduce
Clone https://github.com/majk-p/scala-cli-publish-test and run ./package-and-check.sh

Expected behaviour
I appreciate that publishing is an experimental feature and I see how this might just be a very simple implementation for skipping test sources. I ideal world Scala CLI would simply knew if the file contains references to test framework but implementing that sounds impractical for a niche issue like this one.

A practical solution that would be backwards compatible could be a setting like "always-include-path" that would include a path (one or more) that won't be filtered out.

Anything that can help me include ./test/testapi.scala from the reproduction repo in published jar will be enough.

[Gedochao]

When packaging sources with scala-cli publish, sources within test directories are omitted even when they contain regular sources that are not tests.

@majk-p ok, so first things first, this is not a bug and it's meant to work this way. The test and main scopes should not be compiled together by default here, as per the docs: https://scala-cli.virtuslab.org/docs/commands/test#test-sources

However, I agree we should enable publishing test sources, both to be included in a common fat JAR (behind a flag, like compile's --test) and a separate, test JAR (that'd be out of scope for this ticket, I think - although valid as a separate feature request).

While this issue is not a duplicate per se, the solution to this is the same as:

• There is no command to run a main method in test scope #2728.

We have a --test command line option available for the compile sub-command, but we don't support it for other build commands. We should make it available for all sub-commands building the project, including publish. Just note that this requires a wide-scale refactor of all build commands, which is why it hasn't been done yet.

Will be treated as a feature request, thanks for raising.

[ghostbuster91]

@Gedochao Thanks for the reply. I agree that the test and main scopes should not be compiled together. I also agree about making it possible to publish test sources when needed.

What I think is a bit misleading here is how the test scope is defined.
I wouldn't expect files under ./src/main/com/company/example/test/.. to end up in the test scope.

[Gedochao]

What I think is a bit misleading here is how the test scope is defined. I wouldn't expect files under ./src/main/com/company/example/test/.. to end up in the test scope.

@ghostbuster91 Anything with a directory named test on its path is considered a part of the test scope.
AFAIK, it's always been so, and it's documented as such.
https://scala-cli.virtuslab.org/docs/commands/test/#test-sources

[ghostbuster91]

AFAIK, it's always been so, and it's documented as such.

I get that. I am only saying that this is quite uncommon in the scala land and I cannot recall any other tool that does that.