开源迁移

Author: lanmingle

.gitignore

@@ -0,0 +1,17 @@
+# Local
+.DS_Store
+*.local
+*.log*
+
+# Dist
+node_modules
+dist/
+
+# IDE
+.vscode/*
+!.vscode/extensions.json
+.idea
+
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

README.md

@@ -1,2 +1,49 @@
-# react-security-router
+# React Security Router
+
 React 安全路由器
+
+# 框架说明
+
+rsr 是 react security router 的简写，一个基于 react router 实现路由级别控制的安全框架。
+
+功能简介：
+
+- 认证与授权
+- 权限检测
+- 二次签证（签名：如要求再次输入密码等）
+- 等等
+
+# 版本兼容
+
+注意：不兼容 react router 7 版本，在 v7 😒 版本上的 `useBlocker` 逻辑变更了，暂时不考虑兼容。
+
+# 简单例子
+
+``` tsx
+
+export default withSecurityBlocker(Root, bundler => {
+    return bundler
+        .context(builder => {
+            return builder
+                // 可选层级权限
+                // .hierarchy('superadmin>admin;admin>users;users>guest')
+                .resource(rb => rb.patterns('/login', '/logout', '/denied', '/signature').anonymous().build())
+                .resource(rb => rb.patterns('/sheet').permissions('admin').signatured().build())
+                .resource(rb => rb.patterns('/*').authenticated().build())
+                .build();
+        })
+        .manager(builder => {
+            return builder
+                .behave({
+                    notAuthenticationPath: '/login',
+                    notSignaturePath: '/signature',
+                    accessDeniedPath: '/denied',
+                })
+                .build();
+        })
+        // .addons()
+        .build()
+
+});
+
+```

biome.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "vcs": {
+    "enabled": true,
+    "defaultBranch": "main",
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "css": {
+    "parser": {
+      "cssModules": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "arrowParentheses": "asNeeded",
+      "jsxQuoteStyle": "double",
+      "lineWidth": 160
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "suspicious": {
+        "noDuplicateFontNames": "off",
+        "noExplicitAny": "off"
+      },
+      "style": {
+        "noUselessElse": "off"
+      },
+      "complexity": {
+        "noUselessSwitchCase": "off",
+        "noForEach": "off"
+      }
+    }
+  },
+  "files": {
+    "ignoreUnknown": true,
+    "ignore": [".vscode/**/*", "node_modules/**/*", "dist/**/*"]
+  }
+}

package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@lanaqi/rsr",
+  "version": "0.0.1-rc.1",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "react",
+    "router",
+    "security",
+    "react-security",
+    "router-security",
+    "react-security-router",
+    "react-router-security",
+    "guard",
+    "react-guard",
+    "router-guard",
+    "react-router-guard",
+    "react-router",
+    "react-router-dom",
+    "modern-js",
+    "modernjs",
+    "安全",
+    "鉴权",
+    "守护",
+    "认证",
+    "授权",
+    "权限",
+    "安全框架",
+    "路由安全",
+    "认证授权",
+    "路由守护"
+  ],
+  "description": "React 安全路由器",
+  "scripts": {
+    "build": "rslib build",
+    "lint": "biome lint",
+    "check": "biome check",
+    "format": "biome format --write",
+    "release": "npm run build && npm publish"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@rsbuild/plugin-react": "^1.1.1",
+    "@rslib/core": "^0.5.5",
+    "@types/react": "^18.3.19",
+    "@types/react-dom": "^18.3.5",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router-dom": "^6.30.0",
+    "typescript": "^5.8.2"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0",
+    "react-router-dom": "^6.0.0"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}

rslib.config.ts

@@ -0,0 +1,21 @@
+import { pluginReact } from '@rsbuild/plugin-react';
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  source: {
+    entry: {
+      index: ['./src/index.ts'],
+    },
+  },
+  lib: [
+    {
+      bundle: true,
+      dts: true,
+      format: 'esm',
+    },
+  ],
+  output: {
+    target: 'web',
+  },
+  plugins: [pluginReact()],
+});