should `checkModule` in `masonPublish` only count files? about chapel

[jeremiah-corrado]

Looking at this some more, I think we should make Option 2 illegal, to avoid potential module-resolution ambiguities. This requirement can always be relaxed in the future if we decide it's too strict.

[jeremiah-corrado]

I think this issue can be closed due to #25084 and #25098

[jeremiah-corrado]

I created a draft PR to fix this; however, it does allow Option 2 above, and I'm wondering whether that should be legal.

I suspect that the second case could be a problem if MyPkg.chpl has a public use for the modules something and/or somethingElse because there could be module-resolution conflicts if someone tries to use MyPkg in their project that already has a module with the same name. I'll investigate whether this is an issue before going further with my PR.

Or if anyone happens to already know that Option 2 should be illegal that would be helpful.

[benharsh]

I think you're absolutely right about the listDir being wrong. We'll take a look.

[lucaferranti]

Thanks @benharsh for the reply! I think the fix itself (updating moduleCheck) will be relatively straightforward. I would like to understand the motivation for that check in the first place.

Suppose I have a library MyPkg. Here are three options for src/

Option 1

src/
   MyPkg.chpl

This will be fine, src has only one file, hence only one module, hence only one main module. However, this solution makes sense only for small and simple libraries.

Option 2

src/
   MyPkg.chpl
   something.chpl
   somethignElse.chpl

Do something.chpl and somethingElse.chpl count as submodules of MyPkg.chpl or are they peer main modules? If I read

or packages that span multiple files, the main module is designated by the module that shares the name with the package directory and the name field in the Mason.toml file.

I would understand from it that this structure should still be fine, since MyPkg.chpl is the only main module. However maybe this is a mason specific convention and can causes issues, so this could be forbidden I guess.

Option 3

src/
   MyPkg.chpl
   MyPkg/
       something.chpl
       somethingElse.chpl

This structure will currently fail (because of my diagnosis above) but based on my reading of the docs I think it should be accepted. Is there any problem with this? I tried a small toy example and mason build and mason test with no additional flags seemed to work for this.