# Generated Project Configuration

> **Auto-generated by `analyze_project`**
> **Project:** appscaffold
> **Type:** library

Save this content to `.clinerules/project.md` in your project root,
then review and adjust the values as needed.

---

## 🚨 MANDATORY: Load CodeOps Rules Before Any Work

**Before ANY planning or implementation, the AI agent MUST load these rules
using the codeops-mcp tools:**

1. `get_rule("agents")` — Load agent behavior rules **(REQUIRED FIRST)**
2. `get_rule("code")` — Load coding standards
3. `get_rule("testing")` — Load testing workflows
4. `get_rule("git-commands")` — Load git commit protocols

These rules are **mandatory** and must be consulted before every task.
**Do NOT skip this step. Do NOT proceed without reading these documents.**

---

## Project Overview

- **Name:** appscaffold
- **Description:** BlendSDK application scaffold generator — generates a Yarn workspaces + Turborepo monorepo with shared, codegen, webapi, and webclient packages
- **Type:** library

## Toolchain

- **Language(s):** TypeScript
- **Framework(s):** esbuild
- **Package Manager:** yarn
- **Test Framework:** Vitest

**Manifest files found:** package.json, tsconfig.json

## Commands

All commands assume execution from the project root. Prefix all shell commands with `clear && sleep [delay] &&` (see Terminal Delay below).

### Terminal Delay

- **Delay (seconds):** 3
- The `clear` ensures a clean terminal; the `sleep` gives VS Code time to initialize the terminal before the command runs.
- Adjust the delay for your environment: `1` for fast machines, `3` (default) for normal, `5` for slower environments.
- All command examples below use `sleep 3` — replace `3` with your configured delay.

### Build

```bash
clear && sleep 3 && yarn build
```

### Test

```bash
# Run all tests
clear && sleep 3 && yarn test
```

### Verify (before commit)

```bash
# Full verification — run this before any git commit
clear && sleep 3 && yarn build && yarn test
```

## Project Structure

### Type: Single repository

### Directory Layout

```
node_modules/
plans/
scaffold/
src/
```

## Coding Conventions

### Naming

- **Files:** kebab-case
- **Components/Classes:** PascalCase
- **Functions/Methods:** camelCase
- **Constants:** UPPER_SNAKE_CASE

## Git & Commit Conventions

### Commit Scope

```
# Use module/feature as scope:
# feat(scaffold): template changes
# fix(generator): generator logic fixes
# chore(project): build/config changes
```

### Branch Strategy

- **Main branch:** `master`
- **Feature branches:** `feature/[name]`

## Special Rules (Project-Specific)

```
- Template files use {{VARIABLE}} placeholder syntax
- Partials in scaffold/partials/*.txt are injected into templates during generation
- Test scaffolded output by running the scaffold, then yarn && yarn ncu && yarn build in the output directory
```

## Cross-References

The generic rule files that read this `project.md`:

- **make_plan.md** — Uses verify command, file paths, commit scope, task file path patterns
- **code.md** — Uses language conventions, architecture rules
- **testing.md** — Uses test commands, test locations, test framework
- **git-commands.md** — Uses commit scope, verify command
- **agents.md** — Uses shell commands, verify command
