Skip to content

Commit 3f52915

Browse files
committed
chore: refactor documentation for professional writing
1 parent e027975 commit 3f52915

125 files changed

Lines changed: 761 additions & 714 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.devcontainer/initializeCommand.sh‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
#!/bin/bash
1+
#!/bin/bash
22

33
# Jen.js Development Container - Initialize Command
44
# This script runs before the container is created
55

66
set -e
77

8-
echo "🔧 Initializing dev container environment..."
8+
echo " Initializing dev container environment..."
99

1010
# Clean up any leftover Docker artifacts that might cause issues
1111
if [ -f ".devcontainer/.env" ]; then
1212
export $(cat .devcontainer/.env | xargs)
1313
fi
1414

15-
echo "✅ Initialization complete"
15+
echo " Initialization complete"

‎.devcontainer/postCreateCommand.sh‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
#!/bin/bash
1+
#!/bin/bash
22

33
# Jen.js Development Container - Post-Create Setup
44
# This script runs after the dev container is created
55

66
set -e
77

8-
echo "🚀 Starting Jen.js Development Container Setup..."
8+
echo " Starting Jen.js Development Container Setup..."
99
echo ""
1010

1111
# Colors for output
@@ -15,27 +15,27 @@ YELLOW='\033[1;33m'
1515
NC='\033[0m' # No Color
1616

1717
# Check versions
18-
echo -e "${BLUE}📋 Verifying environment...${NC}"
18+
echo -e "${BLUE} Verifying environment...${NC}"
1919
echo "Node version: $(node --version)"
2020
echo "pnpm version: $(pnpm --version)"
2121
echo "Git version: $(git --version)"
2222
echo "Python version: $(python3 --version)"
2323
echo ""
2424

2525
# Install dependencies with pnpm
26-
echo -e "${BLUE}📦 Installing project dependencies...${NC}"
26+
echo -e "${BLUE} Installing project dependencies...${NC}"
2727
pnpm install --frozen-lockfile
2828

2929
echo ""
30-
echo -e "${BLUE}🔨 Installing turbo globally...${NC}"
30+
echo -e "${BLUE} Installing turbo globally...${NC}"
3131
pnpm add -g turbo
3232

3333
echo ""
34-
echo -e "${BLUE}⚡ Running TypeScript type checking...${NC}"
35-
pnpm typecheck || echo "⚠️ Some type checks failed, but continuing..."
34+
echo -e "${BLUE} Running TypeScript type checking...${NC}"
35+
pnpm typecheck || echo "️ Some type checks failed, but continuing..."
3636

3737
echo ""
38-
echo -e "${GREEN}✅ Setup Complete!${NC}"
38+
echo -e "${GREEN} Setup Complete!${NC}"
3939
echo ""
4040
echo -e "${YELLOW}Available Commands:${NC}"
4141
echo " pnpm dev - Start development server"
@@ -63,7 +63,7 @@ echo " 1. Run: pnpm dev"
6363
echo " 2. Open http://localhost:5173 in your browser"
6464
echo " 3. Edit files in site/ or src/ to see changes"
6565
echo ""
66-
echo -e "${BLUE}💡 Tips:${NC}"
66+
echo -e "${BLUE} Tips:${NC}"
6767
echo " - Use turbo for building: turbo run build"
6868
echo " - Run specific package: pnpm --filter=<package-name> <command>"
6969
echo " - Clean all builds: pnpm clean"

‎.devcontainer/postStartCommand.sh‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#!/bin/bash
1+
#!/bin/bash
22

33
# Jen.js Development Container - Post-Start Setup
44
# This script runs every time the container starts
@@ -10,7 +10,7 @@ GREEN='\033[0;32m'
1010
BLUE='\033[0;34m'
1111
NC='\033[0m' # No Color
1212

13-
echo -e "${BLUE}🔄 Container started, refreshing environment...${NC}"
13+
echo -e "${BLUE} Container started, refreshing environment...${NC}"
1414

1515
# Update pnpm store in case it was corrupted
1616
pnpm store status > /dev/null 2>&1 || true
@@ -21,6 +21,6 @@ if [ ! -d "node_modules" ]; then
2121
pnpm install --frozen-lockfile
2222
fi
2323

24-
echo -e "${GREEN}✅ Container ready!${NC}"
24+
echo -e "${GREEN} Container ready!${NC}"
2525
echo ""
2626
echo "Run 'pnpm dev' to start the development server"

‎.github/workflows/cli.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build Jen CLI
1+
name: Build Jen CLI
22

33
on:
44
push:
@@ -81,7 +81,7 @@ jobs:
8181
# Binary loc: [root]/target/[target]/release/[bin]
8282
cp ../../target/${{ matrix.rust_target }}/release/$RAW_BIN build/$BIN_NAME
8383
84-
echo "✅ Built: $BIN_NAME"
84+
echo " Built: $BIN_NAME"
8585
8686
- name: Upload artifact
8787
uses: actions/upload-artifact@v4

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AGENTS.md - Jen.js Framework Codebase
22

3-
## 🚫 Documentation Rule (CRITICAL)
3+
## Documentation Rule - CRITICAL
44

55
DO NOT create any `.md` or `.txt` files for documentation.
66

‎TESTING.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Jen.js Testing Guide
1+
# Jen.js Testing Guide
22

33
## Overview
44

@@ -120,13 +120,13 @@ npm run test:run -- --coverage # With coverage report
120120

121121
## Key Features
122122

123-
✅ **TypeScript Support** - Full strict mode compatibility
124-
✅ **Path Aliases** - `@src/*` imports work seamlessly
125-
✅ **Watch Mode** - Auto-rerun on file changes
126-
✅ **Coverage Reports** - HTML, JSON, terminal output
127-
✅ **Global APIs** - No import needed for describe/it/expect
128-
✅ **Mocking** - vi.mock(), vi.spyOn() utilities
129-
✅ **UI Dashboard** - Visual test runner with npm run test:ui
123+
**TypeScript Support** - Full strict mode compatibility
124+
**Path Aliases** - `@src/*` imports work seamlessly
125+
**Watch Mode** - Auto-rerun on file changes
126+
**Coverage Reports** - HTML, JSON, terminal output
127+
**Global APIs** - No import needed for describe/it/expect
128+
**Mocking** - vi.mock(), vi.spyOn() utilities
129+
**UI Dashboard** - Visual test runner with npm run test:ui
130130

131131
---
132132

‎bench/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Jen.js Benchmarks
1+
# Jen.js Benchmarks
22

33
Comprehensive performance benchmarks for the Jen.js framework using Vitest's built-in benchmarking capabilities.
44

@@ -94,10 +94,10 @@ describe("Feature Name", () => {
9494
Vitest benchmarks output:
9595

9696
```
97-
✓ Build Performance
98-
✓ SSG Build - Simple Site (100 iterations, 1.23ms / iter)
99-
✓ SSG Build - Complex Routes (100 iterations, 5.67ms / iter)
100-
✓ Asset Hashing - 1000 Files (100 iterations, 12.34ms / iter)
97+
Build Performance
98+
SSG Build - Simple Site (100 iterations, 1.23ms / iter)
99+
SSG Build - Complex Routes (100 iterations, 5.67ms / iter)
100+
Asset Hashing - 1000 Files (100 iterations, 12.34ms / iter)
101101
```
102102

103103
Lower numbers = better performance.

‎bench/compare.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎bench/regression.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎bench/size-bench/jenjs/build.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { dirname, join } from "node:path";
1+
import { dirname, join } from "node:path";
22
import { fileURLToPath, pathToFileURL } from "node:url";
33
import { readdir, stat, readFile, writeFile } from "node:fs/promises";
44
import esbuild from "esbuild";
@@ -80,7 +80,7 @@ async function main() {
8080

8181
await minifyDir(join(currentDir, config.distDir || "dist"));
8282

83-
console.log("✅ Site built successfully!");
83+
console.log(" Site built successfully!");
8484
}
8585

8686
main().catch(console.error);

0 commit comments

Comments
 (0)