create-qwik 0.0.108 → 0.0.109

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "create-qwik",
-  "version": "0.0.108",
-  "description": "Interactive CLI and API for generating Qwik projects.",
-  "bin": "create-qwik",
-  "main": "index.js",
+  "version": "0.0.109",
+  "description": "Interactive CLI for create Qwik projects and adding features.",
+  "bin": "./create-qwik.cjs",
+  "main": "./index.cjs",
   "files": [
-    "create-qwik",
+    "create-qwik.cjs",
+    "index.cjs",
     "starters/"
   ],
   "author": "Builder.io Team",
@@ -13,7 +14,9 @@
   "keywords": [
     "qwik",
     "generator",
-    "builder.io"
+    "builder.io",
+    "starters",
+    "template"
   ],
   "homepage": "https://qwik.builder.io/",
   "repository": {
@@ -27,10 +30,11 @@
   "devDependencies": {
     "@types/prompts": "2.0.14",
     "kleur": "4.1.5",
+    "ora": "^6.1.2",
     "prompts": "2.4.2"
   },
   "engines": {
-    "node": ">=14",
+    "node": ">=14.18",
     "npm": ">=6.0.0"
   }
 }

package/starters/apps/base/.prettierignore

@@ -0,0 +1,6 @@
+# Files Prettier should not format
+**/*.log
+**/.DS_Store
+*.
+dist
+node_modules

package/starters/apps/base/README.md

@@ -1,41 +1,66 @@
-## Development Builds
+# Qwik App ⚡️
 
-### Client only
+- [Qwik Docs](https://qwik.builder.io/)
+- [Discord](https://qwik.builder.io/chat)
+- [Qwik Github](https://github.com/BuilderIO/qwik)
+- [@QwikDev](https://twitter.com/QwikDev)
+- [Vite](https://vitejs.dev/)
+- [Partytown](https://partytown.builder.io/)
+- [Mitosis](https://github.com/BuilderIO/mitosis)
+- [Builder.io](https://www.builder.io/)
 
-During development, the index.html is not a result of server-side rendering, but rather the Qwik app is built using client-side JavaScript only. This is ideal for development with Vite and its ability to reload modules quickly and on-demand. However, this mode is only for development and does not showcase "how" Qwik works since JavaScript is required to execute, and Vite imports many development modules for the app to work.
+---
+
+## Project Structure
+
+Inside of you project, you'll see the following directories and files:
 
 ```
-npm run dev
+├── public/
+│   └── ...
+└── src/
+    ├── components/
+    │   └── ...
+    └── routes/
+        └── ...
 ```
 
-### Server-side Rendering (SSR) and Client
+- `src/routes`: Provides the directory based routing, which can include a hierarchy of `layout.tsx` layout files, and `index.tsx` files as the page. Additionally, `index.ts` files are endpoints. Please see the [routing docs](https://qwik.builder.io/qwikcity/routing/overview/) for more info.
+
+- `src/components`: Recommended directory for components.
+
+- `public`: Any static assets, like images, can be placed in the public directory. Please see the [Vite public directory](https://vitejs.dev/guide/assets.html#the-public-directory) for more info.
 
-Server-side rendered index.html, with client-side modules prefetched and loaded by the browser. This can be used to test out server-side rendered content during development, but will be slower than the client-only development builds.
+## Add Integrations
+
+Use the `npm run qwik add` command to add other integrations. Some examples of integrations include as a Cloudflare, Netlify or Vercel server, and the Static Site Generator (SSG).
 
 ```
-npm run dev.ssr
+npm run qwik add
 ```
 
-## Production Builds
+## Development
 
-A production build should generate the client and server modules by running both client and server build commands.
+Development mode uses [Vite's development server](https://vitejs.dev/). For Qwik during development, the `dev` command will also server-side render (SSR) the output. The client-side development modules loaded by the browser.
 
 ```
-npm run build
+npm run dev
 ```
 
-### Client Modules
+> Note: during dev mode, Vite will request many JS files, which does not represent a Qwik production build.
 
-Production build that creates only the client-side modules that are dynamically imported by the browser.
+## Preview
+
+The preview command will create a production build of the client modules, production build of `src/entry.preview.tsx`, and create a local server. The preview server is only for convenience to locally preview a production build, but it should not be used as a production server.
 
 ```
-npm run build.client
+npm run preview
 ```
 
-### Server Modules
+## Production
 
-Production build that creates the server-side render (SSR) module that is used by the server to render the HTML.
+The production build should generate the client and server modules by running both client and server build commands. Additionally, the build command will use Typescript run a type check on the source.
 
 ```
-npm run build.ssr
+npm run build
 ```

package/starters/apps/base/gitignore

@@ -1,9 +1,7 @@
 # Build
-build
-dist
-lib
-server
-functions/**/*.js
+/dist
+/lib
+/server
 
 # Development
 node_modules
@@ -36,4 +34,4 @@ lerna-debug.log*
 
 # Yarn
 .yarn/*
-!.yarn/releases
+!.yarn/releases

package/starters/apps/base/package.json

@@ -1,35 +1,32 @@
 {
   "name": "qwik-project-name",
-  "description": "",
-  "license": "",
   "scripts": {
-    "build": "npm run typecheck && npm run build.client && npm run build.ssr",
+    "build": "qwik build",
     "build.client": "vite build",
-    "build.ssr": "vite build --ssr src/entry.ssr.tsx",
-    "dev": "npm run dev.ssr",
-    "dev.client": "vite",
-    "dev.ssr": "node --inspect node_modules/vite/bin/vite.js --mode ssr",
-    "dev.debug": "node --inspect-brk node_modules/vite/bin/vite.js --force --mode ssr",
-    "start": "npm run dev",
+    "build.preview": "vite build --ssr src/entry.preview.tsx",
+    "dev": "vite --mode ssr",
+    "fmt": "prettier --write .",
+    "fmt.check": "prettier --check .",
     "lint": "eslint \"src/**/*.ts*\"",
-    "typecheck": "tsc --incremental --noEmit"
+    "preview": "qwik build preview && vite preview",
+    "start": "vite --mode ssr",
+    "typecheck": "tsc --incremental --noEmit",
+    "qwik": "qwik"
   },
   "devDependencies": {
-    "@builder.io/qwik": "0.0.108",
+    "@builder.io/qwik": "0.0.109",
+    "@builder.io/qwik-city": "0.0.110",
     "@types/eslint": "8.4.6",
     "@types/node": "latest",
-    "@typescript-eslint/eslint-plugin": "5.34.0",
-    "@typescript-eslint/parser": "5.34.0",
-    "eslint-plugin-qwik": "0.0.108",
-    "eslint": "8.22.0",
+    "@typescript-eslint/eslint-plugin": "5.37.0",
+    "@typescript-eslint/parser": "5.37.0",
+    "eslint-plugin-qwik": "0.0.109",
+    "eslint": "8.23.1",
     "node-fetch": "3.2.10",
-    "typescript": "4.7.4",
-    "vite": "3.0.9"
+    "prettier": "2.7.1",
+    "typescript": "4.8.3",
+    "vite": "3.1.1",
+    "vite-tsconfig-paths": "3.5.0"
   },
-  "type": "module",
-  "homepage": "https://qwik.builder.io/",
-  "private": true,
-  "engines": {
-    "node": "^14.18.0 || >=16.0.0"
-  }
+  "private": true
 }

package/starters/apps/base/public/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 500 500"><g clip-path="url(#a)"><circle cx="250" cy="250" r="250" fill="#fff"/><path fill="#18B6F6" d="m367.87 418.45-61.17-61.18-.94.13v-.67L175.7 227.53l32.05-31.13L188.9 87.73 99.56 199.09c-15.22 15.42-18.03 40.51-7.08 59.03l55.83 93.11a46.82 46.82 0 0 0 40.73 22.81l27.65-.27 151.18 44.68Z"/><path fill="#AC7EF4" d="m401.25 196.94-12.29-22.81-6.41-11.67-2.54-4.56-.26.26-33.66-58.63a47.07 47.07 0 0 0-41.27-23.75l-29.51.8-88.01.28a47.07 47.07 0 0 0-40.33 23.34L93.4 207l95.76-119.54L314.7 226.19l-22.3 22.67 13.35 108.54.13-.26v.26h-.26l.26.27 10.42 10.2 50.62 49.78c2.13 2 5.6-.4 4.13-2.96l-31.25-61.85 54.5-101.3 1.73-2c.67-.81 1.33-1.62 1.87-2.42a46.8 46.8 0 0 0 3.34-50.18Z"/><path fill="#fff" d="M315.1 225.65 189.18 87.6l17.9 108.14L175 227l130.5 130.27-11.75-108.14 21.37-23.48Z"/></g><defs><clipPath id="a"><path fill="#fff" d="M0 0h500v500H0z"/></clipPath></defs></svg>

package/starters/apps/base/src/entry.preview.tsx

@@ -0,0 +1,6 @@
+import { qwikCity } from '@builder.io/qwik-city/middleware/node';
+import render from './entry.ssr';
+
+// Create the Qwik City ssr preview middleware
+// Imported by vite preview
+export default qwikCity(render);

package/starters/apps/base/src/entry.ssr.tsx

@@ -2,14 +2,16 @@ import { renderToStream, RenderToStreamOptions } from '@builder.io/qwik/server';
 import { manifest } from '@qwik-client-manifest';
 import Root from './root';
 
-/**
- * Server-Side Render method to be called by a server.
- */
 export default function (opts: RenderToStreamOptions) {
-  // Render the Root component to a string
-  // Pass in the manifest that was generated from the client build
   return renderToStream(<Root />, {
     manifest,
     ...opts,
+    prefetchStrategy: {
+      implementation: {
+        linkInsert: null,
+        workerFetchInsert: null,
+        prefetchEvent: 'always',
+      },
+    },
   });
 }

package/starters/apps/base/src/routes/service-worker.ts

@@ -0,0 +1,9 @@
+declare const self: ServiceWorkerGlobalScope;
+
+import { setupServiceWorker } from '@builder.io/qwik-city/service-worker';
+
+setupServiceWorker();
+
+addEventListener('install', () => self.skipWaiting());
+
+addEventListener('activate', () => self.clients.claim());

package/starters/apps/base/tsconfig.json

@@ -3,19 +3,20 @@
     "allowJs": true,
     "target": "ES2017",
     "module": "ES2020",
-    "lib": ["es2020", "DOM"],
+    "lib": ["es2020", "DOM", "WebWorker"],
     "jsx": "react-jsx",
     "jsxImportSource": "@builder.io/qwik",
     "strict": true,
-    "declaration": true,
-    "declarationDir": "lib/types",
     "resolveJsonModule": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
     "skipLibCheck": true,
     "incremental": true,
     "isolatedModules": true,
-    "types": ["vite/client"]
+    "types": ["node", "vite/client"],
+    "paths": {
+      "~/*": ["./src/*"]
+    }
   },
   "include": ["src"]
 }

package/starters/apps/base/vite.config.ts

@@ -1,13 +1,10 @@
 import { defineConfig } from 'vite';
 import { qwikVite } from '@builder.io/qwik/optimizer';
-/* VITE_IMPORTS */
+import { qwikCity } from '@builder.io/qwik-city/vite';
+import tsconfigPaths from 'vite-tsconfig-paths';
 
 export default defineConfig(() => {
   return {
-    /* VITE_CONFIG */
-    plugins: [
-      qwikVite(/* VITE_QWIK */),
-      /* VITE_PLUGINS */
-    ],
+    plugins: [qwikCity(), qwikVite(), tsconfigPaths()],
   };
 });

package/starters/apps/blank/package.json

@@ -1,22 +1,9 @@
 {
+  "name": "qwik-blank-starter",
   "description": "Blank Qwik starter app.",
-  "scripts": {
-    "build.ssr": "vite build --ssr src/entry.express.tsx",
-    "serve": "node server/entry.express"
-  },
-  "devDependencies": {
-    "@types/express": "4.17.13",
-    "express": "4.17.3"
-  },
   "type": "module",
   "__qwik__": {
     "priority": 0,
-    "featureOptions": [
-      "prettier",
-      "tailwindcss"
-    ],
-    "featureEnabled": [
-      "prettier"
-    ]
+    "qwikCity": true
   }
 }

package/starters/apps/blank/src/components/header/header.css

@@ -0,0 +1,37 @@
+header {
+  background: var(--qwik-purple);
+}
+header {
+  display: flex;
+  background: white;
+  border-bottom: 10px solid var(--qwik-dark-purple);
+}
+
+header .logo a {
+  display: inline-block;
+  padding: 10px 10px 7px 20px;
+}
+
+header ul {
+  margin: 0;
+  padding: 3px 10px 0 0;
+  list-style: none;
+  flex: 1;
+  text-align: right;
+}
+
+header li {
+  display: inline-block;
+  margin: 0;
+  padding: 0;
+}
+
+header li a {
+  display: inline-block;
+  padding: 15px 10px;
+  text-decoration: none;
+}
+
+header li a:hover {
+  text-decoration: underline;
+}

package/starters/apps/blank/src/components/header/header.tsx

@@ -0,0 +1,34 @@
+import { component$, useStyles$ } from '@builder.io/qwik';
+import { QwikLogo } from '../icons/qwik';
+import styles from './header.css';
+
+export default component$(() => {
+  useStyles$(styles);
+
+  return (
+    <header>
+      <div class="logo">
+        <a href="https://qwik.builder.io/" target="_blank">
+          <QwikLogo />
+        </a>
+      </div>
+      <ul>
+        <li>
+          <a href="https://qwik.builder.io/" target="_blank">
+            Docs
+          </a>
+        </li>
+        <li>
+          <a href="https://qwik.builder.io/examples/introduction/hello-world/" target="_blank">
+            Examples
+          </a>
+        </li>
+        <li>
+          <a href="https://qwik.builder.io/tutorial/welcome/overview/" target="_blank">
+            Tutorials
+          </a>
+        </li>
+      </ul>
+    </header>
+  );
+});

package/starters/apps/blank/src/components/icons/qwik.tsx

@@ -0,0 +1,32 @@
+export const QwikLogo = () => (
+  <svg width="100" height="35" viewBox="0 0 167 53" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path
+      d="M81.9545 46.5859H75.5513V35.4045C73.4363 36.8579 71.0496 37.5749 68.4884 37.5749C65.0151 37.5749 62.4344 36.6253 60.8239 34.6487C59.2134 32.6915 58.3984 29.2034 58.3984 24.2231C58.3984 19.1266 59.3492 15.5997 61.2702 13.5456C63.23 11.4721 66.3734 10.4644 70.7004 10.4644C74.7946 10.4644 78.5201 11.0264 81.9545 12.131V46.5859ZM75.5513 16.278C74.096 15.8323 72.4661 15.6191 70.7004 15.6191C68.5272 15.6191 66.9749 16.1811 66.1017 17.3244C65.2479 18.4871 64.7823 20.6962 64.7823 23.9712C64.7823 27.0524 65.1897 29.1065 66.0435 30.2304C66.8973 31.335 68.3719 31.897 70.5452 31.897C73.3781 31.897 75.5513 30.7343 75.5513 29.2809V16.278Z"
+      fill="black"
+    />
+    <path
+      d="M91.133 11.1426C93.4033 17.4406 95.3242 23.7386 96.993 30.0948C99.205 23.5836 101.087 17.2856 102.542 11.1426H108.15C110.265 17.4406 112.031 23.7386 113.447 30.0948C115.97 23.196 117.949 16.8787 119.404 11.1426H125.71C123.033 20.173 120.064 28.777 116.785 36.8966H109.256C108.402 32.3039 107.044 26.7617 105.22 20.1536C104.056 25.2889 102.445 30.8893 100.33 36.8966H92.8018C90.2793 27.5174 87.5434 18.9522 84.6328 11.1426H91.133Z"
+      fill="black"
+    />
+    <path
+      d="M132.832 7.55758C129.999 7.55758 129.203 6.85996 129.203 3.97257C129.203 1.39523 130.018 0.794495 132.832 0.794495C135.665 0.794495 136.46 1.39523 136.46 3.97257C136.46 6.85996 135.665 7.55758 132.832 7.55758ZM129.649 11.1426H136.053V36.8966H129.649V11.1426Z"
+      fill="black"
+    />
+    <path
+      d="M166.303 11.1426C161.763 17.5956 158.581 21.5295 156.815 22.9441C158.27 23.8937 162.17 28.8933 167.002 36.916H159.628C153.613 27.7887 150.742 23.8549 149.325 23.2542V36.916H142.922V0H149.325V23.2348C150.78 22.169 153.963 18.1382 158.872 11.1426H166.303Z"
+      fill="black"
+    />
+    <path
+      d="M40.973 52.5351L32.0861 43.6985L31.9503 43.7179V43.621L13.0511 24.9595L17.708 20.4637L14.9721 4.76715L1.99103 20.8513C-0.220992 23.0798 -0.628467 26.7036 0.962635 29.3778L9.07337 42.8265C10.3152 44.9 12.566 46.1402 14.9915 46.1208L19.0081 46.082L40.973 52.5351Z"
+      fill="#18B6F6"
+    />
+    <path
+      d="M45.8232 20.5411L44.038 17.2468L43.1066 15.5609L42.738 14.902L42.6992 14.9408L37.8094 6.47238C36.587 4.34075 34.2974 3.02301 31.8137 3.04239L27.5255 3.15865L14.7384 3.19741C12.313 3.21679 10.101 4.49577 8.87853 6.56927L1.09766 21.9945L15.0101 4.72831L33.2496 24.7656L30.0091 28.0406L31.9495 43.7178L31.9689 43.679V43.7178H31.9301L31.9689 43.7565L33.4824 45.2293L40.8364 52.4187C41.1469 52.7094 41.6514 52.3606 41.4379 51.9924L36.8975 43.0589L44.8142 28.4282L45.0664 28.1375C45.1634 28.0212 45.2604 27.905 45.3381 27.7887C46.8904 25.6764 47.1038 22.8472 45.8232 20.5411Z"
+      fill="#AC7EF4"
+    />
+    <path
+      d="M33.3076 24.6882L15.0099 4.74774L17.61 20.3668L12.9531 24.882L31.9105 43.6985L30.203 28.0794L33.3076 24.6882Z"
+      fill="white"
+    />
+  </svg>
+);

package/starters/apps/blank/src/components/router-head/router-head.tsx

@@ -0,0 +1,43 @@
+import { component$ } from '@builder.io/qwik';
+import { useDocumentHead, useLocation } from '@builder.io/qwik-city';
+
+/**
+ * The RouterHead component is placed inside of the document `<head>` element.
+ */
+export const RouterHead = component$(() => {
+  const head = useDocumentHead();
+  const loc = useLocation();
+
+  return (
+    <>
+      <title>{head.title}</title>
+
+      <link rel="canonical" href={loc.href} />
+      <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+      <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+
+      <link rel="preconnect" href="https://fonts.googleapis.com" />
+      <link rel="preconnect" href="https://fonts.gstatic.com" crossOrigin="" />
+      <link
+        href="https://fonts.googleapis.com/css2?family=Poppins&amp;display=swap"
+        rel="stylesheet"
+      />
+
+      <meta property="og:site_name" content="Qwik" />
+      <meta name="twitter:site" content="@QwikDev" />
+      <meta name="twitter:title" content="Qwik" />
+
+      {head.meta.map((m) => (
+        <meta {...m} />
+      ))}
+
+      {head.links.map((l) => (
+        <link {...l} />
+      ))}
+
+      {head.styles.map((s) => (
+        <style {...s.props} dangerouslySetInnerHTML={s.style} />
+      ))}
+    </>
+  );
+});

package/starters/apps/blank/src/global.css

@@ -1,3 +1,70 @@
-/**
- * Write here your global css styles
- */
+:root {
+  --qwik-dark-blue: #006ce9;
+  --qwik-light-blue: #18b6f6;
+  --qwik-light-purple: #ac7ff4;
+  --qwik-dark-purple: #713fc2;
+}
+
+body {
+  background-color: #fafafa;
+  font-family: 'Poppins', ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, sans-serif;
+  padding: 20px;
+}
+
+main {
+  max-width: 720px;
+  margin: 0 auto;
+  background-color: white;
+  border-radius: 5px;
+  box-shadow: 0px 0px 130px -50px var(--qwik-light-purple);
+  overflow: hidden;
+}
+
+h1 {
+  margin-top: 0;
+}
+
+.lightning {
+  filter: hue-rotate(180deg);
+}
+
+section {
+  padding: 20px;
+  border-bottom: 10px solid var(--qwik-dark-blue);
+}
+
+ul {
+  list-style-type: square;
+  margin: 10px 0 40px 0;
+}
+
+li {
+  padding: 5px 0;
+}
+
+li::marker {
+  color: var(--qwik-light-blue);
+}
+
+a,
+a:visited {
+  color: var(--qwik-dark-blue);
+}
+
+a:hover {
+  text-decoration: none;
+}
+
+table {
+  margin: 10px 0 40px 0;
+}
+
+.commands td:last-child {
+  padding-left: 20px;
+}
+
+code {
+  font-family: Menlo, Monaco, Courier New, monospace;
+  color: var(--qwik-dark-blue);
+  padding: 0 4px;
+}

package/starters/apps/blank/src/root.tsx

@@ -1,18 +1,26 @@
-import { App } from './components/app/app';
+import { component$ } from '@builder.io/qwik';
+import { QwikCity, RouterOutlet, ServiceWorkerRegister } from '@builder.io/qwik-city';
+import { RouterHead } from './components/router-head/router-head';
 
 import './global.css';
 
-export default () => {
+export default component$(() => {
+  /*
+   * The root of a QwikCity site always start with the <QwikCity> component,
+   * immediately followed by the document's <head> and <body>.
+   *
+   * Dont remove the `<head>` and `<body>` elements.
+   */
   return (
-    <html>
+    <QwikCity>
       <head>
         <meta charSet="utf-8" />
-        <title>Qwik Blank App</title>
-        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <RouterHead />
       </head>
-      <body>
-        <App />
+      <body lang="en">
+        <RouterOutlet />
+        <ServiceWorkerRegister />
       </body>
-    </html>
+    </QwikCity>
   );
-};
+});

package/starters/apps/blank/src/routes/index.tsx

@@ -0,0 +1,81 @@
+import { component$ } from '@builder.io/qwik';
+import type { DocumentHead } from '@builder.io/qwik-city';
+
+export default component$(() => {
+  return (
+    <div>
+      <h1>
+        Welcome to Qwik <span class="lightning">⚡️</span>
+      </h1>
+
+      <ul>
+        <li>
+          Check out the <code>src/routes</code> directory to get started.
+        </li>
+        <li>
+          Add integrations with <code>npm run qwik add</code>.
+        </li>
+        <li>
+          More info about development in <code>README.md</code>
+        </li>
+      </ul>
+
+      <h2>Commands</h2>
+
+      <table class="commands">
+        <tr>
+          <td>
+            <code>npm run dev</code>
+          </td>
+          <td>Start the dev server and watch for changes.</td>
+        </tr>
+        <tr>
+          <td>
+            <code>npm run preview</code>
+          </td>
+          <td>Production build and start preview server.</td>
+        </tr>
+        <tr>
+          <td>
+            <code>npm run build</code>
+          </td>
+          <td>Production build.</td>
+        </tr>
+        <tr>
+          <td>
+            <code>npm run qwik add</code>
+          </td>
+          <td>Add integration like edge servers and SSG.</td>
+        </tr>
+      </table>
+
+      <h2>Community</h2>
+
+      <ul>
+        <li>
+          <span>Questions or just want to say hi? </span>
+          <a href="https://qwik.builder.io/chat" target="_blank">
+            Chat on discord!
+          </a>
+        </li>
+        <li>
+          <span>Follow </span>
+          <a href="https://twitter.com/QwikDev" target="_blank">
+            @QwikDev
+          </a>
+          <span> on Twitter</span>
+        </li>
+        <li>
+          <span>Open issues and contribute on </span>
+          <a href="https://github.com/BuilderIO/qwik" target="_blank">
+            Github
+          </a>
+        </li>
+      </ul>
+    </div>
+  );
+});
+
+export const head: DocumentHead = {
+  title: 'Welcome to Qwik',
+};