feat: Enhancements to OpenIM Engineering Practices with Standardizer and Tool Versioning (#2159)

* feat: add standardizer optimize makefile

* feat: add standardizer optimize makefile

* feat: add openim test docs

* feat: add openim kafka docs

* feat: add openim kafka docs

* feat: add openim kafka docs

.github/code-language-detector.yml

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# https://github.com/marketplace/actions/code-language-detector
 directory: ./
 file_types:
   - .go

.github/standardizer.yml

@@ -0,0 +1,50 @@
+# https://github.com/marketplace/actions/conformity-checker-for-project
+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$"
+  - _test\\.txt$
+  - LICENSE
+  - Dockerfile
+  - CODEOWNERS
+  - Makefile
+
+ignoreDirectories:
+  - "vendor"
+  - ".git"
+  - "deployments"
+  - "node_modules"
+  - "logs"
+  - "CHANGELOG"
+  - "components"
+  - "_output"
+  - "tools/openim-web"
+  - "CHANGELOG"
+  - "examples/Test_directory"
+  - test/testdata
+
+fileTypeSpecificNaming:
+  ".yaml":
+    allowHyphens: true
+    allowUnderscores: false
+    mustBeLowercase: true
+  ".go":
+    allowHyphens: false
+    allowUnderscores: true
+    mustBeLowercase: true

.github/workflows/openimci.yml

@@ -73,6 +73,9 @@ jobs:
     - name: Code Typecheck Detector
       uses: kubecub/typecheck@main
 
+    - name: Conformity Checker for Project
+      uses: kubecub/standardizer@main
+
     - name: Module Operations
       run: |
         sudo make tidy

Makefile

@@ -19,6 +19,7 @@ VERSION_PACKAGE=github.com/openimsdk/open-im-server/v3/pkg/version
 # Includes
 
 include scripts/make-rules/common.mk	# make sure include common.mk at the first include line
+include scripts/make-rules/common-versions.mk
 include scripts/make-rules/golang.mk
 include scripts/make-rules/image.mk
 include scripts/make-rules/copyright.mk

README_zh_CN.md

@@ -52,7 +52,7 @@
 </p>
 
 ## 🟢 扫描微信进群交流
-<img src="./docs/images/Wechat.jpg" width="300">
+<img src="./docs/images/wechat.jpg" width="300">
 
 
 ## Ⓜ️ 关于 OpenIM

docker-compose-1.yml

@@ -1,4 +1,4 @@
-#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/OpenIMSDK/Open-IM-Server.git
+#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/openimsdk/open-im-server.git
 #  The command that triggers this file to pull the image is "docker compose up -f"
 version: '3'
 

docker-compose.yml

@@ -1,4 +1,4 @@
-#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/OpenIMSDK/Open-IM-Server.git
+#fixme  Clone openIM Server project before using docker-compose,project address：https://github.com/openimsdk/open-im-server.git
 #  The command that triggers this file to pull the image is "docker compose up -d".
 version: '3'
 

docs/contrib/kafka.md

@@ -0,0 +1,162 @@
+# OpenIM Kafka Guide
+
+This document aims to provide a set of concise guidelines to help you quickly install and use Kafka through Docker Compose.
+
+## Installing Kafka
+
+With the Docker Compose script provided by OpenIM, you can easily install Kafka. Use the following command to start Kafka:
+
+```bash
+docker compose up -d
+```
+
+After executing this command, Kafka will be installed and started. You can confirm the Kafka container is running with the following command:
+
+```bash
+docker ps | grep kafka
+```
+
+The output of this command, as shown below, displays the status information of the Kafka container:
+
+```
+be416b5a0851   bitnami/kafka:3.5.1 "/opt/bitnami/script…"   3 days ago   Up 2 days   9092/tcp, 0.0.0.0:19094->9094/tcp, :::19094->9094/tcp   kafka
+```
+
+### References
+
+- Official Docker installation documentation: [Click here](http://events.jianshu.io/p/b60afa35303a)
+- Detailed installation guide: [Tutorial on Towards Data Science](https://towardsdatascience.com/how-to-install-apache-kafka-using-docker-the-easy-way-4ceb00817d8b)
+
+## Using Kafka
+
+### Entering the Kafka Container
+
+To execute Kafka commands, you first need to enter the Kafka container. Use the following command:
+
+```bash
+docker exec -it kafka bash
+```
+
+### Kafka Command Tools
+
+Inside the Kafka container, you can use various command-line tools to manage Kafka. These tools include but are not limited to:
+
+- `kafka-topics.sh`: For creating, deleting, listing, or altering topics.
+- `kafka-console-producer.sh`: Allows sending messages to a specified topic from the command line.
+- `kafka-console-consumer.sh`: Allows reading messages from the command line, with the ability to specify topics.
+- `kafka-consumer-groups.sh`: For managing consumer group information.
+
+### Kafka Client Tool Installation
+
+For easier Kafka management, you can install Kafka client tools. If you installed Kafka through OpenIM's Docker Compose, you can install the Kafka client tools with the following command:
+
+```bash
+make install.kafkactl
+```
+
+### Automatic Topic Creation
+
+When installing Kafka through OpenIM's Docker Compose method, OpenIM automatically creates the following topics:
+
+- `latestMsgToRedis`
+- `msgToPush`
+- `offlineMsgToMongoMysql`
+
+These topics are created using the `scripts/create-topic.sh` script. The script waits for Kafka to be ready before executing the commands to create topics:
+
+```bash
+# Wait for Kafka to be ready
+until /opt/bitnami/kafka/bin/kafka-topics.sh --list --bootstrap-server localhost:9092; do
+  echo "Waiting for Kafka to be ready..."
+  sleep 2
+done
+
+# Create topics
+/opt/bitnami/kafka/bin/kafka-topics.sh --create --bootstrap-server localhost:9092 --replication-factor 1 --partitions 8 --topic latestMsgToRedis
+/opt/bitnami/kafka/bin/kafka-topics.sh --create --bootstrap-server localhost:9092 --replication-factor 1 --partitions 8 --topic msgToPush
+/opt/bitnami/kafka/bin/kafka-topics.sh --create --bootstrap-server localhost:9092 --replication-factor 1 --partitions 8 --topic offlineMsgToMongoMysql
+
+echo "Topics created."
+```
+
+The optimized and expanded documentation further details some basic commands for operations inside the Kafka container, as well as basic commands for managing Kafka using `kafkactl`. Here is a more detailed guide.
+
+
+## Basic Commands in the Kafka Container
+
+### Listing Topics
+
+To list all existing topics, you can use the following command:
+
+```bash
+kafka-topics.sh --list --bootstrap-server localhost:9092
+```
+
+### Creating a New Topic
+
+When creating a new topic, you can specify the number of partitions and the replication factor. Here is the command to create a new topic:
+
+```bash
+kafka-topics.sh --create --bootstrap-server localhost:9092 --replication-factor 1 --partitions 1 --topic your_topic_name
+```
+
+### Producing Messages
+
+To send messages to a specific topic, you can use the producer command. The following command prompts you to enter messages, which are sent to the specified topic with each press of the Enter key:
+
+```bash
+kafka-console-producer.sh --broker-list localhost:9092 --topic your_topic_name
+```
+
+### Consuming Messages
+
+To read messages from a specific topic, you can use the consumer command. The following command reads new messages from the specified topic and outputs them on the console:
+
+```bash
+kafka-console-consumer.sh --bootstrap-server localhost:9092 --topic your_topic_name --from-beginning
+```
+
+The `
+
+--from-beginning` parameter reads messages from the beginning of the topic. If this parameter is omitted, only new messages will be read.
+
+
+## Basic Commands Using `kafkactl`
+
+`kafkactl` is a command-line tool for managing and operating Kafka clusters. It offers a more modern way to interact with Kafka.
+
+### Listing Topics
+
+To list all topics, you can use:
+
+```bash
+kafkactl get topics
+```
+
+### Creating a New Topic
+
+To create a new topic with `kafkactl`, use:
+
+```bash
+kafkactl create topic your_topic_name --partitions 1 --replication-factor 1
+```
+
+### Producing Messages
+
+To send messages to a topic, you can use:
+
+```bash
+kafkactl produce your_topic_name --value "your message"
+```
+
+Here, `"your message"` is the content of the message you want to send.
+
+### Consuming Messages
+
+To consume messages from a topic, use:
+
+```bash
+kafkactl consume your_topic_name --from-beginning
+```
+
+Again, the `--from-beginning` parameter will start consuming messages from the beginning of the topic. If you do not wish to start from the beginning, you can omit this parameter.

docs/contrib/logging.md

@@ -2,7 +2,7 @@
 
 ## Script Logging Documentation Link
 
-If you wish to view the script's logging documentation, you can click on this link: [Logging Documentation](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/bash-log.md).
+If you wish to view the script's logging documentation, you can click on this link: [Logging Documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/bash-log.md).
 
 Below is the documentation for logging and error handling in the OpenIM Go project.
 

docs/contrib/test.md

@@ -2,14 +2,94 @@
 
 This document serves as a comprehensive guide to understanding and utilizing the `test.sh` script for testing OpenIM RPC services. The `test.sh` script is a collection of bash functions designed to test various aspects of the OpenIM RPC services, ensuring that each part of the API is functioning as expected.
 
-+ Scripts：https://github.com/OpenIMSDK/Open-IM-Server/tree/main/scripts/install/test.sh
++ Scripts：https://github.com/openimsdk/open-im-server/tree/main/scripts/install/test.sh
 
-For some complex, bulky functional tests, performance tests, and various e2e tests, We are all in the current warehouse to https://github.com/OpenIMSDK/Open-IM-Server/tree/main/test or https://github.com/openim-sigs/test-infra directory In the.
+For some complex, bulky functional tests, performance tests, and various e2e tests, We are all in the current warehouse to https://github.com/openimsdk/open-im-server/tree/main/test or https://github.com/openim-sigs/test-infra directory In the.
 
 + About OpenIM Feature [Test Docs](https://docs.google.com/spreadsheets/d/1zELWkwxgOOZ7u5pmYCqqaFnvZy2SVajv/edit?usp=sharing&ouid=103266350914914783293&rtpof=true&sd=true)
 
+## Util Test
 
-## Usage
+Let's restructure and enhance the document under a unified second-level heading, adding clarity and details for better comprehension and visual appeal.
+
+---
+
+## Development Guide
+
+### Comprehensive Testing Instructions
+
+#### Running Unit Tests
+
+- **Command**: To execute unit tests, input the following in your terminal:
+  ```
+  make test
+  ```
+
+#### Evaluating Test Coverage
+
+- **Overview**: It's crucial to assess how much of your code is covered by tests.
+- **Command**:
+  ```bash
+  make cover
+  ```
+  This command generates a report detailing the percentage of your code tested, ensuring adherence to quality standards.
+
+#### Conducting API Tests
+
+- **Purpose**: API tests validate the interaction and functionality of your application's interfaces.
+- **How to Run**:
+  ```
+  make test-api
+  ```
+  Use this to check the integrity and reliability of your API endpoints.
+
+#### End-to-End (E2E) Testing
+
+- **Scope**: E2E tests simulate real-user scenarios from start to finish.
+- **Execution**:
+  ```
+  make test-e2e
+  ```
+  This comprehensive testing ensures your application performs as expected in real-world situations.
+
+### Crafting Unit Test Cases
+
+#### Setup for Test Case Generation
+
+- **Installation**: Install the `gotests` tool to generate test cases automatically.
+  ```bash
+  make install.gotests
+  ```
+  This command installs the `gotests` tool for test case generation.
+
+- **Environment Preparation**: Define your test template environment variable and generate test cases as shown below:
+  ```bash
+  export GOTESTS_TEMPLATE=testify
+  gotests -i -w -only keyFunc .
+  ```
+  This prepares your environment for test case generation using the `testify` template.
+
+#### Isolating Function Tests
+
+- **Single Function Testing**: When you need to focus on testing a single function for detailed examination.
+- **Method**:
+  ```bash
+  go test -v -run TestKeyFunc
+  ```
+  This command specifically runs tests for `TestKeyFunc`, allowing targeted debugging and validation.
+
+### Important Note
+
+- **Quality Assurance**: Throughout your development process, it is imperative to ensure that the unit test coverage meets or surpasses the standards set by OpenIM.
+- **Maintaining Standards**: Regularly running your tests with
+  ```make test```
+  supports maintaining high code quality and adherence to OpenIM's rigorous testing benchmarks.
+
+## E2E Test
+
+TODO
+
+## Api Test
 
 The `test.sh` script is located within the `./scripts/install/` directory of the OpenIM service's codebase. To use the script, navigate to this directory from your terminal:
 

go.work

@@ -4,7 +4,6 @@ use (
 	.
 	./tools/changelog
 	./tools/component
-	./tools/formitychecker
 	./tools/imctl
 	./tools/infra
 	./tools/ncpu

scripts/lib/golang.sh

@@ -314,9 +314,6 @@ openim::golang::setup_platforms
 readonly OPENIM_CLIENT_TARGETS=(
     changelog
     component
-    conversion-msg
-    conversion-mysql
-    formitychecker
     imctl
     infra
     ncpu

scripts/lib/release.sh

@@ -243,7 +243,7 @@ function openim::release::package_client_tarballs() {
 
     local client_bins=("${OPENIM_CLIENT_BINARIES[@]}")
 
-    # client_bins: changelog component conversion-msg conversion-mysql formitychecker imctl infra ncpu openim-web up35 versionchecker yamlfmt
+    # client_bins: changelog component imctl infra ncpu openim-web up35 versionchecker yamlfmt
     # Copy client binclient_bins:aries
     openim::log::info " Copy client binaries: ${client_bins[@]/#/${LOCAL_OUTPUT_BINTOOLSPATH}/${platform}/}"
     openim::log::info " Copy client binaries to: ${release_stage}/client/bin"

scripts/make-rules/common-versions.mk

@@ -0,0 +1,58 @@
+# Copyright © 2023 OpenIMSDK.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+# OpenIM Makefile Versions used
+#
+# Define the latest version for each tool to ensure consistent versioning across installations
+GOLANGCI_LINT_VERSION ?= latest
+GOIMPORTS_VERSION ?= latest
+ADDLICENSE_VERSION ?= latest
+DEEPCOPY_GEN_VERSION ?= latest
+CONVERSION_GEN_VERSION ?= latest
+GINKGO_VERSION ?= v1.16.2
+GO_GITLINT_VERSION ?= latest
+GO_JUNIT_REPORT_VERSION ?= latest
+GOTESTS_VERSION ?= latest
+SWAGGER_VERSION ?= latest
+KUBE_SCORE_VERSION ?= latest
+KUBECONFORM_VERSION ?= latest
+GSEMVER_VERSION ?= latest
+GIT_CHGLOG_VERSION ?= latest
+KO_VERSION ?= latest
+GITHUB_RELEASE_VERSION ?= latest
+COSCLI_VERSION ?= v0.19.0-beta
+MINIO_VERSION ?= latest
+DELVE_VERSION ?= latest
+AIR_VERSION ?= latest
+GOLINES_VERSION ?= latest
+GO_MOD_OUTDATED_VERSION ?= latest
+CFSSL_VERSION ?= latest
+DEPTH_VERSION ?= latest
+GO_CALLVIS_VERSION ?= latest
+MISSPELL_VERSION ?= latest
+GOTHANKS_VERSION ?= latest
+RICHGO_VERSION ?= latest
+RTS_VERSION ?= latest
+TYPECHECK_VERSION ?= latest
+COMMENT_LANG_DETECTOR_VERSION ?= latest
+STANDARDIZER_VERSION ?= latest
+GO_TESTS_VERSION ?= v1.6.0
+GO_APIDIFF_VERSION ?= v0.8.2
+KAFKACTL_VERSION ?= latest
+GOTESTSUM_VERSION ?= latest
+
+WIRE_VERSION ?= latest
+# WIRE_VERSION ?= $(call get_go_version,github.com/google/wire)
+MOCKGEN_VERSION ?= $(call get_go_version,github.com/golang/mock)
+PROTOC_GEN_GO_VERSION ?= $(call get_go_version,github.com/golang/protobuf/protoc-gen-go)

scripts/make-rules/common.mk

@@ -78,6 +78,13 @@ VERSION := $(shell git describe --tags --always --match='v*')
 # v2.3.3: git tag
 endif
 
+# Helper function to get dependency version from go.mod
+get_gomod_version = $(shell go list -m $1 | awk '{print $$2}')
+define go_install
+$(info ===========> Installing $(1)@$(2))
+$(GO) install $(1)@$(2)
+endef
+
 # Check if the tree is dirty. default to dirty(maybe u should commit?)
 GIT_TREE_STATE:="dirty"
 ifeq (, $(shell git status --porcelain 2>/dev/null))

scripts/make-rules/tools.mk

@@ -64,81 +64,101 @@ tools.verify.%:
 ## install.golangci-lint: Install golangci-lint
 .PHONY: install.golangci-lint
 install.golangci-lint:
-	@$(GO) install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+	@$(GO) install github.com/golangci/golangci-lint/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)
 
 ## install.goimports: Install goimports, used to format go source files
 .PHONY: install.goimports
 install.goimports:
-	@$(GO) install golang.org/x/tools/cmd/goimports@latest
+	@$(GO) install golang.org/x/tools/cmd/goimports@$(GOIMPORTS_VERSION)
 
 ## install.addlicense: Install addlicense, used to add license header to source files
 .PHONY: install.addlicense
 install.addlicense:
-	@$(GO) install github.com/google/addlicense@latest
+	@$(GO) install github.com/google/addlicense@$(ADDLICENSE_VERSION)
 
 ## install.deepcopy-gen: Install deepcopy-gen, used to generate deep copy functions
 .PHONY: install.deepcopy-gen
 install.deepcopy-gen:
-	@$(GO) install k8s.io/code-generator/cmd/deepcopy-gen@latest
+	@$(GO) install k8s.io/code-generator/cmd/deepcopy-gen@$(DEEPCOPY_GEN_VERSION)
 
 ## install.conversion-gen: Install conversion-gen, used to generate conversion functions
 .PHONY: install.conversion-gen
 install.conversion-gen:
-	@$(GO) install k8s.io/code-generator/cmd/conversion-gen@latest
+	@$(GO) install k8s.io/code-generator/cmd/conversion-gen@$(CONVERSION_GEN_VERSION)
 
 ## install.ginkgo: Install ginkgo to run a single test or set of tests
 .PHONY: install.ginkgo
 install.ginkgo:
-	@$(GO) install github.com/onsi/ginkgo/ginkgo@v1.16.2
+	@$(GO) install github.com/onsi/ginkgo/ginkgo@$(GINKGO_VERSION)
 
-## Install go-gitlint: Install go-gitlint, used to check git commit message
+## install.go-gitlint: Install go-gitlint, used to check git commit message
 .PHONY: install.go-gitlint
 install.go-gitlint:
-	@$(GO) install github.com/marmotedu/go-gitlint/cmd/go-gitlint@latest
+	@$(GO) install github.com/marmotedu/go-gitlint/cmd/go-gitlint@$(GO_GITLINT_VERSION)
 
 ## install.go-junit-report: Install go-junit-report, used to convert go test output to junit xml
 .PHONY: install.go-junit-report
 install.go-junit-report:
-	@$(GO) install github.com/jstemmer/go-junit-report@latest
+	@$(GO) install github.com/jstemmer/go-junit-report@$(GO_JUNIT_REPORT_VERSION)
 
 ## install.gotests: Install gotests, used to generate go tests
+.PHONY: install.gotests
+install.gotests:
+	@$(GO) install github.com/cweill/gotests/gotests@$(GO_TESTS_VERSION)
+
+## install.kafkactl: Install kafkactl command line tool.
+.PHONY: install.kafkactl
+install.kafkactl:
+	@$(GO) install github.com/deviceinsight/kafkactl@$(KAFKACTL_VERSION)
+
+## install.go-apidiff: Install go-apidiff, used to check api changes
+.PHONY: install.go-apidiff
+install.go-apidiff:
+	@$(GO) install github.com/joelanford/go-apidiff@$(GO_APIDIFF_VERSION)
+
+## install.swagger: Install swagger, used to generate swagger documentation
 .PHONY: install.swagger
 install.swagger:
-	@$(GO) install github.com/go-swagger/go-swagger/cmd/swagger@latest
+	@$(GO) install github.com/go-swagger/go-swagger/cmd/swagger@$(SWAGGER_VERSION)
 
 # ==============================================================================
 # Tools that might be used include go gvm
 #
 
+## install.gotestsum: Install gotestsum, used to run go tests
+.PHONY: install.gotestsum
+install.gotestsum:
+	@$(GO) install gotest.tools/gotestsum@$(GOTESTSUM_VERSION)
+
 ## install.kube-score: Install kube-score, used to check kubernetes yaml files
 .PHONY: install.kube-score
 install.kube-score:
-	@$(GO) install github.com/zegl/kube-score/cmd/kube-score@latest
+	@$(GO) install github.com/zegl/kube-score/cmd/kube-score@$(KUBE_SCORE_VERSION)
 
 ## install.kubeconform: Install kubeconform, used to check kubernetes yaml files
 .PHONY: install.kubeconform
 install.kubeconform:
-	@$(GO) install github.com/yannh/kubeconform/cmd/kubeconform@latest
+	@$(GO) install github.com/yannh/kubeconform/cmd/kubeconform@$(KUBECONFORM_VERSION)
 
 ## install.gsemver: Install gsemver, used to generate semver
 .PHONY: install.gsemver
 install.gsemver:
-	@$(GO) install github.com/arnaud-deprez/gsemver@latest
+	@$(GO) install github.com/arnaud-deprez/gsemver@$(GSEMVER_VERSION)
 
 ## install.git-chglog: Install git-chglog, used to generate changelog
 .PHONY: install.git-chglog
 install.git-chglog:
-	@$(GO) install github.com/git-chglog/git-chglog/cmd/git-chglog@latest
+	@$(GO) install github.com/git-chglog/git-chglog/cmd/git-chglog@$(GIT_CHGLOG_VERSION)
 
 ## install.ko: Install ko, used to build go program into container images
 .PHONY: install.ko
 install.ko:
-	@$(GO) install github.com/google/ko@latest
+	@$(GO) install github.com/google/ko@$(KO_VERSION)
 
 ## install.github-release: Install github-release, used to create github release
 .PHONY: install.github-release
 install.github-release:
-	@$(GO) install github.com/github-release/github-release@latest
+	@$(GO) install github.com/github-release/github-release@$(GITHUB_RELEASE_VERSION)
 
 ## install.coscli: Install coscli, used to upload files to cos
 # example: ./coscli  cp/sync -r  /home/off-line/docker-off-line/ cos://openim-1306374445/openim/image/amd/off-line/off-line/ -e cos.ap-guangzhou.myqcloud.com
@@ -146,7 +166,7 @@ install.github-release:
 # amd64
 .PHONY: install.coscli
 install.coscli:
-	@wget -q https://github.com/tencentyun/coscli/releases/download/v0.19.0-beta/coscli-linux -O ${TOOLS_DIR}/coscli
+	@wget -q https://github.com/tencentyun/coscli/releases/download/$(COSCLI_VERSION)/coscli-linux -O ${TOOLS_DIR}/coscli
 	@chmod +x ${TOOLS_DIR}/coscli
 
 ## install.coscmd: Install coscmd, used to upload files to cos
@@ -157,50 +177,50 @@ install.coscmd:
 ## install.minio: Install minio, used to upload files to minio
 .PHONY: install.minio
 install.minio:
-	@$(GO) install github.com/minio/minio@latest
+	@$(GO) install github.com/minio/minio@$(MINIO_VERSION)
 
 ## install.delve: Install delve, used to debug go program
 .PHONY: install.delve
 install.delve:
-	@$(GO) install github.com/go-delve/delve/cmd/dlv@latest
+	@$(GO) install github.com/go-delve/delve/cmd/dlv@$(DELVE_VERSION)
 
 ## install.air: Install air, used to hot reload go program
 .PHONY: install.air
 install.air:
-	@$(GO) install github.com/cosmtrek/air@latest
+	@$(GO) install github.com/cosmtrek/air@$(AIR_VERSION)
 
 ## install.gvm: Install gvm, gvm is a Go version manager, built on top of the official go tool.
-# github: https://github.com/moovweb/gvm
 .PHONY: install.gvm
 install.gvm:
 	@echo "===========> Installing gvm, The default installation path is ~/.gvm/scripts/gvm"
 	@bash < <(curl -s -S -L https://raw.githubusercontent.com/moovweb/gvm/master/binscripts/gvm-installer)
-	@$(shell source /root/.gvm/scripts/gvm)
+	@source /root/.gvm/scripts/gvm
 
 ## install.golines: Install golines, used to format long lines
 .PHONY: install.golines
 install.golines:
-	@$(GO) install github.com/segmentio/golines@latest
+	@$(GO) install github.com/segmentio/golines@$(GOLINES_VERSION)
 
 ## install.go-mod-outdated: Install go-mod-outdated, used to check outdated dependencies
 .PHONY: install.go-mod-outdated
 install.go-mod-outdated:
-	@$(GO) install github.com/psampaz/go-mod-outdated@latest
+	@$(GO) install github.com/psampaz/go-mod-outdated@$(GO_MOD_OUTDATED_VERSION)
 
 ## install.mockgen: Install mockgen, used to generate mock functions
 .PHONY: install.mockgen
 install.mockgen:
-	@$(GO) install github.com/golang/mock/mockgen@latest
+	@$(GO) install github.com/golang/mock/mockgen@$(MOCKGEN_VERSION)
+
+## install.wire: Install wire, used to generate wire files
+.PHONY: install.wire
+install.wire:
+	@$(GO) install github.com/google/wire/cmd/wire@$(WIRE_VERSION)
 
-## install.gotests: Install gotests, used to generate test functions
-.PHONY: install.gotests
-install.gotests:
-	@$(GO) install github.com/cweill/gotests/gotests@latest
 
 ## install.protoc-gen-go: Install protoc-gen-go, used to generate go source files from protobuf files
 .PHONY: install.protoc-gen-go
 install.protoc-gen-go:
-	@$(GO) install github.com/golang/protobuf/protoc-gen-go@latest
+	@$(GO) install github.com/golang/protobuf/protoc-gen-go@$(PROTOC_GEN_GO_VERSION)
 
 ## install.cfssl: Install cfssl, used to generate certificates
 .PHONY: install.cfssl
@@ -210,43 +230,49 @@ install.cfssl:
 ## install.depth: Install depth, used to check dependency tree
 .PHONY: install.depth
 install.depth:
-	@$(GO) install github.com/KyleBanks/depth/cmd/depth@latest
+	@$(GO) install github.com/KyleBanks/depth/cmd/depth@$(DEPTH_VERSION)
 
 ## install.go-callvis: Install go-callvis, used to visualize call graph
 .PHONY: install.go-callvis
 install.go-callvis:
-	@$(GO) install github.com/ofabry/go-callvis@latest
+	@$(GO) install github.com/ofabry/go-callvis@$(GO_CALLVIS_VERSION)
 
-## install.misspell
+## install.misspell: Install misspell
 .PHONY: install.misspell
 install.misspell:
-	@$(GO) install github.com/client9/misspell/cmd/misspell@latest
+	@$(GO) install github.com/client9/misspell/cmd/misspell@$(MISSPELL_VERSION)
 
 ## install.gothanks: Install gothanks, used to thank go dependencies
 .PHONY: install.gothanks
 install.gothanks:
-	@$(GO) install github.com/psampaz/gothanks@latest
+	@$(GO) install github.com/psampaz/gothanks@$(GOTHANKS_VERSION)
 
 ## install.richgo: Install richgo
 .PHONY: install.richgo
 install.richgo:
-	@$(GO) install github.com/kyoh86/richgo@latest
+	@$(GO) install github.com/kyoh86/richgo@$(RICHGO_VERSION)
 
 ## install.rts: Install rts
 .PHONY: install.rts
 install.rts:
-	@$(GO) install github.com/galeone/rts/cmd/rts@latest
+	@$(GO) install github.com/galeone/rts/cmd/rts@$(RTS_VERSION)
 
 # ================= kubecub openim tools =========================================
-## install.typecheck: install kubecub typecheck check for go code
+# https://github.com/kubecub
+## install.typecheck: Install kubecub typecheck, checks for go code
 .PHONY: install.typecheck
 install.typecheck:
-	@$(GO) install github.com/kubecub/typecheck@latest
+	@$(GO) install github.com/kubecub/typecheck@$(TYPECHECK_VERSION)
 
-## install.comment-lang-detector: install kubecub comment-lang-detector check for go code comment language
+## install.comment-lang-detector: Install kubecub comment-lang-detector, checks for go code comment language
 .PHONY: install.comment-lang-detector
 install.comment-lang-detector:
-	@$(GO) install github.com/kubecub/comment-lang-detector/cmd/cld@latest
+	@$(GO) install github.com/kubecub/comment-lang-detector/cmd/cld@$(COMMENT_LANG_DETECTOR_VERSION)
+
+## install.standardizer: Install kubecub standardizer, checks for go code standardization
+.PHONY: install.standardizer
+install.standardizer:
+	@$(GO) install github.com/kubecub/standardizer@$(STANDARDIZER_VERSION)
 
 ## tools.help: Display help information about the tools package
 .PHONY: tools.help

scripts/verify-standardizer.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This script does a fast type check of script srnetes code for all platforms.
+# Usage: `scripts/verify-standardizer.sh`.
+
+OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+source "${OPENIM_ROOT}/scripts/lib/init.sh"
+
+openim::golang::verify_go_version
+
+cd "${OPENIM_ROOT}"
+ret=0
+scripts/run-in-gopath.sh \
+make tools.verify.standardizer
+${OPENIM_ROOT}/_output/tools/standardizer || ret=$?
+if [[ $ret -ne 0 ]]; then
+  openim::log::error "Failed to check the directory name or file name. Your name may not meet the specification. Please check the configuration file and the directory or file name." >&2
+  openim::log::error "Please see https://github.com/kubecub/standardizer for more information." >&2
+  exit 1
+fi

tools/formitychecker/README.md

@@ -1,102 +0,0 @@
-# Development of a Go-Based Conformity Checker for Project File and Directory Naming Standards
-
-### 1. Project Overview
-
-#### Project Name
-
-- `GoConformityChecker`
-
-#### Functionality Description
-
-- 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
-
-#### Naming Conventions
-
-- 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
-
-- Defines a configuration structure, such as directories to check and ignore.
-
-#### checker.go
-
-- 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.
-
-### 4. Pseudocode Example
-
-#### main.go
-
-```go
-package main
-
-import (
-    "flag"
-    "fmt"
-    "GoConformityChecker/checker"
-)
-
-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()
-
-    // Call the checker
-    err := checker.CheckDirectory(targetDir, ignoreDirs)
-    if err != nil {
-        fmt.Println("Error:", err)
-    }
-}
-```
-
-#### checker.go
-
-```go
-package checker
-
-import (
-    // Import necessary packages
-)
-
-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
-}
-```
-
-### 5. Implementation Details
-
-- **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.
-
-### 6. Future Development and Extensions
-
-- 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.
-
-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.

tools/formitychecker/checker/checker.go

@@ -1,113 +0,0 @@
-// Copyright © 2024 OpenIM. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package checker
-
-import (
-	"fmt"
-	"os"
-	"path/filepath"
-	"regexp"
-	"strings"
-
-	"github.com/OpenIMSDK/tools/errs"
-
-	"github.com/openimsdk/open-im-server/tools/formitychecker/config"
-)
-
-var (
-	underscoreRegex = regexp.MustCompile(`^[a-zA-Z0-9_]+\.[a-zA-Z0-9]+$`)
-	hyphenRegex     = regexp.MustCompile(`^[a-zA-Z0-9\-]+\.[a-zA-Z0-9]+$`)
-)
-
-// CheckDirectory initiates the checking process for the specified directories using configuration from config.Config.
-func CheckDirectory(cfg *config.Config) error {
-	ignoreMap := make(map[string]struct{})
-	for _, dir := range cfg.IgnoreDirs {
-		ignoreMap[dir] = struct{}{}
-	}
-
-	for _, targetDir := range cfg.TargetDirs {
-		err := filepath.Walk(targetDir, func(path string, info os.FileInfo, err error) error {
-			if err != nil {
-				return errs.Wrap(err, fmt.Sprintf("error walking directory '%s'", targetDir))
-			}
-
-			// Skip if the directory is in the ignore list
-			dirName := filepath.Base(filepath.Dir(path))
-			if _, ok := ignoreMap[dirName]; ok && info.IsDir() {
-				return filepath.SkipDir
-			}
-
-			// Check the naming convention
-			if err := checkNamingConvention(path, info); err != nil {
-				fmt.Println(err)
-			}
-
-			return nil
-		})
-
-		if err != nil {
-			return fmt.Errorf("error checking directory '%s': %w", targetDir, err)
-		}
-	}
-
-	return nil
-}
-
-// checkNamingConvention checks if the file or directory name conforms to the standard naming conventions.
-func checkNamingConvention(path string, info os.FileInfo) error {
-	fileName := info.Name()
-
-	// Handle special cases for directories like .git
-	if info.IsDir() && strings.HasPrefix(fileName, ".") {
-		return nil // Skip special directories
-	}
-
-	// Extract the main part of the name (without extension for files)
-	mainName := fileName
-	if !info.IsDir() {
-		mainName = strings.TrimSuffix(fileName, filepath.Ext(fileName))
-	}
-
-	// Determine the type of file and apply corresponding naming rule
-	switch {
-	case info.IsDir():
-		if !isValidName(mainName, "_") { // Directory names must only contain underscores
-			return fmt.Errorf("!!! invalid directory name: %s", path)
-		}
-	case strings.HasSuffix(fileName, ".go"):
-		if !isValidName(mainName, "_") { // Go files must only contain underscores
-			return fmt.Errorf("!!! invalid Go file name: %s", path)
-		}
-	case strings.HasSuffix(fileName, ".yml"), strings.HasSuffix(fileName, ".yaml"), strings.HasSuffix(fileName, ".md"):
-		if !isValidName(mainName, "-") { // YML, YAML, and Markdown files must only contain hyphens
-			return fmt.Errorf("!!! invalid file name: %s", path)
-		}
-	}
-
-	return nil
-}
-
-// isValidName checks if the file name conforms to the specified rule (underscore or hyphen).
-func isValidName(name, charType string) bool {
-	switch charType {
-	case "_":
-		return underscoreRegex.MatchString(name)
-	case "-":
-		return hyphenRegex.MatchString(name)
-	default:
-		return false
-	}
-}

tools/formitychecker/config/config.go

@@ -1,41 +0,0 @@
-// Copyright © 2024 OpenIM. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package config
-
-import (
-	"strings"
-)
-
-// Config holds all the configuration parameters for the checker.
-type Config struct {
-	TargetDirs []string // Directories to check
-	IgnoreDirs []string // Directories to ignore
-}
-
-// NewConfig creates and returns a new Config instance.
-func NewConfig(targetDirs, ignoreDirs string) *Config {
-	return &Config{
-		TargetDirs: parseDirs(targetDirs),
-		IgnoreDirs: parseDirs(ignoreDirs),
-	}
-}
-
-// parseDirs splits a comma-separated string into a slice of directory names.
-func parseDirs(dirs string) []string {
-	if dirs == "" {
-		return nil
-	}
-	return strings.Split(dirs, ",")
-}

tools/formitychecker/formitychecker.go

@@ -1,41 +0,0 @@
-// Copyright © 2024 OpenIM. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package main
-
-import (
-	"flag"
-	"fmt"
-
-	"github.com/openimsdk/open-im-server/tools/formitychecker/checker"
-	"github.com/openimsdk/open-im-server/tools/formitychecker/config"
-)
-
-func main() {
-	defaultTargetDirs := "."
-	defaultIgnoreDirs := "components,.git"
-
-	var targetDirs string
-	var ignoreDirs string
-	flag.StringVar(&targetDirs, "target", defaultTargetDirs, "Directories to check (default: current directory)")
-	flag.StringVar(&ignoreDirs, "ignore", defaultIgnoreDirs, "Directories to ignore (default: A/, B/)")
-	flag.Parse()
-
-	conf := config.NewConfig(targetDirs, ignoreDirs)
-
-	err := checker.CheckDirectory(conf)
-	if err != nil {
-		fmt.Println("Error:", err)
-	}
-}

tools/formitychecker/go.mod

@@ -1,3 +0,0 @@
-module github.com/openimsdk/open-im-server/tools/formitychecker
-
-go 1.19