Skip to content
Merged
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
13 changes: 0 additions & 13 deletions .eslintrc.json

This file was deleted.

31 changes: 31 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: CI

on:
push:
branches: [main, update]
pull_request:
branches: [main]

jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x, 20.x, 22.x]
steps:
- uses: actions/checkout@v4

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Run linter
run: npm run lint

- name: Run tests
run: npm test
7 changes: 0 additions & 7 deletions .travis.yml

This file was deleted.

43 changes: 43 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# AI Agent Guidelines

This project uses AI-assisted development with structured guidance in the `ai/` directory.

## Directory Structure

Agents should examine the `ai/*` directory listings to understand the available commands, rules, and workflows.

## Index Files

Each folder in the `ai/` directory contains an `index.md` file that describes the purpose and contents of that folder. Agents can read these index files to learn the function of files in each folder without needing to read every file.

**Important:** The `ai/**/index.md` files are auto-generated from frontmatter. Do not create or edit these files manually—they will be overwritten by the pre-commit hook.

## Progressive Discovery

Agents should only consume the root index until they need subfolder contents. For example:
- If the project is Python, there is no need to read JavaScript-specific folders
- If working on backend logic, frontend UI folders can be skipped
- Only drill into subfolders when the task requires that specific domain knowledge

This approach minimizes context consumption and keeps agent responses focused.

## Vision Document Requirement

**Before creating or running any task, agents must first read the vision document (`vision.md`) in the project root.**

The vision document serves as the source of truth for:
- Project goals and objectives
- Key constraints and non-negotiables
- Architectural decisions and rationale
- User experience principles
- Success criteria

## Conflict Resolution

If any conflicts are detected between a requested task and the vision document, agents must:

1. Stop and identify the specific conflict
2. Explain how the task conflicts with the stated vision
3. Ask the user to clarify how to resolve the conflict before proceeding

Never proceed with a task that contradicts the vision without explicit user approval.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,17 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [3.0.7] - 2026-01-25

### Fixed

- Fix typo in package.json exports field: `./package.json` path was incorrectly specified
- Fix TypeScript compilation error (TS1203) by replacing export = with named exports in index.d.ts

### Updated

- Update AI development framework (aidd) to v2.5.0 for enhanced security reviews
- Update all devDependencies to latest versions (@types/node, @types/react, eslint, eslint-config-next, eslint-config-prettier, eslint-plugin-prettier, next, prettier, react, react-dom, release-it, riteway, updtr, watch)

## [3.0.2] - 2025-10-27

Expand Down Expand Up @@ -175,6 +181,7 @@ Use v2.3.1 for CommonJS or v3.0.0+ for ESM.
- Configurable length (default 24 characters)
- Customizable fingerprints and random functions

[3.0.7]: https://github.com/paralleldrive/cuid2/compare/v3.0.2...v3.0.7
[3.0.2]: https://github.com/paralleldrive/cuid2/compare/v3.0.0...v3.0.2
[3.0.0]: https://github.com/paralleldrive/cuid2/compare/v2.3.1...v3.0.0
[2.3.1]: https://github.com/paralleldrive/cuid2/compare/v2.2.2...v2.3.1
Expand Down
17 changes: 14 additions & 3 deletions ai/commands/commit.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
## 💾 Commit
# Commit

Use commit.mdc to commit the changes to the repository.
Before beginning, read and respect the constraints in please.mdc.
Act as a senior software engineer to commit changes to the repository in non-interactive modes ONLY, using the following template:

"$type${[(scope)]}{[!]}: $description":where `[]` is optional and `!` is a breaking change

Types: fix|feat|chore|docs|refactor|test|perf|build|ci|style|revert|$other

Constraints {
When committing, don't log about logging in the commit message.
Use multiple -m flags, one for each log entry.
Limit the first commit message line length to 50 characters.
Use conventional commits with the supplied template.
Do NOT add new things to the CHANGELOG.md file.
}
66 changes: 66 additions & 0 deletions ai/commands/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# commands

This index provides an overview of the contents in this directory.

## Files

### Commit

**File:** `commit.md`

*No description available*

### discover

**File:** `discover.md`

*No description available*

### execute

**File:** `execute.md`

*No description available*

### help

**File:** `help.md`

*No description available*

### log

**File:** `log.md`

*No description available*

### plan

**File:** `plan.md`

*No description available*

### 🔬 Code Review

**File:** `review.md`

*No description available*

### run-test

**File:** `run-test.md`

*No description available*

### task

**File:** `task.md`

*No description available*

### user-test

**File:** `user-test.md`

*No description available*

11 changes: 11 additions & 0 deletions ai/commands/run-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## 🤖 Run Test

Execute AI agent test script in real browser.

Use @user-testing.mdc to run agent test, capturing screenshots and generating report.

Constraints {
Before beginning, read and respect the constraints in please.mdc.
Drive real browser, narrate thoughts like human tester.
Generate structured markdown report with screenshots.
}
7 changes: 7 additions & 0 deletions ai/commands/user-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## 🧪 User Test

Use @user-testing.mdc to generate human and AI agent test scripts from user journeys.

Constraints {
Before beginning, read and respect the constraints in please.mdc.
}
14 changes: 14 additions & 0 deletions ai/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ai

This index provides an overview of the contents in this directory.

## Subdirectories

### 📁 commands/

See [`commands/index.md`](./commands/index.md) for contents.

### 📁 rules/

See [`rules/index.md`](./rules/index.md) for contents.

4 changes: 2 additions & 2 deletions ai/rules/agent-orchestrator.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Act as a top-tier software engineer, product manager, project manager, and techn
userRequestIncludes =>
please => please.mdc

You are an agent orchestrator. You are responsible for coordinating the actions of the other agents, which are all available in `.cursor/*.mdc` files:
You are an agent orchestrator. You are responsible for coordinating the actions of the other agents, which are all available in `$projectRoot/ai/**/*.mdc` files:

Agents {
please: when user says "please", use this guide for general assistance, logging, committing, and proofing tasks
Expand Down Expand Up @@ -42,4 +42,4 @@ handleInitialRequest() {
> 1 guide => use withCLI
default => use directExecution
}
}
}
10 changes: 10 additions & 0 deletions ai/rules/frameworks/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# frameworks

This index provides an overview of the contents in this directory.

## Subdirectories

### 📁 redux/

See [`redux/index.md`](./redux/index.md) for contents.

2 changes: 1 addition & 1 deletion ai/rules/frameworks/redux/autodux.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Autodux {
Ignore the example usage, and use it only if the user asks for /help
}
/help - Explain how to use Autodux and list commands
/example - Example SudoLang source code in ./example.sudo
/example - Example SudoLang source code in ai/rules/frameworks/redux/example.mdc
/save - Return the Dux in SudoLang format.
/test cases - List the test cases in SudoLang format: TestCases [ ... ]
/add [prop] [value] to the Dux object
Expand Down
18 changes: 18 additions & 0 deletions ai/rules/frameworks/redux/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# redux

This index provides an overview of the contents in this directory.

## Files

### Autodux

**File:** `autodux.mdc`

When building Redux state management, use this guide for creating and transpiling Autodux dux objects

### example

**File:** `example.mdc`

Autodux usage example showing Todo App implementation in SudoLang

96 changes: 96 additions & 0 deletions ai/rules/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# rules

This index provides an overview of the contents in this directory.

## Subdirectories

### 📁 frameworks/

See [`frameworks/index.md`](./frameworks/index.md) for contents.

### 📁 javascript/

See [`javascript/index.md`](./javascript/index.md) for contents.

### 📁 security/

See [`security/index.md`](./security/index.md) for contents.

## Files

### Aiden Agent Orchestrator

**File:** `agent-orchestrator.mdc`

Senior software engineer, product manager, project manager, and technical writer assistant with reflective thinking

**Always active**

### log

**File:** `log.mdc`

When documenting changes, use this guide for creating structured change logs with emoji categorization

### Aiden

**File:** `please.mdc`

When user says "please", use this guide for general assistance, logging, committing, and proofing tasks

**Always active**

### ProductManager

**File:** `productmanager.mdc`

When planning features, user stories, user journeys, or conducting product discovery, use this guide for building specifications and user journey maps

### Functional requirements

**File:** `requirements.mdc`

When writing functional requirements for a user story, use this guide for functional requirement specification

### 🔬 **COMPREHENSIVE CODE REVIEW: Release Latest Tag Epic**

**File:** `review-example.md`

*No description available*

### 🔬 Code Review

**File:** `review.mdc`

Use this guide to conduct a thorough code review focusing on code quality, best practices, and adherence to project standards.

### Tech Stack

**File:** `stack.mdc`

When implementing NextJS + React/Redux + Shadcn UI features, use this guide for tech stack guidance and best practices

### Task Creator

**File:** `task-creator.mdc`

when the user asks you to complete a task, use this guide for systematic task/epic planning and execution

### TDD Engineer

**File:** `tdd.mdc`

*No description available*

### UI/UX Engineer

**File:** `ui.mdc`

When building user interfaces and user experiences, use this guide for beautiful and friendly UI/UX design

### User Testing Generator

**File:** `user-testing.mdc`

Generate human and AI agent test scripts from user journey specifications

Loading