refactor: 拆分为 middlewares 和 plugins

issue9 · Mar 8, 2024 · 5804585 · 5804585
1 parent bb53254
commit 5804585
Show file tree

Hide file tree

Showing 33 changed files with 19 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,25 +1,34 @@
-# middleware
+# use
 
-[![Go](https://github.com/issue9/middleware/actions/workflows/go.yml/badge.svg)](https://github.com/issue9/middleware/actions/workflows/go.yml)
+[![Go](https://github.com/issue9/use/actions/workflows/go.yml/badge.svg)](https://github.com/issue9/use/actions/workflows/go.yml)
 [![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://opensource.org/licenses/MIT)
-[![codecov](https://codecov.io/gh/issue9/middleware/branch/master/graph/badge.svg)](https://codecov.io/gh/issue9/middleware)
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/issue9/middleware/v6)](https://pkg.go.dev/github.com/issue9/middleware/v6)
-[![Go version](https://img.shields.io/github/go-mod/go-version/issue9/middleware)](https://golang.org)
+[![codecov](https://codecov.io/gh/issue9/use/branch/master/graph/badge.svg)](https://codecov.io/gh/issue9/use)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/issue9/use/v6)](https://pkg.go.dev/github.com/issue9/use/v6)
+[![Go version](https://img.shields.io/github/go-mod/go-version/issue9/use)](https://golang.org)
 
 [web](https://pkg.go.dev/github.com/issue9/web) 适用的中间件；
 
+## 插件
+
+插件位于 plugins 目录之下：
+
 - access 客户端访问记录；
+- health 接口状态的监测；
+
+## 中间件
+
+中间件位于 middlewares 目录之下：
+
 - auth/basic 基本的验证处理；
 - auth/jwt JSON Web Tokens 中间件；
 - auth/session session 管理；
-- health 接口状态的监测；
 - acl/ratelimit x-rate-limit 的相关实现；
 - acl/iplist 黑白名单；
 
 ## 安装
 
 ```shell
-go get github.com/issue9/middleware/v6
+go get github.com/issue9/use/v6
 ```
 
 ## 版权

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/issue9/middleware/v6
+module github.com/issue9/use/v6
 
 require (
 	github.com/golang-jwt/jwt/v5 v5.2.1

diff --git a/acl/acl.go → middlewares/acl/acl.go b/acl/acl.go → middlewares/acl/acl.go
diff --git a/acl/iplist/iplist.go → middlewares/acl/iplist/iplist.go b/acl/iplist/iplist.go → middlewares/acl/iplist/iplist.go
diff --git a/acl/iplist/iplist_test.go → middlewares/acl/iplist/iplist_test.go b/acl/iplist/iplist_test.go → middlewares/acl/iplist/iplist_test.go
diff --git a/acl/ratelimit/ratelimit.go → middlewares/acl/ratelimit/ratelimit.go b/acl/ratelimit/ratelimit.go → middlewares/acl/ratelimit/ratelimit.go
diff --git a/acl/ratelimit/ratelimit_test.go → middlewares/acl/ratelimit/ratelimit_test.go b/acl/ratelimit/ratelimit_test.go → middlewares/acl/ratelimit/ratelimit_test.go
diff --git a/auth/auth.go → middlewares/auth/auth.go b/auth/auth.go → middlewares/auth/auth.go
diff --git a/auth/basic/basic.go → middlewares/auth/basic/basic.go b/auth/basic/basic.go → middlewares/auth/basic/basic.go
diff --git a/auth/basic/basic_test.go → middlewares/auth/basic/basic_test.go b/auth/basic/basic_test.go → middlewares/auth/basic/basic_test.go
diff --git a/auth/jwt/blocker.go → middlewares/auth/jwt/blocker.go b/auth/jwt/blocker.go → middlewares/auth/jwt/blocker.go
diff --git a/auth/jwt/blocker_test.go → middlewares/auth/jwt/blocker_test.go b/auth/jwt/blocker_test.go → middlewares/auth/jwt/blocker_test.go
diff --git a/auth/jwt/jwt.go → middlewares/auth/jwt/jwt.go b/auth/jwt/jwt.go → middlewares/auth/jwt/jwt.go
diff --git a/auth/jwt/jwt_test.go → middlewares/auth/jwt/jwt_test.go b/auth/jwt/jwt_test.go → middlewares/auth/jwt/jwt_test.go
diff --git a/auth/jwt/signer.go → middlewares/auth/jwt/signer.go b/auth/jwt/signer.go → middlewares/auth/jwt/signer.go
diff --git a/auth/jwt/signer_test.go → middlewares/auth/jwt/signer_test.go b/auth/jwt/signer_test.go → middlewares/auth/jwt/signer_test.go
diff --git a/auth/jwt/testdata/README.md → middlewares/auth/jwt/testdata/README.md b/auth/jwt/testdata/README.md → middlewares/auth/jwt/testdata/README.md
diff --git a/auth/jwt/testdata/ec256-private.pem → ...wares/auth/jwt/testdata/ec256-private.pem b/auth/jwt/testdata/ec256-private.pem → ...wares/auth/jwt/testdata/ec256-private.pem
diff --git a/auth/jwt/testdata/ec256-public.pem → ...ewares/auth/jwt/testdata/ec256-public.pem b/auth/jwt/testdata/ec256-public.pem → ...ewares/auth/jwt/testdata/ec256-public.pem
diff --git a/auth/jwt/testdata/ed25519-private.pem → ...res/auth/jwt/testdata/ed25519-private.pem b/auth/jwt/testdata/ed25519-private.pem → ...res/auth/jwt/testdata/ed25519-private.pem
diff --git a/auth/jwt/testdata/ed25519-public.pem → ...ares/auth/jwt/testdata/ed25519-public.pem b/auth/jwt/testdata/ed25519-public.pem → ...ares/auth/jwt/testdata/ed25519-public.pem
diff --git a/auth/jwt/testdata/rsa-private.pem → ...lewares/auth/jwt/testdata/rsa-private.pem b/auth/jwt/testdata/rsa-private.pem → ...lewares/auth/jwt/testdata/rsa-private.pem
diff --git a/auth/jwt/testdata/rsa-public.pem → middlewares/auth/jwt/testdata/rsa-public.pem b/auth/jwt/testdata/rsa-public.pem → middlewares/auth/jwt/testdata/rsa-public.pem
diff --git a/auth/jwt/verifier.go → middlewares/auth/jwt/verifier.go b/auth/jwt/verifier.go → middlewares/auth/jwt/verifier.go
diff --git a/auth/session/session.go → middlewares/auth/session/session.go b/auth/session/session.go → middlewares/auth/session/session.go
diff --git a/auth/session/session_test.go → middlewares/auth/session/session_test.go b/auth/session/session_test.go → middlewares/auth/session/session_test.go
diff --git a/auth/session/store.go → middlewares/auth/session/store.go b/auth/session/store.go → middlewares/auth/session/store.go
diff --git a/access/access.go → plugins/access/access.go b/access/access.go → plugins/access/access.go
diff --git a/access/access_test.go → plugins/access/access_test.go b/access/access_test.go → plugins/access/access_test.go
diff --git a/health/cache.go → plugins/health/cache.go b/health/cache.go → plugins/health/cache.go
diff --git a/health/health.go → plugins/health/health.go b/health/health.go → plugins/health/health.go
diff --git a/health/health_test.go → plugins/health/health_test.go b/health/health_test.go → plugins/health/health_test.go
diff --git a/middleware.go → use.go b/middleware.go → use.go
@@ -5,7 +5,7 @@
 //go:generate web locale -l=und -m -f=yaml ./
 //go:generate web update-locale -src=./locales/und.yaml -dest=./locales/zh-Hans.yaml
 
-// Package middleware 适用 [web] 的一些中间件实现
+// Package use 适用 [web] 的中间件和插件
 //
 // [web]: https://github.com/issue9/web
-package middleware
+package use