create-tinybase 0.2.3 → 0.2.5

package/README.md

@@ -47,9 +47,6 @@ npm install
 npm run dev
 ```
 
-You can also concurrently run both client and server using `npm run dev` in the
-parent directory.
-
 Your app should look something like this:
 
 ### Todo App

package/cli.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
-import{existsSync as v}from"fs";import{dirname as y,join as p}from"path";import{createCLI as f}from"tinycreate";import{fileURLToPath as h}from"url";const w=y(h(import.meta.url)),j={welcomeMessage:`\u{1F389} Welcome to TinyBase!
-`,questions:[{type:"text",name:"projectName",message:"Project name:",initial:"my-tinybase-app",validate:e=>{if(e.length===0)return"Project name is required";const t=p(process.cwd(),e);return v(t)?`Directory "${e}" already exists. Please choose a different name.`:!0}},{type:"select",name:"language",message:"Language:",choices:[{title:"TypeScript",value:"typescript"},{title:"JavaScript",value:"javascript"}],initial:0},{type:"select",name:"framework",message:"Framework:",choices:[{title:"React",value:"react"},{title:"Vanilla",value:"vanilla"}],initial:0},{type:"select",name:"appType",message:"App type:",choices:[{title:"Todo app",value:"todos"},{title:"Chat app",value:"chat"},{title:"Drawing app",value:"drawing"},{title:"Tic-tac-toe game",value:"game"}],initial:0},{type:(e,t)=>t.language==="typescript"?"confirm":null,name:"schemas",message:"Include store schemas?",initial:!1},{type:"confirm",name:"sync",message:"Enable synchronization?",initial:!0},{type:(e,t)=>t.sync?"confirm":null,name:"server",message:"Add code for server?",initial:!1},{type:(e,t)=>t.server?"select":null,name:"serverType",message:"Server type:",choices:[{title:"Node",value:"node"},{title:"Durable Objects",value:"durable-objects"}],initial:0},{type:"confirm",name:"prettier",message:"Include Prettier?",initial:!1},{type:"confirm",name:"eslint",message:"Include ESLint?",initial:!1}],createContext:e=>{const{projectName:t,language:s,framework:n,appType:r,prettier:m,eslint:u,schemas:o,sync:c,server:l,serverType:g}=e,a=s==="typescript",d=!a,i=n==="react";return{projectName:t,language:s,framework:n,appType:r,prettier:m,eslint:u,schemas:a&&(o===!0||o==="true"),sync:c===!0||c==="true",server:l===!0||l==="true",serverType:g||"node",typescript:a,javascript:d,react:i,ext:a?i?"tsx":"ts":i?"jsx":"js"}},createDirectories:async(e,t)=>{const{mkdir:s}=await import("fs/promises"),{join:n}=await import("path"),r=t.server;await s(n(e,"client/src"),{recursive:!0}),await s(n(e,"client/public"),{recursive:!0}),r&&await s(n(e,"server"),{recursive:!0})},getFiles:e=>{const t=e.server,s=[{template:"README.md.hbs",output:"README.md",prettier:!0},{template:"client/package.json.hbs",output:"client/package.json",prettier:!0}];return t&&s.push({template:"package.json.hbs",output:"package.json",prettier:!0}),s},processIncludedFile:(e,t)=>{const{javascript:s}=t,n=e.prettier??/\.(js|jsx|ts|tsx|css|json|html|md)$/.test(e.output),r=e.transpile??(/\.(ts|tsx)\.hbs$/.test(e.template)&&s===!0);return{...e,prettier:n,transpile:r}},templateRoot:p(w,"templates"),installCommand:"{pm} install",devCommand:"{pm} run dev",onSuccess:e=>{console.log("Next steps:"),console.log(`  cd ${e}/client`),console.log("  npm install"),console.log("  npm run dev")}};f(j).catch(e=>{console.error(e),process.exit(1)});
+import{existsSync as y}from"fs";import{dirname as w,join as u}from"path";import{createCLI as f,detectPackageManager as h}from"tinycreate";import{fileURLToPath as k}from"url";const j=w(k(import.meta.url)),x={welcomeMessage:`\u{1F389} Welcome to TinyBase!
+`,questions:[{type:"text",name:"projectName",message:"Project name:",initial:"my-tinybase-app",validate:e=>{if(e.length===0)return"Project name is required";const t=u(process.cwd(),e);return y(t)?`Directory "${e}" already exists. Please choose a different name.`:!0}},{type:"select",name:"appType",message:"App type:",choices:[{title:"Todo app",value:"todos"},{title:"Chat app",value:"chat"},{title:"Drawing app",value:"drawing"},{title:"Tic-tac-toe game",value:"game"}],initial:0},{type:"select",name:"language",message:"Language:",choices:[{title:"TypeScript",value:"typescript"},{title:"JavaScript",value:"javascript"}],initial:0},{type:"select",name:"framework",message:"Framework:",choices:[{title:"React",value:"react"},{title:"Vanilla",value:"vanilla"}],initial:0},{type:(e,t)=>t.language==="typescript"?"confirm":null,name:"schemas",message:"Include store schemas?",initial:!1},{type:"confirm",name:"sync",message:"Enable synchronization?",initial:!0},{type:(e,t)=>t.sync?"confirm":null,name:"server",message:"Add code for server?",initial:!1},{type:(e,t)=>t.server?"select":null,name:"serverType",message:"Server type:",choices:[{title:"Node",value:"node"},{title:"Durable Objects",value:"durable-objects"}],initial:0},{type:"confirm",name:"prettier",message:"Include Prettier?",initial:!0},{type:"confirm",name:"eslint",message:"Include ESLint?",initial:!0},{type:(e,t)=>t.server?null:"confirm",name:"installAndRun",message:"Install dependencies and start dev server?",initial:!0}],createContext:e=>{const{projectName:t,language:s,framework:n,appType:r,prettier:m,eslint:g,schemas:i,sync:c,server:l,serverType:d,installAndRun:p}=e,a=s==="typescript",v=!a,o=n==="react";return{projectName:t,language:s,framework:n,appType:r,prettier:m,eslint:g,schemas:a&&(i===!0||i==="true"),sync:c===!0||c==="true",server:l===!0||l==="true",serverType:d||"node",installAndRun:p===!0||p==="true",typescript:a,javascript:v,react:o,ext:a?o?"tsx":"ts":o?"jsx":"js"}},createDirectories:async(e,t)=>{const{mkdir:s}=await import("fs/promises"),{join:n}=await import("path"),r=t.server;await s(n(e,"client/src"),{recursive:!0}),await s(n(e,"client/public"),{recursive:!0}),r&&await s(n(e,"server"),{recursive:!0})},getFiles:()=>[{template:"README.md.hbs",output:"README.md",prettier:!0}],processIncludedFile:(e,t)=>{const{javascript:s}=t,n=e.prettier??/\.(js|jsx|ts|tsx|css|json|html|md)$/.test(e.output),r=e.transpile??(/\.(ts|tsx)\.hbs$/.test(e.template)&&s===!0);return{...e,prettier:n,transpile:r}},templateRoot:u(j,"templates"),installCommand:"{pm} install",devCommand:"{pm} run dev",workingDirectory:"client",onSuccess:(e,t)=>{const s=t.server,n=h();console.log("Next steps:"),console.log(),s&&(console.log("To run the server:"),console.log(`  cd ${e}/server`),console.log(`  ${n} install`),console.log(`  ${n} run dev`),console.log()),console.log("To run the client:"),console.log(`  cd ${e}/client`),console.log(`  ${n} install`),console.log(`  ${n} run dev`)}};f(x).catch(e=>{console.error(e),process.exit(1)});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-tinybase",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "author": "jamesgpearce",
   "repository": {
     "type": "git",
@@ -23,7 +23,7 @@
     "create-tinybase": "cli.js"
   },
   "dependencies": {
-    "tinycreate": "^1.0.0"
+    "tinycreate": "^1.0.3"
   },
   "engines": {
     "node": ">=18.0.0"

package/templates/README.md.hbs

@@ -1,15 +1,41 @@
+{{includeFile template="client/package.json.hbs" output="client/package.json"}}
+{{#if server}}
+  {{includeFile template="server/package.json.hbs" output="server/package.json"}}
+{{/if}}
+
 # {{projectName}}
 
-A TinyBase app built with {{#if typescript}}TypeScript{{else}}JavaScript{{/if}} and {{#if react}}React{{else}}Vanilla JS{{/if}}.
+A TinyBase app built with {{#if typescript}}TypeScript{{else}}JavaScript{{/if}}
+and {{#if react}}React{{else}}Vanilla JS{{/if}}.
 
 ## Getting Started
 
+Alongside this file, you will see a directory called `client` (and optionally
+one called `server` if you included server code).
+
+To start the web client with Vite, run the following commands:
+
 ```bash
 cd client
 npm install
 npm run dev
 ```
 
+PNPM, Yarn, and Bun should also work. Your app will be available at
+`http://localhost:5173`, or whichever port Vite specifies in the console.
+
+If you included server code, start the server in a separate terminal, ideally
+before starting the client:
+
+```bash
+# In a separate terminal
+cd server
+npm install
+npm run dev
+```
+
+After that, start hacking!
+
 ## Learn More
 
 - [TinyBase Documentation](https://tinybase.org)

package/templates/package.json.hbs

@@ -1,38 +0,0 @@
-{{includeFile template="README.md.hbs" output="README.md"}}
-{
-"name": "{{projectName}}",
-"version": "1.0.0",
-"private": true,
-"scripts": {
-{{#list}}
-  {{#if server}}
-    "dev": "concurrently \"npm run dev -w client\" \"npm run dev -w server\""
-    "dev:client": "npm run dev -w client"
-    "dev:server": "npm run dev -w server"
-  {{else}}
-    "dev": "npm run dev -w client"
-  {{/if}}
-  "build": "npm run build -w client"
-  "preview": "npm run preview -w client"
-{{/list}}
-},
-{{#if server}}
-  "workspaces": ["client", "server"],
-{{else}}
-  "workspaces": ["client"],
-{{/if}}
-"devDependencies": {
-{{#list}}
-  {{#if server}}
-    "concurrently": "^9.1.2"
-  {{/if}}
-{{/list}}
-}
-}
-{{#if server}}
-  {{includeFile template="server/package.json.hbs" output="server/package.json"}}
-{{/if}}
-{{#if prettier}}
-  {{includeFile template="client/.prettierrc.hbs" output=".prettierrc"}}
-{{/if}}
-{{includeFile template="client/package.json.hbs" output="client/package.json"}}