feat: add actions

Author: cubxxw

.github/workflows/release.yml

@@ -2,7 +2,7 @@
 # Licensed under the MIT License (the "License");
 # you may not use this file except in compliance with the License.
 
-name: Go composite Release Version
+name: Go standardizer Release Version
 
 on:
   push:

.github/workflows/test.yml

@@ -14,9 +14,9 @@ jobs:
         with:
           go-version: '1.21'
 
-      - name: Install composite
+      - name: Install standardizer
         run: |
-          go install github.com/kubecub/composite@latest
+          go install github.com/kubecub/standardizer@latest
 
-      - name: Run composite Detector
-        run: composite
+      - name: Run standardizer Detector
+        run: standardizer

.goreleaser.yaml

@@ -19,9 +19,9 @@ report_sizes: true
 dist: _output/dist
 
 builds:
-  - binary: composite
-    id: composite
-    main: ./composite.go
+  - binary: standardizer
+    id: standardizer
+    main: ./standardizer.go
     goos:
       - windows
       - darwin
@@ -85,10 +85,10 @@ archives:
 nfpms:
   - id: packages
     builds:
-      - composite
+      - standardizer
     # Your app's vendor.
     vendor: kubecub
-    homepage: https://github.com/kubecub/composite
+    homepage: https://github.com/kubecub/standardizer
     maintainer: kubbot <https://github.com/kubbot>
     description: |-
       Comment Lang Detector is a tool to detect the language of comments in code files.
@@ -206,7 +206,7 @@ checksum:
 
 release:
   footer: |
-    **Full Changelog**: https://github.com/kubecub/composite/compare/{{ .PreviousTag }}...{{ .Tag }}
+    **Full Changelog**: https://github.com/kubecub/standardizer/compare/{{ .PreviousTag }}...{{ .Tag }}
 
     ## Helping out
 

README.md

@@ -6,7 +6,7 @@ An Github Actions Tools, Development of a Go-Based Conformity Checker for Projec
 
 #### Project Name
 
-- `GoConcomposite`
+- `GoConstandardizer`
 
 #### Functionality Description
 
@@ -54,7 +54,7 @@ package main
 import (
     "flag"
     "fmt"
-    "GoConcomposite/checker"
+    "GoConstandardizer/checker"
 )
 
 func main() {

action.yml

@@ -1,8 +1,8 @@
 name: 'Conformity Checker for Project'
-description: 'composite action for conformity checker for project'
+description: 'standardizer action for conformity checker for project'
 author: 'cubxxw'
 runs:
-  using: 'composite'
+  using: 'standardizer'
   steps:
     - name: Checkout Repository
       uses: actions/checkout@v4

checker/checker.go

@@ -1,8 +1,10 @@
 package checker
 
 import (
+	"fmt"
 	"os"
 	"path/filepath"
+	"regexp"
 	"strings"
 
 	"github.com/kubecub/standardizer/config"
@@ -24,7 +26,24 @@ type Checker struct {
 }
 
 func (c *Checker) Check() error {
-	return filepath.Walk(c.Config.BaseConfig.SearchDirectory, c.checkPath)
+	err := filepath.Walk(c.Config.BaseConfig.SearchDirectory, c.checkPath)
+	if err != nil {
+		return err
+	}
+
+	if len(c.Summary.Issues) > 0 {
+		c.printIssues()
+		return fmt.Errorf("found %d issues in the codebase", len(c.Summary.Issues))
+	}
+	return nil
+}
+
+func (c *Checker) printIssues() {
+	fmt.Println("## Issues found:")
+	fmt.Println("===================================================================================================")
+	for _, issue := range c.Summary.Issues {
+		fmt.Printf("Type: %s, Path: %s, Message: %s\n", issue.Type, issue.Path, issue.Message)
+	}
 }
 
 func (c *Checker) checkPath(path string, info os.FileInfo, err error) error {
@@ -42,15 +61,10 @@ func (c *Checker) checkPath(path string, info os.FileInfo, err error) error {
 	}
 
 	if info.IsDir() {
-		c.Summary.CheckedDirectories++
 		if c.isIgnoredDirectory(relativePath) {
-			c.Summary.Issues = append(c.Summary.Issues, Issue{
-				Type:    "ignoredDirectory",
-				Path:    path,
-				Message: "This directory has been ignored",
-			})
 			return filepath.SkipDir
 		}
+		c.Summary.CheckedDirectories++
 		if !c.checkDirectoryName(relativePath) {
 			c.Summary.Issues = append(c.Summary.Issues, Issue{
 				Type:    "directoryNaming",
@@ -77,17 +91,21 @@ func (c *Checker) checkPath(path string, info os.FileInfo, err error) error {
 
 func (c *Checker) isIgnoredDirectory(path string) bool {
 	for _, ignoredDir := range c.Config.IgnoreDirectories {
-		if strings.Contains(path, ignoredDir) {
+		if strings.HasSuffix(path, ignoredDir) || strings.Contains(path, ignoredDir+"/") {
 			return true
 		}
 	}
 	return false
 }
 
 func (c *Checker) isIgnoredFile(path string) bool {
-	ext := filepath.Ext(path)
 	for _, format := range c.Config.IgnoreFormats {
-		if ext == format {
+		matched, err := regexp.MatchString(format, path)
+		if err != nil {
+			fmt.Printf("Invalid regex pattern: %s, error: %s\n", format, err)
+			continue
+		}
+		if matched {
 			return true
 		}
 	}
@@ -96,21 +114,34 @@ func (c *Checker) isIgnoredFile(path string) bool {
 
 func (c *Checker) checkDirectoryName(path string) bool {
 	dirName := filepath.Base(path)
+	errors := []string{}
+
 	if c.Config.DirectoryNaming.MustBeLowercase && (dirName != strings.ToLower(dirName)) {
-		return false
+		errors = append(errors, "directory name must be lowercase")
 	}
 	if !c.Config.DirectoryNaming.AllowHyphens && strings.Contains(dirName, "-") {
-		return false
+		errors = append(errors, "hyphens are not allowed in directory names")
 	}
 	if !c.Config.DirectoryNaming.AllowUnderscores && strings.Contains(dirName, "_") {
+		errors = append(errors, "underscores are not allowed in directory names")
+	}
+
+	if len(errors) > 0 {
+		c.Summary.Issues = append(c.Summary.Issues, Issue{
+			Type:    "directoryNaming",
+			Path:    path,
+			Message: fmt.Sprintf("Directory naming issues: %s. Example of valid directory name: '%s'", strings.Join(errors, "; "), c.exampleDirectoryName()),
+		})
 		return false
 	}
+
 	return true
 }
 
 func (c *Checker) checkFileName(path string) bool {
 	fileName := filepath.Base(path)
 	ext := filepath.Ext(fileName)
+	errors := []string{}
 
 	allowHyphens := c.Config.FileNaming.AllowHyphens
 	allowUnderscores := c.Config.FileNaming.AllowUnderscores
@@ -123,14 +154,69 @@ func (c *Checker) checkFileName(path string) bool {
 	}
 
 	if mustBeLowercase && (fileName != strings.ToLower(fileName)) {
-		return false
+		errors = append(errors, "file name must be lowercase")
 	}
 	if !allowHyphens && strings.Contains(fileName, "-") {
-		return false
+		errors = append(errors, "hyphens are not allowed in file names")
 	}
 	if !allowUnderscores && strings.Contains(fileName, "_") {
+		errors = append(errors, "underscores are not allowed in file names")
+	}
+
+	if len(errors) > 0 {
+		c.Summary.Issues = append(c.Summary.Issues, Issue{
+			Type:    "fileNaming",
+			Path:    path,
+			Message: fmt.Sprintf("File naming issues: %s. Example of valid file name: '%s'", strings.Join(errors, "; "), c.exampleFileName(ext)),
+		})
 		return false
 	}
 
 	return true
 }
+
+func (c *Checker) exampleDirectoryName() string {
+	exampleName := "ExampleDirectory"
+	if c.Config.DirectoryNaming.MustBeLowercase {
+		exampleName = strings.ToLower(exampleName)
+	}
+	if !c.Config.DirectoryNaming.AllowHyphens && !c.Config.DirectoryNaming.AllowUnderscores {
+		exampleName = strings.ReplaceAll(exampleName, "-", "")
+		exampleName = strings.ReplaceAll(exampleName, "_", "")
+	} else if c.Config.DirectoryNaming.AllowHyphens {
+		exampleName = strings.ReplaceAll(exampleName, "_", "-")
+	} else if c.Config.DirectoryNaming.AllowUnderscores {
+		exampleName = strings.ReplaceAll(exampleName, "-", "_")
+	}
+	return exampleName
+}
+
+func (c *Checker) exampleFileName(ext string) string {
+	baseName := "example_file"
+	if c.Config.FileNaming.MustBeLowercase {
+		baseName = strings.ToLower(baseName)
+	}
+
+	if !c.Config.FileNaming.AllowHyphens && !c.Config.FileNaming.AllowUnderscores {
+		baseName = strings.ReplaceAll(baseName, "-", "")
+		baseName = strings.ReplaceAll(baseName, "_", "")
+	} else if c.Config.FileNaming.AllowHyphens {
+	} else if c.Config.FileNaming.AllowUnderscores {
+		baseName = strings.ReplaceAll(baseName, "-", "_")
+	}
+
+	if specificNaming, ok := c.Config.FileTypeSpecificNaming[ext]; ok {
+		if specificNaming.MustBeLowercase {
+			baseName = strings.ToLower(baseName)
+		}
+		if !specificNaming.AllowHyphens && !specificNaming.AllowUnderscores {
+			baseName = strings.ReplaceAll(baseName, "-", "")
+			baseName = strings.ReplaceAll(baseName, "_", "")
+		} else if specificNaming.AllowHyphens {
+		} else if specificNaming.AllowUnderscores {
+			baseName = strings.ReplaceAll(baseName, "-", "_")
+		}
+	}
+
+	return fmt.Sprintf("%s%s", baseName, ext)
+}

config.yaml

@@ -1,40 +1,36 @@
-# config.yaml 示例配置
-
-# 基础配置
 baseConfig:
-  searchDirectory: "./" # 检索的根目录，"./" 代表当前目录
-  ignoreCase: false # 是否忽略大小写，true 为忽略，false 为区分大小写
+  searchDirectory: "./"
+  ignoreCase: false
 
-# 目录命名风格配置
 directoryNaming:
-  allowHyphens: true # 是否允许目录名中含有中划线
-  allowUnderscores: false # 是否允许目录名中含有下划线
-  mustBeLowercase: true # 目录名是否必须为小写
+  allowHyphens: true
+  allowUnderscores: false
+  mustBeLowercase: true
 
-# 文件命名风格配置
 fileNaming:
-  allowHyphens: true # 是否允许文件名中含有中划线
-  allowUnderscores: true # 是否允许文件名中含有下划线
-  mustBeLowercase: true # 文件名是否必须为小写
+  allowHyphens: true
+  allowUnderscores: true
+  mustBeLowercase: true
 
-# 忽略的文件格式列表
 ignoreFormats:
-  - ".log"
-  - ".env"
-  - "_test.go"
+  - "\\.log$"
+  - "\\.env$"
+  - "README\\.md$"
+  - "_test\\.go$"
+  - "\\.md$"
+  - LICENSE
 
-# 忽略的目录列表
 ignoreDirectories:
   - "vendor"
   - ".git"
   - "node_modules"
   - "logs"
+  - "CHANGELOG"
   - "components"
   - "_output"
-  - "README.md"
   - "tools/openim-web"
   - "CHANGELOG"
-  - "docs/readme"
+  - "examples/Test_directory"
 
 fileTypeSpecificNaming:
   ".yaml":

examples/config/Example.yaml

@@ -0,0 +1 @@
+example.yaml

examples/config/example-File.yaml

@@ -0,0 +1 @@
+example.yaml

examples/config/example-file.yaml

@@ -0,0 +1 @@
+example.yaml

examples/config/example.yaml

@@ -0,0 +1 @@
+example.yaml

examples/config/example_file.yaml

@@ -0,0 +1 @@
+example.yaml

composite.go main.go

@@ -21,8 +21,8 @@ func main() {
 
 	if configPath == "" {
 		configPath = "config.yaml"
-		if _, err := os.Stat(".github/composite.yaml"); err == nil {
-			configPath = ".github/composite.yaml"
+		if _, err := os.Stat(".github/standardizer.yaml"); err == nil {
+			configPath = ".github/standardizer.yaml"
 		}
 	}
 
@@ -35,18 +35,13 @@ func main() {
 	c := &checker.Checker{Config: cfg}
 	err = c.Check()
 	if err != nil {
-		fmt.Println("Error during check:", err)
+		fmt.Println()
+		fmt.Println("===================================================================================================")
+		fmt.Println("Please check whether the above file conforms to the specification, or check whether the configuration file is qualified")
+		fmt.Println("!!!Error during check:", err)
 		os.Exit(1)
 	}
 
-	// if len(c.Errors) > 0 {
-	// 	fmt.Println("Found errors:")
-	// 	for _, errMsg := range c.Errors {
-	// 		fmt.Println("-", errMsg)
-	// 	}
-	// 	os.Exit(1)
-	// }
-
 	summaryJSON, err := json.MarshalIndent(c.Summary, "", "  ")
 	if err != nil {
 		fmt.Println("Error marshalling summary:", err)