Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify integration #157

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,11 @@
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": ["@qwikdev/astro-website", "astro-deno-demo", "astro-node-demo", "astro-demo"]
"ignore": [
"@qwikdev/astro-website",
"astro-deno-demo",
"astro-node-demo",
"astro-demo",
"demo-lib"
]
}
2 changes: 1 addition & 1 deletion apps/demo/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ import qwik from "@qwikdev/astro";

// https://astro.build/config
export default defineConfig({
integrations: [qwik({ include: "**/qwik/*" })]
integrations: [qwik({ include: "**/qwik/*", debug: true })]
});
2 changes: 1 addition & 1 deletion apps/demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"dependencies": {
"@astrojs/react": "^3.6.0",
"@builder.io/qwik": "^1.7.2",
"@builder.io/qwik": "https://pkg.pr.new/@builder.io/qwik@eb845d0",
"@qwikdev/astro": "workspace:*",
"@qwikest/icons": "^0.0.13",
"@types/react": "^18.2.64",
Expand Down
8 changes: 3 additions & 5 deletions apps/demo/src/components/qwik/counter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ export const Counter = component$<{ initial: number }>((props) => {
const counter = useSignal(props.initial);

return (
<>
<button type="button" onClick$={() => counter.value++}>
<Slot /> {counter.value}
</button>
</>
<button type="button" onClick$={() => counter.value++}>
<Slot /> {counter.value}
</button>
);
});
9 changes: 9 additions & 0 deletions apps/demo/src/root.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Slot, component$ } from "@builder.io/qwik";

export default component$(() => {
return (
<>
<Slot />
</>
);
});
3 changes: 2 additions & 1 deletion apps/node-demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"@types/react-dom": "^18.2.21",
"astro": "^4.12.2",
"react": "^18.2.0",
"react-dom": "^18.2.0"
"react-dom": "^18.2.0",
"demo-lib": "workspace:*"
}
}
7 changes: 2 additions & 5 deletions apps/node-demo/src/pages/index.astro
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
import { Counter } from "@components/qwik/counter";
import { SayHi } from "@components/qwik/say-hi";
import { Counter } from "demo-lib";
---

<html lang="en">
Expand All @@ -13,9 +12,7 @@ import { SayHi } from "@components/qwik/say-hi";
</head>
<body>
<div style={{ height: '1000px' }}>
<Counter initial={5}>Yo</Counter>
<SayHi>John</SayHi>
<a href="/test">test</a>
<Counter />
</div>
</body>
</html>
3 changes: 2 additions & 1 deletion apps/node-demo/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@components/*": ["./src/components/*"]
"@components/*": ["./src/components/*"],
"demo-lib": ["../../libs/demo-lib"]
},

"jsx": "react-jsx",
Expand Down
31 changes: 31 additions & 0 deletions libs/demo-lib/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
**/*.log
**/.DS_Store
*.
.vscode/settings.json
.history
.yarn
bazel-*
bazel-bin
bazel-out
bazel-qwik
bazel-testlogs
dist
dist-dev
lib
lib-types
etc
external
node_modules
temp
tsc-out
tsdoc-metadata.json
target
output
rollup.config.js
build
.cache
.vscode
.rollup.cache
dist
tsconfig.tsbuildinfo
vite.config.ts
40 changes: 40 additions & 0 deletions libs/demo-lib/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
module.exports = {
root: true,
env: {
browser: true,
es2021: true,
node: true
},
extends: [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:qwik/recommended"
],
parser: "@typescript-eslint/parser",
parserOptions: {
tsconfigRootDir: __dirname,
project: ["./tsconfig.json"],
ecmaVersion: 2021,
sourceType: "module",
ecmaFeatures: {
jsx: true
}
},
plugins: ["@typescript-eslint"],
rules: {
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/explicit-module-boundary-types": "off",
"@typescript-eslint/no-inferrable-types": "off",
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/no-empty-interface": "off",
"@typescript-eslint/no-namespace": "off",
"@typescript-eslint/no-empty-function": "off",
"@typescript-eslint/no-this-alias": "off",
"@typescript-eslint/ban-types": "off",
"@typescript-eslint/ban-ts-comment": "off",
"prefer-spread": "off",
"no-case-declarations": "off",
"no-console": "off",
"@typescript-eslint/no-unused-vars": ["error"]
}
};
38 changes: 38 additions & 0 deletions libs/demo-lib/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Build
/dist
/lib
/lib-types
/server

# Development
node_modules

# Cache
.cache
.mf
.vscode
.rollup.cache
tsconfig.tsbuildinfo

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

# Editor
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?

# Yarn
.yarn/*
!.yarn/releases
6 changes: 6 additions & 0 deletions libs/demo-lib/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Files Prettier should not format
**/*.log
**/.DS_Store
*.
dist
node_modules
47 changes: 47 additions & 0 deletions libs/demo-lib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Qwik Library ⚡️

- [Qwik Docs](https://qwik.dev/)
- [Discord](https://qwik.dev/chat)
- [Qwik on GitHub](https://github.com/QwikDev/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/)

---

## Project Structure

Inside your project, you'll see the following directories and files:

```
├── public/
│ └── ...
└── src/
├── components/
│ └── ...
└── index.ts
```

- `src/components`: Recommended directory for components.

- `index.ts`: The entry point of your component library, make sure all the public components are exported from this file.

## Development

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 are loaded by the browser.

```
pnpm dev
```

> Note: during dev mode, Vite will request many JS files, which does not represent a Qwik production build.

## Production

The production build should generate the production build of your component library in (./lib) and the typescript type definitions in (./lib-types).

```
pnpm build
```
50 changes: 50 additions & 0 deletions libs/demo-lib/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"name": "demo-lib",
"version": "0.0.1",
"description": "Create a Qwik library",
"main": "./lib/index.qwik.mjs",
"qwik": "./lib/index.qwik.mjs",
"types": "./lib-types/index.d.ts",
"exports": {
".": {
"import": "./lib/index.qwik.mjs",
"require": "./lib/index.qwik.cjs",
"types": "./lib-types/index.d.ts"
}
},
"files": ["lib", "lib-types"],
"engines": {
"node": "^18.17.0 || ^20.3.0 || >=21.0.0"
},
"private": false,
"type": "module",
"scripts": {
"build": "qwik build",
"build.lib": "vite build --mode lib",
"build.types": "tsc --emitDeclarationOnly",
"dev": "vite --mode ssr",
"dev.debug": "node --inspect-brk ./node_modules/vite/bin/vite.js --mode ssr --force",
"fmt": "prettier --write .",
"fmt.check": "prettier --check .",
"lint": "eslint \"src/**/*.ts*\"",
"release": "np",
"start": "vite --open --mode ssr",
"test": "echo \"No test specified\" && exit 0",
"qwik": "qwik"
},
"devDependencies": {
"@builder.io/qwik": "^1.7.3",
"@types/eslint": "^8.56.10",
"@types/node": "^20.12.7",
"@typescript-eslint/eslint-plugin": "^7.7.1",
"@typescript-eslint/parser": "^7.7.1",
"eslint": "^8.57.0",
"eslint-plugin-qwik": "latest",
"np": "^8.0.4",
"prettier": "^3.2.5",
"typescript": "5.4.5",
"undici": "*",
"vite": "^5.2.10",
"vite-tsconfig-paths": "^4.2.1"
}
}
16 changes: 16 additions & 0 deletions libs/demo-lib/src/components/counter/counter.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { component$, useSignal } from "@builder.io/qwik";

export const Counter = component$(() => {
const count = useSignal(0);

return (
<div>
<p>Count: {count.value}</p>
<p>
<button type="button" onClick$={() => count.value++}>
Increment
</button>
</p>
</div>
);
});
16 changes: 16 additions & 0 deletions libs/demo-lib/src/components/logo/logo.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { component$ } from "@builder.io/qwik";

export const Logo = component$(() => {
return (
<div>
<a href="https://qwik.dev/">
<img
alt="Qwik Logo"
width={400}
height={147}
src="https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2F667ab6c2283d4c4d878fb9083aacc10f"
/>
</a>
</div>
);
});
17 changes: 17 additions & 0 deletions libs/demo-lib/src/entry.dev.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
* WHAT IS THIS FILE?
*
* Development entry point using only client-side modules:
* - Do not use this mode in production!
* - No SSR
* - No portion of the application is pre-rendered on the server.
* - All of the application is running eagerly in the browser.
* - More code is transferred to the browser than in SSR mode.
* - Optimizer/Serialization/Deserialization code is not exercised!
*/
import { type RenderOptions, render } from "@builder.io/qwik";
import Root from "./root";

export default function (opts: RenderOptions) {
return render(document, <Root />, opts);
}
22 changes: 22 additions & 0 deletions libs/demo-lib/src/entry.ssr.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/**
* WHAT IS THIS FILE?
*
* SSR entry point, in all cases the application is rendered outside the browser, this
* entry point will be the common one.
*
* - Server (express, cloudflare...)
* - npm run start
* - npm run preview
* - npm run build
*
*/
import { type RenderToStreamOptions, renderToStream } from "@builder.io/qwik/server";
import { manifest } from "@qwik-client-manifest";
import Root from "./root";

export default function (opts: RenderToStreamOptions) {
return renderToStream(<Root />, {
manifest,
...opts
});
}
2 changes: 2 additions & 0 deletions libs/demo-lib/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export { Logo } from "./components/logo/logo";
export { Counter } from "./components/counter/counter";
Loading
Loading