create-vuepress-theme-plume 1.0.0-rc.104 → 1.0.0-rc.106

package/lib/index.js

@@ -39,17 +39,6 @@ import { execaCommand } from "execa";
 import path2 from "node:path";
 import { fileURLToPath } from "node:url";
 
-// src/utils/depsVersion.ts
-var api = "https://api.pengzhanbo.cn/npm/dependencies/version";
-async function getDependenciesVersion(dependencies, version = "latest") {
-  const result = await fetch(api, {
-    method: "POST",
-    headers: { "content-type": "application/json" },
-    body: JSON.stringify({ dependencies, version })
-  }).then((res) => res.json());
-  return result;
-}
-
 // src/utils/fs.ts
 import fs from "node:fs/promises";
 import path from "node:path";
@@ -138,22 +127,22 @@ async function createPackageJson(mode, pkg, {
     }
   }
   pkg.devDependencies ??= {};
+  const hasDep = (dep) => pkg.devDependencies?.[dep] || pkg.dependencies?.[dep];
   const context = await readJsonFile(resolve("package.json"));
-  const meta = context["theme-plume"];
+  const meta = context["plume-deps"];
+  pkg.devDependencies[`@vuepress/bundler-${bundler}`] = `${meta.vuepress}`;
   pkg.devDependencies.vuepress = `${meta.vuepress}`;
   pkg.devDependencies["vuepress-theme-plume"] = `${context.version}`;
-  pkg.devDependencies[`@vuepress/bundler-${bundler}`] = `${meta.vuepress}`;
   pkg.devDependencies["http-server"] = "^14.1.1";
   const deps = [];
-  if (!pkg.dependencies?.vue && !pkg.devDependencies.vue)
+  if (!hasDep("vue"))
     deps.push("vue");
-  if (bundler === "webpack" && !pkg.dependencies?.["sass-loader"] && !pkg.devDependencies["sass-loader"])
+  if (bundler === "webpack" && !hasDep("sass-loader"))
     deps.push("sass-loader");
-  if (!pkg.dependencies?.["sass-embedded"] && !pkg.devDependencies["sass-embedded"])
+  if (!hasDep("sass-embedded"))
     deps.push("sass-embedded");
-  const dv = await getDependenciesVersion(deps);
-  for (const [d, v] of Object.entries(dv))
-    pkg.devDependencies[d] = `^${v}`;
+  for (const dep of deps)
+    pkg.devDependencies[dep] = meta[dep];
   return {
     filepath: "package.json",
     content: JSON.stringify(pkg, null, 2)
@@ -495,17 +484,35 @@ async function run(mode, root) {
   const data = resolveData(result, mode);
   const progress = spinner();
   progress.start(t("spinner.start"));
-  await generate(mode, data);
+  try {
+    await generate(mode, data);
+  } catch (e) {
+    console.error(`${colors.red("generate files error: ")}
+`, e);
+    process4.exit(1);
+  }
   await sleep(200);
   const cwd = path4.join(process4.cwd(), data.root);
   if (data.git) {
     progress.message(t("spinner.git"));
-    await execaCommand3("git init", { cwd });
+    try {
+      await execaCommand3("git init", { cwd });
+    } catch (e) {
+      console.error(`${colors.red("git init error: ")}
+`, e);
+      process4.exit(1);
+    }
   }
   const pm = data.packageManager;
   if (data.install) {
     progress.message(t("spinner.install"));
-    await execaCommand3(pm === "yarn" ? "yarn" : `${pm} install`, { cwd });
+    try {
+      await execaCommand3(pm === "yarn" ? "yarn" : `${pm} install`, { cwd });
+    } catch (e) {
+      console.error(`${colors.red("install dependencies error: ")}
+`, e);
+      process4.exit(1);
+    }
   }
   const cdCommand = mode === 1 /* create */ ? colors.green(`cd ${data.root}`) : "";
   const runCommand = colors.green(pm === "yarn" ? "yarn docs:dev" : `${pm} run docs:dev`);
@@ -531,5 +538,5 @@ var cli = cac("create-vuepress-theme-plume");
 cli.command("[root]", "create a new vuepress-theme-plume project / \u521B\u5EFA\u65B0\u7684 vuepress-theme-plume \u9879\u76EE").action((root) => run(1 /* create */, root));
 cli.command("init [root]", "Initial vuepress-theme-plume in the existing project / \u5728\u73B0\u6709\u9879\u76EE\u4E2D\u521D\u59CB\u5316 vuepress-theme-plume").action((root) => run(0 /* init */, root));
 cli.help();
-cli.version("1.0.0-rc.103");
+cli.version("1.0.0-rc.105");
 cli.parse();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-vuepress-theme-plume",
   "type": "module",
-  "version": "1.0.0-rc.104",
+  "version": "1.0.0-rc.106",
   "description": "The cli for create vuepress-theme-plume's project",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo/)",
   "license": "MIT",
@@ -34,8 +34,11 @@
     "handlebars": "^4.7.8",
     "picocolors": "^1.1.0"
   },
-  "theme-plume": {
-    "vuepress": "2.0.0-rc.15"
+  "plume-deps": {
+    "vuepress": "2.0.0-rc.17",
+    "vue": "^3.5.10",
+    "sass-embedded": "^1.79.4",
+    "sass-loader": "^16.0.2"
   },
   "scripts": {
     "build": "tsup"

package/templates/.vuepress/config.ts.handlebars

@@ -1,5 +1,5 @@
-import { defineUserConfig } from 'vuepress'
 import { {{ bundler }}Bundler } from '@vuepress/bundler-{{ bundler }}'
+import { defineUserConfig } from 'vuepress'
 import { plumeTheme } from 'vuepress-theme-plume'
 
 export default defineUserConfig({
@@ -32,8 +32,8 @@ export default defineUserConfig({
        * @see https://theme-plume.vuejs.press/config/plugins/code-highlight/
        */
       // shiki: {
+           // 强烈建议预设代码块高亮语言，插件默认加载所有语言会产生不必要的时间开销
       //   languages: ['shell', 'bash', 'typescript', 'javascript'],
-      //   twoslash: true,
       // },
 
       /**
@@ -72,7 +72,7 @@ export default defineUserConfig({
       // },
 
       /**
-       * comments
+       * 评论 comments
        * @see https://theme-plume.vuejs.press/guide/features/comments/
        */
       // comment: {

package/templates/common/README.md.handlebars

@@ -51,6 +51,23 @@ npm run vp-update
 ```
 {{/if}}
 
+{{#if (equal deploy "github")}}
+## Deploy to GitHub Pages
+
+The plume theme has been created with GitHub Actions: `.github/workflows/docs-deploy.yml`. You also need to make the following settings in the GitHub repository:
+
+- [ ] `settings > Actions > General`, Scroll to the bottom of the page, under `Workflow permissions`, check `Read and write permissions`, and click the save button.
+
+- [ ] `settings > Pages`, In `Build and deployment`, select `Deploy from a branch` for `Source`, choose `gh-pages` for `Branch`, and click the save button.
+  (The `gh-pages` branch may not exist upon first creation. You can complete the above setup first, push the code to the main branch, wait for `github actions` to finish, and then proceed with the setup.)
+
+- [ ] Modify the `base` option in `docs/.vuepress/config.ts`:
+  - If you are planning to deploy to `https://<USERNAME>.github.io/`, you can skip this step as `base` defaults to `"/"`.
+  - If you are planning to deploy to `https://<USERNAME>.github.io/<REPO>/`, meaning your repository URL is `https://github.com/<USERNAME>/<REPO>`, set `base` to `"/<REPO>/"`.
+
+To customize a domain name, please refer to [Github Pages](https://docs.github.com/zh/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)
+
+{{/if}}
 ## Documents
 
 - [vuepress](https://vuepress.vuejs.org/)

package/templates/common/README.zh-CN.md.handlebars

@@ -51,6 +51,23 @@ npm run vp-update
 ```
 {{/if}}
 
+{{#if (equal deploy "github")}}
+## 部署到 GitHub Pages
+
+主题已创建 github actions: `.github/workflows/docs-deploy.yml`，你还需要在 github 仓库中进行以下设置：
+
+- [ ] `settings > Actions > General`，拉到页面底部，在 `Workflow permissions` 下，勾选 `Read and write permissions`，并点击保存按钮
+
+- [ ] `settings > Pages`, 在 `Build and deployment` 中，`Source` 选择 `Deploy from a branch`, `Branch` 选择 `gh-pages`，并点击保存按钮
+  (首次创建可能没有 `gh-pages`分支，你可以先完成上面的设置后，推送一次代码到主分支，等待 `github actions` 完成后再进行设置)
+
+- [ ] 修改 `docs/.vuepress/config.ts` 中的 `base` 选项：
+  - 如果你准备发布到 `https://<USERNAME>.github.io/` ，你可以省略这一步，因为 `base` 默认就是 `"/"` 。
+  - 如果你准备发布到 `https://<USERNAME>.github.io/<REPO>/` ，也就是说你的仓库地址是 `https://github.com/<USERNAME>/<REPO>` ，则将 `base` 设置为 `"/<REPO>/"`。
+
+如需要自定义域名，请查看 [Github Pages 文档](https://docs.github.com/zh/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)
+
+{{/if}}
 ## 文档
 
 - [vuepress](https://vuepress.vuejs.org/)