bark-edgeone: Instructions file for Codex

Agent Guidelines for Bark EdgeOne

This document provides coding guidelines and conventions for AI agents working on the Bark EdgeOne codebase.

Project Overview

Bark EdgeOne is a push notification server implementation for EdgeOne Pages Edge Functions, providing APNs integration with global edge deployment.

Tech Stack: TypeScript, EdgeOne Pages, Vitest, ESLint, Prettier

Build, Test, and Lint Commands

Build

npm run build              # Compile TypeScript to dist/
npm run type-check         # Type check without emitting files

Testing

npm test                   # Run all tests once
npm run test:watch         # Run tests in watch mode
npm run test:coverage      # Run tests with coverage report

# Run a single test file
npx vitest run src/utils/__tests__/string.test.ts

# Run tests matching a pattern
npx vitest run -t "isEmpty"

Linting and Formatting

npm run lint               # Check for linting errors
npm run lint:fix           # Auto-fix linting errors
npm run format             # Format all files
npm run format:check       # Check formatting without changes

Local Development

npx edgeone pages dev          # Start local dev server on http://localhost:8788

Deploy to EdgeOne Pages

npx edgeone pages deploy          # Start local dev server on http://localhost:8088

Project Structure

bark-edgeone/
├── src/                   # Core source code
│   ├── apns/             # APNs integration (JWT, payload, push)
│   ├── handlers/         # Business logic handlers
│   ├── types/            # TypeScript type definitions
│   └── utils/            # Utility functions
├── edge-functions/        # EdgeOne edge function endpoints
│   └── api/              # API route handlers
├── node-functions/        # Node.js serverless functions
├── dist/                 # Compiled output
└── __tests__/            # Test files (co-located with source)

Code Style Guidelines

Imports

• Use ES6 import syntax
• Import types with type keyword: import type { Foo } from './types'
• Group imports: external packages first, then internal modules
• Use relative paths for local imports