swpp-backends 3.1.0-beta1 → 3.1.0-beta2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +38 -38
  2. package/dist/swpp/FilePath.d.ts +4 -0
  3. package/dist/swpp/FilePath.js +6 -0
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -4,55 +4,55 @@
4
4
 
5
5
  ## 什么是 swpp
6
6
 
7
-   swpp 是一个用于为网站快速生成一个高度可用的 [Service Worker](https://developer.mozilla.org/zh-CN/docs/Web/API/ServiceWorker) 的工具，旨在提高网站的可靠性、优化二次访问性能、提供离线浏览功能……
7
+ swpp（Service Worker Plus Plus）是一个现代化的 Service Worker 生成工具，专注于为静态网站提供精准、高效的缓存控制和离线访问能力。
8
8
 
9
-   常用 SW 构建工具的对比：
9
+ 与传统的 Service Worker 工具相比，swpp 提供了更细粒度的控制能力和更灵活的配置选项，让开发者能够精确管理网站资源的缓存策略。
10
10
 
11
- | | swpp@3 | swpp@2 | hexo-offline |
12
- |:----------:|:------:|:------:|:------------:|
13
- | 本地缓存 | ✔️ | ✔️ | ✔️ |
14
- | 缓存增量更新 | ✔️ | ✔️ | ❌ |
15
- | 缓存过期时间 | ✔️ | ❌ | ✔️ |
16
- | 缓存大小限制 | ❌ | ❌ | ✔️ |
17
- | 预缓存 | ❌ | ❌ | ✔️ |
18
- | Request 篡改 | ✔️ | ✔️ | ❌ |
19
- | URL 竞速 | ✔️ | ✔️ | ❌ |
20
- | 备用 URL | ✔️ | ✔️ | ❌ |
21
- | 204 阻塞响应 | ✔️ | ✔️ | ❌ |
22
- | 逃生门 | ✔️ | ✔️ | ❌ |
23
- | 请求合并 | ❌ | ✔️ | ❌ |
24
- | 高度自由 | ✔️ | ✔️ | ❌ |
25
- | 更新 | 活跃 | 停止维护 | 超过两年没有更新 |
11
+ ## 核心特性
26
12
 
27
- ## swpp v2 与 v3 的区别
13
+ ### 精准缓存控制
14
+ - **智能缓存规则匹配**：基于 URL 模式的精细化缓存策略配置
15
+ - **缓存过期时间管理**：可为不同类型的资源设置独立的过期时间
16
+ - **增量更新机制**：只更新发生变化的资源，避免全量刷新
28
17
 
29
-   swpp v3 对 swpp 的所有代码进行了完全的重构，现在代码逻辑更加的清晰。除了后台代码的差异，v3 还有以下一系列的改进：
18
+ ### 性能优化
19
+ - **URL 竞速加载**：同时请求多个 CDN 源，使用最快响应的资源
20
+ - **备用 URL 机制**：主资源加载失败时自动切换到备用地址
30
21
 
31
- - 完全定制化<br/>
32
- 现在您对 swpp 生成的 sw 拥有完全的控制权。在 v2 中，如果需要修改插件生成的 sw 的逻辑，您需要自行编写整个 sw 文件。<br/>
33
- v3 中将 sw 文件的各个部分拆分到了环境变量中，这使得您可以通过配置文件覆盖 sw 文件中的任意一个部分，或者追加任意内容。
22
+ ### 高度可定制
23
+ - **模块化配置**：将 Service Worker 功能拆分为独立的配置模块
24
+ - **TypeScript 支持**：完整的类型定义，提供更好的开发体验
25
+ - **全面开放**：允许用户修改生成的 Service Worker 文件中任意一处代码
34
26
 
35
- - 现代化配置<br/>
36
- 现在您可以使用 `ts` 语言编写配置文件，同时还可以选择使用 `ESM`。在 v2 中您必须使用 `CommonJS`。<br/>
37
- 同时使用内置的一系列 `define` 函数可以让您对配置的颗粒度进行更加完美的掌控。
27
+ ## swpp 与 hexo-offline 对比
38
28
 
39
- - 完善的类型<br/>
40
- 现在 swpp 提供了更加优雅的数据类型，以优化编写配置项、二次开发时的体验。
29
+ > hexo-offline 是基于 Workbox 构建的 Hexo 插件，采用预缓存（precaching）的工作方式，与 swpp 的设计理念存在本质区别：
30
+ >
31
+ > swpp 设计目标是在提供一系列内置的常用操作的前提下，尽可能地允许用户自定义 Service Worker 的行为，离线访问只是缓存控制产生的“副作用”；
32
+ > hexo-offline 的设计目标是实现网站的离线访问。
41
33
 
42
- ## 版本号
34
+ | 特性 | swpp | hexo-offline |
35
+ |----------|----------------------|-------------------|
36
+ | **核心技术** | 自研 Service Worker 框架 | 基于 Google Workbox |
37
+ | **配置方式** | 可编程配置，支持 TypeScript | JSON/CJS 配置文件 |
38
+ | **缓存策略** | 细粒度 URL 规则匹配 | 文件扩展名模式匹配 |
39
+ | **更新机制** | 智能增量更新 | 全量预缓存更新 |
40
+ | **性能特性** | URL 竞速、备用地址 | 基础缓存策略 |
41
+ | **定制能力** | 高度可定制，完全控制 | 零配置开箱即用 |
42
+ | **适用场景** | 复杂网站、高性能要求 | 简单博客、快速部署 |
43
43
 
44
- &emsp;&emsp;目前 swpp v3 还在测试阶段，版本号全部采用 `3.0.0-alpha.<a><b><c>` 的格式：
44
+ ### 选择建议
45
45
 
46
- - `3.0.0` - 大版本号
47
- - `alpha` - 测试版本
48
- - `a` - 一级子版本号，变动时表明 API 或配置文件等内容发生了不向前兼容的变动
49
- - `b` - 二级子版本号，变动时表明添加了新的功能
50
- - `c` - 三级子版本号，变动时表明进行了漏洞修复
46
+ 如果你：
51
47
 
52
- &emsp;&emsp;当 `a` `b` `c` 的某一位达到两位数时，会在其中添加 `x` 表示分割。
48
+ - 希望对动态资源（如 API 响应、用户内容）的缓存进行精细策略控制；
49
+ - 重视代码的透明度和可审计性，希望完全理解底层逻辑；
50
+ - 享受深入技术细节、亲手构建网络层控制逻辑的过程；
51
+ - 在个人项目或技术实验中探索 Service Worker 的潜力
53
52
 
54
- ## QQ 群
53
+ 那么 swpp 是一个非常值得一试的选择。
55
54
 
56
- &emsp;&emsp;注意：swpp 有且仅有下面的群是官方的：
55
+ ## 社区支持
57
56
 
58
- ![QQ 群：545028909](/qrcode.jpg)
57
+ - **GitHub Issues**：报告问题和功能请求
58
+ - **QQ 群**：545028909（官方技术支持群）
package/dist/swpp/FilePath.d.ts CHANGED
@@ -39,6 +39,10 @@ export declare class FilePath {
39
39
  * @param consumer
40
40
  */
41
41
  walkAllFile(consumer: (filePath: FilePath) => Promise<void> | void): Promise<void>;
42
+ /**
43
+ * 获取文件名
44
+ */
45
+ fileName(): string;
42
46
  /**
43
47
  * 获取上一级目录
44
48
  */
package/dist/swpp/FilePath.js CHANGED
@@ -91,6 +91,12 @@ class FilePath {
91
91
  }
92
92
  } while (queue.length);
93
93
  }
94
+ /**
95
+ * 获取文件名
96
+ */
97
+ fileName() {
98
+ return path_1.default.posix.basename(this.absPath);
99
+ }
94
100
  /**
95
101
  * 获取上一级目录
96
102
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swpp-backends",
3
- "version": "3.1.0-beta1",
3
+ "version": "3.1.0-beta2",
4
4
  "main": "dist/index.js",
5
5
  "typings": "dist/index.d.ts",
6
6
  "description": "Generate a powerful ServiceWorker for your website.",