Support flake.nix and flake.lock as allowed files when initializing a project

[atkrad]

What do you want to happen?

When I attempt to initialize a new project, I encounter the following error:

kubebuilder init --domain example.com --repo example.com/example-operator

Error:

Error: failed to initialize project: unable to run pre-scaffold tasks of "base.go.kubebuilder.io/v4": target directory is not empty (only go.mod, go.sum, files and directories with the prefix ".", files with the suffix ".md" or capitalized files name are allowed); found existing file "flake.lock"

It seems that only specific files, such as go.mod, go.sum, or Markdown files, are accepted in the target directory. However, many developers use Nix to manage dependencies, which requires files like flake.nix and flake.lock to be present in the directory for dependency installation.

To improve compatibility, it would be a good idea to accept flake.nix and flake.lock as allowed files during project initialization.

Extra Labels

No response

[camilamacedo86]

Hi @atkrad,

Thank you for raising this. 🥇

The check is only done when you create the project. If you add these files afterwards, the issue would not be raised.

This aims to prevent users from scaffolding a project in a directory with files that could impact its functionality. However, IHMO we can change this implementation.

See where it is currently done: kubebuilder init.go

Instead of using an allowed list, we could implement a deny list. For example:

• Deny if the directory contains .go files or .yaml files.
• Allow any other extensions.

What do you think? Would you like to work on this?

[sbin64]

@camilamacedo86 I would love to give it a try

@atkrad wanna try out? lmk! thanks

[camilamacedo86]

Go forward, please feel free to raise a PR.