feat: optimize code

Author: cubxxw

.goreleaser.yaml

@@ -21,7 +21,7 @@ dist: _output/dist
 builds:
   - binary: standardizer
     id: standardizer
-    main: ./standardizer.go
+    main: ./main.go
     goos:
       - windows
       - darwin

README.md

@@ -1,104 +1,122 @@
-# Development of a Go-Based Conformity Checker for Project File and Directory Naming Standards
+# README for Standardizer
 
-An Github Actions Tools, Development of a Go-Based Conformity Checker for Project File and Directory Naming Standards
+## Overview
 
-### 1. Project Overview
+**Standardizer** is a versatile GitHub Action tool designed to ensure your project's file and directory names adhere to specified naming conventions. It automates the process of checking the conformity of naming standards within your repository, saving time and maintaining consistency across your codebase. Standardizer can be easily integrated into your GitHub workflows or used locally to inspect your project's structure for any deviations from the defined naming rules.
 
-#### Project Name
+## Features
 
-- `GoConstandardizer`
+- **Flexible Configuration**: Customize naming rules for files and directories through a straightforward YAML configuration.
+- **Regex Support for Ignoring Formats**: Utilize regular expressions to define exceptions for file formats that do not require standardization.
+- **Environment Variables & Flags Support**: Specify the configuration file's location using environment variables or command-line flags for versatile setup options.
+- **Local & CI Integration**: Designed for both local development environments and continuous integration workflows, ensuring consistency across different stages of development.
 
-#### Functionality Description
+## Getting Started
 
-- Checks if the file and subdirectory names in a specified directory adhere to specific naming conventions.
-- Supports specific file types (e.g., `.go`, `.yml`, `.yaml`, `.md`, `.sh`, etc.).
-- Allows users to specify directories to be checked and directories to be ignored.
-- More read https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md
+### Installation
 
-#### Naming Conventions
+For local use, you can either download the latest release from [GitHub Releases](https://github.com/kubecub/standardizer/releases/) or install directly using Go:
 
-- Go files: Only underscores are allowed.
-- YAML, YML, and Markdown files: Only hyphens are allowed.
-- Directories: Only underscores are allowed.
-
-### 2. File Structure
-
-- `main.go`: Entry point of the program, handles command-line arguments.
-- `checker/checker.go`: Contains the core logic.
-- `config/config.go`: Parses and stores configuration information.
-
-### 3. Core Code Design
-
-#### main.go
-
-- Parses command-line arguments, including the directory to be checked and directories to be ignored.
-- Calls the `checker` module for checking.
-
-#### config.go
+```shell
+go install github.com/kubecub/standardizer@latest
+```
 
-- Defines a configuration structure, such as directories to check and ignore.
+### Configuration
+
+Create a `standardizer.yml` configuration file in your project's root directory or under `.github/`. Alternatively, specify the configuration file's path through environment variables or flags.
+
+**Example `standardizer.yml` Configuration:**
+
+```yaml
+baseConfig:
+  searchDirectory: "./"
+  ignoreCase: false
+
+directoryNaming:
+  allowHyphens: true
+  allowUnderscores: false
+  mustBeLowercase: true
+
+fileNaming:
+  allowHyphens: true
+  allowUnderscores: true
+  mustBeLowercase: true
+
+ignoreFormats:
+  - "\\.log$"
+  - "\\.env$"
+  - "README\\.md$"
+  - "_test\\.go$"
+  - "\\.md$"
+  - LICENSE
+
+ignoreDirectories:
+  - "vendor"
+  - ".git"
+  - "node_modules"
+  - "logs"
+  - "CHANGELOG"
+  - "components"
+  - "_output"
+  - "tools/openim-web"
+  - "CHANGELOG"
+  - "examples/Test_directory"
+
+fileTypeSpecificNaming:
+  ".yaml":
+    allowHyphens: true
+    allowUnderscores: false
+    mustBeLowercase: true
+  ".go":
+    allowHyphens: false
+    allowUnderscores: true
+    mustBeLowercase: true
+```
 
-#### checker.go
+### Configuration Details
 
-- Iterates through the specified directory.
-- Applies different naming rules based on file types and directory names.
-- Records files or directories that do not conform to the standards.
+- **baseConfig**: General settings for the scan, such as the directory to search (`searchDirectory`) and whether to ignore case sensitivity (`ignoreCase`).
+- **directoryNaming** & **fileNaming**: Define the allowed naming conventions for directories and files, respectively, including the use of hyphens, underscores, and case sensitivity.
+- **ignoreFormats**: A list of regex patterns for file formats that should be ignored during the naming checks. This is useful for excluding specific file types or naming patterns.
+- **ignoreDirectories**: Directories to exclude from the scan, ensuring that vendor or third-party directories won't affect your compliance results.
+- **fileTypeSpecificNaming**: Allows for specifying naming conventions on a per-file-extension basis, offering greater flexibility for projects that use a variety of file types with different standards.
 
-### 4. Pseudocode Example
+### Using Standardizer in GitHub Actions
 
-#### main.go
+To integrate Standardizer into your GitHub Actions workflow, add the following step to your `.github/workflows/main.yml`:
 
-```go
-package main
+```yaml
+- name: Conformity Checker for Project
+  uses: kubecub/standardizer@main # or use a specific tag like @v1.0.0
+```
 
-import (
-    "flag"
-    "fmt"
-    "GoConstandardizer/checker"
-)
+### Local Usage
 
-func main() {
-    // Parse command-line arguments
-    var targetDir string
-    var ignoreDirs string
-    flag.StringVar(&targetDir, "target", ".", "Directory to check")
-    flag.StringVar(&ignoreDirs, "ignore", "", "Directories to ignore")
-    flag.Parse()
+After configuring `standardizer.yml`, run Standardizer locally to check your project's naming conventions:
 
-    // Call the checker
-    err := checker.CheckDirectory(targetDir, ignoreDirs)
-    if err != nil {
-        fmt.Println("Error:", err)
-    }
-}
+```shell
+standardizer -config .github/standardizer.yml
 ```
 
-#### checker.go
-
-```go
-package checker
+### Success Output
 
-import (
-    // Import necessary packages
-)
+A successful run will output the number of directories and files checked, along with any identified issues:
 
-func CheckDirectory(targetDir, ignoreDirs string) error {
-    // Iterate through the directory, applying rules to check file and directory names
-    // Return any found errors or non-conformities
-    return nil
+```json
+{
+  "CheckedDirectories": 4,
+  "CheckedFiles": 15,
+  "Issues": null
 }
 ```
 
-### 5. Implementation Details
+- **CheckedDirectories** & **CheckedFiles**: The count of directories and files that were checked.
+- **Issues**: Lists any naming convention violations found. `null` indicates no issues were detected.
 
-- **File and Directory Traversal**: Use Go's `path/filepath` package to traverse directories and subdirectories.
-- **Naming Rules Checking**: Apply different regex expressions for naming checks based on file extensions.
-- **Error Handling and Reporting**: Record files or directories that do not conform and report to the user.
+## Contributing
 
-### 6. Future Development and Extensions
+Contributions to Standardizer are welcome! Please refer to the project's GitHub page for contribution guidelines: [https://github.com/kubecub/standardizer](https://github.com/kubecub/standardizer).
 
-- Support more file types and naming rules.
-- Provide more detailed error reports, such as showing line numbers and specific naming mistakes.
-- Add a graphical or web interface for non-command-line users.
+## License
 
-The above is an overview of the entire project's design. Following this design, specific coding implementation can begin. Note that the actual implementation may need adjustments based on real-world conditions.
+Standardizer is released under the MIT License. See the LICENSE file for more details.

main.go

@@ -0,0 +1,54 @@
+package main
+
+import (
+	"encoding/json"
+	"flag"
+	"fmt"
+	"os"
+
+	"github.com/kubecub/standardizer/checker"
+	"github.com/kubecub/standardizer/config"
+)
+
+func main() {
+	var configPath string
+	flag.StringVar(&configPath, "config", "", "Path to the configuration file")
+	flag.Parse()
+
+	if configPath == "" {
+		configPath = os.Getenv("STANDARDIZER_CONFIG_PATH")
+	}
+
+	if configPath == "" {
+		configPath = "standardizer.yaml"
+		if _, err := os.Stat(".github/standardizer.yaml"); err == nil {
+			configPath = ".github/standardizer.yaml"
+		} else if _, err := os.Stat(".github/standardizer.yml"); err == nil {
+			configPath = ".github/standardizer.yml"
+		}
+	}
+
+	cfg, err := config.LoadConfig(configPath)
+	if err != nil {
+		fmt.Println("Error loading config:", err)
+		return
+	}
+
+	c := &checker.Checker{Config: cfg}
+	err = c.Check()
+	if err != nil {
+		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)
+	}
+
+	summaryJSON, err := json.MarshalIndent(c.Summary, "", "  ")
+	if err != nil {
+		fmt.Println("Error marshalling summary:", err)
+		return
+	}
+
+	fmt.Println(string(summaryJSON))
+}