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.

Sign up for GitHub

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

Jump to bottom

✨ Extend files whitelist for init cmd #2160

Merged
merged 1 commit into from
May 28, 2021
Merged

✨ Extend files whitelist for init cmd #2160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 21 additions & 6 deletions pkg/plugins/golang/v3/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"os"
"path/filepath"
"strings"
"unicode"

"github.com/spf13/pflag"

Expand Down Expand Up @@ -171,12 +172,25 @@ func checkDir() error {
if strings.HasPrefix(info.Name(), ".") {
return nil
}
// Allow files ending with '.md' extension
if strings.HasSuffix(info.Name(), ".md") && !info.IsDir() {
return nil
}
// Allow capitalized files except PROJECT
isCapitalized := true
for _, l := range info.Name() {
if !unicode.IsUpper(l) {
isCapitalized = false
break
}
}
if isCapitalized && info.Name() != "PROJECT" {
camilamacedo86 marked this conversation as resolved.
Show resolved Hide resolved
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
"LICENSE", // can be generated when initializing a GitHub project
"README.md", // can be generated when initializing a GitHub project
"go.mod", // user might run `go mod init` instead of providing the `--flag` at init
"go.sum", // auto-generated file related to go.mod
}
for _, allowedFile := range allowedFiles {
if info.Name() == allowedFile {
Expand All @@ -185,8 +199,9 @@ func checkDir() error {
}
// Do not allow any other file
return fmt.Errorf(
"target directory is not empty (only %s, and files and directories with the prefix \".\" are "+
"allowed); found existing file %q", strings.Join(allowedFiles, ", "), path)
"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)
})
if err != nil {
return err
Expand Down