@riebeckite/plugin-deploy 0.0.1
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.
- package/LICENSE +201 -0
- package/README.md +64 -0
- package/README_ja.md +63 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +252 -0
- package/dist/src/plugin.d.ts +15 -0
- package/dist/src/providers.d.ts +31 -0
- package/dist/src/redirects.d.ts +28 -0
- package/dist/src/types.d.ts +33 -0
- package/package.json +55 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright Rerurate_514
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# @riebeckite/plugin-deploy
|
|
2
|
+
|
|
3
|
+
Static hosting output helpers for Riebeckite. The plugin prepares the files a
|
|
4
|
+
deploy target needs and emits them through the build's generated-output sink.
|
|
5
|
+
It does not upload anything and never writes to the filesystem.
|
|
6
|
+
|
|
7
|
+
[日本語](./README_ja.md)
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
`deployPlugin()` reads public redirects from the content manifest and plans the
|
|
12
|
+
provider-specific files for Cloudflare Pages, Netlify, Vercel, or GitHub Pages.
|
|
13
|
+
All planning is pure and deterministic: no timestamps, no randomness, and a
|
|
14
|
+
stable path order.
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
import { defineConfig } from "@riebeckite/core";
|
|
20
|
+
import { deployPlugin } from "@riebeckite/plugin-deploy";
|
|
21
|
+
|
|
22
|
+
export default defineConfig({
|
|
23
|
+
plugins: [
|
|
24
|
+
deployPlugin({
|
|
25
|
+
provider: ["cloudflare-pages", "github-pages"],
|
|
26
|
+
baseUrl: "https://example.com",
|
|
27
|
+
cname: "example.com",
|
|
28
|
+
headers: { "X-Frame-Options": "DENY" },
|
|
29
|
+
}),
|
|
30
|
+
],
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Redirects come only from `manifest.publicRedirects`, so unpublished notes never
|
|
35
|
+
leak their old paths into deploy files. A redirect whose target slug is missing
|
|
36
|
+
is skipped and reported with a `deploy-unresolved-redirect` diagnostic.
|
|
37
|
+
|
|
38
|
+
## Per-provider output
|
|
39
|
+
|
|
40
|
+
| Provider | Files |
|
|
41
|
+
| --- | --- |
|
|
42
|
+
| `cloudflare-pages`, `netlify` | `_redirects` (when redirects exist), `_headers` (when headers are configured) |
|
|
43
|
+
| `vercel` | `vercel.json` |
|
|
44
|
+
| `github-pages` | `.nojekyll`, `404.html`, `CNAME` (when configured), one `<from>/index.html` meta-refresh stub per redirect |
|
|
45
|
+
|
|
46
|
+
GitHub Pages has no `_redirects` syntax, so every redirect becomes an HTML stub
|
|
47
|
+
with a meta refresh and a `<link rel="canonical">`. A redirect from `/` is
|
|
48
|
+
skipped because the root cannot be stubbed.
|
|
49
|
+
|
|
50
|
+
## Public API
|
|
51
|
+
|
|
52
|
+
- `deployPlugin(options: DeployOptions): RiebeckitePlugin`
|
|
53
|
+
- `planDeployOutputs({ provider, redirects, options }): DeployOutput[]`
|
|
54
|
+
- `renderRedirectLines(redirects): string`
|
|
55
|
+
- `renderVercelConfig({ redirects, options }): string`
|
|
56
|
+
- `renderRedirectStub(redirect): string`
|
|
57
|
+
|
|
58
|
+
## Notes
|
|
59
|
+
|
|
60
|
+
- Multiple providers are unioned. Identical files collapse into one; the same
|
|
61
|
+
path with different content throws.
|
|
62
|
+
- Redirect `from` values are resolved (`.` and `..` segments) before they become
|
|
63
|
+
output paths, and every planned path passes `normalizeGeneratedOutputPath`.
|
|
64
|
+
- Uploading, cache invalidation, and provider authentication are out of scope.
|
package/README_ja.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# @riebeckite/plugin-deploy
|
|
2
|
+
|
|
3
|
+
Riebeckite の静的ホスティング向け出力ヘルパーです。デプロイ先が必要とする
|
|
4
|
+
ファイルを組み立て、ビルドの generated-output シンク経由で出力します。
|
|
5
|
+
アップロードは行わず、ファイルシステムにも書き込みません。
|
|
6
|
+
|
|
7
|
+
[English](./README_en.md)
|
|
8
|
+
|
|
9
|
+
## 概要
|
|
10
|
+
|
|
11
|
+
`deployPlugin()` はコンテンツマニフェストの公開リダイレクトを読み、
|
|
12
|
+
Cloudflare Pages / Netlify / Vercel / GitHub Pages 向けのファイルを計画します。
|
|
13
|
+
計画は純粋かつ決定的です。タイムスタンプや乱数は使わず、パスの順序も安定します。
|
|
14
|
+
|
|
15
|
+
## 使い方
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { defineConfig } from "@riebeckite/core";
|
|
19
|
+
import { deployPlugin } from "@riebeckite/plugin-deploy";
|
|
20
|
+
|
|
21
|
+
export default defineConfig({
|
|
22
|
+
plugins: [
|
|
23
|
+
deployPlugin({
|
|
24
|
+
provider: ["cloudflare-pages", "github-pages"],
|
|
25
|
+
baseUrl: "https://example.com",
|
|
26
|
+
cname: "example.com",
|
|
27
|
+
headers: { "X-Frame-Options": "DENY" },
|
|
28
|
+
}),
|
|
29
|
+
],
|
|
30
|
+
});
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
リダイレクトは `manifest.publicRedirects` からのみ読み取ります。非公開ノートの
|
|
34
|
+
旧パスがデプロイファイルに漏れることはありません。遷移先の slug が見つからない
|
|
35
|
+
リダイレクトはスキップし、`deploy-unresolved-redirect` の診断を出します。
|
|
36
|
+
|
|
37
|
+
## プロバイダごとの出力
|
|
38
|
+
|
|
39
|
+
| プロバイダ | ファイル |
|
|
40
|
+
| --- | --- |
|
|
41
|
+
| `cloudflare-pages`, `netlify` | `_redirects`(リダイレクトがある場合)、`_headers`(ヘッダー設定時) |
|
|
42
|
+
| `vercel` | `vercel.json` |
|
|
43
|
+
| `github-pages` | `.nojekyll`、`404.html`、`CNAME`(設定時)、リダイレクトごとの `<from>/index.html` メタリフレッシュ |
|
|
44
|
+
|
|
45
|
+
GitHub Pages には `_redirects` 構文がないため、各リダイレクトはメタリフレッシュと
|
|
46
|
+
`<link rel="canonical">` を持つ HTML スタブになります。`/` からのリダイレクトは
|
|
47
|
+
ルートをスタブ化できないためスキップします。
|
|
48
|
+
|
|
49
|
+
## 公開 API
|
|
50
|
+
|
|
51
|
+
- `deployPlugin(options: DeployOptions): RiebeckitePlugin`
|
|
52
|
+
- `planDeployOutputs({ provider, redirects, options }): DeployOutput[]`
|
|
53
|
+
- `renderRedirectLines(redirects): string`
|
|
54
|
+
- `renderVercelConfig({ redirects, options }): string`
|
|
55
|
+
- `renderRedirectStub(redirect): string`
|
|
56
|
+
|
|
57
|
+
## 注意点
|
|
58
|
+
|
|
59
|
+
- 複数プロバイダの出力は統合されます。同一ファイルは 1 つにまとまり、同じパスに
|
|
60
|
+
異なる内容が来た場合はエラーになります。
|
|
61
|
+
- リダイレクトの `from` は出力パスにする前に `.` と `..` を解決し、すべてのパスが
|
|
62
|
+
`normalizeGeneratedOutputPath` を通ります。
|
|
63
|
+
- アップロード、キャッシュ無効化、プロバイダ認証は対象外です。
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { deployPlugin } from "./src/plugin.js";
|
|
2
|
+
export { mergePlannedOutputs, planDeployOutputs, renderHeaders, renderVercelConfig, } from "./src/providers.js";
|
|
3
|
+
export { isPermanentRedirect, renderNotFoundPage, renderRedirectLines, renderRedirectStub, } from "./src/redirects.js";
|
|
4
|
+
export type { DeployOptions, DeployOutput, DeployProvider, PublicRedirect, } from "./src/types.js";
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
// src/plugin.ts
|
|
2
|
+
import {
|
|
3
|
+
definePlugin
|
|
4
|
+
} from "@riebeckite/core";
|
|
5
|
+
|
|
6
|
+
// src/redirects.ts
|
|
7
|
+
import {
|
|
8
|
+
escapeHtml,
|
|
9
|
+
escapeHtmlAttribute,
|
|
10
|
+
normalizeGeneratedOutputPath
|
|
11
|
+
} from "@riebeckite/core";
|
|
12
|
+
var PERMANENT_STATUSES = /* @__PURE__ */ new Set([301, 308]);
|
|
13
|
+
function isPermanentRedirect(status) {
|
|
14
|
+
return PERMANENT_STATUSES.has(status);
|
|
15
|
+
}
|
|
16
|
+
function compareRedirects(left, right) {
|
|
17
|
+
return compareStrings(left.from, right.from) || compareStrings(left.to, right.to) || left.status - right.status;
|
|
18
|
+
}
|
|
19
|
+
function compareStrings(left, right) {
|
|
20
|
+
if (left < right) return -1;
|
|
21
|
+
if (left > right) return 1;
|
|
22
|
+
return 0;
|
|
23
|
+
}
|
|
24
|
+
function normalizeRedirects(redirects) {
|
|
25
|
+
const byKey = /* @__PURE__ */ new Map();
|
|
26
|
+
for (const redirect of redirects) {
|
|
27
|
+
const from = redirect.from.trim();
|
|
28
|
+
const to = redirect.to.trim();
|
|
29
|
+
if (from.length === 0 || to.length === 0) continue;
|
|
30
|
+
const key = `${from}\0${to}\0${redirect.status}`;
|
|
31
|
+
if (!byKey.has(key)) {
|
|
32
|
+
byKey.set(key, { from, to, status: redirect.status });
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return [...byKey.values()].sort(compareRedirects);
|
|
36
|
+
}
|
|
37
|
+
function renderRedirectLines(redirects) {
|
|
38
|
+
const normalized = normalizeRedirects(redirects);
|
|
39
|
+
if (normalized.length === 0) return "";
|
|
40
|
+
return `${normalized.map((redirect) => `${redirect.from} ${redirect.to} ${redirect.status}`).join("\n")}
|
|
41
|
+
`;
|
|
42
|
+
}
|
|
43
|
+
function redirectStubPath(from) {
|
|
44
|
+
const path = from.split(/[?#]/)[0] ?? "";
|
|
45
|
+
const segments = [];
|
|
46
|
+
for (const segment of path.replace(/\\/g, "/").split("/")) {
|
|
47
|
+
if (segment.length === 0 || segment === ".") continue;
|
|
48
|
+
if (segment === "..") {
|
|
49
|
+
segments.pop();
|
|
50
|
+
continue;
|
|
51
|
+
}
|
|
52
|
+
segments.push(segment);
|
|
53
|
+
}
|
|
54
|
+
if (segments.length === 0) return null;
|
|
55
|
+
try {
|
|
56
|
+
return normalizeGeneratedOutputPath(`${segments.join("/")}/index.html`);
|
|
57
|
+
} catch {
|
|
58
|
+
return null;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
function renderRedirectStub(redirect) {
|
|
62
|
+
return renderRedirectStubFor(redirect, void 0);
|
|
63
|
+
}
|
|
64
|
+
function renderRedirectStubFor(redirect, baseUrl) {
|
|
65
|
+
const target = resolveTargetUrl(redirect.to, baseUrl);
|
|
66
|
+
const href = escapeHtmlAttribute(target);
|
|
67
|
+
const label = escapeHtml(target);
|
|
68
|
+
return [
|
|
69
|
+
"<!doctype html>",
|
|
70
|
+
'<html lang="en">',
|
|
71
|
+
"<head>",
|
|
72
|
+
'<meta charset="utf-8">',
|
|
73
|
+
`<meta http-equiv="refresh" content="0; url=${href}">`,
|
|
74
|
+
`<link rel="canonical" href="${href}">`,
|
|
75
|
+
"<title>Redirecting</title>",
|
|
76
|
+
"</head>",
|
|
77
|
+
"<body>",
|
|
78
|
+
`<p>Redirecting to <a href="${href}">${label}</a>.</p>`,
|
|
79
|
+
"</body>",
|
|
80
|
+
"</html>",
|
|
81
|
+
""
|
|
82
|
+
].join("\n");
|
|
83
|
+
}
|
|
84
|
+
function renderNotFoundPage() {
|
|
85
|
+
return [
|
|
86
|
+
"<!doctype html>",
|
|
87
|
+
'<html lang="en">',
|
|
88
|
+
"<head>",
|
|
89
|
+
'<meta charset="utf-8">',
|
|
90
|
+
"<title>Page not found</title>",
|
|
91
|
+
"</head>",
|
|
92
|
+
"<body>",
|
|
93
|
+
'<p>Page not found. <a href="/">Go to the home page</a>.</p>',
|
|
94
|
+
"</body>",
|
|
95
|
+
"</html>",
|
|
96
|
+
""
|
|
97
|
+
].join("\n");
|
|
98
|
+
}
|
|
99
|
+
function resolveTargetUrl(target, baseUrl) {
|
|
100
|
+
if (!baseUrl) return target;
|
|
101
|
+
if (/^[a-z][a-z0-9+.-]*:/i.test(target)) return target;
|
|
102
|
+
try {
|
|
103
|
+
return new URL(target, baseUrl).href;
|
|
104
|
+
} catch {
|
|
105
|
+
return target;
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
// src/providers.ts
|
|
110
|
+
function renderHeaders(headers) {
|
|
111
|
+
const lines = Object.keys(headers).sort(compareStrings).map((name) => ` ${name}: ${headers[name]}`);
|
|
112
|
+
return `/*
|
|
113
|
+
${lines.join("\n")}
|
|
114
|
+
`;
|
|
115
|
+
}
|
|
116
|
+
function renderVercelConfig(args) {
|
|
117
|
+
const normalized = normalizeRedirects(args.redirects);
|
|
118
|
+
const config = {
|
|
119
|
+
redirects: normalized.map((redirect) => ({
|
|
120
|
+
source: redirect.from,
|
|
121
|
+
destination: redirect.to,
|
|
122
|
+
permanent: isPermanentRedirect(redirect.status)
|
|
123
|
+
})),
|
|
124
|
+
cleanUrls: true
|
|
125
|
+
};
|
|
126
|
+
if (args.options?.trailingSlash) {
|
|
127
|
+
config.trailingSlash = args.options.trailingSlash === "always";
|
|
128
|
+
}
|
|
129
|
+
return `${JSON.stringify(config, null, 2)}
|
|
130
|
+
`;
|
|
131
|
+
}
|
|
132
|
+
function planDeployOutputs(args) {
|
|
133
|
+
const { provider, options } = args;
|
|
134
|
+
const redirects = normalizeRedirects(args.redirects);
|
|
135
|
+
const outputs = /* @__PURE__ */ new Map();
|
|
136
|
+
const add = (path, content) => {
|
|
137
|
+
const existing = outputs.get(path);
|
|
138
|
+
if (existing === void 0) {
|
|
139
|
+
outputs.set(path, content);
|
|
140
|
+
return;
|
|
141
|
+
}
|
|
142
|
+
if (existing !== content) {
|
|
143
|
+
throw new Error(
|
|
144
|
+
`Deploy provider "${provider}" planned conflicting content for "${path}".`
|
|
145
|
+
);
|
|
146
|
+
}
|
|
147
|
+
};
|
|
148
|
+
switch (provider) {
|
|
149
|
+
case "netlify":
|
|
150
|
+
case "cloudflare-pages": {
|
|
151
|
+
const lines = renderRedirectLines(redirects);
|
|
152
|
+
if (lines.length > 0) add("_redirects", lines);
|
|
153
|
+
if (options?.headers && Object.keys(options.headers).length > 0) {
|
|
154
|
+
add("_headers", renderHeaders(options.headers));
|
|
155
|
+
}
|
|
156
|
+
break;
|
|
157
|
+
}
|
|
158
|
+
case "vercel": {
|
|
159
|
+
add("vercel.json", renderVercelConfig({ redirects, options }));
|
|
160
|
+
break;
|
|
161
|
+
}
|
|
162
|
+
case "github-pages": {
|
|
163
|
+
add(".nojekyll", "");
|
|
164
|
+
add("404.html", renderNotFoundPage());
|
|
165
|
+
if (options?.cname) add("CNAME", `${options.cname}
|
|
166
|
+
`);
|
|
167
|
+
for (const redirect of redirects) {
|
|
168
|
+
const path = redirectStubPath(redirect.from);
|
|
169
|
+
if (path === null) continue;
|
|
170
|
+
add(path, renderRedirectStubFor(redirect, options?.baseUrl));
|
|
171
|
+
}
|
|
172
|
+
break;
|
|
173
|
+
}
|
|
174
|
+
default: {
|
|
175
|
+
const exhaustive = provider;
|
|
176
|
+
throw new Error(`Unsupported deploy provider: ${String(exhaustive)}`);
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
return [...outputs.entries()].map(([path, content]) => ({ path, content })).sort((left, right) => compareStrings(left.path, right.path));
|
|
180
|
+
}
|
|
181
|
+
function mergePlannedOutputs(groups) {
|
|
182
|
+
const byPath = /* @__PURE__ */ new Map();
|
|
183
|
+
for (const group of groups) {
|
|
184
|
+
for (const entry of group) {
|
|
185
|
+
const existing = byPath.get(entry.path);
|
|
186
|
+
if (existing === void 0) {
|
|
187
|
+
byPath.set(entry.path, entry.content);
|
|
188
|
+
continue;
|
|
189
|
+
}
|
|
190
|
+
if (existing !== entry.content) {
|
|
191
|
+
throw new Error(
|
|
192
|
+
`Deploy providers planned conflicting content for "${entry.path}".`
|
|
193
|
+
);
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
return [...byPath.entries()].map(([path, content]) => ({ path, content })).sort((left, right) => compareStrings(left.path, right.path));
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
// src/plugin.ts
|
|
201
|
+
var PLUGIN_NAME = "deploy";
|
|
202
|
+
function resolvePublicRedirects(manifest, diagnostics) {
|
|
203
|
+
const redirects = [];
|
|
204
|
+
for (const [from, redirect] of manifest.publicRedirects) {
|
|
205
|
+
const target = manifest.bySlug.get(redirect.slug)?.permalink;
|
|
206
|
+
if (!target) {
|
|
207
|
+
diagnostics.push({
|
|
208
|
+
code: "deploy-unresolved-redirect",
|
|
209
|
+
severity: "warning",
|
|
210
|
+
pluginName: PLUGIN_NAME,
|
|
211
|
+
message: `Redirect "${from}" points to unknown slug "${redirect.slug}"; skipping deploy redirect.`,
|
|
212
|
+
slug: redirect.slug,
|
|
213
|
+
target: from
|
|
214
|
+
});
|
|
215
|
+
continue;
|
|
216
|
+
}
|
|
217
|
+
redirects.push({ from, to: target, status: redirect.status });
|
|
218
|
+
}
|
|
219
|
+
return redirects;
|
|
220
|
+
}
|
|
221
|
+
function deployPlugin(options) {
|
|
222
|
+
return definePlugin({
|
|
223
|
+
name: PLUGIN_NAME,
|
|
224
|
+
options,
|
|
225
|
+
onBuildEnd(context) {
|
|
226
|
+
const redirects = resolvePublicRedirects(
|
|
227
|
+
context.manifest,
|
|
228
|
+
context.diagnostics
|
|
229
|
+
);
|
|
230
|
+
const providers = Array.isArray(options.provider) ? options.provider : [options.provider];
|
|
231
|
+
const outputs = mergePlannedOutputs(
|
|
232
|
+
providers.map(
|
|
233
|
+
(provider) => planDeployOutputs({ provider, redirects, options })
|
|
234
|
+
)
|
|
235
|
+
);
|
|
236
|
+
for (const entry of outputs) {
|
|
237
|
+
context.output.emit(entry);
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
});
|
|
241
|
+
}
|
|
242
|
+
export {
|
|
243
|
+
deployPlugin,
|
|
244
|
+
isPermanentRedirect,
|
|
245
|
+
mergePlannedOutputs,
|
|
246
|
+
planDeployOutputs,
|
|
247
|
+
renderHeaders,
|
|
248
|
+
renderNotFoundPage,
|
|
249
|
+
renderRedirectLines,
|
|
250
|
+
renderRedirectStub,
|
|
251
|
+
renderVercelConfig
|
|
252
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { type ContentManifest, type Diagnostic, type RiebeckitePlugin } from "@riebeckite/core";
|
|
2
|
+
import type { DeployOptions, PublicRedirect } from "./types.js";
|
|
3
|
+
/**
|
|
4
|
+
* Maps the manifest's public redirects to deploy-friendly redirects. Only
|
|
5
|
+
* `manifest.publicRedirects` is read: `manifest.redirects` also contains
|
|
6
|
+
* non-public paths, which must never leak into deploy files. A redirect whose
|
|
7
|
+
* target slug no longer exists is skipped and reported as a diagnostic.
|
|
8
|
+
*/
|
|
9
|
+
export declare function resolvePublicRedirects(manifest: ContentManifest, diagnostics: Diagnostic[]): PublicRedirect[];
|
|
10
|
+
/**
|
|
11
|
+
* Prepares static hosting files for one or more deploy targets. The plugin only
|
|
12
|
+
* plans and emits files through the build's generated-output sink; it never
|
|
13
|
+
* writes to the filesystem and never uploads anything.
|
|
14
|
+
*/
|
|
15
|
+
export declare function deployPlugin(options: DeployOptions): RiebeckitePlugin;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { DeployOptions, DeployOutput, DeployProvider, PublicRedirect } from "./types.js";
|
|
2
|
+
/**
|
|
3
|
+
* Renders a Netlify / Cloudflare Pages `_headers` file. Header names are sorted
|
|
4
|
+
* so the output is stable across builds.
|
|
5
|
+
*/
|
|
6
|
+
export declare function renderHeaders(headers: Record<string, string>): string;
|
|
7
|
+
/**
|
|
8
|
+
* Renders a Vercel `vercel.json`. Redirects use `{ source, destination,
|
|
9
|
+
* permanent }`, `cleanUrls` stays enabled for extensionless URLs, and
|
|
10
|
+
* `trailingSlash` is only written when configured.
|
|
11
|
+
*/
|
|
12
|
+
export declare function renderVercelConfig(args: {
|
|
13
|
+
redirects: readonly PublicRedirect[];
|
|
14
|
+
options?: DeployOptions;
|
|
15
|
+
}): string;
|
|
16
|
+
/**
|
|
17
|
+
* Plans every file a single provider needs. Outputs are path-sorted and every
|
|
18
|
+
* emitted path is safe for `normalizeGeneratedOutputPath`. Planning the same
|
|
19
|
+
* path with different content is a programming error and throws.
|
|
20
|
+
*/
|
|
21
|
+
export declare function planDeployOutputs(args: {
|
|
22
|
+
provider: DeployProvider;
|
|
23
|
+
redirects: readonly PublicRedirect[];
|
|
24
|
+
options?: DeployOptions;
|
|
25
|
+
}): DeployOutput[];
|
|
26
|
+
/**
|
|
27
|
+
* Merges the planned outputs of several providers. Identical files collapse to
|
|
28
|
+
* one entry; the same path with different content is a hard error so a
|
|
29
|
+
* multi-provider deploy never silently picks a winner.
|
|
30
|
+
*/
|
|
31
|
+
export declare function mergePlannedOutputs(groups: ReadonlyArray<readonly DeployOutput[]>): DeployOutput[];
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { PublicRedirect } from "./types.js";
|
|
2
|
+
export declare function isPermanentRedirect(status: PublicRedirect["status"]): boolean;
|
|
3
|
+
/**
|
|
4
|
+
* Deterministic ordering shared by every renderer: by `from`, then `to`, then
|
|
5
|
+
* `status`, using code-unit comparison so the result never depends on locale.
|
|
6
|
+
*/
|
|
7
|
+
export declare function compareRedirects(left: PublicRedirect, right: PublicRedirect): number;
|
|
8
|
+
export declare function compareStrings(left: string, right: string): number;
|
|
9
|
+
/**
|
|
10
|
+
* Drops incomplete redirects, removes exact duplicates, and sorts the rest.
|
|
11
|
+
* Renderers build on this so repeated builds produce identical bytes.
|
|
12
|
+
*/
|
|
13
|
+
export declare function normalizeRedirects(redirects: readonly PublicRedirect[]): PublicRedirect[];
|
|
14
|
+
/**
|
|
15
|
+
* Renders Netlify / Cloudflare Pages `_redirects` syntax: one `from to status`
|
|
16
|
+
* line per redirect, sorted and deduped, with a trailing newline.
|
|
17
|
+
*/
|
|
18
|
+
export declare function renderRedirectLines(redirects: readonly PublicRedirect[]): string;
|
|
19
|
+
/**
|
|
20
|
+
* Resolves a redirect `from` into an output-relative HTML stub path. Traversal
|
|
21
|
+
* and absolute segments are resolved rather than trusted, and the result is
|
|
22
|
+
* validated against `normalizeGeneratedOutputPath`. Returns `null` when no safe
|
|
23
|
+
* stub path can be produced (for example the root path `/`).
|
|
24
|
+
*/
|
|
25
|
+
export declare function redirectStubPath(from: string): string | null;
|
|
26
|
+
export declare function renderRedirectStub(redirect: PublicRedirect): string;
|
|
27
|
+
export declare function renderRedirectStubFor(redirect: PublicRedirect, baseUrl: string | undefined): string;
|
|
28
|
+
export declare function renderNotFoundPage(): string;
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Static hosting targets this plugin can prepare output files for. Uploading is
|
|
3
|
+
* intentionally out of scope: the plugin only plans deterministic files that a
|
|
4
|
+
* deploy step can then pick up.
|
|
5
|
+
*/
|
|
6
|
+
export type DeployProvider = "cloudflare-pages" | "netlify" | "vercel" | "github-pages";
|
|
7
|
+
/**
|
|
8
|
+
* A previous public path that should keep working after a permalink change.
|
|
9
|
+
* `from` is the old public path, `to` is the current permalink of the target
|
|
10
|
+
* entry.
|
|
11
|
+
*/
|
|
12
|
+
export type PublicRedirect = {
|
|
13
|
+
from: string;
|
|
14
|
+
to: string;
|
|
15
|
+
status: 301 | 302 | 307 | 308;
|
|
16
|
+
};
|
|
17
|
+
export type DeployOptions = {
|
|
18
|
+
/** One or more deploy targets to prepare files for. */
|
|
19
|
+
provider: DeployProvider | DeployProvider[];
|
|
20
|
+
/** Absolute site origin used when an absolute canonical URL is required. */
|
|
21
|
+
baseUrl?: string;
|
|
22
|
+
/** Vercel `trailingSlash` preference. */
|
|
23
|
+
trailingSlash?: "always" | "never";
|
|
24
|
+
/** Additional hosting headers, rendered per provider when supported. */
|
|
25
|
+
headers?: Record<string, string>;
|
|
26
|
+
/** GitHub Pages custom domain written to `CNAME`. */
|
|
27
|
+
cname?: string;
|
|
28
|
+
};
|
|
29
|
+
/** A file the plugin wants the build to write into the output directory. */
|
|
30
|
+
export type DeployOutput = {
|
|
31
|
+
path: string;
|
|
32
|
+
content: string;
|
|
33
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@riebeckite/plugin-deploy",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/index.js",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"import": "./dist/index.js",
|
|
12
|
+
"source": "./index.ts",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"dependencies": {
|
|
17
|
+
"@riebeckite/core": "0.0.1"
|
|
18
|
+
},
|
|
19
|
+
"devDependencies": {
|
|
20
|
+
"tsx": "^4.22.4"
|
|
21
|
+
},
|
|
22
|
+
"publishConfig": {
|
|
23
|
+
"access": "public"
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"LICENSE",
|
|
27
|
+
"README.md",
|
|
28
|
+
"README_ja.md",
|
|
29
|
+
"dist"
|
|
30
|
+
],
|
|
31
|
+
"repository": {
|
|
32
|
+
"type": "git",
|
|
33
|
+
"url": "https://github.com/Rerurate514/riebeckite.git",
|
|
34
|
+
"directory": "packages/plugins/deploy"
|
|
35
|
+
},
|
|
36
|
+
"homepage": "https://github.com/Rerurate514/riebeckite#readme",
|
|
37
|
+
"bugs": {
|
|
38
|
+
"url": "https://github.com/Rerurate514/riebeckite/issues"
|
|
39
|
+
},
|
|
40
|
+
"description": "Static hosting deployment output for Riebeckite sites.",
|
|
41
|
+
"keywords": [
|
|
42
|
+
"riebeckite",
|
|
43
|
+
"plugin",
|
|
44
|
+
"deploy",
|
|
45
|
+
"static-hosting"
|
|
46
|
+
],
|
|
47
|
+
"engines": {
|
|
48
|
+
"node": "^20.19.0 || >=22.12.0"
|
|
49
|
+
},
|
|
50
|
+
"sideEffects": false,
|
|
51
|
+
"scripts": {
|
|
52
|
+
"build": "node ../../../scripts/build_package.mjs",
|
|
53
|
+
"test": "node --import tsx --test \"test/*.test.ts\""
|
|
54
|
+
}
|
|
55
|
+
}
|