mirror of
https://github.com/openimsdk/open-im-server.git
synced 2026-05-01 07:35:58 +08:00
feat: Introduce Language-Specific Comment Detection Tool and Standardize Log Filename Convention (#1992)
* feat: optimize openim reset code * feat: optimize openim reset code * feat: optimize openim reset code * feat: optimize openim reset code * feat: optimize openim reset code * feat: optimize openim reset code * feat: optimize openim reset code * feat: optimize openim reset code
This commit is contained in:
@@ -0,0 +1,90 @@
|
||||
package checker
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"github.com/openimsdk/open-im-server/tools/codescan/config"
|
||||
)
|
||||
|
||||
type CheckResult struct {
|
||||
FilePath string
|
||||
Lines []int
|
||||
}
|
||||
|
||||
func checkFileForChineseComments(filePath string) ([]CheckResult, error) {
|
||||
file, err := os.Open(filePath)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
var results []CheckResult
|
||||
scanner := bufio.NewScanner(file)
|
||||
reg := regexp.MustCompile(`[\p{Han}]+`)
|
||||
lineNumber := 0
|
||||
|
||||
var linesWithChinese []int
|
||||
for scanner.Scan() {
|
||||
lineNumber++
|
||||
if reg.FindString(scanner.Text()) != "" {
|
||||
linesWithChinese = append(linesWithChinese, lineNumber)
|
||||
}
|
||||
}
|
||||
|
||||
if len(linesWithChinese) > 0 {
|
||||
results = append(results, CheckResult{
|
||||
FilePath: filePath,
|
||||
Lines: linesWithChinese,
|
||||
})
|
||||
}
|
||||
|
||||
if err := scanner.Err(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return results, nil
|
||||
}
|
||||
|
||||
func WalkDirAndCheckComments(cfg config.Config) error {
|
||||
var allResults []CheckResult
|
||||
err := filepath.Walk(cfg.Directory, func(path string, info os.FileInfo, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if info.IsDir() {
|
||||
return nil
|
||||
}
|
||||
for _, fileType := range cfg.FileTypes {
|
||||
if filepath.Ext(path) == fileType {
|
||||
results, err := checkFileForChineseComments(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if len(results) > 0 {
|
||||
allResults = append(allResults, results...)
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if len(allResults) > 0 {
|
||||
var errMsg strings.Builder
|
||||
errMsg.WriteString("Files containing Chinese comments:\n")
|
||||
for _, result := range allResults {
|
||||
errMsg.WriteString(fmt.Sprintf("%s: Lines %v\n", result.FilePath, result.Lines))
|
||||
}
|
||||
return fmt.Errorf(errMsg.String())
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user