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

FileList property is not populated #112

Open
kilasuit opened this issue Jan 21, 2022 · 4 comments
Open

FileList property is not populated #112

kilasuit opened this issue Jan 21, 2022 · 4 comments
Labels
20 - Enhancement 21 - Hacktoberfest These tickets are particularly easy to do without understanding the whole codebase

Comments

@kilasuit
Copy link
Contributor

kilasuit commented Jan 21, 2022

Loking at the code it seems that there is no attempt to populate the FileList property in the psd1

It would be useful for this property to be populated when using ModuleBuilder

@Jaykul
Copy link
Member

Jaykul commented Jan 22, 2022

Does anything use that property?

@Jaykul Jaykul closed this as completed Jan 22, 2022
@Jaykul Jaykul reopened this Jan 22, 2022
@gaelcolas
Copy link
Contributor

Also, I think we may want to that later in the process?
If we add things like platyps generated maml to the module, we'd have to update-modulemanifest anyway...

@kilasuit
Copy link
Contributor Author

It is useful for metadata quering reasons as well as in security validation, though I expect both aren't all that wide spread in their use.
However I've have had issues in making sure it can be populated via a number of methods and that afterwards that the module can be published using PowerShellGet v2.2.5 to a local fileshare based repo. I have had no issue in doing this before with modules that have nested folders and files so I know it can be done.

@Jaykul
Copy link
Member

Jaykul commented Jan 23, 2022

In an earlier project, I used that value to restrict which files would be packaged into the module package so that you could, for instance, have a config file in the folder next to the module, and trust it wouldn't be included in the package. However, when Microsoft released PowerShellGet, they said that since most people were not setting the value, they were going to package the entire contents of the module folder, regardless of this setting, creating a catch-22 situation: nobody sets it, so they ignore it, so nobody sets it...

Since most people will need to use PowerShellGet to publish their modules, everyone now expects that behavior, and so (as far as I know) nothing in the OS, PowerShell, PowerShellGallery/PowerShellGet, or any antivirus actually references it either, as far as I know, perpetuating the fact that it can't be trusted for any particular use.

All of that said -- I have no problem with setting it although (to avoid the issue @gaelcolas raised), you would have to build any binaries or help files into your module source before running Build-Module (and be sure to set CopyPaths) in order for ModuleBuilder to know all the files that need to be listed.

@Jaykul Jaykul added 20 - Enhancement 21 - Hacktoberfest These tickets are particularly easy to do without understanding the whole codebase labels Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
20 - Enhancement 21 - Hacktoberfest These tickets are particularly easy to do without understanding the whole codebase
Projects
None yet
Development

No branches or pull requests

3 participants