@hile/ioredis 1.0.1

package/README.md

@@ -0,0 +1,37 @@
+# @hile/ioredis
+
+基于 `@hile/core` 的 Redis 集成：将 ioredis 客户端封装为 Hile 服务（单例、随进程退出断开连接）。
+
+## 安装
+
+```bash
+pnpm add @hile/ioredis
+```
+
+依赖 `@hile/core` 与 `ioredis`，请一并安装。
+
+## 快速开始
+
+通过环境变量配置 Redis，用 `loadService` 获取客户端：
+
+```typescript
+import { loadService } from '@hile/core'
+import ioredisService from '@hile/ioredis'
+
+const redis = await loadService(ioredisService)
+// 使用 redis.get/set 等 ioredis API
+```
+
+## 环境变量
+
+客户端从以下环境变量读取配置：
+
+| 变量 | 说明 |
+|------|------|
+| `REDIS_HOST` | Redis 主机 |
+| `REDIS_PORT` | Redis 端口（字符串会被转为数字） |
+| `REDIS_USERNAME` | Redis 用户名 |
+| `REDIS_PASSWORD` | Redis 密码 |
+| `REDIS_DB` | Redis 数据库编号，默认 `0` |
+
+行为：服务在首次加载时创建连接并等待 `connect` 事件；进程退出时通过 Hile 的 shutdown 调用 `client.disconnect()`。

package/SKILL.md

@@ -0,0 +1,55 @@
+# @hile/ioredis
+
+本文档是面向 AI 编码模型和人类开发者的 **代码生成规范**，阅读后应能正确地使用本库编写符合架构规则的代码。
+
+---
+
+## 1. 架构总览
+
+`@hile/ioredis` 在 `@hile/core` 之上提供：
+
+- **默认导出**：一个通过 `defineService` 定义的 **ioredis Redis 客户端** 服务，配置来自环境变量；创建后等待 `connect` 事件再 resolve，进程退出时通过 `shutdown` 注册 `client.disconnect()`。
+
+依赖：`@hile/core`、`ioredis`。生成代码时必须遵循 Hile 的服务定义与加载规则，通过 `loadService` 获取 Redis 实例并使用 ioredis 的标准 API。
+
+---
+
+## 2. 类型与环境变量
+
+### 2.1 环境变量（默认服务）
+
+| 变量 | 说明 |
+|------|------|
+| `REDIS_HOST` | Redis 主机 |
+| `REDIS_PORT` | Redis 端口（字符串会被转为数字） |
+| `REDIS_USERNAME` | Redis 用户名 |
+| `REDIS_PASSWORD` | Redis 密码 |
+| `REDIS_DB` | Redis 数据库编号，未设置时默认为 `0` |
+
+行为：服务在 `new Redis(options)` 后监听 `connect`，连接成功后才 resolve；`shutdown` 时调用 `client.disconnect()`。
+
+### 2.2 类型（生成代码时须遵循）
+
+- 默认服务：`defineService(async (shutdown) => { ... return client; })`，返回值为 ioredis 的 `Redis` 实例。
+- 需要类型时从 `ioredis` 自行引入，例如 `import type { Redis, RedisOptions } from 'ioredis'`；本包仅导出默认服务，不 re-export 类型。
+
+---
+
+## 3. 代码生成模板与规则
+
+### 3.1 使用默认服务
+
+```typescript
+import { loadService } from '@hile/core'
+import ioredisService from '@hile/ioredis'
+
+const redis = await loadService(ioredisService)
+await redis.set('key', 'value')
+const value = await redis.get('key')
+```
+
+### 3.2 规则与反模式
+
+- 不要在本包外再包一层 `defineService` 封装同一个 Redis 连接；直接使用默认服务即可。
+- 不要忽略环境变量：生产环境必须通过 `REDIS_*` 配置，避免硬编码。
+- 需要扩展配置时，应在本包内扩展环境变量或 options 构造方式，保持单例由 Hile 管理。

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import Redis from 'ioredis';
+/**
+ * 创建 Redis 服务
+ * 数据从环境变量中获取
+ * 环境变量：
+ * - REDIS_HOST: Redis 主机
+ * - REDIS_PORT: Redis 端口
+ * - REDIS_USERNAME: Redis 用户名
+ * - REDIS_PASSWORD: Redis 密码
+ * - REDIS_DB: Redis 数据库
+ */
+declare const _default: import("@hile/core").ServiceRegisterProps<Redis>;
+export default _default;

package/dist/index.js

@@ -0,0 +1,32 @@
+import { defineService } from '@hile/core';
+import Redis from 'ioredis';
+/**
+ * 创建 Redis 服务
+ * 数据从环境变量中获取
+ * 环境变量：
+ * - REDIS_HOST: Redis 主机
+ * - REDIS_PORT: Redis 端口
+ * - REDIS_USERNAME: Redis 用户名
+ * - REDIS_PASSWORD: Redis 密码
+ * - REDIS_DB: Redis 数据库
+ */
+export default defineService(async (shutdown) => {
+    const options = {
+        host: process.env.REDIS_HOST,
+        port: typeof process.env.REDIS_PORT === 'string' ? Number(process.env.REDIS_PORT) : process.env.REDIS_PORT,
+        username: process.env.REDIS_USERNAME,
+        password: process.env.REDIS_PASSWORD,
+        db: typeof process.env.REDIS_DB === 'string' ? Number(process.env.REDIS_DB) : process.env.REDIS_DB || 0,
+    };
+    const client = new Redis(options);
+    await new Promise((resolve, reject) => {
+        const onerror = (e) => reject(e);
+        client.on('error', onerror);
+        client.on('connect', () => {
+            client.off('error', onerror);
+            resolve();
+        });
+    });
+    shutdown(() => client.disconnect());
+    return client;
+});

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@hile/ioredis",
+  "version": "1.0.1",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "tsc -b --watch",
+    "test": "vitest run"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "SKILL.md",
+    "skill.json"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "vitest": "^4.0.18"
+  },
+  "dependencies": {
+    "@hile/core": "1.0.11",
+    "ioredis": "^5.10.0"
+  },
+  "gitHead": "618a63b619956a0c1db4d77dece84a7efe18a11e"
+}

package/skill.json

@@ -0,0 +1,16 @@
+{
+  "name": "@hile/ioredis",
+  "version": "1.0.0",
+  "description": "Redis client as Hile service (@hile/ioredis); code generation and contribution rules",
+  "repository": "https://github.com/cevio/hile/tree/main/packages/ioredis",
+  "skills": [
+    {
+      "id": "ioredis",
+      "name": "@hile/ioredis 开发指南",
+      "description": "提供 @hile/ioredis 模块的开发与代码生成规范",
+      "path": "SKILL.md"
+    }
+  ],
+  "authors": [],
+  "license": "MIT"
+}