Introducing...

░▒▓██████▓▒░░▒▓█▓▒░   ░▒▓█▓▒░░▒▓█▓▒░▒▓███████▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░   ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░
░▒▓█▓▒░      ░▒▓█▓▒░   ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░
░▒▓█▓▒▒▓███▓▒░▒▓█▓▒░    ░▒▓██████▓▒░░▒▓███████▓▒░░▒▓████████▓▒░▒▓█▓▒░
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░   ░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░   ░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░
 ░▒▓██████▓▒░░▒▓████████▓▒░▒▓█▓▒░   ░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░
This commit is contained in:
Chris Wanstrath 2025-07-16 22:53:53 -07:00
parent 258dd43e35
commit 7a08efb568
8 changed files with 420 additions and 0 deletions

View File

@ -0,0 +1,117 @@
---
description: Use Bun instead of Node.js, npm, pnpm, or vite.
globs: "*.ts, *.tsx, *.html, *.css, *.js, *.jsx, package.json"
alwaysApply: false
---
Default to using Bun instead of Node.js.
- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
- Use `bun test` instead of `jest` or `vitest`
- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
- Bun automatically loads .env, so don't use dotenv.
## APIs
- `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
- `Bun.redis` for Redis. Don't use `ioredis`.
- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
- `WebSocket` is built-in. Don't use `ws`.
- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
- Bun.$`ls` instead of execa.
## Testing
Use `bun test` to run tests.
Tests should use the toplevel `test()` and the `assert` library.
Test files should always live in `test/` off the project root and be named `THING.test.ts`
```ts#index.test.ts
import { test } from "bun:test"
import assert from 'assert'
test("1 + 2 = 3", () => {
assert.equal(1 + 2, 3)
assert.ok(true)
})
```
## Frontend
Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
Server:
```ts#index.ts
import index from "./index.html"
Bun.serve({
routes: {
"/": index,
"/api/users/:id": {
GET: (req) => {
return new Response(JSON.stringify({ id: req.params.id }));
},
},
},
// optional websocket support
websocket: {
open: (ws) => {
ws.send("Hello, world!");
},
message: (ws, message) => {
ws.send(message);
},
close: (ws) => {
// handle close
}
},
development: {
hmr: true,
console: true,
}
})
```
HTML files can import .tsx, .jsx or .js files directly and Bun's bundler will transpile & bundle automatically. `<link>` tags can point to stylesheets and Bun's CSS bundler will bundle.
```html#index.html
<html>
<body>
<h1>Hello, world!</h1>
<script type="module" src="./frontend.tsx"></script>
</body>
</html>
```
With the following `frontend.tsx`:
```tsx#frontend.tsx
import React from "react";
// import .css files directly and it works
import './index.css';
import { createRoot } from "react-dom/client";
const root = createRoot(document.body);
export default function Frontend() {
return <h1>Hello, world!</h1>;
}
root.render(<Frontend />);
```
Then, run index.ts
```sh
bun --hot ./index.ts
```
For more information, read the Bun API docs in `node_modules/bun-types/docs/**.md`.

View File

@ -0,0 +1,23 @@
---
description: The Workshop's JS/TS style.
alwaysApply: false
globs: "*.ts, *.tsx, *.html, *.css, *.js, *.jsx"
---
- No semicolons — ever.
- No comments — ever.
- 2space indentation.
- Double quotes for strings.
- Trailing commas where ES5 allows (objects, arrays, imports).
- Keep lines <= 100 characters.
- End every file with a single newline.
- This project runs on Bun.
- Assume `strict` mode is on (no implicit `any`).
- Prefer `const`; use `let` only when reassignment is required.
- Avoid the `any` type unless unavoidable.
- Use `import type { … }` when importing only types.
- In TypeScript files put npm imports first, then std imports, then library imports.
- Respond in a concise, direct tone.
- Do not ask followup questions unless clarification is essential.

34
packages/glyph/.gitignore vendored Normal file
View File

@ -0,0 +1,34 @@
# dependencies (bun install)
node_modules
# output
out
dist
*.tgz
# code coverage
coverage
*.lcov
# logs
logs
_.log
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# caches
.eslintcache
.cache
*.tsbuildinfo
# IntelliJ based IDEs
.idea
# Finder (MacOS) folder config
.DS_Store

15
packages/glyph/README.md Normal file
View File

@ -0,0 +1,15 @@
# @workshop/glyph
To install dependencies:
```bash
bun install
```
To run:
```bash
bun run index.ts
```
This project was created using `bun init` in bun v1.2.18. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

View File

@ -0,0 +1,26 @@
<tags>
card: VStack max-w-2xl mx-auto p-6 bg-white rounded-lg shadow-md
name: h3 text-2xl font-bold mb-4 text-gray-800
description: p text-gray-600 mb-6 leading-relaxed
socials: div inline-flex items-center text-blue-600 hover:text-blue-800 transition-colors duration-200
</tags>
<card>
<name>Bobby Tables</name>
<description>
Bobby is a software engineer and the creator of the popular web development framework, Treeact. He is a true master of all things front-end, and his work has been praised by developers and non-developers alike.
</description>
<socials>
<Link to="https://www.github.com/bobbytables2000" text="GitHub" />
</socials>
</card>
<card id="roger">
<name class="this-still-works">Roger Tables</name>
<description>
Roger is a software engineer and the creator of no popular web development frameworks. He is a true lover of all things front-end, but his work has not been praised by developers and non-developers alike.
</description>
<socials>
<Link to="https://www.github.com/rogertables3000" text="GitHub" />
</socials>
</card>

162
packages/glyph/index.ts Normal file
View File

@ -0,0 +1,162 @@
import { parseFragment as parse, serialize } from "parse5"
type TagDefinitions = Record<string, [string, string[]]>
type Node = {
nodeName: string
tagName: string
parentNode: Node | null
childNodes: Node[]
value: string
attrs: { name: string, value: string }[]
}
// search for <tags> node
function findTagsNode(node: Node): Node | null {
if (node.nodeName === "tags" && node.childNodes) {
return node
}
if (node.childNodes) {
for (const child of node.childNodes) {
const result = findTagsNode(child)
if (result) return result
}
}
return null
}
// pull out <tags>'s inner text
function tagsNodeText(node: Node): string | null {
if (node && node.childNodes) {
const textNode = node.childNodes.find((n: Node) => n.nodeName === "#text")
if (textNode)
return textNode.value
}
return null
}
// turn what's inside <tags> into a map of tag definitions
// ignores //comment lines
// format is `tag: parent class1 class2`
function parseTagDefinitions(text: string): TagDefinitions {
const tags: TagDefinitions = {}
text.split("\n")
.forEach(line => {
line = line.trim()
if (line === "") return
if (line.startsWith("//")) return
const [name, definition] = line.split(/:(.+)/)
if (!name || !definition) {
console.error(`Invalid tag definition: ${line}`)
return
}
const [parent, ...classes] = definition.trim().split(" ")
if (!parent) {
console.error(`Invalid tag definition: ${line}`)
return
}
tags[name.trim()] = [parent.trim(), classes]
})
return tags
}
// using our tag definitions, replace the tags in the AST with the real tags w/ classes
function replaceTags(ast: Node, tagDefinitions: TagDefinitions): string {
const tags = Object.keys(tagDefinitions)
for (const tag of tags) {
const [parent, classes] = tagDefinitions[tag] as [string, string[]]
const parentNodes = findTagsByName(ast, tag)
for (const parentNode of parentNodes) {
if (parentNode) {
parentNode.tagName = parent
parentNode.nodeName = parent
if (parentNode.attrs.length === 0) {
parentNode.attrs = [{ name: "class", value: classes.join(" ") }]
} else {
const classAttr = parentNode.attrs.find((a: any) => a.name === "class")
if (classAttr) {
classAttr.value += " " + classes.join(" ")
} else {
parentNode.attrs.push({ name: "class", value: classes.join(" ") })
}
}
}
}
}
// delete <tags> node
const tagsIndex = ast.childNodes.findIndex((n: Node) => n.nodeName === "tags")
if (tagsIndex !== -1) {
ast.childNodes.splice(tagsIndex, 1)
}
return serialize(ast as any)
}
// find tag by name in the AST
function findTagByName(ast: Node, tag: string): Node | null {
if (ast.nodeName === tag) {
return ast
}
if (ast.childNodes) {
for (const child of ast.childNodes) {
const result = findTagByName(child, tag)
if (result) return result
}
}
return null
}
// find tags by name in the AST
function findTagsByName(ast: Node, tag: string): Node[] {
const tags: Node[] = []
if (ast.nodeName === tag) {
tags.push(ast)
}
if (ast.childNodes) {
for (const child of ast.childNodes) {
tags.push(...findTagsByName(child, tag))
}
}
return tags
}
// transform string HTML w/ <tags> into new HTML w/ <tags> + friends replaced by new HTML
function transform(content: string): string {
const ast = parse(content) as Node
const tagsNode = findTagsNode(ast)
if (!tagsNode) {
console.error("No <tags> element found")
return content
}
const tagsText = tagsNodeText(tagsNode)
if (!tagsText) {
console.error("No <tags> text found")
return content
}
const tagDefinitions = parseTagDefinitions(tagsText)
return replaceTags(ast, tagDefinitions)
}
async function main() {
const content = await Bun.file("example.tsx").text()
const transformed = transform(content)
console.log(transformed.trim())
}
if (import.meta.main) {
main()
}

View File

@ -0,0 +1,14 @@
{
"name": "@workshop/glyph",
"module": "index.ts",
"type": "module",
"devDependencies": {
"@types/bun": "latest"
},
"peerDependencies": {
"typescript": "^5"
},
"dependencies": {
"parse5": "^8.0.0"
}
}

View File

@ -0,0 +1,29 @@
{
"compilerOptions": {
// Environment setup & latest features
"lib": ["ESNext"],
"target": "ESNext",
"module": "Preserve",
"moduleDetection": "force",
"jsx": "react-jsx",
"allowJs": true,
// Bundler mode
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": true,
"noEmit": true,
// Best practices
"strict": true,
"skipLibCheck": true,
"noFallthroughCasesInSwitch": true,
"noUncheckedIndexedAccess": true,
"noImplicitOverride": true,
// Some stricter flags (disabled by default)
"noUnusedLocals": false,
"noUnusedParameters": false,
"noPropertyAccessFromIndexSignature": false
}
}