@c-time/frelio-cli 2.3.0 → 2.4.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.
package/README.md CHANGED
@@ -521,9 +521,50 @@ CLI 完了後、Cloudflare Dashboard での設定が必要。
521
521
  ワークフローが `wrangler deploy` / `versions upload` を実行するため、content-repo の
522
522
  **Settings → Secrets and variables → Actions** に以下を設定する:
523
523
 
524
- - `CLOUDFLARE_API_TOKEN` — Workers のデプロイ権限を持つ API トークン
524
+ - `CLOUDFLARE_API_TOKEN` — Workers のデプロイ権限を持つ API トークン(種別と必要権限は下記)
525
525
  - `CLOUDFLARE_ACCOUNT_ID` — Cloudflare アカウント ID
526
526
 
527
+ #### 推奨: 対象アカウント配下の「アカウント API トークン」を使う
528
+
529
+ **ユーザー API トークン(プロフィール → API トークン)ではなく、対象アカウント配下の
530
+ 「アカウント API トークン」を推奨する。** 顧客ごとに Cloudflare アカウントを分ける運用では特に重要。
531
+
532
+ - 作成場所: ダッシュボード → 対象アカウント →「アカウントの管理」→ **API トークン**
533
+ (プロフィール →「API トークン」のユーザートークンとは**別物**)
534
+ - 対象アカウント配下でしか作れないため、**他の顧客アカウントを巻き込む余地が構造的に無い**
535
+ - 人に紐づかないので、アカウント引き渡し・メンバー離脱で壊れない
536
+
537
+ 一方、ユーザー API トークンは作成時に「アカウントリソース」で複数アカウントを選択でき、
538
+ 「すべてのアカウント」のまま作ると 1 顧客の CI に全顧客アカウントへの Workers 書き込み権限が載る。
539
+ また作成者に紐づくため、作成者がメンバーから外れると CI が理由不明のまま壊れる。
540
+ どうしてもユーザートークンを使う場合は「アカウントリソース」を**対象アカウント 1 つに限定**すること。
541
+
542
+ #### 必要権限(アカウントスコープ 3 行で足りる)
543
+
544
+ 通常運用(管理画面デプロイ / staging プレビュー)に必要なのは以下の 3 権限のみ。
545
+ 実地検証済み(`wrangler-action@v4` の `deploy` / `versions upload --preview-alias` がいずれも成功)。
546
+
547
+ | スコープ | 項目 | レベル | 用途 |
548
+ |---|---|---|---|
549
+ | アカウント | Workers スクリプト | 編集 | `wrangler deploy` / `versions upload --preview-alias` |
550
+ | アカウント | Workers R2 ストレージ | 編集 | `[[r2_buckets]]` バインディング |
551
+ | アカウント | アカウント設定 | 読み取り | アカウント情報の解決 |
552
+
553
+ 任意機能・構成に応じて追加する権限:
554
+
555
+ | スコープ | 項目 | レベル | いつ必要か |
556
+ |---|---|---|---|
557
+ | アカウント | D1 | 編集 | contact ワーカー(D1)を使う場合 |
558
+ | ゾーン | Workers ルート | 編集 | 独自ドメインへ Worker を割り当てる場合(DNS を Cloudflare 管理下に置いた後) |
559
+
560
+ **注意点:**
561
+
562
+ - アカウント API トークンには **User スコープの権限(`User → Memberships: Read` 等)を含められない**。
563
+ Cloudflare の「Cloudflare Workers を編集する」テンプレートはこれを含むため、そのままでは使いにくい。
564
+ → カスタムトークンで上記 3 行を付与するのが確実。
565
+ - ワークフローは `wrangler-action` に `accountId` を明示的に渡しているため、アカウント一覧の解決が不要で、
566
+ `Memberships: Read` が無くても実害はない(検証済み)。
567
+
527
568
  ### 2. 初回デプロイ(workers.dev サブドメインの登録)
528
569
 
529
570
  `admin` ブランチへ push すると `deploy-admin.yml` が管理画面 Worker をデプロイする。初回デプロイで
@@ -7,7 +7,7 @@
7
7
  import prompts from 'prompts';
8
8
  import fs from 'node:fs';
9
9
  import path from 'node:path';
10
- import { log, logStep, logSuccess, logError } from '../lib/shell.js';
10
+ import { log, logStep, logSuccess, logError, logWarning } from '../lib/shell.js';
11
11
  import { generateStagingDomain, buildWorkerNames, } from '../lib/templates.js';
12
12
  import { buildResourceLinks } from '../lib/resource-links.js';
13
13
  import { validateContentRepo, validateR2PublicUrl, validateRequired, sanitizeCloudflareName, validateCloudflareName, } from '../lib/validators.js';
@@ -21,7 +21,7 @@ import { setupScheduledPublishWorker } from '../core/scheduled-publish.js';
21
21
  import { createFullContentStructure } from '../core/content-structure.js';
22
22
  import { regenerateAllConfigFiles } from '../core/file-generators.js';
23
23
  import { installBundle } from '../core/bundle.js';
24
- import { initialCommitAndBranches, getGitIdentity, setGitIdentity, } from '../core/git-operations.js';
24
+ import { initialCommitAndBranches, generateLockfile, getGitIdentity, setGitIdentity, } from '../core/git-operations.js';
25
25
  export async function initCommand(options) {
26
26
  log('');
27
27
  log('🚀 Frelio CMS プロジェクトセットアップ');
@@ -171,6 +171,21 @@ export async function initCommand(options) {
171
171
  logError(configResult.error);
172
172
  process.exit(1);
173
173
  }
174
+ // package-lock.json 生成(初回コミットに含める)
175
+ // init は npm install を実行しないため、放置するとロックファイルが無いまま push され、
176
+ // admin ブランチ初回 push の deploy-admin(setup-node cache:'npm')や
177
+ // build-staging / promote-production(npm ci)が必ず1回失敗する。ここで生成しておくと
178
+ // 後続の初回コミット(git add -A)に含まれる。失敗は致命ではないので警告に留めて続行。
179
+ step++;
180
+ logStep(step, totalSteps, 'package-lock.json 生成...');
181
+ const lockResult = generateLockfile(projectDir);
182
+ if (lockResult.success) {
183
+ logSuccess('package-lock.json 生成完了');
184
+ }
185
+ else {
186
+ log(` ⚠ package-lock.json を生成できませんでした(${lockResult.error})。`);
187
+ log(' デプロイ前に `npm install` を実行し、package-lock.json をコミットしてください。');
188
+ }
174
189
  // Cloudflare セットアップ
175
190
  if (!options.skipCloudflare) {
176
191
  step++;
@@ -269,6 +284,29 @@ export async function initCommand(options) {
269
284
  // wrangler versions upload --preview-alias で生成)を案内する。
270
285
  log(` プレビュー: ${config.previewUrl || `https://staging-${config.contentWorkerName}.<your-subdomain>.workers.dev`}`);
271
286
  log('');
287
+ // 公開に必須だが空のまま完了しうる値を警告(開発は動くが本番公開が成立しない)。
288
+ // 特に R2 公開URL はバケット作成後にしか確定しないため未入力で終わりやすい。
289
+ const publishBlockers = [];
290
+ if (!config.r2PublicUrl) {
291
+ publishBlockers.push({
292
+ label: 'R2 公開URL',
293
+ note: '未設定だと画像・ファイルが表示されません(R2 の r2.dev URL かカスタムドメインを設定)',
294
+ });
295
+ }
296
+ if (!config.productionUrl) {
297
+ publishBlockers.push({
298
+ label: '本番URL',
299
+ note: '未設定だと sitemap・OGP・正規URL 等の絶対URLが生成できません',
300
+ });
301
+ }
302
+ if (publishBlockers.length > 0) {
303
+ logWarning('公開に必要な設定が未入力のまま完了しました(開発・プレビューは動作しますが、本番公開はできません):');
304
+ for (const b of publishBlockers) {
305
+ logWarning(` - ${b.label}: ${b.note}`);
306
+ }
307
+ log(' → 管理画面の「基本設定」で設定し、「セットアップ検証」で確認してください。');
308
+ log('');
309
+ }
272
310
  // 作成したリソースへのリンク(確認・設定変更の導線)
273
311
  const resourceSections = buildResourceLinks(config, {
274
312
  github: !options.skipGithub,
@@ -286,6 +324,9 @@ export async function initCommand(options) {
286
324
  }
287
325
  log(' 残りの手動作業:');
288
326
  log(' 1. GitHub Actions シークレットを設定: CLOUDFLARE_API_TOKEN / CLOUDFLARE_ACCOUNT_ID');
327
+ log(' ※ トークンは対象アカウント配下の「アカウント API トークン」推奨(他顧客アカウントを巻き込まない)');
328
+ log(' 必要権限(アカウントスコープ3行): Workers スクリプト=編集 / Workers R2 ストレージ=編集 / アカウント設定=読み取り');
329
+ log(' 詳細: packages/cli/README.md「GitHub Actions シークレットの設定」');
289
330
  log(' 2. admin ブランチへ push して管理画面 Worker を初回デプロイ(workers.dev サブドメインが登録される)');
290
331
  log(' 3. staging ブランチへ push してコンテンツのプレビュー、main で本番デプロイ');
291
332
  if (config.stagingDomain) {
@@ -649,7 +690,7 @@ function buildConfigFromOptions(options) {
649
690
  };
650
691
  }
651
692
  function getTotalSteps(options, withContact = false, withSchedule = false) {
652
- let steps = 3; // content structure (includes workflows), bundle, config files
693
+ let steps = 4; // content structure (includes workflows), bundle, config files, lockfile
653
694
  if (!options.skipGithub)
654
695
  steps += 4; // create repo, clone, git identity, commit/push
655
696
  if (!options.skipCloudflare)
@@ -6,6 +6,22 @@ export declare function initialCommitAndBranches(projectDir: string, contentRepo
6
6
  branches: string[];
7
7
  defaultBranch: string;
8
8
  }>;
9
+ /**
10
+ * package-lock.json を生成する(`npm install --package-lock-only`)。
11
+ *
12
+ * init は package.json を配置するが `npm install` を実行しないため、そのままでは
13
+ * package-lock.json が生成されず初回コミットに含まれない。GitHub Actions の各デプロイ
14
+ * ワークフローはロックファイルの存在を前提とするため、これが無いと **admin ブランチへの
15
+ * 初回 push で必ず1回失敗**していた(`deploy-admin` は setup-node の `cache:'npm'` が
16
+ * ロックファイルを要求し、`build-staging` / `promote-production` / `scheduled-publish` /
17
+ * `_deploy` は `npm ci` がロックファイルを要求する)。
18
+ *
19
+ * ここで生成しておくと {@link initialCommitAndBranches} の `git add -A` が拾い、初回コミット
20
+ * に含めて push できる。`--package-lock-only` なので node_modules は作らず軽量。ネットワーク
21
+ * 不通等で失敗しても後から `npm install` で生成できるため best-effort とし、呼び出し側は
22
+ * 警告に留めて続行する。既にロックファイルがあれば何もしない。
23
+ */
24
+ export declare function generateLockfile(projectDir: string): OperationResult<void>;
9
25
  /**
10
26
  * commit author に使われる git identity を取得する。
11
27
  * projectDir 内で実行するため、git が commit 時に解決する値(local→global→system)と一致する。
@@ -30,6 +30,39 @@ export function initialCommitAndBranches(projectDir, contentRepo) {
30
30
  }
31
31
  }
32
32
  // ---------------------------------------------------------------------------
33
+ // Lockfile generation (pre-commit)
34
+ // ---------------------------------------------------------------------------
35
+ /**
36
+ * package-lock.json を生成する(`npm install --package-lock-only`)。
37
+ *
38
+ * init は package.json を配置するが `npm install` を実行しないため、そのままでは
39
+ * package-lock.json が生成されず初回コミットに含まれない。GitHub Actions の各デプロイ
40
+ * ワークフローはロックファイルの存在を前提とするため、これが無いと **admin ブランチへの
41
+ * 初回 push で必ず1回失敗**していた(`deploy-admin` は setup-node の `cache:'npm'` が
42
+ * ロックファイルを要求し、`build-staging` / `promote-production` / `scheduled-publish` /
43
+ * `_deploy` は `npm ci` がロックファイルを要求する)。
44
+ *
45
+ * ここで生成しておくと {@link initialCommitAndBranches} の `git add -A` が拾い、初回コミット
46
+ * に含めて push できる。`--package-lock-only` なので node_modules は作らず軽量。ネットワーク
47
+ * 不通等で失敗しても後から `npm install` で生成できるため best-effort とし、呼び出し側は
48
+ * 警告に留めて続行する。既にロックファイルがあれば何もしない。
49
+ */
50
+ export function generateLockfile(projectDir) {
51
+ if (!fs.existsSync(`${projectDir}/package.json`)) {
52
+ return fail('package.json が見つかりません。', 'NOT_FOUND');
53
+ }
54
+ if (fs.existsSync(`${projectDir}/package-lock.json`)) {
55
+ return okVoid();
56
+ }
57
+ try {
58
+ exec('npm install --package-lock-only --ignore-scripts', { cwd: projectDir, silent: true });
59
+ return okVoid();
60
+ }
61
+ catch (e) {
62
+ return fail(`package-lock.json 生成失敗: ${e.message}`, 'EXEC_FAILED');
63
+ }
64
+ }
65
+ // ---------------------------------------------------------------------------
33
66
  // Git identity (user.name / user.email)
34
67
  // ---------------------------------------------------------------------------
35
68
  /**
@@ -18,4 +18,4 @@ export { createFullContentStructure } from './content-structure.js';
18
18
  export { scaffoldFromTemplate } from './template-scaffold.js';
19
19
  export { generateAndWriteConfigJson, generateAndWriteWorkerWranglerToml, generateAndWriteContentWorkerSiteMode, generateAndWriteContentWorkerWranglerToml, generateAndWriteAdminWorkerWranglerToml, regenerateAllConfigFiles, } from './file-generators.js';
20
20
  export { installBundle, updateBundle, getBundleVersion } from './bundle.js';
21
- export { initialCommitAndBranches, createBranch, checkWorkflowBranchCoverage, } from './git-operations.js';
21
+ export { initialCommitAndBranches, generateLockfile, createBranch, checkWorkflowBranchCoverage, } from './git-operations.js';
@@ -25,4 +25,4 @@ export { generateAndWriteConfigJson, generateAndWriteWorkerWranglerToml, generat
25
25
  // Bundle
26
26
  export { installBundle, updateBundle, getBundleVersion } from './bundle.js';
27
27
  // Git operations
28
- export { initialCommitAndBranches, createBranch, checkWorkflowBranchCoverage, } from './git-operations.js';
28
+ export { initialCommitAndBranches, generateLockfile, createBranch, checkWorkflowBranchCoverage, } from './git-operations.js';
@@ -10,3 +10,4 @@ export declare function log(message: string): void;
10
10
  export declare function logStep(step: number, total: number, message: string): void;
11
11
  export declare function logSuccess(message: string): void;
12
12
  export declare function logError(message: string): void;
13
+ export declare function logWarning(message: string): void;
package/dist/lib/shell.js CHANGED
@@ -38,3 +38,6 @@ export function logSuccess(message) {
38
38
  export function logError(message) {
39
39
  console.error(` ✗ ${message}`);
40
40
  }
41
+ export function logWarning(message) {
42
+ console.warn(` ⚠ ${message}`);
43
+ }
@@ -323,8 +323,9 @@ directory = "./admin"
323
323
  binding = "ASSETS"
324
324
  # SPA: 未マッチ URL は index.html へフォールバック(クライアントサイドルーティング)
325
325
  not_found_handling = "single-page-application"
326
- # /api/* のみ Worker を経由(SPA アセットは直接配信=コスト0)
327
- run_worker_first = ["/api/*"]
326
+ # /api/*(ルーター)と /storage/*(R2 公開配信・本文インライン画像の相対URL解決)のみ
327
+ # Worker を経由(SPA アセットは直接配信=コスト0)
328
+ run_worker_first = ["/api/*", "/storage/*"]
328
329
 
329
330
  [vars]
330
331
  R2_PUBLIC_URL = "${config.r2PublicUrl}"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@c-time/frelio-cli",
3
- "version": "2.3.0",
3
+ "version": "2.4.0",
4
4
  "description": "Frelio CMS setup CLI",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -23,8 +23,8 @@
23
23
  "prepublishOnly": "npm run build"
24
24
  },
25
25
  "dependencies": {
26
- "@c-time/frelio-data-json": "^2.3.0",
27
- "@c-time/frelio-gentl": "^2.3.0",
26
+ "@c-time/frelio-data-json": "^2.4.0",
27
+ "@c-time/frelio-gentl": "^2.4.0",
28
28
  "commander": "^13.0.0",
29
29
  "prompts": "^2.4.2",
30
30
  "tar": "^7.0.0"