@hoardodile/create-plugin 0.1.5 → 0.1.6

package/dist/template/.github/workflows/release.yml

@@ -43,15 +43,15 @@ jobs:
       - name: Package the release artifacts
         run: pnpm exec hoardodile plugin package --skip-build
 
-      - name: Gate the introduction (intro/ must be flat, images by bare filename)
-        run: pnpm intro:check
+      - name: Gate the readme (readme/ must be flat, images by bare filename)
+        run: pnpm readme:check
 
       - name: Publish the GitHub release
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           files=$(ls release/*)
-          if [ -d intro ]; then
-            files="$files intro/*"
+          if [ -d readme ]; then
+            files="$files readme/*"
           fi
           gh release create "$GITHUB_REF_NAME" $files --generate-notes

package/dist/template/CONTRIBUTING.md

@@ -51,8 +51,8 @@ Pushing the tag by hand still works as a fallback:
 ## Marketplace publishing
 
 1. Add the repository address to your registry repo's `registry.json`.
-2. Ship `intro.<locale>.md` files (see the README) so each release carries a
-   version-pinned introduction the app can show.
+2. Ship a `README.md` fallback plus `README.<locale>.md` files (see the
+   README) so each release carries a version-pinned readme the app can show.
 
 ## Issues and pull requests
 

package/dist/template/README.md

@@ -50,7 +50,7 @@ server uses — the exact production execution path.
 - hoardodile **≥ 0.1.1** — the built-in plugin marketplace
   (**Settings → Marketplace**) and the batched asset-download API
   (`download([…])`) when the manifest declares `"download": true`.
-  The marketplace's Intro and Release notes tabs and release intro
+  The marketplace's Readme and Release notes tabs and release readme
   assets are read by newer builds; older builds still list and install
   the plugin normally.
 - `"minAppVersion"` in `manifest.json` declares the lowest hoardodile
@@ -97,38 +97,42 @@ git tag v<version> && git push origin v<version>
 Local installs (zip upload in **Settings → Plugins**) still work for
 private packages.
 
-## Publishing an introduction
-
-The marketplace detail view shows a per-release **Intro** tab. Ship one
-markdown file per supported language inside the **`intro/` folder**, named
-`intro.<locale>.md` (e.g. `intro/intro.en.md`, `intro/intro.zh.md`) —
-`release.yml` uploads the whole folder alongside the zip, so **each release
-carries its own introduction** and every version shows independent notes.
-Use the app's supported language codes as file names (`en`, `zh`, `ja`,
-`de`, `es`) — a region-coded name like `intro.zh-CN.md` only matches a UI
-language resolved to that exact code, so `intro.zh.md` is what Chinese
-users see.
+## Publishing a readme
+
+The marketplace detail view shows a per-release **Readme** tab. Ship the
+readme markdown in the **`readme/` folder** as a bare **`README.md`**
+fallback, plus one `README.<locale>.md` file per extra language (e.g.
+`readme/README.md`, `readme/README.zh.md`) — `release.yml` uploads the whole
+folder alongside the zip, so **each release carries its own readme** and
+every version shows independent notes.
+`README.md` is the fallback the app shows for any language without a
+specific file, so English normally lives there and you do **not** need a
+`README.en.md`. Use the app's supported language codes for the extra files
+(`zh`, `ja`, `de`, `es`) — a region-coded name like `README.zh-CN.md` only
+matches a UI language resolved to that exact code, so `README.zh.md` is what
+Chinese users see.
 
 ### Adding images
 
-An introduction may reference images. Place the image in `intro/` and
+A readme may reference images. Place the image in `readme/` and
 reference it by its **bare filename**:
 
 ```md
 ![Plugin screenshot](screenshot.png)
 ```
 
-Every file in `intro/` is published as a release asset on each release, and
+Every file in `readme/` is published as a release asset on each release, and
 the app resolves a relative image reference against that release's download
-URL. Because a GitHub release is a flat list of assets, the `intro/` folder
+URL. Because a GitHub release is a flat list of assets, the `readme/` folder
 must stay **flat** and references must be bare filenames — a nested path
 like `![alt](img/shot.png)` resolves to a URL the release does not serve and
 the image breaks. Absolute `http(s)://` and `data:` image URIs are allowed.
 
-`pnpm intro:check` (run by `release.yml` before publishing) gates this: it
-fails the release if `intro/` is absent-and-required, is not flat, ships no
-`intro.<locale>.md`, or references an image by a nested/missing path.
+`pnpm readme:check` (run by `release.yml` before publishing) gates this: it
+fails the release if `readme/` is absent-and-required, is not flat, ships no
+`README.md` / `README.<locale>.md`, or references an image by a
+nested/missing path.
 
-The app resolves the intro for the user's UI language (exact locale → base
-language → `en` → the only shipped language); the release body always shows
+The app resolves the readme for the user's UI language (exact locale → base
+language → the `README.md` fallback); the release body always shows
 in the **Release notes** tab.

package/dist/template/package.json

@@ -11,7 +11,7 @@
 		"detect:smoke": "hoardodile plugin run detect testdata --plugin-dir dist",
 		"lint": "tsc --noEmit",
 		"test": "vitest run",
-		"intro:check": "node scripts/check-intro.mjs",
+		"readme:check": "node scripts/check-readme.mjs",
 		"release": "node scripts/release.mjs"
 	},
 	"release-it": {

package/dist/template/{intro/intro.en.md → readme/README.md}

@@ -1,9 +1,9 @@
 # My plugin
 
-_Replace this introduction with a real overview: what content the plugin
+_Replace this readme with a real overview: what content the plugin
 detects, how it renders it, and where users see it._
 
-This introduction ships with **every GitHub release** — edit it per release so
+This readme ships with **every GitHub release** — edit it per release so
 each version presents its own notes in the marketplace.
 
 ## Features

package/dist/template/{intro/intro.zh.md → readme/README.zh.md}

@@ -1,8 +1,8 @@
 # 我的插件
 
-_把这段介绍替换为真实内容：插件识别什么内容、如何渲染、用户在何处看到效果。_
+_把这段说明替换为真实内容：插件识别什么内容、如何渲染、用户在何处看到效果。_
 
-本介绍随**每个 GitHub Release** 一同发布——请随版本更新，让每个版本在插件市场中呈现各自的介绍。
+本说明随**每个 GitHub Release** 一同发布——请随版本更新，让每个版本在插件市场中呈现各自的说明。
 
 ## 功能
 

package/dist/template/scripts/{check-intro.mjs → check-readme.mjs}

@@ -1,26 +1,26 @@
 #!/usr/bin/env node
 /**
- * Release gate for the plugin marketplace introduction images.
+ * Release gate for the plugin marketplace readme files.
  *
- * The marketplace reads each release's `intro.<locale>.md` asset and the
- * app resolves any image referenced inside it against the release's
- * download URL. Because a GitHub release is a flat list of assets, every
- * referenced image must be:
+ * The marketplace reads each release's `README.md` fallback asset and its
+ * `README.<locale>.md` assets, and the app resolves any image referenced
+ * inside them against the release's download URL. Because a GitHub release
+ * is a flat list of assets, every referenced image must be:
  *
- *   1. Shipped inside the `intro/` folder (the only folder the release
+ *   1. Shipped inside the `readme/` folder (the only folder the release
  *      workflow uploads), and
  *   2. Referenced by its bare filename (`![alt](shot.png)`), never a
  *      nested path (`img/shot.png`) — a nested path resolves to a URL the
  *      release does not actually serve, so the image is silently broken.
  *
- * This gate fails a build/release when the `intro/` folder is absent, is
- * not flat, ships no `intro.<locale>.md`, or references an image by a
- * nested/missing path. External `http(s)://` and `data:` image URIs are
- * allowed (they are not release assets).
+ * This gate fails a build/release when the `readme/` folder is absent, is
+ * not flat, ships no `README.md` / `README.<locale>.md`, or references an
+ * image by a nested/missing path. External `http(s)://` and `data:` image
+ * URIs are allowed (they are not release assets).
  *
  * Usage:
- *   node scripts/check-intro.mjs            # checks ./intro
- *   node scripts/check-intro.mjs <dir>      # checks <dir>/intro
+ *   node scripts/check-readme.mjs            # checks ./readme
+ *   node scripts/check-readme.mjs <dir>      # checks <dir>/readme
  *
  * Dependency-free on purpose — it ships inside every scaffolded plugin.
  */
@@ -29,16 +29,18 @@ import { existsSync, readdirSync, readFileSync, statSync } from "node:fs"
 import { join, resolve } from "node:path"
 
 const ROOT = resolve(process.argv[2] ?? process.cwd())
-const INTRO_DIR = join(ROOT, "intro")
+const README_DIR = join(ROOT, "readme")
 
 const RULE_SUMMARY =
-	"intro/ must be flat; each intro.<locale>.md image is referenced by a " +
-	"bare filename that exists in intro/ (absolute http(s)/data URIs are ok)"
+	"readme/ must be flat; each README image is referenced by a " +
+	"bare filename that exists in readme/ (absolute http(s)/data URIs are ok)"
 
 // `![alt](src)`, `![alt](src "title")`, `<img src="x">` (`src` images only).
 const MARKDOWN_IMG_RE = /!\[[^\]]*\]\(([^)\s]+)(?:\s+["'][^"']*["'])?\)/g
 const HTML_IMG_RE = /<img\b[^>]*\bsrc\s*=\s*(["'])([^"']+)\1/gi
 const EXT_URL_RE = /^(?:https?:\/\/|data:)/i
+/** `README.md` or `README.<locale>.md` — the marketplace readme assets. */
+const README_FILE_RE = /^(?:README\.md|README\.[A-Za-z0-9-]+\.md)$/
 
 function isRelative(src) {
 	return !EXT_URL_RE.test(src)
@@ -46,7 +48,7 @@ function isRelative(src) {
 
 /**
  * A relative reference is valid only as a flat bare filename that exists
- * inside `intro/` — not a nested path and not a missing/unshipsed file.
+ * inside `readme/` — not a nested path and not a missing/unshipsed file.
  */
 function resolveRelativeRef(src, file, issues) {
 	const trimmed = src.trim().replace(/^\.\//, "")
@@ -64,10 +66,10 @@ function resolveRelativeRef(src, file, issues) {
 		)
 		return
 	}
-	const target = join(INTRO_DIR, trimmed)
+	const target = join(README_DIR, trimmed)
 	if (!existsSync(target) || !statSync(target).isFile()) {
 		issues.push(
-			`${file}: image "${src}" is not in intro/ — every referenced image must be committed there (it is published with the release)`,
+			`${file}: image "${src}" is not in readme/ — every referenced image must be committed there (it is published with the release)`,
 		)
 	}
 }
@@ -80,55 +82,52 @@ function collectImageRefs(text) {
 }
 
 function main() {
-	if (!existsSync(INTRO_DIR)) {
+	if (!existsSync(README_DIR)) {
 		console.log(
-			"[check-intro] no intro/ folder — nothing to gate (a release without an introduction is valid).",
+			"[check-readme] no readme/ folder — nothing to gate (a release without a readme is valid).",
 		)
 		return
 	}
 
-	const entries = readdirSync(INTRO_DIR, { withFileTypes: true })
+	const entries = readdirSync(README_DIR, { withFileTypes: true })
 	const issues = []
 
 	// 1. Flat-only: any subdirectory makes the folder publish incorrectly.
 	for (const entry of entries) {
 		if (entry.isDirectory()) {
 			issues.push(
-				`intro/${entry.name}/ is a subdirectory — the intro folder must be flat (release assets are a flat list)`,
+				`readme/${entry.name}/ is a subdirectory — the readme folder must be flat (release assets are a flat list)`,
 			)
 		}
 	}
 
 	const mdFiles = entries
-		.filter(
-			(entry) =>
-				entry.isFile() && /^intro\.[A-Za-z0-9-]+\.md$/.test(entry.name),
-		)
+		.filter((entry) => entry.isFile() && README_FILE_RE.test(entry.name))
 		.map((entry) => entry.name)
 
 	if (mdFiles.length === 0) {
 		issues.push(
-			"intro/ has no intro.<locale>.md — the release would ship images but the marketplace could not display an introduction",
+			"readme/ has no README.md / README.<locale>.md — the release would ship images but the marketplace could not display a readme",
 		)
 	}
 
-	// 2. Flat, present image references inside each intro markdown.
+	// 2. Flat, present image references inside each readme markdown.
 	for (const name of mdFiles) {
-		const text = readFileSync(join(INTRO_DIR, name), "utf-8")
+		const text = readFileSync(join(README_DIR, name), "utf-8")
 		for (const src of collectImageRefs(text)) {
-			if (isRelative(src)) resolveRelativeRef(src, `intro/${name}`, issues)
+			if (isRelative(src)) resolveRelativeRef(src, `readme/${name}`, issues)
 		}
 	}
 
 	if (issues.length > 0) {
-		console.error("[check-intro] gate failed:")
+		console.error("[check-readme] gate failed:")
 		for (const issue of issues) console.error(`  - ${issue}`)
 		console.error(`\n${RULE_SUMMARY}`)
 		process.exit(1)
 	}
 
 	console.log(
-		`[check-intro] intro/ ok — ${mdFiles.length} introduction file(s), flat references only.`,
+		`[check-readme] readme/ ok — ${mdFiles.length} readme file(s), flat references only.`,
 	)
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hoardodile/create-plugin",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "license": "MIT",
   "description": "Scaffold a hoardodile content plugin.",
   "keywords": [
@@ -37,7 +37,7 @@
   "dependencies": {
     "@clack/prompts": "^1.7.0",
     "zod": "^4.4.3",
-    "@hoardodile/sdk-types": "0.1.5"
+    "@hoardodile/sdk-types": "0.1.6"
   },
   "devDependencies": {
     "@types/node": "^26.2.0",