@hyacine/site-uptime 0.0.1

package/README.md

@@ -0,0 +1,110 @@
+# @hyacine/site-uptime
+
+一个用于在页脚显示站点运行时间的 Hyacine 插件。
+
+## 功能
+
+- 📊 实时显示站点已运行的时间（精确到秒）
+- 🎨 自动计算年、月、日、小时、分钟、秒
+- 🔄 每秒自动更新
+- 🌐 Runtime-only 插件，无需服务器端渲染
+- ⚙️ 可自定义前缀文本
+
+## 安装
+
+```bash
+bun add @hyacine/site-uptime
+```
+
+## 使用方法
+
+### 基础配置
+
+在你的 `hyacine.plugin.ts` 或 `hyacine.plugin.mjs` 文件中配置插件：
+
+```typescript
+import { defineConfig } from "@hyacine/core";
+import siteUptime from "@hyacine/site-uptime";
+
+export default defineConfig({
+  injectPoints: {
+    "footer-status": ".footer-status", // 你的页脚状态区域选择器
+    // ... 其他注入点
+  },
+  plugins: [
+    {
+      plugin: siteUptime,
+      options: {
+        siteCreatedAt: "2024-01-01T00:00:00Z",
+        prefixText: "本站已持续运行", // 自定义前缀
+      },
+    },
+  ],
+});
+```
+
+### 配置选项
+
+#### `SiteUptimeOptions`
+
+| 选项            | 类型     | 必填 | 默认值               | 说明                                                                                      |
+| --------------- | -------- | ---- | -------------------- | ----------------------------------------------------------------------------------------- |
+| `siteCreatedAt` | `string` | ✅   | -                    | 建站时间，必须是合法的 Date 字符串表达式（如 `"2024-01-01"` 或 `"2024-01-01T00:00:00Z"`） |
+| `prefixText`    | `string` | ❌   | `"该站点已经存在了"` | 显示在时间前的文本                                                                        |
+
+## 显示效果
+
+根据站点运行时间，插件会显示类似以下格式的文本：
+
+- 短期运行：`该站点已经存在了 5日12小时30分钟45秒`
+- 中期运行：`该站点已经存在了 2月15日8小时20分钟10秒`
+- 长期运行：`该站点已经存在了 1年3月22日16小时45分钟30秒`
+
+## 注入点
+
+此插件默认注入到 `footer-status` 注入点。你需要在你的布局模板中确保该注入点存在。
+
+### Astro 示例
+
+```astro
+<!-- 在你的 Layout.astro 中 -->
+<footer>
+  <div class="footer-status">
+    <!-- 插件内容将注入到这里 -->
+  </div>
+</footer>
+```
+
+## 技术细节
+
+- **插件类型**：Runtime-only
+- **注入点**：footer-status
+- **更新频率**：每秒更新一次
+- **时间计算**：基于客户端时间，自动处理时区
+
+## 注意事项
+
+1. **日期格式**：`siteCreatedAt` 必须是合法的日期字符串，建议使用 ISO 8601 格式（如 `"2024-01-01T00:00:00Z"`）
+2. **时区处理**：时间计算基于用户的本地时间，确保建站时间使用合适的时区
+3. **性能优化**：定时器在元素从 DOM 移除时会自动清理，避免内存泄漏
+
+## 开发
+
+```bash
+# 格式化代码
+bun run format
+
+# 检查代码质量
+bun run lint
+
+# 构建
+bun run build
+```
+
+## 许可证
+
+MIT
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@hyacine/site-uptime",
+  "version": "0.0.1",
+  "description": "A Hyacine plugin that displays site uptime in footer-status",
+  "keywords": [
+    "footer",
+    "hyacine",
+    "plugin",
+    "uptime"
+  ],
+  "files": [
+    "dist",
+    "src"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "lint": "bunx --bun oxlint --type-aware --type-check . --fix",
+    "format": "bunx oxfmt ."
+  },
+  "dependencies": {
+    "@hyacine/core": "workspace:*",
+    "@hyacine/helper": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  }
+}

package/src/index.ts

@@ -0,0 +1,44 @@
+import type { PluginManifest } from "@hyacine/core";
+
+export interface SiteUptimeOptions {
+  /**
+   * 建站时间，合法的 Date 字符串表达式
+   * @example "2024-01-01T00:00:00Z"
+   * @example "2024-01-01"
+   */
+  siteCreatedAt: string;
+
+  /**
+   * 自定义前缀文本，默认为 "该站点已经存在了"
+   * @default "该站点已经存在了"
+   */
+  prefixText?: string;
+}
+
+export default (options: SiteUptimeOptions): PluginManifest => {
+  // 验证 siteCreatedAt 是否为合法的日期字符串
+  const createdDate = new Date(options.siteCreatedAt);
+  if (Number.isNaN(createdDate.getTime())) {
+    throw new Error(
+      `[site-uptime] Invalid siteCreatedAt: "${options.siteCreatedAt}". Please provide a valid date string.`,
+    );
+  }
+
+  return {
+    name: "@hyacine/site-uptime",
+    version: "0.0.1",
+    minRenderCapability: "runtime-only",
+    entry: [
+      {
+        type: "runtime-only",
+        injectPoint: "footer-status",
+        path: new URL("./runtime.ts", import.meta.url).href,
+        name: "site-uptime-runtime",
+        options: {
+          siteCreatedAt: options.siteCreatedAt,
+          prefixText: options.prefixText || "该站点已经存在了",
+        },
+      },
+    ],
+  };
+};

package/src/runtime.ts

@@ -0,0 +1,111 @@
+import type { PluginInitFunction } from "@hyacine/helper/runtime";
+import { getInjectPointSelector } from "@hyacine/helper/runtime";
+
+interface SiteUptimeRuntimeOptions {
+  siteCreatedAt: string;
+  prefixText: string;
+}
+
+/**
+ * 计算站点存在时间并格式化输出
+ * @param createdAt 建站时间
+ * @param prefixText 前缀文本
+ * @returns 格式化的时间字符串，例如 "该站点已经存在了 1年2月3日4小时5分钟6秒"
+ */
+function calculateUptime(createdAt: Date, prefixText: string): string {
+  const now = new Date();
+  const diff = now.getTime() - createdAt.getTime();
+
+  if (diff < 0) {
+    return `${prefixText} 0秒`;
+  }
+
+  // 计算各个时间单位
+  const seconds = Math.floor(diff / 1000);
+  const minutes = Math.floor(seconds / 60);
+  const hours = Math.floor(minutes / 60);
+  const days = Math.floor(hours / 24);
+  const months = Math.floor(days / 30);
+  const years = Math.floor(months / 12);
+
+  // 计算余数
+  const remainingMonths = months % 12;
+  const remainingDays = days % 30;
+  const remainingHours = hours % 24;
+  const remainingMinutes = minutes % 60;
+  const remainingSeconds = seconds % 60;
+
+  // 构建时间字符串
+  const parts: string[] = [];
+
+  if (years > 0) parts.push(`${years}年`);
+  if (remainingMonths > 0) parts.push(`${remainingMonths}月`);
+  if (remainingDays > 0) parts.push(`${remainingDays}日`);
+  if (remainingHours > 0) parts.push(`${remainingHours}小时`);
+  if (remainingMinutes > 0) parts.push(`${remainingMinutes}分钟`);
+  if (remainingSeconds > 0 || parts.length === 0) parts.push(`${remainingSeconds}秒`);
+
+  return `${prefixText} ${parts.join("")}`;
+}
+
+/**
+ * 创建并插入站点运行时间显示元素
+ */
+function createUptimeElement(options: SiteUptimeRuntimeOptions): HTMLElement {
+  const container = document.createElement("div");
+  container.className = "site-uptime";
+  container.style.cssText = "margin: 0.5rem 0; font-size: 0.9em;";
+
+  const createdAt = new Date(options.siteCreatedAt);
+
+  // 初始渲染
+  container.textContent = calculateUptime(createdAt, options.prefixText);
+
+  // 每秒更新一次
+  const intervalId = setInterval(() => {
+    container.textContent = calculateUptime(createdAt, options.prefixText);
+  }, 1000);
+
+  // 清理函数：当元素从 DOM 中移除时清除定时器
+  const observer = new MutationObserver((mutations) => {
+    for (const mutation of mutations) {
+      for (const node of mutation.removedNodes) {
+        if (node === container) {
+          clearInterval(intervalId);
+          observer.disconnect();
+        }
+      }
+    }
+  });
+
+  // 观察父节点的变化
+  if (container.parentNode) {
+    observer.observe(container.parentNode, { childList: true });
+  }
+
+  return container;
+}
+
+/**
+ * Runtime-only 插件初始化函数
+ */
+export const init: PluginInitFunction<SiteUptimeRuntimeOptions> = (options) => {
+  // 等待 DOM 加载完成
+  if (document.readyState === "loading") {
+    document.addEventListener("DOMContentLoaded", () => {
+      const element = createUptimeElement(options);
+      const selector = getInjectPointSelector("footer-status");
+      const targetElement = document.querySelector(selector);
+      if (targetElement) {
+        targetElement.appendChild(element);
+      }
+    });
+  } else {
+    const element = createUptimeElement(options);
+    const selector = getInjectPointSelector("footer-status");
+    const targetElement = document.querySelector(selector);
+    if (targetElement) {
+      targetElement.appendChild(element);
+    }
+  }
+};