@tomjs/create-app 0.0.6 → 0.0.7

package/README.md

@@ -2,7 +2,7 @@
 
 ![npm](https://img.shields.io/npm/v/%40tomjs/create-app) ![NPM](https://img.shields.io/npm/l/%40tomjs%2Fcreate-app) ![npm package minimized gzipped size (scoped version select exports)](https://img.shields.io/bundlejs/size/%40tomjs/create-app)
 
-Create a web application based on the tomjs configuration, recommended `node>=18`
+Create a web application based on [vite](https://github.com/vitejs/vite) + [tomjs](https://github.com/tomgao365/tomjs), recommended `node>=18`
 
 **English** | [中文](./README.zh_CN.md)
 
@@ -33,33 +33,33 @@ You can also directly specify the project name, template, and module type.
 - Using `npm`
 
 ```bash
-npm create @tomjs/app@latest my-app -- --template vue --module
+npm create @tomjs/app@latest my-app -- --template vue
 ```
 
 - Using `yarn`
 
 ```bash
-yarn create @tomjs/app my-app --template vue --module
+yarn create @tomjs/app my-app --template vue
 ```
 
 - Using `pnpm`
 
 ```bash
-pnpm create @tomjs/app --template vue --module
+pnpm create @tomjs/app --template vue
 ```
 
 Parameters:
 
 - `-t --template` : specify the template, optional values: `vue` , `react`
-- `-m --module` : `package.json` uses `type:"module"`, otherwise use `commonjs`
 
 Support templates:
 
 - vue
-- vue + electron
+- electron-vue
 - react
-- react + electron
+- electron-react
 
 ## Reference project
 
 - [create-vite](https://github.com/vitejs/vite/tree/main/packages/create-vite)
+- [electron-vite-vue](https://github.com/electron-vite/electron-vite-vue)

package/README.zh_CN.md

@@ -2,7 +2,7 @@
 
 ![npm](https://img.shields.io/npm/v/%40tomjs/create-app) ![NPM](https://img.shields.io/npm/l/%40tomjs%2Fcreate-app) ![npm package minimized gzipped size (scoped version select exports)](https://img.shields.io/bundlejs/size/%40tomjs/create-app)
 
-创建基于 tomjs 配置的 web 应用，推荐 `node>=18`
+创建基于 [vite](https://github.com/vitejs/vite) + [tomjs](https://github.com/tomgao365/tomjs) 的 web 应用，推荐 `node>=18`
 
 [English](./README.md) | **中文**
 
@@ -34,56 +34,33 @@ pnpm create @tomjs/app
 
 ```bash
 npm create @tomjs/app@latest
-npm create @tomjs/app@latest my-app -- --template vue --module
+npm create @tomjs/app@latest my-app -- --template vue
 ```
 
 - 使用 `yarn`
 
 ```bash
-yarn create @tomjs/app my-app --template vue --module
+yarn create @tomjs/app my-app --template vue
 ```
 
 - 使用 `pnpm`
 
 ```bash
-pnpm create @tomjs/app my-app --template vue --module
+pnpm create @tomjs/app my-app --template vue
 ```
 
 参数说明:
 
 - `-t --template`：指定模板，可选值：`vue`、`react`
-- `-m --module`：`package.json` 使用 `type:"module"`，否则使用 `commonjs`
 
 支持模板:
 
 - vue
+- electron-vue
 - react
-
-## 项目配置
-
-项目配置在 `package.json` 中，可配置项如下：
-
-````json
-{
-  "name": "my-app",
-  "version": "0.0.1",
-  "description": "",
-  "main": "src/main.ts",
-}
-
-## 项目结构
-
-```bash
-.
-├── README.md
-├── package.json
-├── src
-│   ├── App.vue
-│   ├── main.ts
-│   └── shims-vue.d.ts
-├── tsconfig.json
+- electron-react
 
 ## 参考项目
 
 - [create-vite](https://github.com/vitejs/vite/tree/main/packages/create-vite)
-````
+- [electron-vite-vue](https://github.com/electron-vite/electron-vite-vue)

package/dist/index.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import c from"fs";import a from"path";import{fileURLToPath as K}from"url";import{blue as D,cyan as q,green as B,red as $,reset as l,yellow as V}from"kolorist";import G from"minimist";import H from"prompts";import s from"fs";import k from"path";function T(e){return[["t","template"],["m","module"]].forEach(([t,r])=>{e[r]=e[r]??e[t]}),e}function _(e){let t=s.readdirSync(e);return t.length===0||t.length===1&&t[0]===".git"}function S(e){return e?.trim().replace(/\/+$/g,"")}function J(e,t){s.mkdirSync(t,{recursive:!0});for(let r of s.readdirSync(e)){let m=k.resolve(e,r),u=k.resolve(t,r);w(m,u)}}function w(e,t){s.statSync(e).isDirectory()?J(e,t):s.copyFileSync(e,t)}function E(e){if(s.existsSync(e))for(let t of s.readdirSync(e))t!==".git"&&s.rmSync(k.resolve(e,t),{recursive:!0,force:!0})}function j(e){return/^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(e)}function A(e){return e.trim().toLowerCase().replace(/\s+/g,"-").replace(/^[._]/,"").replace(/[^a-z\d\-~]+/g,"-")}function C(e){if(!e)return;let r=e.split(" ")[0].split("/");return{name:r[0],version:r[1]}}var g=T(G(process.argv.slice(2),{string:["_"]})),F=process.cwd(),R=[{name:"vue",display:"Vue",color:B,variants:[{name:"vue",display:"Web",color:D},{name:"electron-vue",display:"Electron",color:V}]},{name:"react",display:"React",color:q,variants:[{name:"react",display:"Web",color:D},{name:"electron-react",display:"Electron",color:V}]}],M=R.map(e=>e.variants&&e.variants.map(t=>t.name)||[e.name]).reduce((e,t)=>e.concat(t),[]),Q={_gitignore:".gitignore","_lintstagedrc.js":".lintstagedrc.js"},h="my-app";async function X(){let e=S(g._[0]),t=g.template||g.t,r=e||h,m=()=>r==="."?a.basename(a.resolve()):r,u=await H([{type:e?null:"text",name:"projectName",message:l("Project name:"),initial:h,onState:n=>{r=S(n.value)||h}},{type:()=>!c.existsSync(r)||_(r)?null:"toggle",name:"overwrite",message:()=>(r==="."?"Current directory":`Target directory "${r}"`)+" is not empty. Remove existing files and continue?",initial:!1,active:"yes",inactive:"no"},{type:(n,{overwrite:o})=>{if(o===!1)throw new Error($("\u2716")+" Operation cancelled");return null},name:"overwriteChecker"},{type:()=>j(m())?null:"text",name:"packageName",message:l("Package name:"),initial:()=>A(m()),validate:n=>j(n)||"Invalid package.json name"},{type:t&&M.includes(t)?null:"select",name:"framework",message:typeof t=="string"&&!M.includes(t)?l(`"${t}" isn't a valid template. Please choose from below: `):l("Select a framework:"),initial:0,choices:R.map(n=>{let o=n.color;return{title:o(n.display||n.name),value:n}})},{type:n=>n&&n.variants?"select":null,name:"variant",message:l("Select a variant:"),choices:n=>n.variants.map(o=>{let p=o.color;return{title:p(o.display||o.name),value:o.name}})},{type:()=>g.module!==void 0?null:"toggle",name:"isModuleType",message:l("Is it set to module type?"),initial:!1,active:"yes",inactive:"no"}],{onCancel:()=>{throw console.log($("\u2716")+" Operation cancelled"),new Error}}),{framework:z,overwrite:O,packageName:W,variant:I}=u,i=a.join(F,r);O?E(i):c.existsSync(i)||c.mkdirSync(i,{recursive:!0}),console.log(`
-Scaffolding project in ${i}...`);let L=I||z?.name||t,x=u.isModuleType??g.module,b=n=>a.join(K(import.meta.url),"../..",`template-${n}`),N=b(L);[N,b("config")].forEach(n=>{let o=c.readdirSync(n);for(let p of o){let f=Q[p]??p;x&&f.endsWith("rc.js")&&(f=f.replace(".js",".cjs"));let U=a.join(i,f);w(a.join(n,p),U)}});let d=JSON.parse(c.readFileSync(a.join(N,"package.json"),"utf-8"));d.name=W||m(),x?d.type="module":delete d.type,c.writeFileSync(a.join(i,"package.json"),JSON.stringify(d,null,2)+`
-`);let P=C(process.env.npm_config_user_agent),y=P?P.name:"npm",v=a.relative(F,i);switch(console.log(`
+import c from"fs";import a from"path";import{fileURLToPath as J}from"url";import{blue as A,cyan as K,green as q,red as D,reset as p,yellow as T}from"kolorist";import B from"minimist";import G from"prompts";import s from"fs";import d from"path";function P(e){return[["t","template"]].forEach(([t,n])=>{e[n]=e[n]??e[t]}),e}function _(e){let t=s.readdirSync(e);return t.length===0||t.length===1&&t[0]===".git"}function y(e){return e?.trim().replace(/\/+$/g,"")}function I(e,t){s.mkdirSync(t,{recursive:!0});for(let n of s.readdirSync(e)){let l=d.resolve(e,n),g=d.resolve(t,n);v(l,g)}}function v(e,t){s.statSync(e).isDirectory()?I(e,t):s.copyFileSync(e,t)}function b(e){if(s.existsSync(e))for(let t of s.readdirSync(e))t!==".git"&&s.rmSync(d.resolve(e,t),{recursive:!0,force:!0})}function k(e){return/^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(e)}function C(e){return e.trim().toLowerCase().replace(/\s+/g,"-").replace(/^[._]/,"").replace(/[^a-z\d\-~]+/g,"-")}function E(e){if(!e)return;let n=e.split(" ")[0].split("/");return{name:n[0],version:n[1]}}var w=P(B(process.argv.slice(2),{string:["_"]})),S=process.cwd(),R=[{name:"vue",display:"Vue",color:q,variants:[{name:"vue",display:"Web",color:A},{name:"electron-vue",display:"Electron",color:T}]},{name:"react",display:"React",color:K,variants:[{name:"react",display:"Web",color:A},{name:"electron-react",display:"Electron",color:T}]}],$=R.map(e=>e.variants&&e.variants.map(t=>t.name)||[e.name]).reduce((e,t)=>e.concat(t),[]),H={_gitignore:".gitignore","_lintstagedrc.cjs":".lintstagedrc.cjs"},F="my-app";async function Q(){let e=y(w._[0]),t=w.template||w.t,n=e||F,l=()=>n==="."?a.basename(a.resolve()):n,g={};g=await G([{type:e?null:"text",name:"projectName",message:p("Project name:"),initial:F,onState:r=>{n=y(r.value)||F}},{type:()=>!c.existsSync(n)||_(n)?null:"toggle",name:"overwrite",message:()=>(n==="."?"Current directory":`Target directory "${n}"`)+" is not empty. Remove existing files and continue?",initial:!1,active:"yes",inactive:"no"},{type:(r,{overwrite:o})=>{if(o===!1)throw console.log(D("\u2716")+" Operation cancelled"),new Error;return null},name:"overwriteChecker"},{type:()=>k(l())?null:"text",name:"packageName",message:p("Package name:"),initial:()=>C(l()),validate:r=>k(r)||"Invalid package.json name"},{type:t&&$.includes(t)?null:"select",name:"framework",message:typeof t=="string"&&!$.includes(t)?p(`"${t}" isn't a valid template. Please choose from below: `):p("Select a framework:"),initial:0,choices:R.map(r=>{let o=r.color;return{title:o(r.display||r.name),value:r}})},{type:r=>r&&r.variants?"select":null,name:"variant",message:p("Select a variant:"),choices:r=>r.variants.map(o=>{let m=o.color;return{title:m(o.display||o.name),value:o.name}})}],{onCancel:()=>{throw console.log(D("\u2716")+" Operation cancelled"),new Error}});let{framework:V,overwrite:z,packageName:O,variant:L}=g,i=a.join(S,n);z?b(i):c.existsSync(i)||c.mkdirSync(i,{recursive:!0}),console.log(`
+Scaffolding project in ${i}...`);let M=L||V?.name||t||"",h=r=>a.join(J(import.meta.url),"../..",`template-${r}`),j=h(M);[j,h("config")].forEach(r=>{let o=c.readdirSync(r);for(let m of o){let U=H[m]??m,W=a.join(i,U);v(a.join(r,m),W)}});let x=JSON.parse(c.readFileSync(a.join(j,"package.json"),"utf-8"));x.name=O||l(),c.writeFileSync(a.join(i,"package.json"),JSON.stringify(x,null,2)+`
+`);let N=E(process.env.npm_config_user_agent),u=N?N.name:"npm",f=a.relative(S,i);switch(console.log(`
 Done. Now run:
-`),i!==F&&console.log(`  cd ${v.includes(" ")?`"${v}"`:v}`),y){case"yarn":console.log("  yarn"),console.log("  yarn dev");break;default:console.log(`  ${y} install`),console.log(`  ${y} run dev`);break}}X().catch(()=>{});
+`),i!==S&&console.log(`  cd ${f.includes(" ")?`"${f}"`:f}`),u){case"yarn":console.log("  yarn"),console.log("  yarn dev");break;default:console.log(`  ${u} install`),console.log(`  ${u} run dev`);break}}Q().catch(e=>{e.message&&console.error(e)});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomjs/create-app",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "create tomjs web app",
   "keywords": [
     "tomjs",
@@ -43,9 +43,9 @@
     "@tomjs/commitlint": "^2.0.3",
     "@tomjs/eslint": "^1.0.7",
     "@tomjs/prettier": "^1.0.5",
-    "@tomjs/tsconfig": "^1.0.6",
+    "@tomjs/tsconfig": "^1.0.7",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^18.18.9",
+    "@types/node": "^18.18.10",
     "@types/prompts": "^2.4.8",
     "eslint": "^8.53.0",
     "husky": "^8.0.3",
@@ -53,7 +53,7 @@
     "np": "^8.0.4",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.1.0",
-    "tsup": "^7.2.0",
+    "tsup": "^7.3.0",
     "typescript": "^5.2.2"
   },
   "scripts": {

package/template-electron-react/package.json

@@ -2,6 +2,7 @@
   "name": "electron-app",
   "version": "0.0.0",
   "description": "vite + electron + vue",
+  "type": "module",
   "engines": {
     "node": ">=18"
   },
@@ -35,11 +36,11 @@
     "@tomjs/prettier": "^1.0.5",
     "@tomjs/stylelint": "^1.0.5",
     "@tomjs/tsconfig": "^1.0.7",
-    "@types/node": "^18.18.9",
+    "@types/node": "^18.18.10",
     "@types/react": "^18.2.37",
     "@types/react-dom": "^18.2.15",
     "@types/shelljs": "^0.8.15",
-    "@vitejs/plugin-react-swc": "^3.4.1",
+    "@vitejs/plugin-react-swc": "^3.5.0",
     "electron": "^27.1.0",
     "electron-builder": "^24.6.4",
     "eslint": "^8.53.0",
@@ -53,7 +54,7 @@
     "tree-kill": "^1.2.2",
     "tsx": "^4.1.3",
     "typescript": "^5.2.2",
-    "vite": "^4.5.0",
+    "vite": "^5.0.0",
     "vite-plugin-electron": "^0.15.4",
     "vite-plugin-electron-renderer": "^0.14.5",
     "vue-tsc": "^1.8.22"

package/template-electron-vue/package.json

@@ -2,6 +2,7 @@
   "name": "electron-app",
   "version": "0.0.0",
   "description": "vite + electron + vue",
+  "type": "module",
   "engines": {
     "node": ">=18"
   },
@@ -34,7 +35,7 @@
     "@tomjs/prettier": "^1.0.5",
     "@tomjs/stylelint": "^1.0.5",
     "@tomjs/tsconfig": "^1.0.7",
-    "@types/node": "^18.18.9",
+    "@types/node": "^18.18.10",
     "@types/shelljs": "^0.8.15",
     "@vitejs/plugin-vue": "^4.5.0",
     "electron": "^27.1.0",
@@ -50,7 +51,7 @@
     "tree-kill": "^1.2.2",
     "tsx": "^4.1.3",
     "typescript": "^5.2.2",
-    "vite": "^4.5.0",
+    "vite": "^5.0.0",
     "vite-plugin-electron": "^0.15.4",
     "vite-plugin-electron-renderer": "^0.14.5",
     "vue-tsc": "^1.8.22"

package/template-react/README.md

@@ -1,3 +1,7 @@
 # react
 
-react project
+vite + react
+
+## Reference project
+
+- [create-vite](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts)

package/template-react/package.json

@@ -1,7 +1,8 @@
 {
   "name": "template-react",
   "version": "0.0.0",
-  "type": "commonjs",
+  "description": "vite + react",
+  "type": "module",
   "engines": {
     "node": ">=18"
   },
@@ -25,10 +26,10 @@
     "@tomjs/eslint": "^1.0.7",
     "@tomjs/prettier": "^1.0.5",
     "@tomjs/stylelint": "^1.0.5",
-    "@tomjs/tsconfig": "^1.0.6",
+    "@tomjs/tsconfig": "^1.0.7",
     "@types/react": "^18.2.37",
     "@types/react-dom": "^18.2.15",
-    "@vitejs/plugin-react-swc": "^3.4.1",
+    "@vitejs/plugin-react-swc": "^3.5.0",
     "eslint": "^8.53.0",
     "husky": "^8.0.3",
     "lint-staged": "^15.1.0",
@@ -36,6 +37,6 @@
     "prettier": "^3.1.0",
     "stylelint": "^15.11.0",
     "typescript": "^5.2.2",
-    "vite": "^4.5.0"
+    "vite": "^5.0.0"
   }
 }

package/template-vue/README.md

@@ -1,18 +1,7 @@
-# Vue 3 + TypeScript + Vite
+# vue
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+vite + vue
 
-## Recommended IDE Setup
+## Reference project
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
-
-## Type Support For `.vue` Imports in TS
-
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
-
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
-
-1. Disable the built-in TypeScript Extension
-   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+- [create-vite](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-vue-ts)

package/template-vue/package.json

@@ -1,7 +1,8 @@
 {
   "name": "template-vue",
   "version": "0.0.0",
-  "type": "commonjs",
+  "description": "vite + vue",
+  "type": "module",
   "engines": {
     "node": ">=18"
   },
@@ -24,7 +25,7 @@
     "@tomjs/eslint": "^1.0.7",
     "@tomjs/prettier": "^1.0.5",
     "@tomjs/stylelint": "^1.0.5",
-    "@tomjs/tsconfig": "^1.0.6",
+    "@tomjs/tsconfig": "^1.0.7",
     "@vitejs/plugin-vue": "^4.5.0",
     "eslint": "^8.53.0",
     "husky": "^8.0.3",
@@ -33,7 +34,7 @@
     "prettier": "^3.1.0",
     "stylelint": "^15.11.0",
     "typescript": "^5.2.2",
-    "vite": "^4.5.0",
+    "vite": "^5.0.0",
     "vue-tsc": "^1.8.22"
   }
 }