create-riebeckite 0.0.17 → 0.0.19

package/README.md

@@ -7,7 +7,7 @@ Create a new Riebeckite site from an official starter preset.
 ## Usage
 
 Interactive (recommended): run without arguments and answer the prompts for
-the project name, preset, content source, and deployment.
+the project name, preset, project files, content source, and deployment.
 
 ```sh
 npx create-riebeckite
@@ -30,14 +30,15 @@ The prompts ask, in order:
 | --- | --- | --- |
 | Project name | the folder to create (empty input uses the default name) | any name, e.g. `my-site` |
 | Preset | `starter`, `minimal`, `showcase`, `empty` | `starter` for most sites |
+| Project files | `.editorconfig`, `.gitattributes`, `biome.json`, `.npmrc`, `.vscode/settings.json` | the recommended set is pre-selected |
 | Content source | `This project`, `Separate GitHub repository` | `This project` to start |
 | Deployment | `GitHub Actions + Cloudflare Workers`, `Not now` | `Not now` for local development |
 
 `Separate GitHub repository` also asks for the content and site repositories,
 and GitHub Actions deployment is then configured for you. That setup is covered
-in the [content repository guide](../../docs/en/docs/guides/content-repositories.md).
+in the [content repository guide](../../docs/docs/guides/content-repositories.en.md).
 Deployment can be added later, described in
-[Deployment](../../docs/en/docs/getting-started/deployment.md).
+[Deployment](../../docs/docs/getting-started/deployment.en.md).
 
 ## Options
 
@@ -45,6 +46,7 @@ Deployment can be added later, described in
 | --- | --- |
 | `[directory]` | Directory to scaffold into (default: the current directory) |
 | `--preset <name>` | Starter composition, e.g. `showcase` (default: `starter`) |
+| `--utilities <names>` | Comma-separated project files to generate: `editorconfig`, `gitattributes`, `biome`, `npmrc`, `vscode`, or `none` (default: `editorconfig,gitattributes,biome`) |
 | `--force` | Scaffold even when the target directory is not empty |
 | `--list-presets` | Print the available presets and their descriptions, then exit |
 | `--github-actions` | Generate the Cloudflare deployment workflow |
@@ -57,6 +59,27 @@ For example, scaffold the complete feature tour:
 npx create-riebeckite my-site --preset showcase
 ```
 
+## Project files
+
+Alongside the preset, `create-riebeckite` writes optional project files. In
+interactive mode the `Extra project files` prompt pre-selects the recommended
+set; toggle any of them there. Non-interactive runs select them with a
+comma-separated `--utilities` value.
+
+| Name | File | Default |
+| --- | --- | --- |
+| `editorconfig` | `.editorconfig` | yes |
+| `gitattributes` | `.gitattributes` | yes |
+| `biome` | `biome.json` | yes |
+| `npmrc` | `.npmrc` | no |
+| `vscode` | `.vscode/settings.json` | no |
+
+Pass `none` to write no project files, or list the ones you want:
+
+```sh
+npx create-riebeckite my-site --utilities editorconfig,npmrc,vscode
+```
+
 ## External content repository
 
 To use a separate content repository and deploy after its `main` branch is
@@ -71,7 +94,7 @@ npx create-riebeckite my-site --github-actions \
 Set `content.directory` to `"content"`, add the documented repository secrets,
 then copy `github/notify-site.yml` into the content repository as
 `.github/workflows/notify-site.yml`. See the [separate-content deployment
-guide](../../templates/cloudflare/README_en.md).
+guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/guides/deployment/separate-content-repository.en.md).
 
 `--content-repository` automatically configures the external checkout, the
 `content-updated` repository-dispatch receiver, and `github/notify-site.yml`.
@@ -101,15 +124,15 @@ Each preset has a one-line description, shown by `--list-presets`:
 - `showcase` — The complete plugin catalog with rendered examples, local fixtures, and reference pages.
 - `empty` — A blank application shell: no plugins, theme, content, or components.
 
-Presets are defined in `@riebeckite/honox` and can be imported into your own
-tooling:
+Presets are defined in `create-riebeckite/scaffold` and can be imported into
+your own tooling:
 
 ```ts
-import { scaffoldRiebeckiteSite, showcase } from "@riebeckite/honox";
+import { scaffoldRiebeckiteSite } from "create-riebeckite/scaffold";
 
 await scaffoldRiebeckiteSite({
   targetDirectory: "./my-site",
-  preset: showcase,
+  preset: "showcase",
 });
 ```
 

package/README_ja.md

@@ -8,7 +8,7 @@ CLI ツールです。
 ## 使い方
 
 対話モード（推奨）: 引数なしで実行すると、プロジェクト名・preset・
-コンテンツの格納場所・デプロイについて順に確認します。
+プロジェクトファイル・コンテンツの格納場所・デプロイについて順に確認します。
 
 ```sh
 npx create-riebeckite
@@ -31,10 +31,11 @@ npm exec riebeckite build
 | --- | --- | --- |
 | Project name | 作るフォルダ名（空なら既定の名前） | 任意。例: `my-site` |
 | Preset | `starter`、`minimal`、`showcase`、`empty` | 大半のサイトは `starter` |
+| Project files | `.editorconfig`、`.gitattributes`、`biome.json`、`.npmrc`、`.vscode/settings.json` | 推奨セットをあらかじめ選択 |
 | Content source | `This project`、`Separate GitHub repository` | 最初は `This project` |
 | デプロイ設定 | `GitHub Actions + Cloudflare Workers`、`Not now` | 手元で試すなら `Not now` |
 
-`Separate GitHub repository` を選ぶと content と site のリポジトリ名も入力し、GitHub Actions のデプロイ設定が自動で構成されます。この構成は[content repository ガイド](../../docs/ja/docs/guides/content-repositories.md)に、デプロイの追加方法は [Deployment](../../docs/ja/docs/getting-started/deployment.md) にあります。
+`Separate GitHub repository` を選ぶと content と site のリポジトリ名も入力し、GitHub Actions のデプロイ設定が自動で構成されます。この構成は[content repository ガイド](../../docs/docs/guides/content-repositories.md)に、デプロイの追加方法は [Deployment](../../docs/docs/getting-started/deployment.md) にあります。
 
 ## オプション
 
@@ -42,6 +43,7 @@ npm exec riebeckite build
 | --- | --- |
 | `[directory]` | 生成先ディレクトリ（既定はカレントディレクトリ） |
 | `--preset <name>` | 使用するスターター構成（既定は `starter`） |
+| `--utilities <names>` | 生成するプロジェクトファイルをカンマ区切りで指定する（`editorconfig`、`gitattributes`、`biome`、`npmrc`、`vscode`、または `none`。既定は `editorconfig,gitattributes,biome`） |
 | `--force` | 空でないディレクトリにも展開する |
 | `--list-presets` | 利用可能な preset と説明を一覧表示して終了する |
 | `--github-actions` | Cloudflare へのデプロイ workflow を生成する |
@@ -54,6 +56,28 @@ npm exec riebeckite build
 npx create-riebeckite my-site --preset showcase
 ```
 
+## Project files
+
+preset とは別に、`create-riebeckite` は任意のプロジェクトファイルを生成します。
+対話モードでは `Extra project files` の質問で推奨セットがあらかじめ選択されて
+いるので、そこから個別に切り替えられます。非対話で実行する場合は、
+カンマ区切りの `--utilities` で選択します。
+
+| 名前 | ファイル | 既定 |
+| --- | --- | --- |
+| `editorconfig` | `.editorconfig` | 生成する |
+| `gitattributes` | `.gitattributes` | 生成する |
+| `biome` | `biome.json` | 生成する |
+| `npmrc` | `.npmrc` | 生成しない |
+| `vscode` | `.vscode/settings.json` | 生成しない |
+
+`none` を渡すとプロジェクトファイルを一切生成しません。個別に選ぶ場合は
+次のように指定します。
+
+```sh
+npx create-riebeckite my-site --utilities editorconfig,npmrc,vscode
+```
+
 ## External content repository
 
 別の記事リポジトリを使い、その `main` への push でデプロイする場合は、共通の
@@ -68,7 +92,7 @@ npx create-riebeckite my-site --github-actions \
 `content.directory` は `"content"` にし、必要な repository Secret を登録した後、
 `github/notify-site.yml` を記事リポジトリの
 `.github/workflows/notify-site.yml` にコピーします。詳細は[別記事リポジトリの
-デプロイガイド](../../templates/cloudflare/README_ja.md)を参照してください。
+デプロイガイド](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/guides/deployment/separate-content-repository.md)を参照してください。
 
 `--content-repository` を指定すると、外部 content の checkout、
 `content-updated` の repository dispatch receiver、`github/notify-site.yml` がまとめて構成されます。以前の通知用オプションは廃止しました。

package/dist/src/arguments.d.ts

@@ -1,13 +1,13 @@
-import { type ScaffoldPresetName } from "@riebeckite/honox";
+import type { ScaffoldDeployment } from "./scaffold/options.js";
+import { type ScaffoldPresetName } from "./scaffold/presets.js";
+import { type ScaffoldUtilityName } from "./scaffold/utilities.js";
 export type CreateRiebeckiteOptions = {
     readonly directory: string;
     readonly force: boolean;
     readonly preset: ScaffoldPresetName;
+    readonly utilities: readonly ScaffoldUtilityName[];
     readonly listPresets: boolean;
-    readonly githubActions: boolean;
-    readonly cloudflareWorkers: boolean;
-    readonly contentRepository?: string;
-    readonly siteRepository?: string;
+    readonly deployment: ScaffoldDeployment;
 };
 export declare function parseArguments(arguments_: readonly string[]): CreateRiebeckiteOptions;
 export declare function printPresets(): void;