docs: modify scripts style(#7)

Signed-off-by: AllianceTing <[email protected]>
openimsdk · Jul 10, 2023 · b4ebe28 · b4ebe28
1 parent dd5e1d0
commit b4ebe28
Show file tree

Hide file tree

Showing 37 changed files with 93 additions and 55 deletions.
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ OUT_DIR=$(REPO_ROOT)/_output
 
 # define the default goal
 #
-
+# define shell
 SHELL := /bin/bash
 DIRS=$(shell ls)
 GO=go

diff --git a/cmd/api/admin_api/main.go b/cmd/api/admin_api/main.go
@@ -24,11 +24,12 @@ import (
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/mw"
 	openKeeper "github.com/OpenIMSDK/Open-IM-Server/pkg/discoveryregistry/zookeeper"
-	"github.com/OpenIMSDK/chat/internal/api"
-	"github.com/OpenIMSDK/chat/pkg/common/config"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
 
+	"github.com/OpenIMSDK/chat/internal/api"
+	"github.com/OpenIMSDK/chat/pkg/common/config"
+
 	"github.com/gin-gonic/gin"
 )
 

diff --git a/cmd/api/chat_api/main.go b/cmd/api/chat_api/main.go
@@ -24,11 +24,12 @@ import (
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/mw"
 	openKeeper "github.com/OpenIMSDK/Open-IM-Server/pkg/discoveryregistry/zookeeper"
-	"github.com/OpenIMSDK/chat/internal/api"
-	"github.com/OpenIMSDK/chat/pkg/common/config"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
 
+	"github.com/OpenIMSDK/chat/internal/api"
+	"github.com/OpenIMSDK/chat/pkg/common/config"
+
 	"github.com/gin-gonic/gin"
 )
 

diff --git a/cmd/rpc/admin/main.go b/cmd/rpc/admin/main.go
@@ -16,6 +16,7 @@ package main
 
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
 	"github.com/OpenIMSDK/chat/pkg/common/chatrpcstart"
 
 	"github.com/OpenIMSDK/chat/internal/rpc/admin"

diff --git a/cmd/rpc/chat/main.go b/cmd/rpc/chat/main.go
@@ -16,6 +16,7 @@ package main
 
 import (
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
 	"github.com/OpenIMSDK/chat/pkg/common/chatrpcstart"
 
 	"github.com/OpenIMSDK/chat/internal/rpc/chat"

diff --git a/internal/api/chat.go b/internal/api/chat.go
@@ -32,7 +32,6 @@ import (
 )
 
 func NewChat(chatConn, adminConn grpc.ClientConnInterface) *ChatApi {
-
 	return &ChatApi{chatClient: chat.NewChatClient(chatConn), adminClient: admin.NewAdminClient(adminConn)}
 }
 

diff --git a/internal/api/router.go b/internal/api/router.go
@@ -18,8 +18,9 @@ import (
 	"context"
 
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/discoveryregistry"
-	"github.com/OpenIMSDK/chat/pkg/common/config"
 	"github.com/gin-gonic/gin"
+
+	"github.com/OpenIMSDK/chat/pkg/common/config"
 )
 
 func NewChatRoute(router gin.IRouter, discov discoveryregistry.SvcDiscoveryRegistry) {

diff --git a/internal/rpc/admin/applet.go b/internal/rpc/admin/applet.go
@@ -16,10 +16,13 @@ package admin
 
 import (
 	"context"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"strings"
 	"time"
 
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/utils"
 	"github.com/google/uuid"

diff --git a/internal/rpc/admin/check.go b/internal/rpc/admin/check.go
@@ -17,6 +17,7 @@ package admin
 import (
 	"context"
 	"fmt"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 
 	"github.com/OpenIMSDK/chat/pkg/common/db/dbutil"

diff --git a/internal/rpc/admin/client_config.go b/internal/rpc/admin/client_config.go
@@ -16,6 +16,7 @@ package admin
 
 import (
 	"context"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"

diff --git a/internal/rpc/admin/invitation.go b/internal/rpc/admin/invitation.go
@@ -16,11 +16,14 @@ package admin
 
 import (
 	"context"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"math/rand"
 	"strings"
 	"time"
 
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/utils"
 

diff --git a/internal/rpc/admin/ip_forbidden.go b/internal/rpc/admin/ip_forbidden.go
@@ -16,9 +16,11 @@ package admin
 
 import (
 	"context"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"time"
 
+
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
 	admin2 "github.com/OpenIMSDK/chat/pkg/common/db/table/admin"
 	"github.com/OpenIMSDK/chat/pkg/common/mctx"
 	"github.com/OpenIMSDK/chat/pkg/proto/admin"

diff --git a/internal/rpc/admin/register_add_friend.go b/internal/rpc/admin/register_add_friend.go
@@ -16,10 +16,13 @@ package admin
 
 import (
 	"context"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"strings"
 	"time"
 
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/utils"
 

diff --git a/internal/rpc/admin/register_add_group.go b/internal/rpc/admin/register_add_group.go
@@ -16,10 +16,13 @@ package admin
 
 import (
 	"context"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"strings"
 	"time"
 
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/proto/sdkws"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/utils"

diff --git a/internal/rpc/admin/token.go b/internal/rpc/admin/token.go
@@ -16,6 +16,7 @@ package admin
 
 import (
 	"context"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 
 	"github.com/OpenIMSDK/chat/pkg/common/config"

diff --git a/internal/rpc/admin/user.go b/internal/rpc/admin/user.go
@@ -16,11 +16,14 @@ package admin
 
 import (
 	"context"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
-	"github.com/OpenIMSDK/chat/pkg/common/constant"
 	"strings"
 	"time"
 
+
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
+	"github.com/OpenIMSDK/chat/pkg/common/constant"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/mcontext"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/proto/wrapperspb"

diff --git a/internal/rpc/admin/user_ip_limit_login.go b/internal/rpc/admin/user_ip_limit_login.go
@@ -16,9 +16,11 @@ package admin
 
 import (
 	"context"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"time"
 
+
+	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/utils"
 

diff --git a/internal/rpc/chat/password.go b/internal/rpc/chat/password.go
@@ -16,6 +16,7 @@ package chat
 
 import (
 	"context"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"

diff --git a/internal/rpc/chat/user.go b/internal/rpc/chat/user.go
@@ -16,6 +16,7 @@ package chat
 
 import (
 	"context"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"

diff --git a/pkg/common/chatrpcstart/start.go b/pkg/common/chatrpcstart/start.go
@@ -2,20 +2,19 @@ package chatrpcstart
 
 import (
 	"fmt"
+	"net"
+	"strconv"
+	"time"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/mw"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/network"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/discoveryregistry"
 	openKeeper "github.com/OpenIMSDK/Open-IM-Server/pkg/discoveryregistry/zookeeper"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/utils"
-	"github.com/OpenIMSDK/chat/pkg/common/config"
-	chatMw "github.com/OpenIMSDK/chat/pkg/common/mw"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
-	"net"
-	"strconv"
-	"time"
 )
 
 func Start(rpcPort int, rpcRegisterName string, prometheusPort int, rpcFn func(client discoveryregistry.SvcDiscoveryRegistry, server *grpc.Server) error, options ...grpc.ServerOption) error {

diff --git a/pkg/common/config/parse.go b/pkg/common/config/parse.go
@@ -18,19 +18,16 @@ import (
 	"bytes"
 	"errors"
 	"fmt"
-	openIMConfig "github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
-	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/constant"
-	openKeeper "github.com/OpenIMSDK/Open-IM-Server/pkg/discoveryregistry/zookeeper"
-	"gopkg.in/yaml.v3"
 	"os"
 	"path/filepath"
 	"runtime"
 	"time"
+
 )
 
 var (
 	_, b, _, _ = runtime.Caller(0)
-	// Root folder of this project
+	// Root folder of this project.
 	Root = filepath.Join(filepath.Dir(b), "../../..")
 )
 

diff --git a/pkg/common/db/database/chat.go b/pkg/common/db/database/chat.go
@@ -16,12 +16,14 @@ package database
 
 import (
 	"context"
+	"time"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/tx"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
+	"gorm.io/gorm"
+
 	"github.com/OpenIMSDK/chat/pkg/common/db/model/chat"
 	table "github.com/OpenIMSDK/chat/pkg/common/db/table/chat"
-	"gorm.io/gorm"
-	"time"
 )
 
 type ChatDatabaseInterface interface {

diff --git a/pkg/common/db/model/admin/admin.go b/pkg/common/db/model/admin/admin.go
@@ -18,11 +18,11 @@ import (
 	"context"
 	"crypto/md5"
 	"encoding/hex"
+	"time"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/config"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
-	"github.com/OpenIMSDK/chat/pkg/common/db/table/admin"
 	"gorm.io/gorm"
-	"time"
 )
 
 func NewAdmin(db *gorm.DB) *Admin {

diff --git a/pkg/common/db/model/chat/account.go b/pkg/common/db/model/chat/account.go
@@ -16,10 +16,10 @@ package chat
 
 import (
 	"context"
+	"time"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
-	"github.com/OpenIMSDK/chat/pkg/common/db/table/chat"
 	"gorm.io/gorm"
-	"time"
 )
 
 func NewAccount(db *gorm.DB) chat.AccountInterface {

diff --git a/pkg/common/db/model/chat/user_login_record.go b/pkg/common/db/model/chat/user_login_record.go
@@ -17,7 +17,6 @@ package chat
 import (
 	"context"
 
-
 	"gorm.io/gorm"
 
 	"github.com/OpenIMSDK/chat/pkg/common/db/table/chat"

diff --git a/pkg/common/db/model/chat/verify_code.go b/pkg/common/db/model/chat/verify_code.go
@@ -16,10 +16,10 @@ package chat
 
 import (
 	"context"
+	"time"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
-	"github.com/OpenIMSDK/chat/pkg/common/db/table/chat"
 	"gorm.io/gorm"
-	"time"
 )
 
 func NewVerifyCode(db *gorm.DB) *VerifyCode {

diff --git a/pkg/common/dbconn/gorm.go b/pkg/common/dbconn/gorm.go
@@ -16,15 +16,15 @@ package dbconn
 
 import (
 	"fmt"
+	"time"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/mw/specialerror"
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
-	"github.com/OpenIMSDK/chat/pkg/common/config"
 	mysqlDriver "github.com/go-sql-driver/mysql"
 	"gorm.io/driver/mysql"
 	"gorm.io/gorm"
 	"gorm.io/gorm/logger"
-	"time"
 )
 
 func NewMysqlGormDB() (*gorm.DB, error) {

diff --git a/pkg/common/mw/user.go b/pkg/common/mw/user.go
@@ -2,9 +2,11 @@ package mw
 
 import (
 	"context"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/common/log"
-	"github.com/OpenIMSDK/chat/pkg/common/constant"
 	"google.golang.org/grpc"
+
+	"github.com/OpenIMSDK/chat/pkg/common/constant"
 )
 
 func AddUserType() grpc.DialOption {

diff --git a/pkg/common/tokenverify/token_verify.go b/pkg/common/tokenverify/token_verify.go
@@ -15,12 +15,11 @@
 package tokenverify
 
 import (
+	"time"
+
 	"github.com/OpenIMSDK/Open-IM-Server/pkg/errs"
-	"github.com/OpenIMSDK/chat/pkg/common/config"
-	"github.com/OpenIMSDK/chat/pkg/common/constant"
 	utils "github.com/OpenIMSDK/open_utils"
 	"github.com/golang-jwt/jwt/v4"
-	"time"
 )
 
 const (
@@ -41,10 +40,11 @@ func buildClaims(userID string, userType int32, ttl int64) claims {
 		UserID:   userID,
 		UserType: userType,
 		RegisteredClaims: jwt.RegisteredClaims{
-			ExpiresAt: jwt.NewNumericDate(now.Add(time.Duration(ttl*24) * time.Hour)), //Expiration time
-			IssuedAt:  jwt.NewNumericDate(now),                                        //Issuing time
-			NotBefore: jwt.NewNumericDate(before),                                     //Begin Effective time
-		}}
+			ExpiresAt: jwt.NewNumericDate(now.Add(time.Duration(ttl*24) * time.Hour)), // Expiration time
+			IssuedAt:  jwt.NewNumericDate(now),                                        // Issuing time
+			NotBefore: jwt.NewNumericDate(before),                                     // Begin Effective time
+		},
+	}
 }
 
 func CreateToken(UserID string, userType int32, ttl int64) (string, error) {