create-vite-hyperapp 1.0.0 → 1.1.0

package/README.md

@@ -1 +1,34 @@
 # create-vite-hyperapp
+
+Quickly scaffold new web-frontend projects using the [Hyperapp](https://hyperapp.dev) microframework, using the [Vite](https://vitejs.dev) bundler.
+
+## Usage
+
+With your shell in the folder _under which_ you would like to create your new project folder, run `npm create vite-hyperapp` and answer the questions. 
+
+To skip questions and do the entire setup directly in the command line, use the options:
+
+```
+Usage: npm create vite-hyperapp -- [TARGET_DIR] [OPTIONS]
+
+Options:
+    -t, --typescript      Use typescript
+    -s, --ssr             Use server-side rendering
+    -n, --no-prompt       Just do it, no questions asked
+    -h, --help            Show this message 
+
+If no target dir is specified, the project name will be used.
+If --no-prompt option is used, project name will be target dir
+Default project-name/target-dir is 'hyperapp-project'
+```
+
+## About the scaffolds
+
+There are four basic templates that can be scaffolded up, depending on wether you want to use Typescript or not, and if you want to scaffold your project for SSR or not. 
+
+The vite-hyperapp connection is provided by [vite-plugin-hyperapp](https://github.com/zaceno/vite-plugin-hyperapp).
+
+The SSR scaffolds are based directly on Vite's SSR docs for setting up a server with SSR support.
+
+All templates have their views written in JSX (or TSX, for the TS-templates), but you can just as easily install a view-system of your preference (or use hyperapp's builtin `h` and `text`). Just name your files with `.js` or `.ts` extensions instead of `.jsx`.
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-vite-hyperapp",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "\"Scaffold a project quickly with Hyperapp and Vite\"",
   "main": "index.js",
   "scripts": {

package/templates/template/package.json

@@ -8,9 +8,11 @@
     "build": "vite build",
     "preview": "vite preview"
   },
+  "dependencies": {
+    "hyperapp": "^2.0.22"
+  },
   "devDependencies": {
-    "hyperapp": "^2.0.22",
-    "vite": "^4.4.5",
-    "vite-plugin-hyperapp": "^1.0.3"
+    "vite": "^4.5.14",
+    "vite-plugin-hyperapp": "^1.2.0"
   }
 }

package/templates/template-ssr/package.json

@@ -11,11 +11,11 @@
     "preview": "NODE_ENV=production node server"
   },
   "devDependencies": {
-    "hyperapp": "^2.0.22",
-    "vite": "^4.4.5",
-    "vite-plugin-hyperapp": "^1.0.3"
+    "vite": "^4.5.14",
+    "vite-plugin-hyperapp": "^1.2.0"
   },
   "dependencies": {
+    "hyperapp": "^2.0.22",
     "compression": "^1.7.4",
     "express": "^4.19.2",
     "sirv": "^2.0.4"

package/templates/template-ts/package.json

@@ -8,10 +8,12 @@
     "build": "tsc && vite build",
     "preview": "vite preview"
   },
+  "dependencies": {
+    "hyperapp": "^2.0.22"
+  },
   "devDependencies": {
-    "hyperapp": "^2.0.22",
     "typescript": "^5.0.2",
-    "vite": "^4.4.5",
-    "vite-plugin-hyperapp": "^1.0.3"
+    "vite": "^4.5.14",
+    "vite-plugin-hyperapp": "^1.2.0"
   }
 }

package/templates/template-ts/src/vite-env.d.ts

@@ -1 +1,2 @@
 /// <reference types="vite/client" />
+/// <reference types="vite-plugin-hyperapp/jsx" />

package/templates/template-ts/tsconfig.json

@@ -21,7 +21,8 @@
 
     /* Necessary for tsx to work with vite-plugin-hyperapp*/
     "jsx": "preserve",
-    "jsxImportSource": "vite-plugin-hyperapp"
+    "jsxFactory": "jsx",
+    "jsxFragmentFactory": "jsxFragment"
   },
   "include": ["src"]
 }

package/templates/template-ts-ssr/package.json

@@ -11,12 +11,12 @@
     "preview": "NODE_ENV=production node server"
   },
   "devDependencies": {
-    "hyperapp": "^2.0.22",
     "typescript": "^5.0.2",
-    "vite": "^4.4.5",
-    "vite-plugin-hyperapp": "^1.0.3"
+    "vite": "^4.5.14",
+    "vite-plugin-hyperapp": "^1.2.0"
   },
   "dependencies": {
+    "hyperapp": "^2.0.22",
     "compression": "^1.7.4",
     "express": "^4.19.2",
     "sirv": "^2.0.4"

package/templates/template-ts-ssr/src/vite-env.d.ts

@@ -1 +1,2 @@
 /// <reference types="vite/client" />
+/// <reference types="vite-plugin-hyperapp/jsx" />

package/templates/template-ts-ssr/tsconfig.json

@@ -21,7 +21,8 @@
 
     /* Necessary for tsx to work with vite-plugin-hyperapp*/
     "jsx": "preserve",
-    "jsxImportSource": "vite-plugin-hyperapp"
+    "jsxFactory": "jsx",
+    "jsxFragmentFactory": "jsxFragment"
   },
   "include": ["src"]
 }