dto: 基本目录结构&对象定义

--issue=#1

Author: vissong

.gitignore

@@ -13,3 +13,4 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+.idea

.golangci.yml

@@ -0,0 +1,104 @@
+# details in https://golangci-lint.run/usage/configuration/
+run:
+  timeout: 3m
+
+output:
+  sort-results: true
+
+linters-settings:
+  funlen:
+    lines: 80
+    statements: 80
+  goconst:
+    min-len: 2
+    min-occurrences: 2
+  gocyclo:
+    min-complexity: 10
+  goimports:
+    local-prefixes: tencent-connect/
+  govet:
+    check-shadowing: true
+  lll:
+    line-length: 120
+    tab-width: 4
+  gocritic:
+    enabled-checks:
+      - nestingReduce
+    settings:
+      nestingReduce:
+        bodyWidth: 5
+
+linters:
+  disable-all: true
+  enable:
+    - revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.
+    - deadcode
+    - funlen
+    - goconst
+    - gocyclo
+    - gofmt
+    - ineffassign
+    - staticcheck
+    - structcheck # 当非导出结构嵌入另一个结构, 前一个结构被使用就不会监测到, 这个需要每个业务自己屏蔽
+    - typecheck
+    - goimports
+    - gosimple
+    - govet
+    - lll
+    - rowserrcheck
+    - errcheck
+    - unused
+    - varcheck
+    - gocritic
+    - dupl
+    - ifshort
+    - whitespace
+    - bodyclose
+    - sqlclosecheck
+
+issues:
+  exclude-use-default: true
+
+  # The list of ids of default excludes to include or disable. By default it's empty.
+  # 为了避免 exclude default 导致一些问题被隐藏，所以需要自己声明不想要排除的问题，在 https://golangci-lint.run/usage/configuration/ 搜索  --exclude-use-default
+  include:
+    - EXC0004 # govet (possible misuse of unsafe.Pointer|should have signature)
+    - EXC0005 # staticcheck ineffective break statement. Did you mean to break out of the outer loop
+    - EXC0011 # stylecheck (comment on exported (method|function|type|const)|should have( a package)? comment|comment should be of the form)
+    - EXC0012 # revive
+    - EXC0013 # revive
+    - EXC0014 # revive
+    - EXC0015 # revive
+
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - funlen # 规范说单测函数，单个函数可以到160行，但是工具不好做区分处理，这里就直接不检查单测的函数长度
+        - lll
+        - goconst
+        - gocyclo
+        - golint
+        - staticcheck
+        - revive
+        - dupl
+        - ifshort
+    - linters:
+        - staticcheck
+      text: "SA1019: package github.com/golang/protobuf" # 它会说 'SA1019: package github.com/golang/protobuf/proto is deprecated: Use the "google.golang.org/protobuf/proto" package instead.', 但是这个库更更新很稳定
+    - linters:
+        - staticcheck
+      text: "SA6002: argument should be pointer-like to avoid allocations" # sync.pool.Put(buf), slice `var buf []byte` will tiger this
+    - linters:
+        - staticcheck
+      text: "SA3000: TestMain should call os.Exit to set exit code"
+    - linters:
+        - lll
+      source: "^//go:generate " # Exclude lll issues for long lines with go:generate
+
+  max-same-issues: 0
+  new: false
+  max-issues-per-linter: 0
+  fix: false # 如果设置为 true，会导致一些问题不被扫描出来，而且也不会自动 fix，而且在ci上跑，会莫名的报错
+
+service:
+  golangci-lint-version: 1.23.x

botgo.go

@@ -0,0 +1,2 @@
+// Package botgo 是一个QQ频道机器人 sdk 的 golang 实现
+package botgo

demo/.keep

@@ -0,0 +1,3 @@
+## dto
+
+与 openapi/websocket 通信时所使用的对象。

dto/README.md

@@ -0,0 +1,33 @@
+package dto
+
+// ChannelType 频道类型定义
+type ChannelType int
+
+// 子频道类型定义
+const (
+	ChannelTypeText ChannelType = iota
+	_
+	ChannelTypeVoice
+	_
+	ChannelTypeCategory
+	ChannelTypeLive        // 直播子频道
+	ChannelTypeApplication // 应用子频道
+)
+
+// Channel 频道结构定义
+type Channel struct {
+	// 频道ID
+	ID string `json:"id"`
+	// 群ID
+	GuildID string `json:"guild_id"`
+	// 频道名称
+	Name string `json:"name"`
+	// 频道类型
+	Type ChannelType `json:"type"`
+	// 排序位置
+	Position int `json:"position"`
+	// 父频道的ID
+	ParentID string `json:"parent_id"`
+	// 拥有者ID
+	OwnerID string `json:"owner_id"`
+}

dto/channel.go

@@ -0,0 +1,23 @@
+package dto
+
+import (
+	"fmt"
+	"strings"
+	"time"
+)
+
+// Duration 支持能够直接配置中解析出来 time.Duration 类型的数据
+// 需要实现对应类型的 Unmarshaler 接口
+type Duration time.Duration
+
+// UnmarshalJSON 实现json的解析接口
+func (d *Duration) UnmarshalJSON(bytes []byte) error {
+	var s = strings.Trim(string(bytes), "\"'")
+	t, err := time.ParseDuration(s)
+	if err != nil {
+		return fmt.Errorf("failed to parse '%s' to time.Duration: %v", s, err)
+	}
+
+	*d = Duration(t)
+	return nil
+}

dto/duration.go

@@ -0,0 +1,30 @@
+package dto
+
+// Guild 频道结构定义
+type Guild struct {
+	// 频道ID（与客户端上看到的频道ID不同）
+	ID string `json:"id"`
+	// 频道名称
+	Name string `json:"name"`
+	// 频道头像
+	Icon string `json:"icon"`
+	// 拥有者ID
+	OwnerID string `json:"owner_id"`
+	// 是否为拥有者
+	IsOwner bool `json:"owner"`
+	// 成员数量
+	MemberCount int `json:"member_count"`
+	// 最大成员数目
+	MaxMembers int64 `json:"max_members"`
+	// 频道描述
+	Desc string `json:"description"`
+	// 当前用户加入群的时间
+	// 此字段只在GUILD_CREATE事件中使用
+	JoinedAt Timestamp `json:"joined_at"`
+	// 频道列表
+	Channels []*Channel `json:"channels"`
+	// 游戏绑定公会区服ID
+	UnionWorldID string `json:"union_world_id"`
+	// 游戏绑定公会/战队ID
+	UnionOrgID string `json:"union_org_id"`
+}

dto/guild.go

@@ -0,0 +1,12 @@
+package dto
+
+// Member 群成员
+type Member struct {
+	GuildID  string    `json:"guild_id"`
+	JoinedAt Timestamp `json:"joined_at"`
+	Nick     string    `json:"nick"`
+	User     *User     `json:"user"`
+	Roles    []string  `json:"roles"`
+	Deaf     bool      `json:"deaf"`
+	Mute     bool      `json:"mute"`
+}

dto/member.go

@@ -0,0 +1,11 @@
+package dto
+
+import "time"
+
+// Timestamp 时间戳
+type Timestamp string
+
+// Time 时间字符串格式转换
+func (t Timestamp) Time() (time.Time, error) {
+	return time.Parse(time.RFC3339, string(t))
+}

dto/timestamp.go

@@ -0,0 +1,11 @@
+package dto
+
+// User 用户
+type User struct {
+	ID               string `json:"id"`
+	Username         string `json:"username"`
+	Avatar           string `json:"avatar"`
+	Bot              bool   `json:"bot"`
+	UnionOpenID      string `json:"union_openid"`       // 特殊关联应用的 openid
+	UnionUserAccount string `json:"union_user_account"` // 机器人关联的用户信息，与union_openid关联的应用是同一个
+}

dto/user.go

@@ -0,0 +1,3 @@
+module github.com/tencent-connect/botgo
+
+go 1.16

go.mod

@@ -0,0 +1 @@
+package botgo

internal/.keep

@@ -0,0 +1 @@
+package botgo

oauth.go

@@ -0,0 +1,33 @@
+#!/bin/sh
+
+# 检查是否携带了 scope:
+COMMIT_MSG=$(cat $1 | grep -E "^.+:\s.+(\s|\S)*")
+if [ -z "$COMMIT_MSG" ]; then
+    echo -e "提交信息不符合标准规范, 请使用规范格式, Example: \n\nserver: 增加某某错误处理处理 \n\n--issue=#123"
+    exit 1
+fi
+
+# 检查是否携带了需求ID
+COMMIT_MSG=$(cat $1 | grep -E "\-\-(bug|story|task|issue)=(\#)?([0-9])+")
+if [ -z "$COMMIT_MSG" ]; then
+    echo -e "提交信息不符合标准规范, 请使用规范格式, Example: \n\nserver: 增加某某错误处理处理 \n\n--issue=#123"
+    exit 1
+fi
+
+# 检查第一行是否有需求ID
+COMMIT_MSG=$(head -n 1 $1 | grep -E "\-\-(bug|story|task|issue)=(\#)?([0-9])+")
+if [ -n "$COMMIT_MSG" ]; then
+    echo "请不要在标题携带 bug/story/task/issue 等 \n\n"
+    echo "${COMMIT_MSG}"
+    exit 1
+fi
+
+# 检查第一行是否超长，75 字节
+COMMIT_MSG=$(head -n 1 $1)
+if [ ${#COMMIT_MSG} -gt 75 ]; then
+    echo "CommitMsg 第一行过长，请保持在 75 字节以内 \n\n"
+    echo "${COMMIT_MSG}"
+    exit 1
+fi
+
+exit 0

openapi.go

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+git config core.hooksPath scripts/git_hooks && echo ">> local githook has been set" && git config --get core.hooksPath

scripts/git_hooks/commit-msg

@@ -0,0 +1,33 @@
+#!/bin/sh
+
+
+# 检查当前目录下是否有 golang 文件，如果有则执行 golangci-lint run
+go_lint() {
+  # 当前目录是否有 go 文件
+  if [ -z "$(search_go_mod)" ]; then
+    exit 0
+  fi
+  echo "发现 go mod，执行 golint 检查" && golangci-lint version && golangci-lint run
+}
+
+# 递归向上寻找 go.mod
+search_go_mod() {
+  pwd=$(pwd)
+  git_top=$(git rev-parse --show-toplevel)
+
+  go_mod=$(find . -maxdepth 1 -name "go.mod")
+  if [ -n "$go_mod" ];then
+    echo "$go_mod"
+  fi
+
+  if [ "$pwd" == "$git_top" ]; then
+    return 0
+  fi
+
+  up=$(git rev-parse --show-cdup)
+  if [ -n "$up" ]; then
+    cd $up && search_go_mod
+  fi
+}
+
+go_lint

scripts/git_hooks/install.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# 获取分支名
+git_branch() {
+    git rev-parse --abbrev-ref HEAD
+}
+
+# 自动给 commit 追加--story, --bug等
+auto_append_id() {
+  branch=$(git_branch)
+  idstr=$(echo "$branch" | grep -oE "(issue)_([0-9]*)$")
+  # 分支名中存在 story 等关键词，自动替换为 --story=xxx
+  if [ -n "$idstr" ]; then
+    append_str="--${idstr//_/=#}"
+    echo -e "\n$append_str" >> "$1"
+  fi
+}
+
+# 如果未补充git type，自动在message前补充 git type
+# https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
+auto_prepend_type() {
+  checkScope=$(cat $1 | grep -E "^.+:\s.+(\s|\S)*")
+  if [ -n "$checkScope" ]; then
+    return
+  fi
+  prepend_str="$(gen_scope)"": "
+  content=$(cat "$1")
+  echo "$prepend_str""$content" > "$1"
+}
+
+# 根据提交的变更，自动生成 scope
+gen_scope(){
+  scope=$(get_change_paths | uniq -c | sort -r | head -1 | awk '{print $2}')
+  echo "$scope"
+}
+
+# 获取修改内容的路径
+get_change_paths(){
+  # 提取已经 git add 的修改内容，并且判断，如果目录层级大于2，则提取二级目录名，否则使用以及目录名或者根目录文件名
+  git status --porcelain | grep -E "^(M|A|D|R|C|U)" | awk '{print $2}' | awk -F/ '{if (NF>2) print $(NF-2)"/"$(NF-1); else print $1}'
+}
+
+auto_prepend_type "$1"
+auto_append_id "$1"

scripts/git_hooks/pre-commit

@@ -0,0 +1,4 @@
+package botgo
+
+// Version sdk 版本
+const Version = "0.0.1"

scripts/git_hooks/prepare-commit-msg

@@ -0,0 +1 @@
+package botgo