unpkg-white-list 1.205.0 → 1.206.0

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 (2) hide show
  1. package/README.md +91 -6
  2. package/package.json +13 -1
package/README.md CHANGED
@@ -3,21 +3,59 @@
3
3
  [![NPM version](https://img.shields.io/npm/v/unpkg-white-list.svg?style=flat-square)](https://npmjs.org/package/unpkg-white-list)
4
4
  [![CI](https://github.com/cnpm/unpkg-white-list/actions/workflows/nodejs.yml/badge.svg)](https://github.com/cnpm/unpkg-white-list/actions/workflows/nodejs.yml)
5
5
 
6
- [npmmirror.com](https://npmmirror.com) 允许开启 [unpkg 功能](https://www.yuque.com/egg/cnpm/files)的白名单列表,避免 https://x.com/fengmk2/status/1791498406923215020 类似问题
6
+ - [npmmirror.com](https://npmmirror.com) 允许开启 [unpkg 功能](https://www.yuque.com/egg/cnpm/files)的白名单列表,避免 https://x.com/fengmk2/status/1791498406923215020 类似问题
7
+ - `allowPackages` 字段:用于添加指定包名和版本号,示例:
8
+
9
+ ```json
10
+ "allowPackages": {
11
+ "urllib": {
12
+ "version": "*"
13
+ }
14
+ }
15
+ ```
16
+
17
+ - `allowScopes` 字段:用于添加指定 scope,示例:
18
+
19
+ ```json
20
+ "allowScopes": [
21
+ "@eggjs",
22
+ "@ant-design"
23
+ ]
24
+ ```
25
+
26
+ - npmmirror sync package tgz 超大文件白名单列表,避免 https://x.com/fengmk2/status/1999821026012889567 类似问题
27
+ - `allowLargePackages` 字段:用于添加指定包名和版本号,示例:
28
+
29
+ ```json
30
+ "allowLargePackages": {
31
+ "aws-cdk-lib": {
32
+ "version": "*"
33
+ }
34
+ }
35
+ ```
36
+
37
+ - `allowLargeScopes` 字段:用于添加指定 scope,示例:
38
+
39
+ ```json
40
+ "allowLargeScopes": [
41
+ "@next",
42
+ "@swc"
43
+ ]
44
+ ```
7
45
 
8
46
  ## 添加白名单方式
9
47
 
10
48
  > [!NOTE]
11
49
  > 尽量使用 CLI 添加白名单,它可以确保字段顺序和格式正确,避免手动修改 `package.json` 文件。
12
50
 
13
- ### 添加指定包名和版本号
51
+ ### unpkg 白名单添加指定包名和版本号
14
52
 
15
53
  用 CLI 添加你想开启 unpkg 文件同步的 npm 包名和版本号,全量同步版本号可以设置为 `*`,以同步 [urllib](https://npmmirror.com/package/urllib) 为示例:
16
54
 
17
55
  ```bash
18
- npm run add -- --pkg=urllib:* # 同步 urllib 所有版本
56
+ npm run add -- "--pkg=urllib:*" # 同步 urllib 所有版本
19
57
  # or
20
- npm run add -- --pkg=urllib:1.0.0 # 同步 urllib 1.0.0 版本
58
+ npm run add -- "--pkg=urllib:1.0.0" # 同步 urllib 1.0.0 版本
21
59
  # or
22
60
  npm run add -- "--pkg=urllib:>=1.0.0" # 同步 urllib 大于等于 1.0.0 版本
23
61
  ```
@@ -34,7 +72,7 @@ _你将会看到 package.json 文件中的 `allowPackages` 字段被更新,如
34
72
  }
35
73
  ```
36
74
 
37
- ### 添加指定 scope
75
+ ### unpkg 白名单添加指定 scope
38
76
 
39
77
  > [!WARNING]
40
78
  > 为避免滥用,申请添加的 scope 必须已包含热门包(如周下载量超过 1 万)。我们不接受为刚创建且无热门包的 scope 添加白名单。
@@ -55,7 +93,54 @@ _你将会看到 package.json 文件中的 `allowScopes` 字段被更新,如
55
93
  ]
56
94
  ```
57
95
 
58
- 2、修改完成后提交一个 `Pull Request` 合并到 master 分支,等待 Review,合并后会自动发布,预计最长 5 分钟后会全网生效。
96
+ ### sync package tgz 超大文件白名单添加指定包名和版本号
97
+
98
+ 用 CLI 添加你想开启 npmmirror sync package tgz 超大文件同步的 npm 包名和版本号,全量同步版本号可以设置为 `*`,以同步 [aws-cdk-lib](https://npmmirror.com/package/aws-cdk-lib) 为示例:
99
+
100
+ ```bash
101
+ npm run add -- "--large-pkg=aws-cdk-lib:*" # 同步 aws-cdk-lib 所有版本
102
+ # or
103
+ npm run add -- "--large-pkg=aws-cdk-lib:1.0.0" # 同步 aws-cdk-lib 1.0.0 版本
104
+ # or
105
+ npm run add -- "--large-pkg=aws-cdk-lib:>=1.0.0" # 同步 aws-cdk-lib 大于等于 1.0.0 版本
106
+ ```
107
+
108
+ _你将会看到 package.json 文件中的 `allowLargePackages` 字段被更新,如下所示:_
109
+
110
+ ```json
111
+ "allowLargePackages": {
112
+ ...
113
+ "aws-cdk-lib": {
114
+ "version": "*"
115
+ }
116
+ ...
117
+ }
118
+ ```
119
+
120
+ ### sync package tgz 超大文件白名单添加指定 scope
121
+
122
+ > [!WARNING]
123
+ > 为避免滥用,申请添加的 scope 必须已包含热门包(如周下载量超过 1 万)。我们不接受为刚创建且无热门包的 scope 添加白名单。
124
+
125
+ 当然你发布的是 scoped package,可以用 CLI 添加 scope 到白名单 `allowLargeScopes`:
126
+
127
+ ```bash
128
+ npm run add -- --large-scope=@next
129
+ ```
130
+
131
+ _你将会看到 package.json 文件中的 `allowLargeScopes` 字段被更新,如下所示:_
132
+
133
+ ```json
134
+ "allowLargeScopes": [
135
+ ...
136
+ "@next",
137
+ ...
138
+ ]
139
+ ```
140
+
141
+ ## 提交 PR 并等待合并生效
142
+
143
+ 修改完成后提交一个 `Pull Request` 合并到 master 分支,等待 Review,合并后会自动发布,预计最长 5 分钟后会全网生效。
59
144
 
60
145
  ## License
61
146
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "unpkg-white-list",
3
- "version": "1.205.0",
3
+ "version": "1.206.0",
4
4
  "description": "npmmirror 允许开启 unpkg 功能的白名单列表,避免 https://x.com/fengmk2/status/1791498406923215020 类似问题",
5
5
  "main": "index.js",
6
6
  "files": [],
@@ -18937,5 +18937,17 @@
18937
18937
  "zy-count-up": {
18938
18938
  "version": "*"
18939
18939
  }
18940
+ },
18941
+ "allowLargeScopes": [
18942
+ "@next",
18943
+ "@swc"
18944
+ ],
18945
+ "allowLargePackages": {
18946
+ "aws-cdk-lib": {
18947
+ "version": "*"
18948
+ },
18949
+ "ant-design-vue": {
18950
+ "version": "*"
18951
+ }
18940
18952
  }
18941
18953
  }