Merge pull request #24 from cloudflare/aj/add-formatting

Add formatting  (fix) and linting (fix) to pre-push hook

Author: andyjessop

.changeset/config.json

@@ -1,9 +1,6 @@
 {
 	"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
-	"changelog": [
-		"@changesets/changelog-github",
-		{ "repo": "cloudflare/ai" }
-	],
+	"changelog": ["@changesets/changelog-github", { "repo": "cloudflare/ai" }],
 	"commit": false,
 	"fixed": [],
 	"linked": [],

.husky/pre-push

@@ -1,29 +1,55 @@
 #!/bin/sh
-# This husky pre-push hook fails if the lockfile changes after npm install.
-# Replace "package-lock.json" with your actual lockfile if needed.
+# This Husky pre-push hook checks two things:
+# 1. That the lockfile is not modified by `npm install`.
+# 2. That formatting does not introduce any unstaged changes.
+
+# ANSI colour codes for yellow and reset.
+YELLOW="\033[1;33m"
+RESET="\033[0m"
 
+# Replace "package-lock.json" with your actual lockfile if needed.
 LOCKFILE="package-lock.json"
 
-# Ensure the lockfile exists.
+# 1. Ensure the lockfile exists.
 if [ ! -f "$LOCKFILE" ]; then
-  echo "Error: $LOCKFILE not found."
+  echo ""
+  echo "**ACTION REQUIRED**"
+  echo "${YELLOW}The lockfile ($LOCKFILE) was not found. Please ensure it is present.${RESET}"
+  echo ""
   exit 1
 fi
 
-# Calculate the original hash of the lockfile.
+# 2. Calculate the original hash of the lockfile.
 ORIGINAL_HASH=$(sha256sum "$LOCKFILE" | cut -d ' ' -f 1)
 
-# Run npm install.
+# 3. Run npm install.
 npm install
 
-# Recalculate the hash after npm install.
+# 4. Recalculate the hash after npm install.
 NEW_HASH=$(sha256sum "$LOCKFILE" | cut -d ' ' -f 1)
 
-# Compare the hashes.
+# 5. Compare the hashes.
 if [ "$ORIGINAL_HASH" != "$NEW_HASH" ]; then
-  echo "Error: $LOCKFILE has been modified after npm install. Please review and commit the updated lockfile."
+  echo ""
+  echo "**ACTION REQUIRED**"
+  echo "${YELLOW}Your lockfile has been modified after npm install. Please review and commit the updated lockfile.${RESET}"
+  echo ""
+  exit 1
+fi
+
+# 6. Run Nx format across all projects.
+npx nx run-many -t format lint:fix
+npm run format
+npm run lint:fix
+
+# 7. Check if formatting introduced any changes that need committing.
+if [ -n "$(git status --porcelain)" ]; then
+  echo ""
+  echo "**ACTION REQUIRED**"
+  echo "${YELLOW}Formatting and/or linting caused changes. Please commit them before pushing.${RESET}"
+  echo ""
   exit 1
 fi
 
-# Continue with the remaining pre-push commands.
+# 8. Continue with the remaining pre-push commands.
 npx nx affected --base=main --head=HEAD -t lint types test:ci type-check build

biome.json

@@ -4,7 +4,12 @@
 		"enabled": true
 	},
 	"files": {
-		"ignore": ["node_modules/**/*", "dist/**/*"]
+		"ignore": ["worker-configuration.d.ts", "types/workerd.d.ts"]
+	},
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true
 	},
 	"linter": {
 		"enabled": true,
@@ -23,7 +28,6 @@
 	},
 	"formatter": {
 		"enabled": true,
-		"indentStyle": "tab",
 		"indentWidth": 4,
 		"lineWidth": 100
 	}

demos/agent-scheduler/.gitignore

@@ -0,0 +1,178 @@
+node_modules
+
+.nx
+.idea
+.vscode
+.zed
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*
+
+# wrangler project
+
+.dev.vars
+.wrangler/

demos/agent-scheduler/biome.json

@@ -4,7 +4,12 @@
 		"enabled": true
 	},
 	"files": {
-		"ignore": ["node_modules/**/*", ".wrangler/**/*"]
+		"ignore": ["worker-configuration.d.ts"]
+	},
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true
 	},
 	"linter": {
 		"enabled": true,
@@ -23,8 +28,7 @@
 	},
 	"formatter": {
 		"enabled": true,
-		"indentStyle": "tab",
 		"indentWidth": 4,
-		"lineWidth": 140
+		"lineWidth": 100
 	}
 }

demos/agent-scheduler/package.json

@@ -6,13 +6,16 @@
 		"build": "vite build",
 		"preview": "npm run build && vite preview",
 		"deploy": "npm run build && wrangler deploy",
+		"format": "biome format --write",
 		"test": "vitest",
 		"test:ci": "vitest --watch=false",
 		"cf-typegen": "wrangler types",
-		"lint": "biome lint --error-on-warnings ./src",
+		"lint": "biome lint --error-on-warnings",
+		"lint:fix": "biome lint --fix",
 		"type-check": "tsc --noEmit"
 	},
 	"devDependencies": {
+		"@biomejs/biome": "^1.8.2",
 		"@cloudflare/vitest-pool-workers": "^0.7.5",
 		"typescript": "^5.5.2",
 		"vitest": "~3.0.7",

demos/agent-scheduler/src/SchedulerAgent.ts

@@ -71,7 +71,11 @@ export class SchedulerAgent extends Agent<{ AI: any }, SchedulerAgentState> {
 	/**
 	 * Processes user queries and determines the appropriate scheduling action.
 	 */
-	async query(query: string): Promise<{ confirmation?: Confirmation; message?: string } | Schedule[] | string | undefined> {
+	async query(
+		query: string,
+	): Promise<
+		{ confirmation?: Confirmation; message?: string } | Schedule[] | string | undefined
+	> {
 		const workersai = createWorkersAI({ binding: this.env.AI });
 		const aiModel = workersai("@cf/meta/llama-3.3-70b-instruct-fp8-fast");
 
@@ -87,7 +91,10 @@ export class SchedulerAgent extends Agent<{ AI: any }, SchedulerAgentState> {
 		}
 
 		if (action === "add") {
-			const [payload, scheduleType] = await Promise.all([extractAlarmMessage(aiModel, query), extractAlarmType(aiModel, query)]);
+			const [payload, scheduleType] = await Promise.all([
+				extractAlarmMessage(aiModel, query),
+				extractAlarmType(aiModel, query),
+			]);
 
 			// We can use the same logic for delayed and schedule as they both refer to a
 			// specific time in the future.
@@ -163,7 +170,10 @@ export class SchedulerAgent extends Agent<{ AI: any }, SchedulerAgentState> {
 	/**
 	 * Confirms or rejects a pending scheduling operation based on user input.
 	 */
-	async confirm(confirmationId: string, userConfirmed: boolean): Promise<Schedule | string | false | undefined> {
+	async confirm(
+		confirmationId: string,
+		userConfirmed: boolean,
+	): Promise<Schedule | string | false | undefined> {
 		const confirmation = this.state.confirmations.find((c) => c.id === confirmationId);
 
 		if (!confirmation) {
@@ -204,7 +214,9 @@ export class SchedulerAgent extends Agent<{ AI: any }, SchedulerAgentState> {
 			result = "User chose not to proceed with this action.";
 		}
 
-		const remainingConfirmations = this.state.confirmations.filter((c) => c.id !== confirmationId);
+		const remainingConfirmations = this.state.confirmations.filter(
+			(c) => c.id !== confirmationId,
+		);
 
 		this.setState({
 			...this.state,

demos/agent-scheduler/src/llm/extract-scheduled-date.ts

@@ -1,10 +1,7 @@
 import { generateObject, type LanguageModel } from "ai";
 import z from "zod";
 
-export async function extractScheduledDate(
-	model: LanguageModel,
-	query: string,
-) {
+export async function extractScheduledDate(model: LanguageModel, query: string) {
 	const { object } = await generateObject({
 		model,
 		schema: z.object({

demos/agent-scheduler/src/types/hono.ts

@@ -1,4 +1,8 @@
-import type { Hono, Context as HonoContext, MiddlewareHandler as HonoMiddlewareHandler } from "hono";
+import type {
+	Hono,
+	Context as HonoContext,
+	MiddlewareHandler as HonoMiddlewareHandler,
+} from "hono";
 
 export type Variables = Record<string, string>;