Skip to content

🐛 fix: disallow files containing unwanted files when initializing a project #4510

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

Merged
merged 1 commit into from
Jan 23, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions pkg/plugins/golang/v4/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -187,21 +187,23 @@ func checkDir() error {
if isCapitalized && info.Name() != "PROJECT" {
return nil
}
// Allow files in the following list
allowedFiles := []string{
"go.mod", // user might run `go mod init` instead of providing the `--flag` at init
"go.sum", // auto-generated file related to go.mod
disallowedExtensions := []string{
".go",
".yaml",
".mod",
".sum",
}
for _, allowedFile := range allowedFiles {
if info.Name() == allowedFile {
// Deny files with .go or .yaml or .mod or .sum extensions
for _, ext := range disallowedExtensions {
if strings.HasSuffix(info.Name(), ext) {
return nil
}
}
// Do not allow any other file
return fmt.Errorf(
"target directory is not empty (only %s, files and directories with the prefix \".\", "+
"files with the suffix \".md\" or capitalized files name are allowed); "+
"found existing file %q", strings.Join(allowedFiles, ", "), path)
"target directory is not empty and contains a disallowed file %q. "+
"files with the following extensions [%s] are not allowed to avoid conflicts with the tooling.",
path, strings.Join(disallowedExtensions, ", "))
})
if err != nil {
return err
Expand Down
Loading