create-valaxy 0.28.0 → 0.28.1

package/dist/index.mjs

@@ -1,6 +1,6 @@
-import r from"node:fs";import s from"node:path";import C from"node:process";import{fileURLToPath as V}from"node:url";import{colors as e}from"consola/utils";import{execa as T}from"execa";import M from"minimist";import u from"prompts";const R="0.28.0",j={name:"starter",repo:"https://github.com/valaxyjs/valaxy-theme-starter"};async function B(n){const t=j.name;let o=n.themeName||t;const y=`valaxy-theme-${o.trim()}`;return console.log(`  ${e.dim("npx")} ${e.gray("degit")} ${e.blue(j.repo)} ${e.yellow(y)}`),await T("npx",["degit",j.repo,y],{stdio:"inherit"}),console.log(),console.log(`  ${e.bold("Check it")}:`),console.log(),console.log(`- Change ${e.bold("author")} name in ${e.yellow("LICENSE")} & ${e.green("package.json")} & ${e.blue(".github")}`),console.log(`- Change ${e.blue("valaxy.config.ts")} theme: ${e.yellow("starter")} to ${e.cyan(`${o}`)}`),console.log(`- Rename ${e.yellow(`valaxy-theme-${o}`)} to ${e.cyan(`valaxy-theme-${o}`)}`),console.log(),console.log(`  ${e.cyan("\u2728")}`),console.log(),`valaxy-theme-${o}`}const H={_gitignore:".gitignore",_npmrc:".npmrc"},J=[{name:"yun",display:"Yun",desc:"A light & clean theme (default)",color:e.cyan},{name:"press",display:"Press",desc:"A document-oriented theme",color:e.green},{name:"custom",display:"Custom",desc:"Enter a custom theme name",color:e.yellow}],k=[{name:"blog",display:"Blog",desc:"For Most Users",message:"Project name:",initial:"valaxy-blog",color:e.cyan},{name:"theme",display:"Theme",desc:"For Theme Developers",message:"Theme name: valaxy-theme-",initial:"starter",prefix:"valaxy-theme-",color:e.green,customInit:async n=>B(n).catch(t=>{console.error(t)})},{name:"addon",display:"Addon",desc:"For Addon Developers",message:"Addon name: valaxy-addon-",initial:"template",prefix:"valaxy-addon-",color:e.yellow}],_=k.map(n=>n.name),A="valaxy-theme-";function Y(n){const t=n.trim();return t.startsWith(A)?t.slice(A.length):t}function G(n,t){const o={...n,dependencies:{...n.dependencies}};return t==="yun"||(o.dependencies?.["valaxy-theme-yun"]&&delete o.dependencies["valaxy-theme-yun"],o.dependencies[`valaxy-theme-${t}`]="latest"),o}function K(n,t){if(t==="yun")return n;let o=n;return o=o.replace("import type { UserThemeConfig } from 'valaxy-theme-yun'",`// import type { UserThemeConfig } from 'valaxy-theme-${t}'`),o=o.replace("theme: 'yun'",`theme: '${t}'`),o=o.replace("defineValaxyConfig<UserThemeConfig>","defineValaxyConfig"),o=o.replace(/themeConfig: \{[\s\S]*?\n {2}\},/,"themeConfig: {},"),o}function P(n){return n?.trim().replace(/\/+$/g,"")}function Q(n){const t=r.readdirSync(n);return t.length===0||t.length===1&&t[0]===".git"}function D(n,t){r.statSync(n).isDirectory()?W(n,t):r.copyFileSync(n,t)}function W(n,t){r.mkdirSync(t,{recursive:!0});for(const o of r.readdirSync(n)){const y=s.resolve(n,o),c=s.resolve(t,o);D(y,c)}}function q(n){if(console.log(`
-  ${e.red("Removing")} ${e.dim(n)}`),!!r.existsSync(n))for(const t of r.readdirSync(n))t!==".git"&&r.rmSync(s.resolve(n,t),{recursive:!0,force:!0})}function I(n){return/^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(n)}function O(n){return n.trim().toLowerCase().replace(/\s+/g,"-").replace(/^[._]/,"").replace(/[^a-z\d\-~]+/g,"-")}function X(n){if(!n)return;const t=n.split(" ")[0].split("/");return{name:t[0],version:t[1]}}const p=M(C.argv.slice(2)),N=C.cwd(),Z="valaxy-blog",ee=V(import.meta.url);async function ne(){console.log(),console.log(`  ${e.bold("\u{1F30C} Valaxy")}  ${e.blue(`v${R}`)}`),console.log();const n=P(p._[0]),t=p.template||p.t,o=p.y||p.yes,y=p.port||p.p;let c=n||Z;const f=()=>c==="."?s.basename(s.resolve()):c;let x,l=k[0],h="yun";if(o)x={projectName:c,overwrite:!1,packageName:O(f())};else{if(l=(await u({type:t&&_.includes(t)?null:"select",name:"template",message:typeof t=="string"&&!_.includes(t)?e.reset(`"${t}" isn't a valid template. Please choose from below: `):e.reset("Select a type:"),initial:0,choices:k.map(a=>{const i=a.color;return{title:i(a.display||a.name)+e.dim(` - ${a.desc}`),value:a}})})).template,l.name==="blog"){const a=await u({type:"select",name:"theme",message:e.reset("Select a theme:"),initial:0,choices:J.map(i=>{const b=i.color;return{title:b(i.display)+e.dim(` - ${i.desc}`),value:i.name}})});if(a.theme==="custom"){const i=await u({type:"text",name:"themeName",message:e.reset('Theme name (e.g. "starter" or "valaxy-theme-starter"):'),initial:"yun"});h=Y(i.themeName||"yun")}else h=a.theme||"yun"}try{x=await u([{type:n?null:"text",name:"projectName",message:e.reset(l.message),initial:l.initial,onState:a=>{c=P(l.prefix?l.prefix+a.value:a.value)||l.initial}},{type:()=>!r.existsSync(c)||Q(c)?null:"confirm",name:"overwrite",message:()=>`${c==="."?"Current directory":`Target directory "${c}"`} is not empty. Remove existing files and continue?`},{type:(a,{overwrite:i})=>{if(i===!1)throw new Error(`${e.red("\u2716")} Operation cancelled`);return null},name:"overwriteChecker"},{type:()=>I(f())?null:"text",name:"packageName",message:e.reset("Package name:"),initial:()=>O(f()),validate:a=>I(a)||"Invalid package.json name"}],{onCancel:()=>{throw new Error(`${e.red("\u2716")} Operation cancelled`)}})}catch(a){console.log(a.message);return}}const{projectName:v,overwrite:L}=x,z=l.prefix?l.prefix+v:v,g=s.join(N,z);if(L?q(g):r.existsSync(g)||r.mkdirSync(g,{recursive:!0}),l.customInit)await l.customInit({themeName:v});else{const a=s.resolve(ee,"../..",`template-${l.name}`),i=(m,d)=>{const F=s.join(g,H[m]??m);d?r.writeFileSync(F,d):D(s.join(a,m),F)},b=r.readdirSync(a);for(const m of b.filter(d=>d!=="package.json"))i(m);const $=JSON.parse(r.readFileSync(s.join(a,"package.json"),"utf-8"));if($.name=v||f(),l.name==="blog"){const m=G($,h);Object.assign($,m)}if(i("package.json",`${JSON.stringify($,null,2)}
-`),l.name==="blog"){const m=s.join(g,"valaxy.config.ts");if(r.existsSync(m)){const d=r.readFileSync(m,"utf-8");r.writeFileSync(m,K(d,h))}}}console.log(`  ${e.dim("\u{1F4C1}")} ${e.dim(g)}`),console.log(),console.log(e.dim("  Scaffolding project in ")+c+e.dim(" ..."));const E=X(C.env.npm_config_user_agent),w=E?E.name:"npm",U=s.relative(N,g);if(console.log(e.green(`  Done.
-`)),l.name==="addon")return;let S;if(o?S=!1:{yes:S}=await u({type:"confirm",name:"yes",initial:"Y",message:"Install and start it now?"}),S){let a;if(o?a="pnpm":{agent:a}=await u({name:"agent",type:"select",message:"Choose the agent",choices:["npm","yarn","pnpm","bun"].map(i=>({value:i,title:i})),initial:2}),!a)return;await T(a,["install"],{stdio:"inherit",cwd:g}),await T(a,y?["run","dev","--port",y]:["run","dev"],{stdio:"inherit",cwd:g})}else{switch(console.log(e.dim(`
+import r from"node:fs";import s from"node:path";import C from"node:process";import{fileURLToPath as P}from"node:url";import{colors as e}from"consola/utils";import{execa as j}from"execa";import V from"minimist";import f from"prompts";const B="0.28.1",k={name:"starter",repo:"https://github.com/valaxyjs/valaxy-theme-starter"};async function H(t){const n=k.name;let o=t.themeName||n;const y=`valaxy-theme-${o.trim()}`;return console.log(`  ${e.dim("npx")} ${e.gray("degit")} ${e.blue(k.repo)} ${e.yellow(y)}`),await j("npx",["degit",k.repo,y],{stdio:"inherit"}),console.log(),console.log(`  ${e.bold("Check it")}:`),console.log(),console.log(`- Change ${e.bold("author")} name in ${e.yellow("LICENSE")} & ${e.green("package.json")} & ${e.blue(".github")}`),console.log(`- Change ${e.blue("valaxy.config.ts")} theme: ${e.yellow("starter")} to ${e.cyan(`${o}`)}`),console.log(`- Rename ${e.yellow(`valaxy-theme-${o}`)} to ${e.cyan(`valaxy-theme-${o}`)}`),console.log(),console.log(`  ${e.cyan("\u2728")}`),console.log(),`valaxy-theme-${o}`}const J={_gitignore:".gitignore",_npmrc:".npmrc"},W=[{name:"yun",display:"Yun",desc:"A light & clean theme (default)",color:e.cyan},{name:"press",display:"Press",desc:"A document-oriented theme",color:e.green},{name:"custom",display:"Custom",desc:"Enter a custom theme name",color:e.yellow}],N=[{name:"blog",display:"Blog",desc:"For Most Users",message:"Project name:",initial:"valaxy-blog",color:e.cyan},{name:"theme",display:"Theme",desc:"For Theme Developers",message:"Theme name: valaxy-theme-",initial:"starter",prefix:"valaxy-theme-",color:e.green,customInit:async t=>H(t).catch(n=>{console.error(n)})},{name:"addon",display:"Addon",desc:"For Addon Developers",message:"Addon name: valaxy-addon-",initial:"template",prefix:"valaxy-addon-",color:e.yellow}],A=N.map(t=>t.name),I="valaxy-theme-",Y=/^[a-z\d\-_]+$/,G=P(import.meta.url);function D(t){if(!Y.test(t))throw new Error(`Invalid theme name: "${t}"`);return s.resolve(G,"../..",`template-blog-${t}`)}function X(t){try{return r.existsSync(D(t))}catch{return!1}}function q(t){const n=t.trim();return n.startsWith(I)?n.slice(I.length):n}function K(t,n){const o={...t,dependencies:{...t.dependencies}};return n==="yun"||(o.dependencies?.["valaxy-theme-yun"]&&delete o.dependencies["valaxy-theme-yun"],o.dependencies[`valaxy-theme-${n}`]="latest"),o}function Q(t,n){if(n==="yun")return t;let o=t;return o=o.replace("import type { UserThemeConfig } from 'valaxy-theme-yun'",`// import type { UserThemeConfig } from 'valaxy-theme-${n}'`),o=o.replace("theme: 'yun'",`theme: '${n}'`),o=o.replace("defineValaxyConfig<UserThemeConfig>","defineValaxyConfig"),o=o.replace(/themeConfig: \{[\s\S]*?\n {2}\},/,"themeConfig: {},"),o}function O(t){return t?.trim().replace(/\/+$/g,"")}function Z(t){const n=r.readdirSync(t);return n.length===0||n.length===1&&n[0]===".git"}function E(t,n){r.statSync(t).isDirectory()?ee(t,n):r.copyFileSync(t,n)}function ee(t,n){r.mkdirSync(n,{recursive:!0});for(const o of r.readdirSync(t)){const y=s.resolve(t,o),m=s.resolve(n,o);E(y,m)}}function te(t){if(console.log(`
+  ${e.red("Removing")} ${e.dim(t)}`),!!r.existsSync(t))for(const n of r.readdirSync(t))n!==".git"&&r.rmSync(s.resolve(t,n),{recursive:!0,force:!0})}function z(t){return/^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(t)}function L(t){return t.trim().toLowerCase().replace(/\s+/g,"-").replace(/^[._]/,"").replace(/[^a-z\d\-~]+/g,"-")}function ne(t){if(!t)return;const n=t.split(" ")[0].split("/");return{name:n[0],version:n[1]}}const d=V(C.argv.slice(2)),F=C.cwd(),oe="valaxy-blog",ae=P(import.meta.url);async function re(){console.log(),console.log(`  ${e.bold("\u{1F30C} Valaxy")}  ${e.blue(`v${B}`)}`),console.log();const t=O(d._[0]),n=d.template||d.t,o=d.y||d.yes,y=d.port||d.p;let m=t||oe;const v=()=>m==="."?s.basename(s.resolve()):m;let w,l=N[0],u="yun";if(o)w={projectName:m,overwrite:!1,packageName:L(v())};else{if(l=(await f({type:n&&A.includes(n)?null:"select",name:"template",message:typeof n=="string"&&!A.includes(n)?e.reset(`"${n}" isn't a valid template. Please choose from below: `):e.reset("Select a type:"),initial:0,choices:N.map(a=>{const i=a.color;return{title:i(a.display||a.name)+e.dim(` - ${a.desc}`),value:a}})})).template,l.name==="blog"){const a=await f({type:"select",name:"theme",message:e.reset("Select a theme:"),initial:0,choices:W.map(i=>{const T=i.color;return{title:T(i.display)+e.dim(` - ${i.desc}`),value:i.name}})});if(a.theme==="custom"){const i=await f({type:"text",name:"themeName",message:e.reset('Theme name (e.g. "starter" or "valaxy-theme-starter"):'),initial:"yun"});u=q(i.themeName||"yun")}else u=a.theme||"yun"}try{w=await f([{type:t?null:"text",name:"projectName",message:e.reset(l.message),initial:l.initial,onState:a=>{m=O(l.prefix?l.prefix+a.value:a.value)||l.initial}},{type:()=>!r.existsSync(m)||Z(m)?null:"confirm",name:"overwrite",message:()=>`${m==="."?"Current directory":`Target directory "${m}"`} is not empty. Remove existing files and continue?`},{type:(a,{overwrite:i})=>{if(i===!1)throw new Error(`${e.red("\u2716")} Operation cancelled`);return null},name:"overwriteChecker"},{type:()=>z(v())?null:"text",name:"packageName",message:e.reset("Package name:"),initial:()=>L(v()),validate:a=>z(a)||"Invalid package.json name"}],{onCancel:()=>{throw new Error(`${e.red("\u2716")} Operation cancelled`)}})}catch(a){console.log(a.message);return}}const{projectName:$,overwrite:U}=w,M=l.prefix?l.prefix+$:$,g=s.join(F,M);if(U?te(g):r.existsSync(g)||r.mkdirSync(g,{recursive:!0}),l.customInit)await l.customInit({themeName:$});else{const a=s.resolve(ae,"../..",`template-${l.name}`),i=(c,p)=>{const h=s.join(g,J[c]??c);p?r.writeFileSync(h,p):E(s.join(a,c),h)},T=r.readdirSync(a);for(const c of T.filter(p=>p!=="package.json"))i(c);const x=JSON.parse(r.readFileSync(s.join(a,"package.json"),"utf-8"));if(x.name=$||v(),l.name==="blog"){const c=K(x,u);Object.assign(x,c)}if(i("package.json",`${JSON.stringify(x,null,2)}
+`),l.name==="blog")if(X(u)){const c=D(u),p=r.readdirSync(c);for(const h of p)E(s.join(c,h),s.join(g,h))}else{const c=s.join(g,"valaxy.config.ts");if(r.existsSync(c)){const p=r.readFileSync(c,"utf-8");r.writeFileSync(c,Q(p,u))}}}console.log(`  ${e.dim("\u{1F4C1}")} ${e.dim(g)}`),console.log(),console.log(e.dim("  Scaffolding project in ")+m+e.dim(" ..."));const _=ne(C.env.npm_config_user_agent),S=_?_.name:"npm",R=s.relative(F,g);if(console.log(e.green(`  Done.
+`)),l.name==="addon")return;let b;if(o?b=!1:{yes:b}=await f({type:"confirm",name:"yes",initial:"Y",message:"Install and start it now?"}),b){let a;if(o?a="pnpm":{agent:a}=await f({name:"agent",type:"select",message:"Choose the agent",choices:["npm","yarn","pnpm","bun"].map(i=>({value:i,title:i})),initial:2}),!a)return;await j(a,["install"],{stdio:"inherit",cwd:g}),await j(a,y?["run","dev","--port",y]:["run","dev"],{stdio:"inherit",cwd:g})}else{switch(console.log(e.dim(`
   start it later by:
-`)),g!==N&&console.log(`  ${e.green("cd")} ${e.blue(U)}`),w){case"yarn":console.log(`  ${e.green("yarn")}`),console.log(`  ${e.green("yarn")} dev`);break;default:console.log(`  ${e.green(w)} install`),console.log(`  ${e.green(w)} run dev`);break}console.log(),console.log(`  ${e.cyan("\u2728")}`)}}ne().catch(n=>{console.error(n)});
+`)),g!==F&&console.log(`  ${e.green("cd")} ${e.blue(R)}`),S){case"yarn":console.log(`  ${e.green("yarn")}`),console.log(`  ${e.green("yarn")} dev`);break;default:console.log(`  ${e.green(S)} install`),console.log(`  ${e.green(S)} run dev`);break}console.log(),console.log(`  ${e.cyan("\u2728")}`)}}re().catch(t=>{console.error(t)});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-valaxy",
   "type": "module",
-  "version": "0.28.0",
+  "version": "0.28.1",
   "description": "Create Starter Template for Valaxy",
   "author": {
     "email": "me@yunyoujun.cn",

package/template-blog/package.json

@@ -12,8 +12,8 @@
     "serve": "vite preview"
   },
   "dependencies": {
-    "valaxy": "0.28.0",
-    "valaxy-theme-yun": "0.28.0"
+    "valaxy": "0.28.1",
+    "valaxy-theme-yun": "0.28.1"
   },
   "devDependencies": {
     "typescript": "^5.9.3"

package/template-blog-press/pages/index.md

@@ -0,0 +1,23 @@
+---
+layout: home
+
+hero:
+  name: My Site
+  text: Welcome to My Site
+  tagline: Powered by Valaxy
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /
+
+features:
+  - icon: i-ri-book-2-line
+    title: Documentation
+    details: Write docs with Markdown and Vue components.
+  - icon: i-ri-flashlight-line
+    title: Fast
+    details: Powered by Vite for instant HMR and fast builds.
+  - icon: i-ri-palette-line
+    title: Customizable
+    details: Fully customizable theme with flexible configuration.
+---

package/template-blog-press/site.config.ts

@@ -0,0 +1,11 @@
+import { defineSiteConfig } from 'valaxy'
+
+export default defineSiteConfig({
+  lang: 'en',
+  title: 'My Site',
+  description: 'My documentation site powered by Valaxy.',
+  search: {
+    enable: true,
+    provider: 'fuse',
+  },
+})

package/template-blog-press/valaxy.config.ts

@@ -0,0 +1,21 @@
+import { defineValaxyConfig } from 'valaxy'
+
+export default defineValaxyConfig({
+  theme: 'press',
+  themeConfig: {
+    nav: [
+      { text: 'Home', link: '/' },
+    ],
+    sidebar: [],
+    footer: {
+      message: 'Powered by <a href="https://valaxy.site">Valaxy</a>',
+    },
+  },
+  unocss: {
+    safelist: [
+      'i-ri-book-2-line',
+      'i-ri-flashlight-line',
+      'i-ri-palette-line',
+    ],
+  },
+})