Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 semantic-release-bot
|
aec53651ed | ||
|
asepharyana
|
93f3c2a357 | ||
|
semantic-release-bot
|
9ea3d361b1 | ||
|
asepharyana
|
271721694b | ||
|
semantic-release-bot
|
171597ca05 | ||
|
asepharyana
|
7b0b53671f | ||
|
asepharyana
|
884b19ccb5 | ||
|
asepharyana
|
6db00b2266 | ||
|
asepharyana
|
7f64423615 | ||
|
asepharyana
|
6d3f4918bf | ||
|
asepharyana
|
448eb5d462 | ||
|
semantic-release-bot
|
924576d2ee | ||
|
mytheclipsebotreview
|
033f964be0 | ||
|
mytheclipsebotreview
|
2de5b57133 | ||
|
mytheclipsebotreview
|
d1929f2fd4 |
@@ -1,94 +0,0 @@
|
||||
---
|
||||
name: commit-and-push
|
||||
description: Enforce Conventional Commits specification for all commit messages and push workflows
|
||||
---
|
||||
|
||||
# Commit and Push Rule
|
||||
|
||||
All commits MUST follow the [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) specification. No exceptions.
|
||||
|
||||
## Commit Message Format
|
||||
|
||||
```
|
||||
<type>[optional scope]: <description>
|
||||
|
||||
[optional body]
|
||||
|
||||
[optional footer(s)]
|
||||
```
|
||||
|
||||
## Types
|
||||
|
||||
| Type | When to use |
|
||||
|------|-------------|
|
||||
| `feat` | New feature — correlates with `MINOR` in semver |
|
||||
| `fix` | Bug fix — correlates with `PATCH` in semver |
|
||||
| `chore` | Maintenance, deps, config — no production code change |
|
||||
| `docs` | Documentation only |
|
||||
| `style` | Formatting, whitespace — no logic change |
|
||||
| `refactor` | Code restructure — no feature or fix |
|
||||
| `perf` | Performance improvement |
|
||||
| `test` | Adding or correcting tests |
|
||||
| `build` | Build system or external dependency changes |
|
||||
| `ci` | CI configuration and scripts |
|
||||
| `revert` | Reverts a previous commit |
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
Append `!` after type/scope to indicate a breaking change. This correlates with `MAJOR` in semver.
|
||||
|
||||
```
|
||||
feat(api)!: remove deprecated /v1/users endpoint
|
||||
|
||||
BREAKING CHANGE: /v1/users has been removed. Use /v2/users instead.
|
||||
```
|
||||
|
||||
A `BREAKING CHANGE:` footer can also be used in the commit body.
|
||||
|
||||
## Rules
|
||||
|
||||
1. Type is ALWAYS lowercase.
|
||||
2. Description is imperative mood ("add", not "added" or "adds").
|
||||
3. Description is lowercase, no trailing period.
|
||||
4. Keep subject line under 72 characters.
|
||||
5. Scope is optional but recommended for `feat` and `fix` — use the affected module name.
|
||||
6. One logical change per commit. If a commit spans multiple types, split into multiple commits.
|
||||
7. Body wraps at 72 characters. Use it to explain **why**, not **what**.
|
||||
8. Footer uses `git trailer` format (e.g., `BREAKING CHANGE:`, `Reviewed-by:`, `Refs:`).
|
||||
|
||||
## Lefthook Hooks
|
||||
|
||||
Every commit and push MUST go through Lefthook's `pre-commit` and `pre-push` hooks. Hooks are the gatekeeper — if they fail, the commit/push does not happen.
|
||||
|
||||
1. `pre-commit` runs lint-staged on staged files. Commit is blocked until lint-staged passes.
|
||||
2. `pre-push` runs lint-staged diff check and version bump. Push is blocked until both pass.
|
||||
3. If a hook fails, **fix the root cause**. Do not work around it.
|
||||
|
||||
## Push
|
||||
|
||||
1. Every push MUST pass pre-commit and pre-push hooks (see `push-flow-convention` skill).
|
||||
2. **NEVER use `--no-verify`** to bypass hooks. No exceptions. No "just this once." If hooks fail, fix the issue and retry.
|
||||
3. **NEVER use `git commit --no-verify`**. If pre-commit fails, fix linting/formatting and restage.
|
||||
4. **NEVER use `git push --no-verify`**. If pre-push fails, fix the failing check and push again.
|
||||
5. Commit message quality is enforced — reject vague messages like "fix stuff", "update", "wip", "misc".
|
||||
6. If Lefthook is not installed, run `pnpm exec lefthook install` before committing. Do not commit without hooks registered.
|
||||
7. **NEVER add `Co-Authored-By` trailers for AI tools** (e.g., `Co-Authored-By: Claude Code <noreply@anthropic.com>`). Commits are authored by humans only. No AI attribution in commit messages.
|
||||
8. **NEVER stage all files in one commit** (`git add .` or `git add -A` then commit). Group related changes into separate, focused commits. Each commit = one logical change. If a feature touches auth + billing, split into separate commits per module.
|
||||
9. Stage files deliberately by name (`git add src/auth/login.ts src/auth/types.ts`). Review what's staged before committing (`git status`, `git diff --cached`).
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
feat(auth): add google oauth sign-in
|
||||
fix(cart): correct total calculation when discount is zero
|
||||
chore: update eslint config
|
||||
docs: add setup guide to README
|
||||
refactor(billing): extract invoice calculation to service layer
|
||||
test(users): add unit tests for avatar upload
|
||||
perf(api): cache user profile queries
|
||||
feat(api)!: change response format for /orders endpoint
|
||||
```
|
||||
|
||||
## Reference
|
||||
|
||||
Full specification: [conventionalcommits.org/en/v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/)
|
||||
@@ -1,58 +0,0 @@
|
||||
---
|
||||
name: docs-folder
|
||||
description: Route non-hexagonal files to docs/ folder to keep domain architecture clean
|
||||
---
|
||||
|
||||
# Docs Folder Rule
|
||||
|
||||
Any file that does not fit the hexagonal architecture design pattern MUST live in the `docs/` folder. The source tree stays clean — only hexagonal-compliant code belongs in `src/`.
|
||||
|
||||
## Hexagonal Architecture Recap
|
||||
|
||||
```
|
||||
src/
|
||||
├── domain/ # Pure business logic, entities, value objects, ports (interfaces)
|
||||
├── application/ # Use cases, orchestration, input/output ports
|
||||
├── infrastructure/ # Adapters — DB, HTTP clients, messaging, external APIs
|
||||
└── interfaces/ # Controllers, routes, CLI, resolvers (driving adapters)
|
||||
```
|
||||
|
||||
Only code that fits one of these layers belongs in the source tree.
|
||||
|
||||
## What goes in `docs/`
|
||||
|
||||
| Item | Why it's not hexagonal |
|
||||
|------|----------------------|
|
||||
| Architecture decision records (ADRs) | Documentation, not code |
|
||||
| API documentation / OpenAPI specs | Reference material |
|
||||
| Database diagrams / ERDs | Design artifacts |
|
||||
| Flowcharts / sequence diagrams | Visual documentation |
|
||||
| Meeting notes / technical decisions | Project context |
|
||||
| Onboarding guides | People documentation |
|
||||
| RFC / proposal documents | Decision records |
|
||||
| Scratch files / experiments | Not production code |
|
||||
| Third-party integration guides | Reference material |
|
||||
| Deployment runbooks | Ops documentation |
|
||||
| Configuration examples / templates | Not domain logic |
|
||||
| Migration guides / upgrade notes | Process documentation |
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
docs/
|
||||
├── adr/ # Architecture Decision Records
|
||||
├── api/ # API specs, OpenAPI/Swagger files
|
||||
├── diagrams/ # ERDs, flowcharts, sequence diagrams
|
||||
├── guides/ # Onboarding, deployment, migration guides
|
||||
├── rfcs/ # Proposals and RFCs
|
||||
└── notes/ # Meeting notes, scratch, experiments
|
||||
```
|
||||
|
||||
## Non-negotiables
|
||||
|
||||
1. NEVER put documentation files in `src/` — they pollute the domain.
|
||||
2. NEVER put scratch code, experiments, or spikes in `src/` — use `docs/notes/` or a separate branch.
|
||||
3. NEVER put config examples or templates in `src/` — use `docs/` or project root.
|
||||
4. If a file doesn't implement a port, adapter, use case, or entity — it doesn't belong in `src/`.
|
||||
5. Keep `docs/` organized by category, not by date or author.
|
||||
6. README at project root is fine — detailed docs go in `docs/`.
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,144 +0,0 @@
|
||||
# Clean Architecture
|
||||
|
||||
When to load this reference: when structuring a new service or module, drawing boundaries between components, deciding what a microservice should own, untangling framework coupling, reviewing a system for testability and longevity, or choosing a top-level folder structure.
|
||||
|
||||
Clean Architecture is Uncle Bob's synthesis of Hexagonal Architecture (Alistair Cockburn), Onion Architecture (Jeffrey Palermo), DCI (Coplien & Reenskaug), and BCE (Ivar Jacobson, *Object-Oriented Software Engineering*, 1992). They differ in detail but agree on one goal: **separation of concerns by layering**, with business rules isolated from delivery mechanisms.
|
||||
|
||||
The foundational insight comes from Jacobson: **architectures are structures that support the use cases of the system.** Not frameworks. Not databases. Not UIs. Use cases.
|
||||
|
||||
---
|
||||
|
||||
## What a Clean Architecture Produces
|
||||
|
||||
A system that is:
|
||||
|
||||
1. **Independent of frameworks.** Frameworks are tools, not constraints.
|
||||
2. **Testable.** Business rules tested without UI, DB, web server, or any external element.
|
||||
3. **Independent of UI.** The UI can be replaced (web → console → CLI → TUI) without touching business rules.
|
||||
4. **Independent of database.** Swap PostgreSQL for MongoDB, ClickHouse, or in-memory without rewriting domain logic.
|
||||
5. **Independent of any external agency.** The core business rules know nothing about the outside world.
|
||||
|
||||
**The database is a detail.** So is the web. So is the framework. These are the most common sources of architectural rot because developers mistake them for foundations.
|
||||
|
||||
> "The database is merely an IO device. It happens to provide some useful tools for sorting, querying, and reporting but those are ancillary to the system architecture." — *A Little Architecture* (2016)
|
||||
|
||||
---
|
||||
|
||||
## The Dependency Rule
|
||||
|
||||
The one rule that makes everything else work:
|
||||
|
||||
> **Source code dependencies point only inward, toward higher-level policy.**
|
||||
|
||||
- Nothing in an inner layer may name anything from an outer layer — no function, class, variable, or data format.
|
||||
- Data formats convenient for the outer layer (ORM row struct, JSON DTO) must not leak inward.
|
||||
- Control flow may cross boundaries in either direction, but *source dependencies* point only inward. The Dependency Inversion Principle (see [solid.md](solid.md)) is the mechanism that makes this possible when control flow runs outward.
|
||||
|
||||
When this rule is obeyed, external details — databases, frameworks, UIs — become replaceable plugins.
|
||||
|
||||
---
|
||||
|
||||
## The Four Concentric Layers
|
||||
|
||||
Schematic. You may need more or fewer for a given system, but the Dependency Rule always applies.
|
||||
|
||||
### 1. Entities (innermost)
|
||||
|
||||
Encapsulate **enterprise-wide** business rules. An entity can be a class with methods or a data structure plus functions — style choice.
|
||||
|
||||
- Entities know nothing about applications, use cases, frameworks, or anything outside.
|
||||
- For single applications (no "enterprise"), these are your core business objects.
|
||||
- These are the least affected by operational change. Changes to page navigation, auth mechanisms, or DB schemas must not reach here.
|
||||
|
||||
### 2. Use Cases
|
||||
|
||||
Encapsulate **application-specific** business rules. Use cases orchestrate entities to accomplish the application's goals.
|
||||
|
||||
- A use case directs entities; it does not contain enterprise-wide rules itself.
|
||||
- Changes to the application's *behavior* land here. Changes to externalities do not.
|
||||
- Simple request/response data structures (not entities) flow in and out.
|
||||
|
||||
### 3. Interface Adapters
|
||||
|
||||
Convert data between the format convenient for use cases/entities and the format convenient for external agencies.
|
||||
|
||||
- MVC's Controllers, Presenters, and Views live here.
|
||||
- All SQL lives here (if the database is SQL). Nothing inside knows about SQL.
|
||||
- DTOs are translated into domain types and back here.
|
||||
|
||||
### 4. Frameworks and Drivers (outermost)
|
||||
|
||||
The web framework, the database, the message broker, the file system. Glue code only — you do not write much application logic here. Details live here because details change, and the outer ring is where change is cheap.
|
||||
|
||||
---
|
||||
|
||||
## Crossing Boundaries
|
||||
|
||||
When control flow needs to run outward — a use case needs to call a presenter — a direct call violates the Dependency Rule (the inner layer names something in the outer layer).
|
||||
|
||||
**Solution: the Dependency Inversion Principle.** The use case calls an interface (an "output port") defined in its own layer. The outer-layer presenter implements that interface. Control flows outward; source dependencies point inward. Same pattern works for repositories, gateways, any outward call.
|
||||
|
||||
---
|
||||
|
||||
## What Crosses Boundaries
|
||||
|
||||
Only **simple data structures** cross boundaries:
|
||||
- Plain structs or Data Transfer Objects.
|
||||
- Primitive arguments in function calls.
|
||||
- Maps/dictionaries, when appropriate.
|
||||
|
||||
Never pass Entity objects or ORM row objects across boundaries — that couples layers. Translate to the format most convenient for the inner circle at every boundary crossing.
|
||||
|
||||
---
|
||||
|
||||
## Screaming Architecture
|
||||
|
||||
From the 2011 blog post of the same name. The top-level layout of a project should *scream* what the system does, not what framework it uses.
|
||||
|
||||
**The blueprint metaphor.** Imagine looking at the blueprints of a building. A single-family residence: front entrance, foyer, living room, dining room, kitchen. A library: grand entrance, check-in clerks, reading areas, galleries of bookshelves. A shopping mall: corridors, store bays, parking lots. You can tell what kind of building it is before you see any sign.
|
||||
|
||||
What does *your* application architecture scream?
|
||||
|
||||
**Bad top-level:** `controllers/`, `models/`, `views/`, `services/`. Tells you the system uses MVC. Tells you nothing about what the system is for.
|
||||
|
||||
**Good top-level:** `billing/`, `shipping/`, `catalog/`, `fraud_detection/`. Now you know what the system does.
|
||||
|
||||
**Why it matters:** A good architecture lets you defer decisions about Rails, Spring, Hibernate, Tomcat, MySQL, or React until much later in the project. A framework-centric top-level locks those decisions in day one, and also makes the code base mute about its own purpose. The web is a *delivery mechanism*; the database is a *detail*. Neither should dominate your system structure.
|
||||
|
||||
If a stranger cannot tell from the directory structure whether they are looking at an e-commerce platform or a hospital records system, the architecture is failing at the highest level.
|
||||
|
||||
---
|
||||
|
||||
## Component Principles
|
||||
|
||||
Once modules are organized, they group into **components** — independently deployable units (libraries, services, jars, crates). Two sets of principles govern them.
|
||||
|
||||
### Component Cohesion
|
||||
|
||||
- **REP — Reuse/Release Equivalence Principle.** The unit of reuse is the unit of release.
|
||||
- **CCP — Common Closure Principle.** Group together classes that change for the same reasons at the same times. (SRP at component scale.)
|
||||
- **CRP — Common Reuse Principle.** Classes used together belong together; classes not used together don't. (ISP at component scale.)
|
||||
|
||||
These three pull in different directions — the **tension diagram** is a triangle and component design is an ongoing balance. Early-stage projects lean toward REP+CCP (ship quickly, include more); mature, widely-reused components shift toward CRP (exclude what clients don't need).
|
||||
|
||||
### Component Coupling
|
||||
|
||||
- **ADP — Acyclic Dependencies Principle.** The dependency graph among components must have no cycles. Break cycles with DIP or by extracting a new component both sides depend on.
|
||||
- **SDP — Stable Dependencies Principle.** Depend in the direction of stability.
|
||||
- **SAP — Stable Abstractions Principle.** Stable components should be abstract; volatile components should be concrete.
|
||||
|
||||
---
|
||||
|
||||
## Applying This in Practice
|
||||
|
||||
- **"NO DB" and "NO Web" are valid starting positions.** Business rules should be expressible, testable, and useful before either is chosen.
|
||||
- **Frameworks are tools, not partners.** Wrap them. Keep `import django` or `import axum::Router` out of the core. (Uncle Bob's 2014 "Framework Bound" is a full rant on this.)
|
||||
- **Not every project needs four full circles.** Small projects may collapse Entities and Use Cases into one layer. The Dependency Rule still applies whatever the count.
|
||||
- **The seams matter most.** Architecture lives at the boundaries between components. Defend them at every review — once they rot, replacing a dependency stops being a weekend task and becomes a six-month project.
|
||||
- **Dialog from *A Little Architecture* (2016).** An aspiring architect says they want to make decisions about databases, frameworks, and webservers. Uncle Bob's response: "Oh. Well, then you don't want to become a Software Architect after all." The architect's job is to make decisions that let you **defer** the irrelevant decisions.
|
||||
|
||||
---
|
||||
|
||||
## Architecture and Agility
|
||||
|
||||
From "The Scatology of Agile Architecture" (2009): Agile does *not* mean no up-front architecture. The myth that you evolve architecture from zero is, in Uncle Bob's words, "horse shit." Good teams do enough architecture up front to get the seams right, then let the details emerge inside those seams. See [craft.md](craft.md) for more on this.
|
||||
@@ -1,135 +0,0 @@
|
||||
# The Craftsmanship Ethic
|
||||
|
||||
When to load this reference: when the task raises questions of professional judgment — estimation, deadline pressure, sloppy code accumulating, pairing, saying no to bad requests, or when the user invokes "technical debt" or "mess" or "craftsmanship."
|
||||
|
||||
The behaviors in *Clean Code* and *Clean Architecture* are not ends in themselves. They are instrumental to a larger ethic that Uncle Bob has been refining since the early 2000s: the software craftsmanship movement, which evolved into the Programmer's Oath (see [oath.md](oath.md)) and the 2022 book *Clean Craftsmanship*. This reference captures the non-code parts of that ethic that still materially affect how Claude should behave when writing or reviewing code.
|
||||
|
||||
---
|
||||
|
||||
## Clean Code Is a Practice, Not a Destination
|
||||
|
||||
From many posts, consolidated:
|
||||
|
||||
- Every function is an opportunity to practice. You don't reach "clean" and stop.
|
||||
- The **Boy Scout Rule** is the daily discipline: leave each module cleaner than you found it, even if just by renaming one variable.
|
||||
- "The only way to go fast is to go well." Dirty code does not trade speed for quality; it trades illusory short-term speed for enormous long-term slowness. This is the Productivity Roller-Coaster: feel fast for weeks, slow to a crawl over months.
|
||||
- From *Going Fast*: "Fast" is a property you get by being disciplined, not by skipping discipline.
|
||||
- From *Speed Kills*: conversely, the illusion that you can get fast by cutting corners almost always kills a project.
|
||||
|
||||
---
|
||||
|
||||
## A Mess Is Not Technical Debt
|
||||
|
||||
**This distinction matters.** People conflate them, and the conflation is a way to make sloppiness sound respectable.
|
||||
|
||||
**Ward Cunningham's Technical Debt (the original, 1992):** a **deliberate, considered** engineering trade-off when a schedule or learning situation justifies using a suboptimal design temporarily. You know what the right design is; you are choosing the wrong one now, *with intent*, and you will fix it later. Example: initial website uses server-rendered pages because there's no time to build an Ajax framework.
|
||||
|
||||
**A Mess:** bad code written by someone who did not do the work to understand the problem, did not refactor, did not test, did not think. It is not "debt" because it was never a considered choice — it is just poor craftsmanship.
|
||||
|
||||
From "A Mess is not a Technical Debt" (2009): calling a mess "technical debt" launders bad craftsmanship as if it were responsible engineering. It is not. When refusing to ship a mess, do not accept the framing that "we're just taking on some debt." Debt is deliberate; a mess is sloppy.
|
||||
|
||||
**Fowler's four quadrants of debt** (prudent/imprudent × deliberate/inadvertent) are a better map:
|
||||
- Deliberate+prudent: the original Cunningham case ("we must ship now, we'll fix X next sprint").
|
||||
- Deliberate+imprudent: "we don't have time for design" (toxic, not actually debt).
|
||||
- Inadvertent+prudent: "now I know how we should have done it" (honest learning).
|
||||
- Inadvertent+imprudent: plain-old-mess masquerading as debt.
|
||||
|
||||
---
|
||||
|
||||
## Saying No
|
||||
|
||||
From "Saying No!" (2009) and elaborated in *The Clean Coder*: professionals have an obligation to refuse impossible or unethical demands.
|
||||
|
||||
- When a manager asks for something that cannot be done correctly in the time allowed, the professional answer is "no, but here's what I can do," not "yes" followed by silent quality compromise.
|
||||
- "Yes and then failing to deliver" is worse than "no" — the manager loses the ability to plan around reality.
|
||||
- Professionals push back on their own estimates. If pressure makes you shorten a number you believe, you have stopped being the expert the organization pays you to be.
|
||||
|
||||
Applied to Claude: when a user asks for something that cannot be done well under the stated constraints (skip the tests, skip the error handling, ship something that will crash), the right response includes the pushback. Offer what you *can* deliver cleanly, not a degraded version of what was asked for.
|
||||
|
||||
---
|
||||
|
||||
## Honest Estimates
|
||||
|
||||
From "Why is Estimating so Hard?" (2012) and related posts:
|
||||
|
||||
- Estimates are **probability distributions, not numbers.** Give a range: optimistic, nominal, pessimistic. Three-point estimates are honest; single-point estimates almost always compress uncertainty.
|
||||
- "I don't know yet, let me do a spike" is a professional answer. "I'll have it by Friday" said under duress without real confidence is not.
|
||||
- An estimate is not a commitment; commitments come from negotiating after estimates are honestly given.
|
||||
|
||||
---
|
||||
|
||||
## On Documentation
|
||||
|
||||
**Martin's First Law of Documentation** (from *Agile Software Development: PPP*): "Produce no document unless its need is immediate and significant."
|
||||
|
||||
This is often misread as "Agile means no documentation." It does not. From the butunclebob.com wiki:
|
||||
|
||||
> "Agile Development is NOT development without documentation. Rejecting documentation in the name of 'Agility' is a flawed religious behavior. It is just as flawed as uncritically accepting the production of dozens of different documents."
|
||||
|
||||
Documentation, like any engineering activity, is prioritized by ROI. Create documents that more than pay back the effort to produce them. Skip documents written because policy requires them but no one will read them.
|
||||
|
||||
What counts as documentation:
|
||||
- API docs (rustdoc, TSDoc, javadoc) — high value, close to code.
|
||||
- Architecture decision records (ADRs) — capture *why* decisions were made.
|
||||
- Onboarding / how-to guides — pay back every time a new person joins.
|
||||
- Specs for important flows — pay back every time a flow breaks.
|
||||
|
||||
What does not:
|
||||
- Status reports that recapitulate information already in the tracker.
|
||||
- Design documents written after implementation that no one will read.
|
||||
- Comments that restate the code.
|
||||
|
||||
---
|
||||
|
||||
## Pairing Guidelines
|
||||
|
||||
From "Pairing Guidelines" (2021) and earlier posts:
|
||||
|
||||
- Pairing is a **tool**, not a religion. Use it when it works; don't when it doesn't.
|
||||
- Mature agile teams pair maybe 50–70% of the time, not 100%.
|
||||
- Some problems require "time, focus, and silence" to study before attacking. Pairing on those is worse than solo.
|
||||
- Pair at the start of a story to align direction; solo for deep-focus passages; reunite to review.
|
||||
- The strategy "separate the syntax issues from the semantic issues" is a useful pattern when stuck as a pair — refactor the mechanical noise (parsing, config, regex) into a helper module so the core algorithm can be reasoned about on its own.
|
||||
|
||||
---
|
||||
|
||||
## Shipping Under Pressure
|
||||
|
||||
From "AgilePeopleStillDontGetIt" (2006) and "We must ship now and deal with consequences" (2009):
|
||||
|
||||
- "It is completely unacceptable to release code that you aren't sure works. Either make sure it works, or don't ship it. Period."
|
||||
- "A feature that crashes is much worse than a feature that doesn't exist. A feature that doesn't exist will defer revenue. A feature that crashes makes enemies out of customers."
|
||||
- "Our customers interpret features as promises. When we release a feature we are promising that it works. When it crashes we have broken that promise."
|
||||
- "Shipping untested software is shipping something unfinished and your customers will force you to finish it. The pressure will be higher at orders of magnitude if you finish it AFTER you have shipped it."
|
||||
|
||||
Applied to Claude: when asked to ship quickly and drop tests, the honest response is that the tests aren't slowing you down; they are the only way to ship correctly. "Going fast" without tests produces code that will return tenfold in debugging and firefighting over the next weeks.
|
||||
|
||||
---
|
||||
|
||||
## Professionalism Is Not Rigid Formalism
|
||||
|
||||
From "Why the sea is boiling hot" (2009) — the closing statement of Uncle Bob's 2009 Rails Conf keynote:
|
||||
|
||||
> "Professionalism does not mean rigid formalism. Professionalism does not mean adhering to bureaucracy. Professionalism is **honor**. Professionalism is being honest with yourself and disciplined in the way you work. Professionalism is not letting fear take over."
|
||||
|
||||
Honor and discipline. Not process for its own sake. The rules in this skill are tools for being disciplined; they are not a rulebook to hide behind.
|
||||
|
||||
---
|
||||
|
||||
## The Tricky Bit
|
||||
|
||||
From "The Tricky Bit" (2010): a British MP flew the Concorde and complained to the designer that going supersonic "didn't feel any different at all." The designer beamed: "Yes, that was the tricky bit."
|
||||
|
||||
Clean code, good architecture, solid tests — when they are working, the reader doesn't notice. The absence of friction is the product. Code that *announces* how clever it is, how much architecture it has, how sophisticated its patterns are, is usually the opposite of clean. The goal is invisibility — the reader moves through the code and feels nothing but understanding.
|
||||
|
||||
---
|
||||
|
||||
## When Claude Should Invoke Any of This
|
||||
|
||||
- **User wants to skip tests "just this once":** reference the "A Mess is not Debt" framing and the shipping-under-pressure material.
|
||||
- **User wants a speculative number instead of a range:** offer a range and explain why.
|
||||
- **User wants you to document something they won't read:** suggest the minimum viable doc that pays its way.
|
||||
- **User wants a "quick fix" that you can see will rot the module:** explain the Boy Scout Rule cost — a quick fix that makes the code worse is a negative-value change even at zero time cost.
|
||||
- **User says "we're doing Agile, we don't write documentation":** redirect to Martin's First Law and the "it's about ROI" framing.
|
||||
|
||||
The oath ([oath.md](oath.md)) captures the promises. This file captures the attitude and the vocabulary for navigating the hard conversations where craft meets pressure.
|
||||
File diff suppressed because one or more lines are too long
@@ -1,161 +0,0 @@
|
||||
# Programming Paradigms
|
||||
|
||||
When to load this reference: when choosing between procedural and OO style, writing code in a functional language, refactoring switch statements, handling persistence, or when the user asks about OO vs FP, design patterns, or Clean Code's chapter on objects and data structures.
|
||||
|
||||
Uncle Bob's reductionist framing of the three paradigms is a powerful lens for reasoning about code shape. Each paradigm imposes **discipline** by **taking something away** from the programmer.
|
||||
|
||||
---
|
||||
|
||||
## The Three Paradigms
|
||||
|
||||
Each paradigm is defined by what it *forbids*, not by what it enables. This is Dijkstra-style reasoning: fewer primitives mean fewer ways to be wrong.
|
||||
|
||||
### Structured Programming
|
||||
|
||||
- **Forbids:** `goto` (direct transfer of control).
|
||||
- **Provides:** Sequence, Selection (if/else), Iteration (while). Dijkstra proved any algorithm can be expressed with just these three.
|
||||
- **Why:** Dijkstra's 1968 letter "Go To Statement Considered Harmful." Unrestricted `goto` makes programs impossible to reason about. Restricted control flow is provably correct for sequence, selection, iteration; not provably correct with arbitrary `goto`.
|
||||
- **Status today:** Won so completely that most developers don't even realize they're using it. Modern languages don't have `goto` (or discourage it).
|
||||
|
||||
### Object-Oriented Programming
|
||||
|
||||
- **Forbids:** Raw function pointers / indirect transfer of control through unmanaged pointers.
|
||||
- **Provides:** Polymorphism. The language manages the function pointers for you.
|
||||
- **Why:** Raw function pointers (as in C) are correct but fragile — every caller must follow conventions every time. Polymorphism provides the same runtime capability through a disciplined mechanism: objects carry their own dispatch table, set up once when the object is created.
|
||||
- **The reductionist core:** OO = polymorphism. Encapsulation, methods-bound-to-data, and simple inheritance exist in C and Pascal too. **What OO uniquely gives you is convenient polymorphism.** "OO without polymorphism is not OO."
|
||||
|
||||
### Functional Programming
|
||||
|
||||
- **Forbids:** Assignment / mutation of state.
|
||||
- **Provides:** Referential transparency. Same inputs → same outputs, always, everywhere.
|
||||
- **Why:** Shared mutable state is the source of most concurrency bugs and most "action at a distance" reasoning failures. Forbidding it means state changes are explicit and localized.
|
||||
- **The reductionist core:** FP = referential transparency. Higher-order functions exist in OO languages too (Smalltalk, etc.). What FP uniquely gives you is the guarantee that a function call cannot change anything you didn't pass to it.
|
||||
|
||||
### Why "Three Paradigms" Matters
|
||||
|
||||
These are **orthogonal**, not competing. Each removes a different freedom:
|
||||
|
||||
| Paradigm | Discipline on | Mechanism |
|
||||
|---|---|---|
|
||||
| Structured | Direct transfer of control | No `goto` |
|
||||
| OO | Indirect transfer of control | Polymorphism |
|
||||
| FP | Assignment | Referential transparency |
|
||||
|
||||
A language can (and modern ones often do) impose all three disciplines at once. You can write OO code functionally, and you can apply SOLID inside a functional program.
|
||||
|
||||
---
|
||||
|
||||
## OO and FP Are Orthogonal, Not Exclusive
|
||||
|
||||
From Uncle Bob's 2014 and 2018 "FP vs OO" posts:
|
||||
|
||||
> "The principles of software design still apply, regardless of your programming style. The fact that you've decided to use a language that doesn't have an assignment operator does not mean that you can ignore the Single Responsibility Principle; or that the Open Closed Principle is somehow automatic."
|
||||
|
||||
And from his 2023 *Functional Classes* post: "Should you subdivide a functional program into classes the way you would an object oriented program? Yes. You should. Because the rules don't change just because you've chosen to use immutable data structures."
|
||||
|
||||
**A class, reductively:** "A group of cohesive and narrowly defined functions that operate on an encapsulated data structure. The functions may, or may not, be polymorphically deployed." This definition works in Clojure, Haskell, Rust, Java, TypeScript, Python.
|
||||
|
||||
**The design principles transcend paradigm:**
|
||||
- SRP applies in Clojure (group functions by actor).
|
||||
- OCP applies in Haskell (use abstraction, add type class instances).
|
||||
- DIP applies anywhere there are modules.
|
||||
- A "class" in the sense above is a cohesive namespace of related functions plus the data they operate on.
|
||||
|
||||
---
|
||||
|
||||
## Data/Object Anti-Symmetry
|
||||
|
||||
From Chapter 6 of *Clean Code* and elaborated in the 2019 blog post "Classes vs. Data Structures."
|
||||
|
||||
**Two definitions that complement each other:**
|
||||
|
||||
- **Object:** A set of functions that operate on **implied** data. Data exists but is hidden. Callers see only functions.
|
||||
- **Data structure:** A set of data elements operated on by **implied** functions. Data is exposed. Functions exist but are not specified by the structure.
|
||||
|
||||
They are **diametric opposites**. You cannot fully be both.
|
||||
|
||||
### Consequences
|
||||
|
||||
- **DTOs are data structures, not objects.**
|
||||
- **Database tables are data structures, not objects.**
|
||||
- **"ORM" is a misnomer.** There is no mapping between database tables and objects. ORMs map tables to data structures. (This is not pedantic; it explains why ORMs have the smells they do.)
|
||||
- **Polymorphism is the marker of objects.** When `shape.area()` dispatches dynamically to the Circle or Square implementation, you are doing OO. When `area(shape)` is a free function with `match shape { Circle => …, Square => … }`, you are doing procedural work.
|
||||
|
||||
### The Four Symmetry Rules
|
||||
|
||||
These tell you when to choose each style.
|
||||
|
||||
| | Add new FUNCTION | Add new TYPE |
|
||||
|---|---|---|
|
||||
| **Classes (OO)** | **Hard** — change every class | **Easy** — add one class |
|
||||
| **Data structures (procedural)** | **Easy** — add one function | **Hard** — change every function |
|
||||
|
||||
**Choose by expected axis of change:**
|
||||
|
||||
- If you expect more new functions than new types → procedural style with data structures + functions (e.g., visitor pattern, pattern matching over enums, Clojure-style).
|
||||
- If you expect more new types than new functions → OO style with classes and polymorphism.
|
||||
- The **Visitor pattern** is procedural-style behavior over OO data — it bridges the two.
|
||||
|
||||
**In Rust specifically:** enums with `match` are procedural by this taxonomy (add a variant → every match must handle it); traits with implementations are OO (add an impl → no existing code changes). Neither is wrong; choose by axis of change. If new variants are rare and new operations are common, the enum wins. If new types are common, the trait wins.
|
||||
|
||||
---
|
||||
|
||||
## Polymorphism and if-else-switch
|
||||
|
||||
From "if-else-switch" (2021). A very common refactor:
|
||||
|
||||
**The pattern.** When you see an if/else chain or switch that branches by type or by "kind," replace it with:
|
||||
|
||||
1. A base class or interface with one method per case.
|
||||
2. Concrete implementations, one per branch.
|
||||
3. A **factory** that creates the right implementation based on the discriminator (this is where the if/else/switch ends up, condensed into one place).
|
||||
4. The business logic calls the interface, never the discriminator.
|
||||
|
||||
**Runtime characteristics are identical.** If/else does a procedural lookup, switch uses a compiler-built jump table, polymorphic dispatch uses a vtable — similar performance.
|
||||
|
||||
**What you gain:**
|
||||
- The high-level business code no longer transitively depends on every low-level case.
|
||||
- Each case is its own named method, not an indented block within a branch.
|
||||
- New cases = new classes (OCP).
|
||||
- Independent deployment becomes possible: the high-level module and each implementation can live in separate components.
|
||||
|
||||
**When not to apply:** if the switch is small, stable, and not type-based (e.g., processing a small enum of flags in one place), leaving it as a switch is fine. The rule is "factor out switches on *type*," not "destroy every conditional."
|
||||
|
||||
---
|
||||
|
||||
## The Tell-Don't-Ask Style
|
||||
|
||||
Alan Kay's original OO conception: objects as cells in a biological system.
|
||||
|
||||
> "Neurons are tellers, not askers. Hormones are tellers, not askers. In biological systems, communication was half-duplex."
|
||||
|
||||
Instead of:
|
||||
```
|
||||
if account.getBalance() < amount:
|
||||
throw InsufficientFunds
|
||||
account.setBalance(account.getBalance() - amount)
|
||||
```
|
||||
|
||||
Say:
|
||||
```
|
||||
account.withdraw(amount) // account decides if it can, and how
|
||||
```
|
||||
|
||||
The caller stops interrogating state and deciding. The object owns the decision. This is what Law of Demeter is a weak shadow of — the deeper principle is that state should not leak out of objects.
|
||||
|
||||
---
|
||||
|
||||
## Loops and State Machines
|
||||
|
||||
From the 2020 "Loopy" post. Any program with nested loops can be refactored step-by-step into a Turing-style finite state machine, with tests passing at every step. This is a useful mental exercise: a nested loop is a state machine that a programmer wrote too compactly.
|
||||
|
||||
Practical takeaway: when a loop body is getting complex, consider extracting an explicit state (enum of states) and transitioning between them. Reads better than four nested `if`s; generalizes better; easier to test.
|
||||
|
||||
---
|
||||
|
||||
## Applying This in Practice
|
||||
|
||||
- **Default to OO + polymorphism** for business logic where types vary (entities, strategies, handlers). Polymorphism is the mechanism behind DIP, OCP, and Clean Architecture boundaries.
|
||||
- **Default to data structures + free functions** for values, messages, and records that flow through the system. DTOs, events, API payloads, DB rows.
|
||||
- **Keep the two species apart.** A "hybrid" that has both public fields and rich behavior usually gets the worst of both worlds.
|
||||
- **FP is not an exception to SOLID.** Cohesion, SRP, DIP all still apply; you express them with namespaces, protocols, or type classes instead of classes.
|
||||
File diff suppressed because one or more lines are too long
@@ -1,177 +0,0 @@
|
||||
# Test Driven Development
|
||||
|
||||
When to load this reference: when writing new tests, reviewing tests, debugging brittle tests, dealing with legacy code that resists testing, or deciding on a testing strategy for a module.
|
||||
|
||||
Tests are the safety net that makes fearless refactoring possible. Without that net, every change is a gamble; with it, every change can be confident. Tests are also the most precise, executable documentation a system will ever have.
|
||||
|
||||
**Michael Feathers's definition of legacy code:** *Legacy code is code without tests.* Uncle Bob adopted this definition and it underpins the TDD practice.
|
||||
|
||||
---
|
||||
|
||||
## The Three Laws of TDD
|
||||
|
||||
1. **You are not allowed to write any production code unless it is to make a failing unit test pass.**
|
||||
2. **You are not allowed to write any more of a unit test than is sufficient to fail — and compilation failures are failures.**
|
||||
3. **You are not allowed to write any more production code than is sufficient to pass the one failing unit test.**
|
||||
|
||||
The loop is measured in seconds, not minutes. Write a line or two of test, see it fail, write a line or two of production, see it pass, repeat. This is the **nano-cycle**.
|
||||
|
||||
**Why these rules:**
|
||||
|
||||
- **Debugging time plummets** — you were never more than 60 seconds away from working code.
|
||||
- **Tests are automatic documentation** that cannot fall out of sync with the system.
|
||||
- **Design improves** because code written to be testable is naturally decoupled.
|
||||
- **Refactoring becomes fearless** because the net catches regressions instantly.
|
||||
|
||||
This is double-entry bookkeeping for software. Every behavior is stated twice — once in the test, once in the code — and they must agree.
|
||||
|
||||
---
|
||||
|
||||
## F.I.R.S.T. — Clean Tests
|
||||
|
||||
Clean tests are:
|
||||
|
||||
- **Fast.** Slow tests will stop being run. If a suite takes 10 minutes, people will commit without running it. 15-minute CI feedback is too slow for the TDD loop.
|
||||
- **Independent.** No test depends on another. Any test can run alone, in any order.
|
||||
- **Repeatable.** Same result in every environment — laptop, CI, staging. If a test depends on the network, wall clock, or shared database, it is flaky and must be fixed.
|
||||
- **Self-validating.** Pass or fail. No manual inspection.
|
||||
- **Timely.** Written *just before* the production code they cover — not "when we have time."
|
||||
|
||||
Test code is first-class. Hold it to the same clarity bar as production code. When tests rot, production code rots.
|
||||
|
||||
---
|
||||
|
||||
## Canonical Test Definitions (First-Class Tests, 2017)
|
||||
|
||||
The industry has been sloppy about what "unit," "integration," "acceptance," etc. mean. Uncle Bob's proposed taxonomy:
|
||||
|
||||
- **Unit Test.** Written by a programmer, for a programmer. Ensures production code does what the programmer expected. Sometimes called **programmer test** or **micro-test**.
|
||||
- **Acceptance Test.** Written by the business (or a BA/QA representing the business). Ensures production code does what the business expects. Sometimes called **customer test**.
|
||||
- **Integration Test.** Written by architects or technical leads. Ensures a sub-assembly of system components operates correctly. **These are plumbing tests, not business-rule tests** — rules are already verified by unit and acceptance tests.
|
||||
- **System Test.** An integration test for the whole integrated system.
|
||||
- **Micro-test** (Mike Hill / @GeePawHill). A unit test at very small scope — tests a single function or small group.
|
||||
- **Functional Test.** A unit test at larger scope, with mocks for slow components.
|
||||
|
||||
> "Integration tests do not test business rules. Those rules have already been tested, once by programmer (unit) tests, and again by customer (acceptance) tests. Integration tests test the plumbing and choreography of the components." — Uncle Bob (Twitter, 2019)
|
||||
|
||||
**Implication for Claude when writing tests:** Know which kind of test you are writing and don't couple it to the wrong kind. If you're asked to "add tests" for a pure function, write unit/micro tests. If you're asked to "test the API works end-to-end," that's integration/system. Don't test business rules in an integration test — the rules should already have unit tests.
|
||||
|
||||
---
|
||||
|
||||
## Test Structure
|
||||
|
||||
Use one of these structures; be consistent.
|
||||
|
||||
- **Arrange / Act / Assert** — set up context, perform action, check result.
|
||||
- **Given / When / Then** — same thing in BDD vocabulary.
|
||||
- **Build / Operate / Check** — same thing, different vocabulary.
|
||||
|
||||
One *concept* per test. Often one assertion, but "one concept" is the real rule — several assertions verifying the same behavior are fine.
|
||||
|
||||
### Test Naming
|
||||
|
||||
Name the test for what it verifies about behavior, not for the method. `returns_empty_list_when_given_empty_input` beats `test_filter_1`. If the name runs long, the test is probably doing more than one thing.
|
||||
|
||||
---
|
||||
|
||||
## Test Doubles — The Hierarchy
|
||||
|
||||
Adapted from Gerard Meszaros's *xUnit Patterns*, with Uncle Bob's gloss. Each is a degree of sophistication above the last.
|
||||
|
||||
- **Dummy.** Passed around but never used. Fills a parameter slot.
|
||||
- **Stub.** Returns canned answers. No logic.
|
||||
- **Spy.** A stub that records the calls it received.
|
||||
- **Mock.** A spy with expectations built in: set up *before* the act, verified *after*. Fails if expected interactions didn't happen.
|
||||
- **Fake.** A working implementation with production-unfit shortcuts — e.g., in-memory repo that stands in for a real database.
|
||||
|
||||
Pick the lowest-sophistication double that does the job. A mock where a stub would suffice adds coupling and fragility.
|
||||
|
||||
**Uncle Bob hand-rolls most of his Java mocks** ("Manual Mocking," 2009) rather than using mockito, to keep explicit control over ceremony. This is a taste preference, not a rule, but his reasoning (less magic, clearer test code) is worth knowing.
|
||||
|
||||
---
|
||||
|
||||
## Chicago vs. London (State-ism vs. Mockism)
|
||||
|
||||
Two schools of TDD.
|
||||
|
||||
- **Chicago / Classical / State-ist.** Test behavior through state. Exercise the object, assert on its final state (or collaborators' state). Minimal mocking. Less coupled to implementation detail.
|
||||
- **London / Mockist.** Test behavior through interactions. Mock collaborators; assert on calls. More explicit about collaboration but more coupled to it.
|
||||
|
||||
**Practical guidance:** Use Chicago for value objects, algorithms, internal logic. Use London at **boundaries** — where the code coordinates external collaborators. Never mock what you own when you could exercise it directly; mock (or fake) what you do not own when the real thing would make the test slow or flaky.
|
||||
|
||||
---
|
||||
|
||||
## Fragile Tests
|
||||
|
||||
Tests that break without a real regression are worse than no tests — they train developers to ignore the suite. Known causes:
|
||||
|
||||
- **Interface sensitivity.** Tests break because a signature changed, not behavior. Often a sign of excessive mocking.
|
||||
- **Behavior sensitivity.** Tests break because an unrelated behavior changed. A sign of poor isolation.
|
||||
- **Data sensitivity.** Tests break because shared fixtures changed. Fix by making tests own their data.
|
||||
- **Context sensitivity.** Tests pass locally, fail in CI. Remove environmental coupling: clock, network, filesystem, time zone.
|
||||
- **Over-specification.** Tests assert on more than the behavior under test — internal call order, private fields, log output. Assert on what the *user of the code* would observe.
|
||||
|
||||
A fragile test is a design signal — usually a missing abstraction, a leaky boundary, or an over-eager mock.
|
||||
|
||||
"Skilled TDDers understand that neither micro-tests, nor functional tests, nor acceptance tests should be coupled to the implementation of the system." — *First-Class Tests* (2017)
|
||||
|
||||
---
|
||||
|
||||
## As Tests Get More Specific, Code Gets More Generic
|
||||
|
||||
Uncle Bob's formulation (2009): tests are specifications. As you add tests, the specifications grow more specific. To satisfy them all, the production code must grow more *generic*. This is the inverse relationship that drives TDD-induced good design — the code gets pushed toward abstractions that cover many cases rather than one.
|
||||
|
||||
---
|
||||
|
||||
## The Transformation Priority Premise (TPP)
|
||||
|
||||
When making a failing test pass, there is a natural ordering of changes, simpler before more complex. Prefer earlier transformations when more than one would work:
|
||||
|
||||
1. `{} → nil` — no code → returning nil
|
||||
2. `nil → constant` — return a constant
|
||||
3. `constant → variable` — replace constant with a variable
|
||||
4. `statement → statements` — add another statement
|
||||
5. `unconditional → if` — introduce a branch
|
||||
6. `scalar → array` — move from a single value to a collection
|
||||
7. `array → container` — move to a richer collection type
|
||||
8. `statement → recursion` — replace a statement with recursion
|
||||
9. `if → while` — replace a branch with iteration
|
||||
10. `expression → function` — extract a function
|
||||
11. `variable → assignment` — introduce mutation
|
||||
|
||||
Using lower-priority transformations earlier creates needless complexity; using higher-priority ones later often indicates a design that could be simpler. TPP is a tiebreaker, not a law — but it usually guides tests toward algorithms that generalize cleanly.
|
||||
|
||||
---
|
||||
|
||||
## The Cycles of TDD
|
||||
|
||||
TDD operates at multiple time scales simultaneously. Working at only one scale produces bad software.
|
||||
|
||||
- **Seconds (Red-Green-Refactor).** The nano-cycle.
|
||||
- **Minutes (Specific-to-Generic).** Tests grow more specific; code grows more generic.
|
||||
- **Tens of minutes (Boundary).** Periodically step back and ask whether the module is still well-factored. Extract. Rename. Regroup.
|
||||
- **Hours (Architecture).** Once a day or so, step back further: are the component boundaries still correct? Does the Dependency Rule still hold?
|
||||
- **Days (Acceptance).** Acceptance tests (at the feature/use-case level) close the loop with the business.
|
||||
|
||||
Skipping the larger cycles is the most common failure mode. Red-Green-Refactor religiously, but never step back to reconsider architecture, and you end up with a suite of fine-grained tests wrapped around a tangled ball of mud.
|
||||
|
||||
---
|
||||
|
||||
## Testing Across Architectural Boundaries
|
||||
|
||||
- **The test boundary** is a first-class part of architecture. Tests live outside the system they test.
|
||||
- **Do not couple tests to UI frameworks or databases.** If a test needs a browser to exercise a use case, the boundary between use case and UI is broken.
|
||||
- **Legacy code strategy** (Feathers). Find a seam — a place where behavior can be varied without modifying code. Write a characterization test at that seam to pin down current behavior. Refactor behind the pin. Repeat.
|
||||
|
||||
Uncle Bob's position on test placement: "Don't test through UIs. Don't test through web servers. Test as close to the code as you can." — *Testing Like the TSA* (2017)
|
||||
|
||||
---
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
- **Writing tests after the fact.** Produces tests that confirm whatever the code happens to do, including the bugs. Much lower value than TDD.
|
||||
- **Slow test suites.** If any unit test takes more than a fraction of a second, isolate it. Keep the unit suite fast and run integration tests separately.
|
||||
- **Mocking what you own.** Prefer real objects for your own code.
|
||||
- **Testing implementation details.** Refactors then break tests without any real regression, and people conclude "TDD gets in the way of refactoring." It doesn't — the tests were just wrong.
|
||||
- **Skipping refactor.** Red-Green-… is not TDD. The third step is where design emerges.
|
||||
- **Over-coverage religion.** Uncle Bob's ratio for some project types: 20% test-first, 80% test-after is acceptable for controllers/models/views (per *Testing Like the TSA*, 2017). The three laws are guidance for the hottest logic in the system, not dogma for every trivial accessor.
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
name: commit-convention
|
||||
description: Conventional Commits format and version-bump rules for this repo (Bahasa Indonesia commit style). Use when creating a git commit in zesdex.
|
||||
---
|
||||
|
||||
# Commit Convention
|
||||
|
||||
Gunakan **Conventional Commits** untuk semua commit. Format:
|
||||
|
||||
```
|
||||
<type>(<scope>): <description>
|
||||
```
|
||||
|
||||
**Type & efek ke versi:**
|
||||
|
||||
| Type | Bump | Kapan pakai |
|
||||
|-------------|-------|------------------------------------------|
|
||||
| `feat` | minor | Fitur baru |
|
||||
| `fix` | patch | Perbaikan bug |
|
||||
| `chore` | patch | Maintenance, update deps, dll |
|
||||
| `docs` | patch | Perubahan dokumentasi/comment |
|
||||
| `refactor` | patch | Refactor kode tanpa perubahan fungsional |
|
||||
| `test` | patch | Nambah/ubah test |
|
||||
| `style` | patch | Formatting, whitespace, lint |
|
||||
| `perf` | patch | Optimasi performa |
|
||||
| `ci` | patch | Perubahan CI/CD |
|
||||
|
||||
**Catatan:**
|
||||
- **Semua type menghasilkan release** (patch minimal). Tidak ada commit yang "skip release".
|
||||
- Tambahkan `BREAKING CHANGE:` di body commit untuk bump **major**.
|
||||
- **Scope** opsional, tapi direkomendasikan (misal `feat(agent):`, `fix(ipc):`).
|
||||
|
||||
### Contoh
|
||||
|
||||
```
|
||||
feat(tool): add batch file delete
|
||||
|
||||
chore: bump reqwest to 0.12
|
||||
|
||||
refactor(harness): flatten guard pipeline
|
||||
|
||||
fix(ipc): reconnect loop on socket timeout
|
||||
|
||||
docs: add architecture diagram to README
|
||||
|
||||
BREAKING CHANGE: IPC frame header changed from 4-byte to 8-byte length
|
||||
```
|
||||
@@ -1,449 +0,0 @@
|
||||
---
|
||||
name: kana-rust-backend-best-practice
|
||||
description: Reference guide for building a Rust clean-architecture backend with Axum, SeaORM, Argon2, JWT, and sea-orm-migration. Use when scaffolding a new Rust service, adding a feature (domain + use-case + repository + handler), or reviewing Rust code against the axum-clean-architecture reference layout.
|
||||
---
|
||||
|
||||
# Axum Clean Architecture Skill
|
||||
|
||||
Reference stack (see `../axum-clean-architecture`):
|
||||
|
||||
| Layer | Tech |
|
||||
|---|---|
|
||||
| HTTP framework | Axum 0.8 |
|
||||
| ORM | SeaORM 1.1 (PostgreSQL via sqlx + rustls) |
|
||||
| Migrations | sea-orm-migration |
|
||||
| Auth | Argon2 (password hashing) + jsonwebtoken (JWT) |
|
||||
| Validation | zod-rs (schema-driven, mirrors Zod) |
|
||||
| Pagination | paginator-rs + paginator-sea-orm + paginator-axum |
|
||||
| Observability | tracing + tracing-subscriber |
|
||||
| Middleware | tower-http (CORS, TraceLayer) |
|
||||
| Runtime | Tokio (full features) |
|
||||
| Error handling | anyhow (app-level), typed domain errors |
|
||||
|
||||
---
|
||||
|
||||
## 0. Workspace layout
|
||||
|
||||
```
|
||||
axum-clean-architecture/
|
||||
├── Cargo.toml # workspace, resolver = "3"
|
||||
├── apps/
|
||||
│ ├── iam/ # core domain library (lib crate)
|
||||
│ │ └── src/
|
||||
│ │ ├── domain/ # entities, repository traits, domain errors
|
||||
│ │ ├── application/ # use cases + port traits
|
||||
│ │ ├── infrastructure/ # SeaORM repos + auth services
|
||||
│ │ └── presentation/ # Axum handlers, DTOs, middleware, state
|
||||
│ ├── gateway/ # binary — assembles router, runs server
|
||||
│ └── bootstrap/ # binary — seeds permissions/roles/admin
|
||||
├── .config/ # AppServer, database/env helpers
|
||||
└── .migrations/ # sea-orm-migration crate
|
||||
```
|
||||
|
||||
The `iam` app is a **library crate**. `gateway` and `bootstrap` depend on it.
|
||||
|
||||
---
|
||||
|
||||
## 1. Dependency rules (strictly enforced)
|
||||
|
||||
```
|
||||
presentation → application → domain
|
||||
infrastructure → domain (implements domain traits)
|
||||
presentation → infrastructure (only to wire AppState)
|
||||
```
|
||||
|
||||
- Domain has **zero** external crate dependencies beyond `uuid`, `chrono`.
|
||||
- Use cases depend only on port traits — never on concrete infrastructure types.
|
||||
- Presentation instantiates use cases from `AppState` on every request; use cases are not stored.
|
||||
|
||||
---
|
||||
|
||||
## 2. Domain layer
|
||||
|
||||
### Entity pattern
|
||||
|
||||
Plain Rust structs — no derives beyond what domain logic needs. No ORM annotations.
|
||||
|
||||
```rust
|
||||
// domain/user/entity.rs
|
||||
pub struct User {
|
||||
pub id: Uuid,
|
||||
pub email: String,
|
||||
pub password_hash: String,
|
||||
pub created_at: DateTime<Utc>,
|
||||
pub updated_at: DateTime<Utc>,
|
||||
}
|
||||
|
||||
pub struct NewUser {
|
||||
pub id: Uuid,
|
||||
pub email: String,
|
||||
pub password_hash: String,
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
pub struct UserPatch {
|
||||
pub email: Option<String>,
|
||||
pub password_hash: Option<String>,
|
||||
}
|
||||
```
|
||||
|
||||
### Repository trait pattern
|
||||
|
||||
Use `impl Future` in trait methods (Rust 2024 edition, no `async_trait` needed).
|
||||
Always `Send + Sync` on the trait.
|
||||
|
||||
```rust
|
||||
// domain/user/repository.rs
|
||||
pub trait UserRepository: Send + Sync {
|
||||
fn find_by_id(&self, id: Uuid)
|
||||
-> impl Future<Output = Result<Option<User>, RepositoryError>> + Send;
|
||||
fn find_by_email(&self, email: &str)
|
||||
-> impl Future<Output = Result<Option<User>, RepositoryError>> + Send;
|
||||
fn create(&self, user: NewUser)
|
||||
-> impl Future<Output = Result<User, RepositoryError>> + Send;
|
||||
fn update(&self, id: Uuid, patch: UserPatch)
|
||||
-> impl Future<Output = Result<User, RepositoryError>> + Send;
|
||||
fn delete(&self, id: Uuid)
|
||||
-> impl Future<Output = Result<(), RepositoryError>> + Send;
|
||||
fn list(&self, params: &PaginationParams)
|
||||
-> impl Future<Output = Result<PaginatorResponse<User>, RepositoryError>> + Send;
|
||||
}
|
||||
```
|
||||
|
||||
### Shared RepositoryError (lives in domain)
|
||||
|
||||
```rust
|
||||
pub enum RepositoryError {
|
||||
NotFound,
|
||||
Conflict(String),
|
||||
Database(String),
|
||||
}
|
||||
```
|
||||
|
||||
### Domain errors
|
||||
|
||||
Per-aggregate. `AuthError` lives in `domain/auth/errors.rs`:
|
||||
|
||||
```rust
|
||||
pub enum AuthError {
|
||||
InvalidCredentials,
|
||||
EmailAlreadyExists,
|
||||
UserNotFound,
|
||||
PasswordHashFailed(String),
|
||||
PasswordVerificationFailed(String),
|
||||
TokenGenerationFailed(String),
|
||||
InvalidToken(String),
|
||||
RepositoryError(String),
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Application layer
|
||||
|
||||
### Port traits (interfaces for external services)
|
||||
|
||||
```rust
|
||||
// application/auth/ports/password.rs
|
||||
pub trait PasswordService: Send + Sync {
|
||||
fn hash(&self, password: &str)
|
||||
-> impl Future<Output = Result<String, PasswordError>> + Send;
|
||||
fn verify(&self, password: &str, hash: &str)
|
||||
-> impl Future<Output = Result<bool, PasswordError>> + Send;
|
||||
}
|
||||
```
|
||||
|
||||
```rust
|
||||
// application/auth/ports/token.rs
|
||||
pub trait TokenService: Send + Sync {
|
||||
fn generate_auth_tokens(&self, sub: &str)
|
||||
-> impl Future<Output = Result<(String, String), TokenError>> + Send;
|
||||
fn verify_access_token(&self, token: &str)
|
||||
-> Result<String, TokenError>;
|
||||
}
|
||||
```
|
||||
|
||||
### Use case pattern
|
||||
|
||||
Generic over port traits and repository traits. Constructed in the handler, not stored.
|
||||
|
||||
```rust
|
||||
// application/user/use_cases/create.rs
|
||||
pub struct CreateUserCommand { pub email: String, pub password: String }
|
||||
|
||||
pub struct CreateUserUseCase<P, R> {
|
||||
password_service: P,
|
||||
user_repository: R,
|
||||
}
|
||||
|
||||
impl<P: PasswordService, R: UserRepository> CreateUserUseCase<P, R> {
|
||||
pub fn new(password_service: P, user_repository: R) -> Self { ... }
|
||||
|
||||
pub async fn execute(&self, cmd: CreateUserCommand) -> Result<User, AuthError> {
|
||||
// 1. guard: check uniqueness
|
||||
// 2. hash password via port
|
||||
// 3. create domain entity with Uuid::new_v4()
|
||||
// 4. persist via repository
|
||||
// 5. log + return
|
||||
info!(user_id = %user.id, "user created");
|
||||
Ok(user)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Use case naming convention
|
||||
|
||||
| File | Struct | Command/Query |
|
||||
|---|---|---|
|
||||
| `create.rs` | `CreateXxxUseCase` | `CreateXxxCommand` |
|
||||
| `update.rs` | `UpdateXxxUseCase` | `UpdateXxxCommand` |
|
||||
| `delete.rs` | `DeleteXxxUseCase` | `DeleteXxxCommand` |
|
||||
| `detail.rs` | `XxxDetailUseCase` | `XxxDetailQuery` |
|
||||
| `list.rs` | `ListXxxsUseCase` | takes `&PaginationParams` |
|
||||
|
||||
---
|
||||
|
||||
## 4. Infrastructure layer
|
||||
|
||||
### SeaORM repository implementation
|
||||
|
||||
```rust
|
||||
// infrastructure/repository/user.rs
|
||||
#[derive(Clone)]
|
||||
pub struct SeaOrmUserRepository { db: DatabaseConnection }
|
||||
|
||||
// Convert ORM Model → domain entity here (not in domain)
|
||||
impl From<Model> for User { ... }
|
||||
|
||||
// Map DbErr → RepositoryError
|
||||
fn map_db_err(e: DbErr) -> RepositoryError {
|
||||
match e {
|
||||
DbErr::RecordNotFound(_) => RepositoryError::NotFound,
|
||||
other => { error!(error = %other, "database operation failed"); RepositoryError::Database(other.to_string()) }
|
||||
}
|
||||
}
|
||||
|
||||
impl UserRepository for SeaOrmUserRepository {
|
||||
async fn create(&self, user: NewUser) -> Result<User, RepositoryError> {
|
||||
let model = ActiveModel {
|
||||
id: Set(user.id),
|
||||
email: Set(user.email),
|
||||
password_hash: Set(user.password_hash),
|
||||
created_at: Set(now),
|
||||
updated_at: Set(now),
|
||||
};
|
||||
let inserted = model.insert(&self.db).await.map_err(|e| match e {
|
||||
DbErr::Exec(ref msg) | DbErr::Query(ref msg)
|
||||
if msg.to_string().contains("unique") =>
|
||||
RepositoryError::Conflict("email already exists".into()),
|
||||
other => RepositoryError::Database(other.to_string()),
|
||||
})?;
|
||||
Ok(User::from(inserted))
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Pagination uses `paginator-sea-orm`:
|
||||
|
||||
```rust
|
||||
let response = UserEntity::find()
|
||||
.paginate_with(&self.db, params)
|
||||
.await
|
||||
.map_err(|e| RepositoryError::Database(e.to_string()))?;
|
||||
let mapped: Vec<User> = response.data.into_iter().map(User::from).collect();
|
||||
Ok(PaginatorResponse { data: mapped, meta: response.meta })
|
||||
```
|
||||
|
||||
### Auth services
|
||||
|
||||
- `Argon2PasswordService`: uses `spawn_blocking` for CPU-bound hashing, `SaltString::generate(OsRng)`.
|
||||
- `JwtTokenService`: stores `secret: Vec<u8>`, generates separate access/refresh tokens with a `type` claim. `verify_access_token` checks `claims.token_type == "access"`.
|
||||
|
||||
### SeaORM entities (ORM models)
|
||||
|
||||
Live in `infrastructure/repository/entities/`. One file per table. Junction tables (`user_role`, `role_permission`) have composite primary keys. Timestamps use `DateTimeWithTimeZone`.
|
||||
|
||||
---
|
||||
|
||||
## 5. Presentation layer
|
||||
|
||||
### AppState
|
||||
|
||||
Concrete types only — no trait objects. Cheap to clone because `DatabaseConnection` is internally Arc-backed.
|
||||
|
||||
```rust
|
||||
#[derive(Clone)]
|
||||
pub struct AppState {
|
||||
pub password_service: Argon2PasswordService,
|
||||
pub token_service: JwtTokenService,
|
||||
pub user_repository: SeaOrmUserRepository,
|
||||
pub role_repository: SeaOrmRoleRepository,
|
||||
pub permission_repository: SeaOrmPermissionRepository,
|
||||
}
|
||||
```
|
||||
|
||||
Injected via `Extension(state)` on every handler. Use cases are constructed inside handlers.
|
||||
|
||||
### AppError
|
||||
|
||||
```rust
|
||||
pub enum AppError { BadRequest(String), Unauthorized, Forbidden, NotFound, Conflict(String), Internal(String) }
|
||||
|
||||
impl IntoResponse for AppError { /* maps to HTTP status + JSON { "error": "..." } */ }
|
||||
|
||||
impl From<AuthError> for AppError { ... }
|
||||
impl From<RepositoryError> for AppError { ... }
|
||||
impl From<TokenError> for AppError { ... }
|
||||
```
|
||||
|
||||
Internal errors are logged with `tracing::error!` before returning a generic 500 message.
|
||||
|
||||
### Handler pattern
|
||||
|
||||
```rust
|
||||
#[instrument(skip_all, fields(actor = %actor.id, email = %req.email))]
|
||||
pub async fn create(
|
||||
Extension(state): Extension<AppState>,
|
||||
Extension(actor): Extension<AuthenticatedUser>,
|
||||
Json(req): Json<CreateUserRequest>,
|
||||
) -> Result<(StatusCode, Json<UserResponse>), AppError> {
|
||||
let use_case = CreateUserUseCase::new(
|
||||
state.password_service.clone(),
|
||||
state.user_repository.clone(),
|
||||
);
|
||||
let user = use_case.execute(req.into()).await?;
|
||||
Ok((StatusCode::CREATED, Json(user.into())))
|
||||
}
|
||||
```
|
||||
|
||||
Rules:
|
||||
- Always `#[instrument(skip_all, fields(...))]` on every handler.
|
||||
- Use `?` to propagate `AppError` (via `From` impls).
|
||||
- `201 CREATED` for `POST`, `204 NO_CONTENT` for `DELETE`, `200 OK` for everything else.
|
||||
- Pagination handlers return `PaginatedJson<Dto>` via `paginator-axum`.
|
||||
|
||||
### DTO pattern
|
||||
|
||||
```rust
|
||||
#[derive(Debug, Serialize, Deserialize, ZodSchema)]
|
||||
pub struct CreateUserRequest {
|
||||
#[zod(email)]
|
||||
pub email: String,
|
||||
#[zod(min_length(8), max_length(128))]
|
||||
pub password: String,
|
||||
}
|
||||
|
||||
impl From<CreateUserRequest> for CreateUserCommand { ... }
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
pub struct UserResponse { pub id: Uuid, pub email: String, pub created_at: DateTime<Utc>, pub updated_at: DateTime<Utc> }
|
||||
|
||||
impl From<User> for UserResponse { ... }
|
||||
```
|
||||
|
||||
- Request structs: `Deserialize + ZodSchema`. Use `#[zod(...)]` for field-level validation.
|
||||
- Response structs: `Serialize` only. Never expose `password_hash`.
|
||||
- Conversions: `impl From<Request> for Command` and `impl From<DomainEntity> for Response`.
|
||||
|
||||
### Middleware
|
||||
|
||||
**Auth middleware** (`presentation/middleware/auth.rs`):
|
||||
- Extracts `Bearer <token>` from `Authorization` header.
|
||||
- Calls `state.token_service.verify_access_token(token)`.
|
||||
- Inserts `AuthenticatedUser { id: Uuid }` into request extensions.
|
||||
|
||||
**Permission check** (`presentation/middleware/permission.rs`):
|
||||
- Called inline from handlers: `ensure_permission(&state, &actor, "users:write").await?`.
|
||||
- Queries `permission_repository.find_for_user(actor.id)` and checks by name.
|
||||
|
||||
### Router assembly
|
||||
|
||||
```rust
|
||||
pub fn build_router(state: AppState) -> Router {
|
||||
Router::new()
|
||||
.nest("/auth", auth::router())
|
||||
.nest("/me", me::router())
|
||||
.nest("/users", user::router())
|
||||
.nest("/roles", role::router())
|
||||
.nest("/permissions", permission::router())
|
||||
.layer(Extension(state))
|
||||
}
|
||||
```
|
||||
|
||||
Gateway nests the IAM router at `/api/v1/iam` and adds a health check at `/`.
|
||||
|
||||
---
|
||||
|
||||
## 6. Migrations (sea-orm-migration)
|
||||
|
||||
```rust
|
||||
#[derive(DeriveMigrationName)]
|
||||
pub struct Migration;
|
||||
|
||||
#[async_trait::async_trait]
|
||||
impl MigrationTrait for Migration {
|
||||
async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
|
||||
manager.create_table(
|
||||
Table::create()
|
||||
.table(Users::Table)
|
||||
.if_not_exists()
|
||||
.col(ColumnDef::new(Users::Id).uuid().not_null().primary_key())
|
||||
.col(ColumnDef::new(Users::Email).string().not_null().unique_key())
|
||||
...
|
||||
.to_owned(),
|
||||
).await
|
||||
}
|
||||
async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
|
||||
manager.drop_table(Table::drop().table(Users::Table).to_owned()).await
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(DeriveIden)]
|
||||
pub enum Users { Table, Id, Email, PasswordHash, CreatedAt, UpdatedAt }
|
||||
```
|
||||
|
||||
Naming convention: `m{YYYYMMDD}_{6-digit-seq}_{description}.rs`, e.g. `m20260413_000001_create_users.rs`.
|
||||
|
||||
---
|
||||
|
||||
## 7. Bootstrap pattern
|
||||
|
||||
A separate `bootstrap` binary seeds idempotent system data (permissions, roles, admin user):
|
||||
|
||||
```rust
|
||||
// Check existence before inserting — fully idempotent
|
||||
if permission_repo.find_by_name("rbac:manage").await?.is_none() {
|
||||
permission_repo.create(...).await?;
|
||||
}
|
||||
```
|
||||
|
||||
Standard permissions:
|
||||
- `rbac:manage`, `users:read`, `users:write`, `roles:read`, `roles:write`, `permissions:read`, `permissions:write`
|
||||
|
||||
---
|
||||
|
||||
## 8. Adding a new aggregate (checklist)
|
||||
|
||||
1. **Domain**: `domain/{name}/entity.rs` (entity + NewXxx + XxxPatch), `domain/{name}/repository.rs` (trait + errors), `domain/{name}/errors.rs` if needed.
|
||||
2. **Application**: `application/{name}/mod.rs`, `application/{name}/use_cases/{create,update,delete,detail,list}.rs`.
|
||||
3. **Infrastructure entity**: `infrastructure/repository/entities/{name}.rs` (SeaORM model).
|
||||
4. **Infrastructure repo**: `infrastructure/repository/{name}.rs` (`From<Model>`, `impl XxxRepository for SeaOrmXxxRepository`).
|
||||
5. **Add to AppState**: `{name}_repository: SeaOrmXxxRepository`.
|
||||
6. **Presentation DTO**: `presentation/{name}/dto.rs` (Request + Response with `From` impls).
|
||||
7. **Presentation handlers**: `presentation/{name}/handlers.rs` (`#[instrument]`, construct use case, return DTO).
|
||||
8. **Presentation router**: `presentation/{name}/mod.rs` (define routes with `axum_route_macro` or `Router::new().route(...)`).
|
||||
9. **Nest in `build_router`**.
|
||||
10. **Migration**: new file in `.migrations/src/` following naming convention.
|
||||
11. **Bootstrap**: seed any required initial data.
|
||||
|
||||
---
|
||||
|
||||
## 9. Key conventions
|
||||
|
||||
- Edition **2024** — use `impl Future` in traits, not `#[async_trait]`.
|
||||
- All timestamps are `DateTime<Utc>` in domain; `DateTimeWithTimeZone` in SeaORM models; convert with `.with_timezone(&Utc)`.
|
||||
- UUIDs generated with `Uuid::new_v4()` in the use case, not the repository.
|
||||
- Unique-constraint conflicts detected via string match on `DbErr::Exec`/`DbErr::Query` containing `"unique"` — map to `RepositoryError::Conflict`.
|
||||
- `tracing::instrument` on every handler; log user/actor IDs as structured fields.
|
||||
- `warn!` for expected failures (wrong password, permission denied), `error!` for unexpected DB errors.
|
||||
- Response structs never expose internal fields (`password_hash`, internal IDs from junction tables).
|
||||
@@ -1,107 +0,0 @@
|
||||
---
|
||||
name: push-flow-convention
|
||||
description: Enforce pre-commit/pre-push hooks, lint-staged checks, and semver version bump on every push
|
||||
---
|
||||
|
||||
# Push Flow Convention
|
||||
|
||||
Every repository MUST enforce the same pre-commit, pre-push, and versioning flow. No push lands without hooks, lint-staged, and a version bump.
|
||||
|
||||
## Required Setup
|
||||
|
||||
### 1. Lefthook (pre-commit + pre-push)
|
||||
|
||||
> **Always use [Lefthook](https://lefthook.dev/) for git hooks. Never use husky.**
|
||||
|
||||
Install once per repo:
|
||||
|
||||
```bash
|
||||
pnpm add -D lefthook lint-staged
|
||||
pnpm exec lefthook install
|
||||
```
|
||||
|
||||
Create `lefthook.yml` in project root:
|
||||
|
||||
```yaml
|
||||
pre-commit:
|
||||
commands:
|
||||
lint-staged:
|
||||
run: pnpm exec lint-staged
|
||||
|
||||
pre-push:
|
||||
commands:
|
||||
lint-staged:
|
||||
run: pnpm exec lint-staged --diff="origin/{push_remote_branch}...HEAD"
|
||||
bump:
|
||||
run: pnpm run bump
|
||||
```
|
||||
|
||||
### 2. lint-staged
|
||||
|
||||
Declared in `package.json`. Runs ONLY on staged files so commits stay fast.
|
||||
|
||||
```json
|
||||
{
|
||||
"lint-staged": {
|
||||
"*.{ts,tsx,js,jsx}": [
|
||||
"eslint --fix",
|
||||
"prettier --write"
|
||||
],
|
||||
"*.{json,md,yml,yaml}": [
|
||||
"prettier --write"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Version bump script
|
||||
|
||||
`package.json` MUST expose a `bump` script used by `pre-push`:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"bump": "node scripts/bump-version.mjs"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The script inspects the diff between the current branch and its upstream, applies the semver rule below, and writes the new version back to `package.json`. Commit the bump before pushing (amend the previous commit or create a `chore: adjust package.json version (bump)` commit — see `commit-convention`).
|
||||
|
||||
## Semver Rules (applied on every push)
|
||||
|
||||
The bump is based on the changes in the commits being pushed:
|
||||
|
||||
| Change size / kind | Bump |
|
||||
|--------------------|------|
|
||||
| `< 5` changed files across pushed commits | **patch** (`x.y.Z`) |
|
||||
| `>= 5` changed files across pushed commits | **minor** (`x.Y.0`) |
|
||||
| New feature OR new behaviour (any `feat:` commit) | **major** (`X.0.0`) |
|
||||
|
||||
Rules in order of precedence:
|
||||
1. If ANY commit being pushed is a `feat(...)` → **major** bump.
|
||||
2. Otherwise, count files changed (`git diff --name-only origin/<branch>...HEAD | wc -l`):
|
||||
- fewer than 5 → **patch**
|
||||
- 5 or more → **minor**
|
||||
|
||||
The `feat` rule always wins — a new feature is always a major bump regardless of file count.
|
||||
|
||||
## Non-negotiables
|
||||
|
||||
1. NEVER push without pre-commit and pre-push hooks installed.
|
||||
2. NEVER bypass hooks with `--no-verify` — if a hook fails, fix the root cause.
|
||||
3. NEVER push without a version bump. Every push = new version.
|
||||
4. The bump commit MUST use the `chore: adjust package.json version (bump)` message (see `commit-convention`).
|
||||
5. lint-staged MUST run on every commit. A green lint-staged is a prerequisite for the commit to be created.
|
||||
6. If `pnpm` is not the package manager, substitute with `npm` or `yarn` but keep the same flow.
|
||||
|
||||
## Quick verification checklist
|
||||
|
||||
Before declaring the push flow set up, confirm:
|
||||
|
||||
- [ ] `lefthook.yml` exists with `pre-commit` and `pre-push` hooks
|
||||
- [ ] `pnpm exec lefthook install` has been run (hooks registered in `.git/hooks/`)
|
||||
- [ ] `package.json` has a `lint-staged` block
|
||||
- [ ] `package.json` has a `bump` script
|
||||
- [ ] A dry-run commit triggers lint-staged
|
||||
- [ ] A dry-run push triggers the version bump
|
||||
@@ -0,0 +1,26 @@
|
||||
# Rust build artifacts
|
||||
target/
|
||||
|
||||
# VCS
|
||||
.git/
|
||||
.gitignore
|
||||
|
||||
# Local/secret files
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
|
||||
# Editor
|
||||
.idea/
|
||||
.vscode/
|
||||
*.swp
|
||||
|
||||
# Nix
|
||||
result
|
||||
result-*
|
||||
|
||||
# Kilo metadata
|
||||
.kilo/
|
||||
|
||||
# Docs lessons
|
||||
docs/lesson/
|
||||
@@ -21,11 +21,11 @@ jobs:
|
||||
with:
|
||||
components: clippy
|
||||
|
||||
- name: Build workspace
|
||||
run: cargo build --release --workspace
|
||||
|
||||
- name: Test workspace
|
||||
run: cargo test --workspace
|
||||
- name: Format check
|
||||
run: cargo fmt --all -- --check
|
||||
|
||||
- name: Clippy workspace
|
||||
run: cargo clippy --workspace -- -D warnings
|
||||
run: cargo clippy --workspace --all-targets -- -D warnings
|
||||
|
||||
- name: Test workspace
|
||||
run: cargo test --workspace
|
||||
@@ -0,0 +1,61 @@
|
||||
name: Build & Deploy (Nix)
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: deploy
|
||||
cancel-in-progress: false
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
env:
|
||||
VPS_HOST: ${{ secrets.VPS_HOST }}
|
||||
VPS_USER: ${{ secrets.VPS_USER }}
|
||||
|
||||
jobs:
|
||||
build-and-deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Install Nix
|
||||
uses: DeterminateSystems/nix-installer-action@v22
|
||||
with:
|
||||
determinate: false
|
||||
extra-conf: |
|
||||
sandbox = false
|
||||
accept-flake-config = true
|
||||
|
||||
- name: Cache Nix
|
||||
uses: DeterminateSystems/magic-nix-cache-action@v14
|
||||
|
||||
- name: Build zesdex
|
||||
id: build
|
||||
run: |
|
||||
nix build .#default --impure --option sandbox false --print-build-logs
|
||||
STORE_PATH=$(readlink result)
|
||||
echo "store-path=$STORE_PATH" >> "$GITHUB_OUTPUT"
|
||||
echo "Build OK: $STORE_PATH"
|
||||
|
||||
- name: Setup SSH key
|
||||
env:
|
||||
SSH_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo "$SSH_KEY" > ~/.ssh/id_ed25519
|
||||
chmod 600 ~/.ssh/id_ed25519
|
||||
sed -i 's/\r$//' ~/.ssh/id_ed25519
|
||||
ssh-keygen -y -f ~/.ssh/id_ed25519 >/dev/null 2>&1 || { echo "SSH key invalid"; exit 1; }
|
||||
ssh-keyscan -H "$VPS_HOST" >> ~/.ssh/known_hosts 2>/dev/null
|
||||
|
||||
- name: Deploy zesdex to VPS
|
||||
run: |
|
||||
STORE_PATH="${{ steps.build.outputs.store-path }}"
|
||||
ssh "$VPS_USER@$VPS_HOST" "nix copy --to file:///nix/store $STORE_PATH && nix-env --install --force $STORE_PATH --profile /nix/var/nix/profiles/zesdex && systemctl restart zesdex"
|
||||
@@ -1,20 +0,0 @@
|
||||
Codemap Update Report — 2026-07-12
|
||||
====================================
|
||||
|
||||
Status: FIRST GENERATION (no previous codemaps to compare)
|
||||
|
||||
Files created:
|
||||
- docs/CODEMAPS/architecture.md (new)
|
||||
- docs/CODEMAPS/backend.md (new)
|
||||
- docs/CODEMAPS/frontend.md (new)
|
||||
- docs/CODEMAPS/data.md (new)
|
||||
- docs/CODEMAPS/dependencies.md (new)
|
||||
|
||||
Source scanned:
|
||||
- 124 Rust source files
|
||||
- 30 directories
|
||||
- 103 modules
|
||||
- 10,402 lines total
|
||||
|
||||
No previous codemaps found — diff calculation skipped.
|
||||
Freshness: all documents generated 2026-07-12.
|
||||
@@ -1,3 +1,35 @@
|
||||
# [1.19.0](https://github.com/asepharyana/zesdex/compare/v1.18.4...v1.19.0) (2026-08-27)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* hapus fitur LSP bawaan (language server protocol) ([93f3c2a](https://github.com/asepharyana/zesdex/commit/93f3c2a3572511b5a84f244980ad71bd1b455e70))
|
||||
|
||||
## [1.18.4](https://github.com/asepharyana/zesdex/compare/v1.18.3...v1.18.4) (2026-08-27)
|
||||
|
||||
|
||||
### Performance Improvements
|
||||
|
||||
* **tui:** render streaming token secara inkremental + kurangi redraw sia-sia ([2717216](https://github.com/asepharyana/zesdex/commit/271721694beb62e9fa5ff932312b293aa1d56823))
|
||||
|
||||
## [1.18.3](https://github.com/asepharyana/zesdex/compare/v1.18.2...v1.18.3) (2026-08-27)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **api:** cegah race condition pada register users.json (TOCTOU) ([884b19c](https://github.com/asepharyana/zesdex/commit/884b19ccb5fbcaa6b29cb41dc978386cf7b1b3f9))
|
||||
* **api:** perbaiki keamanan auth & WebSocket, tambah rate limiting ([6db00b2](https://github.com/asepharyana/zesdex/commit/6db00b22663839a6a975ae978058b894900c71de))
|
||||
* **build:** perbaiki referensi paket zesdex-gateway dan sinkronisasi versi nix ([6d3f491](https://github.com/asepharyana/zesdex/commit/6d3f4918bfea06b106d4fe75adf58e6a29aca2a5))
|
||||
* **build:** perbaiki referensi paket zesdex-gateway di Dockerfile & default.nix ([7f64423](https://github.com/asepharyana/zesdex/commit/7f644236158f66fcc106ec55e437ebf28ee1cca1))
|
||||
|
||||
## [1.18.2](https://github.com/asepharyana/zesdex/compare/v1.18.1...v1.18.2) (2026-08-20)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **nix:** add perl to nativeBuildInputs for openssl-sys Configure ([033f964](https://github.com/asepharyana/zesdex/commit/033f964be0c695106eef74329524ad7b4b8dba14))
|
||||
* **nix:** correct cargoBuildFlags package name zesdex-backend -> zesdex-gateway ([2de5b57](https://github.com/asepharyana/zesdex/commit/2de5b57133f6c7295d8a85e63cb86504ea2a7d3e))
|
||||
|
||||
## [1.18.1](https://github.com/asepharyana/zesdex/compare/v1.18.0...v1.18.1) (2026-08-01)
|
||||
|
||||
|
||||
|
||||
@@ -1,156 +0,0 @@
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
Tests use `#[cfg(test)] mod tests` blocks inline in production files (not a separate `tests/` dir).
|
||||
|
||||
Tracing output goes to `~/.local/share/zesdex/zesdex.log`. Set `RUST_LOG=debug` for verbose logging.
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
Zesdex is an autonomous AI coding agent with a TUI — an OpenAI/Anthropic-compatible LLM client wrapped in a tool-use harness with 37 built-in tools.
|
||||
|
||||
Detailed architecture documentation is in `docs/CODEMAPS/`:
|
||||
|
||||
| File | Covers |
|
||||
|------|--------|
|
||||
| [`docs/CODEMAPS/architecture.md`](docs/CODEMAPS/architecture.md) | System layout, process modes, data flow, key files |
|
||||
| [`docs/CODEMAPS/backend.md`](docs/CODEMAPS/backend.md) | Provider, OAuth, IPC, workflow engine, MCP, review, bg bash |
|
||||
| [`docs/CODEMAPS/frontend.md`](docs/CODEMAPS/frontend.md) | TUI render pipeline, 16 overlays, toasts, input handling |
|
||||
| [`docs/CODEMAPS/data.md`](docs/CODEMAPS/data.md) | Persistence, SQLite msglog, memory files, settings/config |
|
||||
| [`docs/CODEMAPS/dependencies.md`](docs/CODEMAPS/dependencies.md) | 23 Rust crates, 5 external services |
|
||||
|
||||
`docs/runs/` holds an auto-generated audit trail: one markdown file per hive-mind convergence (see below), written deterministically by `app::workflow::docs::write_hive_mind_convergence` — not hand-maintained like `docs/CODEMAPS/`.
|
||||
|
||||
### Key Patterns
|
||||
|
||||
- **State mutation** — `AppStateRest` is mutable in-place from `actions/mod.rs` and `controller/input.rs`. No generic update function.
|
||||
- **No DI** — modules call `Settings::load()`, `AppConfig::load()`, `all_tools()` directly.
|
||||
- **Logging** — `tracing::warn!` to `~/.local/share/zesdex/zesdex.log` (not stderr, avoids TUI corruption).
|
||||
- **Error handling** — `anyhow::Result` and `anyhow::bail!` throughout. No custom error types.
|
||||
- **Static strings** — MCP tool descriptions use `Box::leak` + `OnceLock` cache.
|
||||
- **Tools** — `trait Tool { fn name() -> &str, fn run() -> Result<String> }`, 28 impls, gated by `Harness`.
|
||||
- **Shell safety** — `tool/shell_filter/` blocks destructive git commands (`shell_filter::git::check_git_destructive`, called from `tool/shell.rs::Bash::run`). It also contains a `check_credential_read` detector for credential-file reads, but that one is intentionally NOT wired into `Bash::run` today — see the doc comment on `Bash::run` for why.
|
||||
|
||||
### Hive-Mind Orchestration (Machine Intelligence)
|
||||
|
||||
- **A single Core Intelligence spawning anonymous processing nodes.** The Core Intelligence (main agent) compiles a cognitive cycle plan per task: an ordered list of cycles, each cycle a set of processing nodes that run in parallel. Each node's sole identity is its directive (what to do) and an access tier. Cycle count and nodes-per-cycle are entirely Core-Intelligence output.
|
||||
- **Access tiers** in `src/app/subagent/division.rs` (`tool_scope` module): tool access is granted per node via one of three tiers (`read` / `write` / `full`, see `tool_scope::tools_for`) picked by the Core Intelligence based on what each node's directive actually needs.
|
||||
- **Orchestrator** in `src/app/workflow/hive_mind.rs`: `run_hive_mind()` executes a `CognitiveCyclePlan { cycles: Vec<Vec<NodeDirective>> }` cycle-by-cycle. Node IDs are system-assigned coordinates (e.g. `"Node-0-1"`).
|
||||
- **Continuous collective state, not phase-boundary sync**: `engine::execute_primitive`'s `ScopedAgent` arm merges each node's complete output into the shared collective-state channel the instant that node finishes — not after its whole parallel cohort completes — so sibling/later nodes see it in real time.
|
||||
- **Consensus synthesis, not a per-node summary**: after all cycles complete, `synthesize_consensus()` spawns one final read-only node whose sole directive is to reconcile the entire collective state into a single consensus assessment — a real reasoning pass, not string concatenation, since node outputs can overlap or conflict.
|
||||
- **Auto-trigger** in `run_agent_turn()` (`actions/mod.rs`): `is_complex_request()` heuristics decide only whether to ask the Core Intelligence to compile a plan at all — the plan's shape is fully dynamic.
|
||||
- **`hive_mind` tool** (`src/tool/workflow.rs`) is the manual entry point: the calling LLM supplies its own `cycles` array of `{directive, access}` directly.
|
||||
- **Guaranteed documentation**: after every convergence, `src/app/workflow/docs.rs::write_hive_mind_convergence()` deterministically (not an LLM step, not skippable) writes every node's full output plus the final consensus to `docs/runs/<timestamp>-<slug>.md`.
|
||||
- **Live node progress** in TUI panel (`view/workflow.rs`): shows node designation + current tool via `AgentStatus::progress`.
|
||||
- **Auto inline review** after each edit: `src/app/subagent/auto.rs` — `spawn_quick_review()` injects verdict back into LLM conversation.
|
||||
- **Background subagents** (test-gen, arch-review, security-review) fire asynchronously at turn end via `TurnEvent::SystemNote`, retrying once on failure and escalating to a blocking (`ESCALATED:`-prefixed, `ToastKind::Error`) notice if the retry also fails.
|
||||
|
||||
---
|
||||
|
||||
## Best Practices (Kana Engineering Standards)
|
||||
|
||||
This project follows Kana Engineering Best Practices. The following skills are loaded and enforced:
|
||||
|
||||
| Skill | Location | Purpose |
|
||||
|-------|----------|---------|
|
||||
| `clean-code` | `.claude/skills/clean-code/SKILL.md` | Clean Code principles (naming, functions, classes, comments) |
|
||||
| `commit-convention` | `.claude/skills/commit-convention/SKILL.md` | Conventional Commits (Bahasa Indonesia) |
|
||||
| `push-flow-convention` | `.claude/skills/push-flow-convention/SKILL.md` | Pre-commit/pre-push hooks via lefthook |
|
||||
| `kana-rust-backend-best-practice` | `.claude/skills/kana-rust-backend-best-practice/SKILL.md` | Rust clean-architecture patterns (Axum, SeaORM, etc.) |
|
||||
|
||||
### Layering Rules
|
||||
|
||||
```
|
||||
domain/ → application/ → infrastructure/ → interfaces/ → gateway/
|
||||
(inward) (outward)
|
||||
```
|
||||
|
||||
- **Domain** (Layer 0): Pure entities, value objects, repository/service traits. ZERO external framework deps.
|
||||
- **Application** (Layer 1): Use-case services (one per file), port traits. Depends ONLY on domain.
|
||||
- **Infrastructure** (Layer 2): Concrete implementations of domain traits (SQLite, JSON files, LLM clients, LSP servers, MCP).
|
||||
- **Interfaces** (Layer 3): Presentation adapters — TUI (ratatui), API (Axum), WebSocket, daemon, gRPC, web.
|
||||
- **Gateway**: Composition root — the only place that wires all layers together.
|
||||
|
||||
**Critical:** Domain must NEVER import application, infrastructure, or interfaces. Application must NEVER import infrastructure or interfaces.
|
||||
|
||||
### Commit Convention (Bahasa Indonesia)
|
||||
|
||||
All commits follow Conventional Commits in Bahasa Indonesia:
|
||||
|
||||
```
|
||||
feat(tool): add batch file delete
|
||||
fix(ipc): reconnect loop on socket timeout
|
||||
chore: bump reqwest to 0.13
|
||||
docs: add architecture diagram to README
|
||||
refactor(harness): flatten guard pipeline
|
||||
```
|
||||
|
||||
Types: `feat`, `fix`, `chore`, `docs`, `refactor`, `test`, `style`, `perf`, `ci`. All types produce a release (patch minimum). Add `BREAKING CHANGE:` for major bumps.
|
||||
|
||||
### Clean Code Principles
|
||||
|
||||
- **Functions under ~40 lines**, one level of abstraction, extracted till you drop.
|
||||
- **No flag arguments** — split `render(true)` into `renderForSuite()` / `renderForSingleTest()`.
|
||||
- **Command-Query Separation** — function either does or answers, never both.
|
||||
- **No switch/if-else on type** — replace with factory + polymorphism.
|
||||
- **No null returns** — use `Option<T>` or empty collections.
|
||||
- **No magic numbers** — extract named constants.
|
||||
- **DRY** — no duplication.
|
||||
- **Tell, Don't Ask** — don't fetch state then decide; tell the object to work.
|
||||
- **Boy Scout Rule** — leave every module cleaner than you found it.
|
||||
|
||||
### Error Handling
|
||||
|
||||
- `anyhow::Result` and `anyhow::bail!` throughout (except domain layer typed errors).
|
||||
- `tracing::warn!` / `tracing::error!` for logging. NEVER stderr (corrupts TUI).
|
||||
- Never `.unwrap()` or `.expect()` in production code — use `?` or proper error handling.
|
||||
- Log expected failures at `warn!`, unexpected errors at `error!`.
|
||||
|
||||
### Testing
|
||||
|
||||
- `#[cfg(test)] mod tests` blocks inline in production files.
|
||||
- Tests are F.I.R.S.T. — Fast, Independent, Repeatable, Self-validating, Timely.
|
||||
- Use `Result<()>` as test return type for `?` propagation.
|
||||
- Mock at boundaries only; prefer fakes for owned abstractions.
|
||||
|
||||
### Compiler Bypasses
|
||||
|
||||
NEVER use `#[allow(...)]`, `#[expect(...)]`, or `#[allow(dead_code)]`. Fix the underlying code instead.
|
||||
|
||||
## Code Documentation
|
||||
|
||||
Every function, struct, enum, trait, module, and significant code block must have a doc comment (`///` or `//!`) that explains:
|
||||
|
||||
- **What** the function/module does (purpose, not how)
|
||||
- **Flow** — a brief ASCII or prose description of the code flow / data flow above each non-trivial function
|
||||
- **Why** — non-obvious decisions, edge cases, invariants
|
||||
- **Return** — what the caller gets back, especially for `Result` types
|
||||
|
||||
Examples:
|
||||
|
||||
```rust
|
||||
/// Parse an SSE data chunk into one or more StreamEvents.
|
||||
///
|
||||
/// Flow: buffer → split on '\n' → flush on blank line → JSON parse → match event type
|
||||
/// → return Token / ToolCallDelta / Usage / Done.
|
||||
///
|
||||
/// Edge case: chunk may split mid-line; remaining bytes stay in buffer
|
||||
/// for the next feed() call.
|
||||
fn feed(&mut self, chunk: &str) -> Vec<StreamEvent> { ... }
|
||||
|
||||
/// The single source-of-truth state struct for the entire application.
|
||||
///
|
||||
/// Mutated in-place from two locations: actions/mod.rs (apply_action)
|
||||
/// and controller/input.rs (key event handlers). Read-only from
|
||||
/// every other module.
|
||||
struct AppStateRest { ... }
|
||||
```
|
||||
|
||||
Rules:
|
||||
- Every `pub fn` needs a doc comment
|
||||
- Every `pub struct` / `pub enum` / `pub trait` needs a doc comment
|
||||
- Non-trivial private functions (≥10 lines) need a doc comment
|
||||
- Write the comment above the code it documents (not inline in the body)
|
||||
- Update comments when code behavior changes — stale docs are worse than no docs
|
||||
- NEVER use compiler/linter bypass annotations or attributes (such as `#[allow(clippy::too_many_lines, clippy::too_many_arguments, clippy::ref_option)]`, `#[allow(dead_code)]`, etc.) to silence warnings or skip linter checks. Always fix the underlying code issues instead.
|
||||
Generated
+11
-45
@@ -1088,15 +1088,6 @@ dependencies = [
|
||||
"miniz_oxide",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "fluent-uri"
|
||||
version = "0.1.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "17c704e9dbe1ddd863da1e6ff3567795087b1eb201ce80d8fa81162e1516500d"
|
||||
dependencies = [
|
||||
"bitflags 1.3.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "fnv"
|
||||
version = "1.0.7"
|
||||
@@ -1972,19 +1963,6 @@ version = "0.1.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "112b39cec0b298b6c1999fee3e31427f74f676e4cb9879ed1a121b43661a4154"
|
||||
|
||||
[[package]]
|
||||
name = "lsp-types"
|
||||
version = "0.97.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "53353550a17c04ac46c585feb189c2db82154fc84b79c7a66c96c2c644f66071"
|
||||
dependencies = [
|
||||
"bitflags 1.3.2",
|
||||
"fluent-uri",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"serde_repr",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "mac_address"
|
||||
version = "1.1.8"
|
||||
@@ -3369,17 +3347,6 @@ dependencies = [
|
||||
"serde_core",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde_repr"
|
||||
version = "0.1.20"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "175ee3e80ae9982737ca543e96133087cbd9a485eecc3bc4de9c1a37b47ea59c"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn 2.0.118",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde_urlencoded"
|
||||
version = "0.7.1"
|
||||
@@ -4895,7 +4862,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-api"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"argon2",
|
||||
@@ -4918,7 +4885,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-application"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"base64",
|
||||
@@ -4935,7 +4902,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-bootstrap"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"chrono",
|
||||
@@ -4952,7 +4919,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-daemon"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"base64",
|
||||
@@ -4976,7 +4943,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-domain"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"base64",
|
||||
@@ -4992,7 +4959,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-gateway"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"axum",
|
||||
@@ -5019,7 +4986,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-grpc"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"axum",
|
||||
@@ -5036,7 +5003,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-infrastructure"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"argon2",
|
||||
@@ -5055,7 +5022,6 @@ dependencies = [
|
||||
"infer",
|
||||
"jsonwebtoken",
|
||||
"libc",
|
||||
"lsp-types",
|
||||
"nucleo-matcher",
|
||||
"percent-encoding",
|
||||
"pulldown-cmark",
|
||||
@@ -5085,7 +5051,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-tui"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"base64",
|
||||
@@ -5111,7 +5077,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-web"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"axum",
|
||||
@@ -5131,7 +5097,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "zesdex-ws"
|
||||
version = "1.18.0"
|
||||
version = "1.18.3"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"axum",
|
||||
|
||||
+1
-2
@@ -15,7 +15,7 @@ members = [
|
||||
]
|
||||
|
||||
[workspace.package]
|
||||
version = "1.18.1"
|
||||
version = "1.19.0"
|
||||
edition = "2021"
|
||||
authors = ["asepharyana <superaseph@gmail.com>"]
|
||||
|
||||
@@ -61,7 +61,6 @@ ignore = "0.4"
|
||||
nucleo-matcher = "0.3"
|
||||
futures-util = "0.3"
|
||||
rmcp = { version = "2.2", default-features = false, features = ["client", "transport-child-process", "transport-streamable-http-client-reqwest", "macros"] }
|
||||
lsp-types = "0.97"
|
||||
tiktoken-rs = "0.12"
|
||||
similar = "3"
|
||||
syntect = { version = "5", default-features = false, features = ["default-fancy"] }
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@ WORKDIR /app
|
||||
COPY . .
|
||||
|
||||
# Build with release profile (treats warnings as errors via lints)
|
||||
RUN cargo build --release -p zesdex-backend --bin zesdex
|
||||
RUN cargo build --release -p zesdex-gateway --bin zesdex
|
||||
|
||||
# Stage 2: Minimal runtime image
|
||||
FROM debian:bookworm-slim
|
||||
|
||||
@@ -16,10 +16,7 @@ pub trait ToolExecutor: Send + Sync {
|
||||
/// Service for running agent turns asynchronously.
|
||||
pub trait AgentTurnService: Send + Sync {
|
||||
/// Run a full agent turn loop asynchronously.
|
||||
fn run_turn(
|
||||
&self,
|
||||
params: AgentTurnParams,
|
||||
) -> impl Future<Output = Result<()>> + Send;
|
||||
fn run_turn(&self, params: AgentTurnParams) -> impl Future<Output = Result<()>> + Send;
|
||||
}
|
||||
|
||||
pub mod explore;
|
||||
|
||||
@@ -7,8 +7,8 @@ use zesdex_domain::agent::{AgentTurnParams, TurnEvent};
|
||||
use zesdex_domain::core::{ChatMessage, StreamEvent, ToolDef};
|
||||
use zesdex_domain::main_agent_prompt;
|
||||
|
||||
use crate::ports::ProviderService;
|
||||
use super::{ExploreService, ToolExecutor};
|
||||
use crate::ports::ProviderService;
|
||||
|
||||
/// Maximum tool-call iterations per agent turn before forcing termination.
|
||||
const MAX_TURN_ITERATIONS: u32 = 50;
|
||||
@@ -124,11 +124,7 @@ pub struct AgentTurnServiceImpl<P: ProviderService, T: ToolExecutor> {
|
||||
}
|
||||
|
||||
impl<P: ProviderService, T: ToolExecutor> AgentTurnServiceImpl<P, T> {
|
||||
pub fn new(
|
||||
provider: Arc<P>,
|
||||
tool_executor: Arc<T>,
|
||||
tool_defs: Vec<ToolDef>,
|
||||
) -> Self {
|
||||
pub fn new(provider: Arc<P>, tool_executor: Arc<T>, tool_defs: Vec<ToolDef>) -> Self {
|
||||
Self {
|
||||
provider,
|
||||
tool_executor,
|
||||
@@ -203,7 +199,10 @@ impl<P: ProviderService, T: ToolExecutor> super::AgentTurnService for AgentTurnS
|
||||
},
|
||||
);
|
||||
|
||||
match explorer.explore(&user_query, &workspace_root, ¶ms.turn_events).await {
|
||||
match explorer
|
||||
.explore(&user_query, &workspace_root, ¶ms.turn_events)
|
||||
.await
|
||||
{
|
||||
Ok(output) => {
|
||||
// Insert each context message as a system message.
|
||||
// They go at index 0 and are removed after the turn
|
||||
@@ -236,7 +235,9 @@ impl<P: ProviderService, T: ToolExecutor> super::AgentTurnService for AgentTurnS
|
||||
// entire turn, avoiding per-iteration clones of the full message list.
|
||||
// It is removed before emitting the Compacted event so persistence
|
||||
// does not store the prompt redundantly.
|
||||
params.messages.insert(0, ChatMessage::system(main_agent_prompt()));
|
||||
params
|
||||
.messages
|
||||
.insert(0, ChatMessage::system(main_agent_prompt()));
|
||||
let original_count = params.messages.len();
|
||||
|
||||
for iteration in 0..MAX_TURN_ITERATIONS {
|
||||
@@ -287,7 +288,8 @@ impl<P: ProviderService, T: ToolExecutor> super::AgentTurnService for AgentTurnS
|
||||
// ── Execute each tool call ──────────────────────────
|
||||
for tc in &tool_calls {
|
||||
let output =
|
||||
execute_tool_call(self.tool_executor.as_ref(), ¶ms.turn_events, tc).await;
|
||||
execute_tool_call(self.tool_executor.as_ref(), ¶ms.turn_events, tc)
|
||||
.await;
|
||||
params
|
||||
.messages
|
||||
.push(ChatMessage::tool(tc.id.clone(), output));
|
||||
@@ -295,10 +297,7 @@ impl<P: ProviderService, T: ToolExecutor> super::AgentTurnService for AgentTurnS
|
||||
}
|
||||
Err(e) => {
|
||||
warn!("{e}");
|
||||
push_event(
|
||||
¶ms.turn_events,
|
||||
TurnEvent::Error(e),
|
||||
);
|
||||
push_event(¶ms.turn_events, TurnEvent::Error(e));
|
||||
break;
|
||||
}
|
||||
}
|
||||
@@ -307,10 +306,7 @@ impl<P: ProviderService, T: ToolExecutor> super::AgentTurnService for AgentTurnS
|
||||
// Remove the synthetic sys_msg before shipping events to the TUI
|
||||
// so the transcript shows only the actual user/assistant/tool exchange.
|
||||
let compacted: Vec<ChatMessage> = params.messages.drain(original_count - 1..).collect();
|
||||
push_event(
|
||||
¶ms.turn_events,
|
||||
TurnEvent::Compacted(compacted),
|
||||
);
|
||||
push_event(¶ms.turn_events, TurnEvent::Compacted(compacted));
|
||||
push_event(¶ms.turn_events, TurnEvent::Done);
|
||||
params.in_flight.store(false, Ordering::SeqCst);
|
||||
|
||||
@@ -341,15 +337,16 @@ pub async fn compact_messages_with_ai<P: ProviderService>(
|
||||
let split_idx = messages.len() - COMPACT_KEEP_TAIL;
|
||||
let evicted: Vec<_> = messages.drain(..split_idx).collect();
|
||||
|
||||
let mut summary_prompt = vec![
|
||||
ChatMessage::system(zesdex_domain::compaction_prompt()),
|
||||
];
|
||||
let mut summary_prompt = vec![ChatMessage::system(zesdex_domain::compaction_prompt())];
|
||||
summary_prompt.extend(evicted);
|
||||
summary_prompt.push(ChatMessage::user(
|
||||
"Please summarise our previous conversation above for context continuity.".to_string(),
|
||||
));
|
||||
|
||||
match provider.chat(&summary_prompt, None, Some(1024), Some(0.3)).await {
|
||||
match provider
|
||||
.chat(&summary_prompt, None, Some(1024), Some(0.3))
|
||||
.await
|
||||
{
|
||||
Ok((summary_msg, _)) => {
|
||||
let summary_text = summary_msg
|
||||
.content
|
||||
@@ -373,5 +370,3 @@ pub async fn compact_messages_with_ai<P: ProviderService>(
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -45,11 +45,7 @@ use sha2::{Digest, Sha256};
|
||||
/// and clear them after a successful (or failed) flow completion.
|
||||
pub trait OAuthFlowStore: Send + Sync {
|
||||
/// Persist the PKCE code verifier and CSRF state token.
|
||||
fn save_flow_state(
|
||||
&self,
|
||||
verifier: &str,
|
||||
state: &str,
|
||||
) -> Result<(), ServiceError>;
|
||||
fn save_flow_state(&self, verifier: &str, state: &str) -> Result<(), ServiceError>;
|
||||
|
||||
/// Load the stored PKCE code verifier.
|
||||
fn load_verifier(&self) -> Result<String, ServiceError>;
|
||||
@@ -141,12 +137,7 @@ pub struct OAuthUseCase<R, S, E> {
|
||||
|
||||
impl<R: OAuthRepository, S: OAuthFlowStore, E: TokenExchanger> OAuthUseCase<R, S, E> {
|
||||
/// Create a new OAuth use-case.
|
||||
pub fn new(
|
||||
token_repo: R,
|
||||
flow_store: S,
|
||||
token_exchanger: E,
|
||||
token_path: PathBuf,
|
||||
) -> Self {
|
||||
pub fn new(token_repo: R, flow_store: S, token_exchanger: E, token_path: PathBuf) -> Self {
|
||||
OAuthUseCase {
|
||||
token_repo,
|
||||
flow_store,
|
||||
@@ -156,8 +147,8 @@ impl<R: OAuthRepository, S: OAuthFlowStore, E: TokenExchanger> OAuthUseCase<R, S
|
||||
}
|
||||
}
|
||||
|
||||
impl<R: OAuthRepository, S: OAuthFlowStore, E: TokenExchanger>
|
||||
zesdex_domain::auth::OAuthService for OAuthUseCase<R, S, E>
|
||||
impl<R: OAuthRepository, S: OAuthFlowStore, E: TokenExchanger> zesdex_domain::auth::OAuthService
|
||||
for OAuthUseCase<R, S, E>
|
||||
{
|
||||
fn start_flow(
|
||||
&self,
|
||||
@@ -183,13 +174,9 @@ impl<R: OAuthRepository, S: OAuthFlowStore, E: TokenExchanger>
|
||||
"starting OAuth flow",
|
||||
);
|
||||
|
||||
let mut url = url::Url::parse(&config.auth_url)
|
||||
.map_err(|e| {
|
||||
ServiceError::InvalidConfig(format!(
|
||||
"invalid auth_url '{}': {e}",
|
||||
config.auth_url
|
||||
))
|
||||
})?;
|
||||
let mut url = url::Url::parse(&config.auth_url).map_err(|e| {
|
||||
ServiceError::InvalidConfig(format!("invalid auth_url '{}': {e}", config.auth_url))
|
||||
})?;
|
||||
|
||||
url.query_pairs_mut()
|
||||
.append_pair("response_type", "code")
|
||||
|
||||
@@ -46,12 +46,11 @@ impl<R: SessionRepository, L: SessionLockRepository> SessionServiceImpl<R, L> {
|
||||
}
|
||||
}
|
||||
|
||||
impl<R: SessionRepository, L: SessionLockRepository>
|
||||
zesdex_domain::auth::SessionService for SessionServiceImpl<R, L>
|
||||
impl<R: SessionRepository, L: SessionLockRepository> zesdex_domain::auth::SessionService
|
||||
for SessionServiceImpl<R, L>
|
||||
{
|
||||
fn create_session(&self, title: &str) -> Result<Session, ServiceError> {
|
||||
let id = SessionId::new(&Uuid::new_v4().to_string())
|
||||
.map_err(ServiceError::Other)?;
|
||||
let id = SessionId::new(&Uuid::new_v4().to_string()).map_err(ServiceError::Other)?;
|
||||
let title_owned = if title.is_empty() {
|
||||
"New Session".to_string()
|
||||
} else {
|
||||
@@ -59,8 +58,7 @@ impl<R: SessionRepository, L: SessionLockRepository>
|
||||
};
|
||||
let session = Session::new(id.into_string(), title_owned);
|
||||
tracing::debug!(session_id = %session.id, title = %session.title, "creating new session");
|
||||
self.session_repo
|
||||
.save_session(&self.base_dir, &session)?;
|
||||
self.session_repo.save_session(&self.base_dir, &session)?;
|
||||
Ok(session)
|
||||
}
|
||||
|
||||
@@ -73,17 +71,14 @@ impl<R: SessionRepository, L: SessionLockRepository>
|
||||
|
||||
fn archive_session(&self, id: SessionId) -> Result<(), ServiceError> {
|
||||
tracing::debug!(session_id = %id, "archiving session");
|
||||
let mut session = self
|
||||
.session_repo
|
||||
.load_session(&self.base_dir, &id)?;
|
||||
let mut session = self.session_repo.load_session(&self.base_dir, &id)?;
|
||||
session.archived = true;
|
||||
let millis = std::time::SystemTime::now()
|
||||
.duration_since(std::time::UNIX_EPOCH)
|
||||
.unwrap_or_default()
|
||||
.as_millis();
|
||||
session.updated_at = i64::try_from(millis).unwrap_or(i64::MAX);
|
||||
self.session_repo
|
||||
.save_session(&self.base_dir, &session)?;
|
||||
self.session_repo.save_session(&self.base_dir, &session)?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -58,11 +58,7 @@ impl<R: ConversationRepository> zesdex_domain::cms::ConversationService
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn add_message(
|
||||
&self,
|
||||
conv: &mut Conversation,
|
||||
msg: ChatMessage,
|
||||
) -> Result<(), ServiceError> {
|
||||
fn add_message(&self, conv: &mut Conversation, msg: ChatMessage) -> Result<(), ServiceError> {
|
||||
tracing::debug!("adding message to session {}", conv.session_id);
|
||||
conv.push(msg);
|
||||
let dir = self.session_dir(&conv.session_id);
|
||||
|
||||
@@ -14,8 +14,7 @@ use std::path::PathBuf;
|
||||
use tracing;
|
||||
|
||||
use zesdex_domain::cms::{
|
||||
AppConfig, AppConfigRepository, ProviderConfig, ServiceError, Settings,
|
||||
SettingsRepository,
|
||||
AppConfig, AppConfigRepository, ProviderConfig, ServiceError, Settings, SettingsRepository,
|
||||
};
|
||||
|
||||
/// Service implementation for settings and app-config operations.
|
||||
@@ -30,11 +29,7 @@ pub struct SettingsServiceImpl<S, C> {
|
||||
|
||||
impl<S: SettingsRepository, C: AppConfigRepository> SettingsServiceImpl<S, C> {
|
||||
/// Create a new service with the given repositories and base directory.
|
||||
pub fn new(
|
||||
settings_repo: S,
|
||||
app_config_repo: C,
|
||||
base_dir: impl Into<PathBuf>,
|
||||
) -> Self {
|
||||
pub fn new(settings_repo: S, app_config_repo: C, base_dir: impl Into<PathBuf>) -> Self {
|
||||
tracing::debug!("creating SettingsServiceImpl");
|
||||
Self {
|
||||
settings_repo,
|
||||
@@ -44,8 +39,8 @@ impl<S: SettingsRepository, C: AppConfigRepository> SettingsServiceImpl<S, C> {
|
||||
}
|
||||
}
|
||||
|
||||
impl<S: SettingsRepository, C: AppConfigRepository>
|
||||
zesdex_domain::cms::SettingsService for SettingsServiceImpl<S, C>
|
||||
impl<S: SettingsRepository, C: AppConfigRepository> zesdex_domain::cms::SettingsService
|
||||
for SettingsServiceImpl<S, C>
|
||||
{
|
||||
fn load_settings(&self) -> Result<Settings, ServiceError> {
|
||||
tracing::debug!("loading settings");
|
||||
@@ -60,11 +55,7 @@ impl<S: SettingsRepository, C: AppConfigRepository>
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn update_provider(
|
||||
&self,
|
||||
name: &str,
|
||||
config: &ProviderConfig,
|
||||
) -> Result<(), ServiceError> {
|
||||
fn update_provider(&self, name: &str, config: &ProviderConfig) -> Result<(), ServiceError> {
|
||||
tracing::debug!("updating provider '{name}'");
|
||||
let mut app_config: AppConfig = self.app_config_repo.load(&self.base_dir)?;
|
||||
app_config
|
||||
|
||||
@@ -30,10 +30,10 @@
|
||||
//! the use-case logic independent of any specific persistence or infrastructure
|
||||
//! technology.
|
||||
|
||||
pub mod agent;
|
||||
pub mod auth;
|
||||
pub mod cms;
|
||||
pub mod ports;
|
||||
pub mod agent;
|
||||
|
||||
// Re-export port traits for ergonomic access.
|
||||
pub use ports::*;
|
||||
@@ -46,12 +46,11 @@ pub use auth::{
|
||||
|
||||
// Re-export CMS use-cases.
|
||||
pub use cms::{
|
||||
conversation_service::ConversationServiceImpl,
|
||||
memory_service::MemoryServiceImpl,
|
||||
conversation_service::ConversationServiceImpl, memory_service::MemoryServiceImpl,
|
||||
settings_service::SettingsServiceImpl,
|
||||
};
|
||||
|
||||
pub use agent::{
|
||||
turn_service::{compact_messages_with_ai, AgentTurnServiceImpl},
|
||||
AgentTurnService, ExploreOutput, ExploreService, ToolExecutor,
|
||||
turn_service::{AgentTurnServiceImpl, compact_messages_with_ai},
|
||||
};
|
||||
|
||||
@@ -22,11 +22,8 @@ pub trait AuthService: Send + Sync {
|
||||
/// Authenticate a user by verifying a password against a stored hash.
|
||||
///
|
||||
/// Returns `true` if the password matches, `false` otherwise.
|
||||
fn authenticate(
|
||||
&self,
|
||||
password: &str,
|
||||
hash: &str,
|
||||
) -> impl Future<Output = Result<bool>> + Send;
|
||||
fn authenticate(&self, password: &str, hash: &str)
|
||||
-> impl Future<Output = Result<bool>> + Send;
|
||||
|
||||
/// Issue a new access + refresh token pair for the given subject.
|
||||
///
|
||||
|
||||
@@ -7,8 +7,8 @@ use std::path::PathBuf;
|
||||
use crate::core::{ChatMessage, ToolCallResult, UsageStats};
|
||||
|
||||
pub mod defaults;
|
||||
pub mod prompt;
|
||||
pub mod progress;
|
||||
pub mod prompt;
|
||||
|
||||
/// Which kind of caller (main agent vs. subagent vs. reviewer) is
|
||||
/// invoking a tool, used to scope permissions and tag log/output paths.
|
||||
|
||||
@@ -46,10 +46,6 @@ pub struct SettingsPatch {
|
||||
pub review_enabled: Option<bool>,
|
||||
/// Override the session-archive-enabled flag.
|
||||
pub session_archive_enabled: Option<bool>,
|
||||
/// Override the LSP auto-provision flag.
|
||||
pub lsp_auto_provision: Option<bool>,
|
||||
/// Override the list of LSP-managed languages.
|
||||
pub lsp_languages: Option<Vec<String>>,
|
||||
/// Override the hive-mind node timeout in milliseconds.
|
||||
pub hive_mind_node_timeout_ms: Option<u64>,
|
||||
}
|
||||
@@ -111,12 +107,6 @@ impl SettingsPatch {
|
||||
if let Some(val) = self.session_archive_enabled {
|
||||
settings.flags.session_archive_enabled = val;
|
||||
}
|
||||
if let Some(val) = self.lsp_auto_provision {
|
||||
settings.flags.lsp_auto_provision = val;
|
||||
}
|
||||
if let Some(ref val) = self.lsp_languages {
|
||||
settings.lsp_languages = val.clone();
|
||||
}
|
||||
if let Some(val) = self.hive_mind_node_timeout_ms {
|
||||
settings.hive_mind_node_timeout_ms = val;
|
||||
}
|
||||
|
||||
@@ -11,5 +11,5 @@
|
||||
//! - `ChatMessage` — a single message with role, content, and tool metadata
|
||||
//! - `Role` — message role enum (User, Assistant, System, Tool)
|
||||
|
||||
pub use crate::core::message::{ChatMessage, Role};
|
||||
pub use crate::core::conversation::Conversation;
|
||||
pub use crate::core::message::{ChatMessage, Role};
|
||||
|
||||
@@ -32,6 +32,7 @@ pub mod settings;
|
||||
pub use app_config::AppConfig;
|
||||
pub use app_config::ModelRole;
|
||||
pub use app_config::ProviderConfig;
|
||||
pub use commands::{NewMemory, SettingsPatch};
|
||||
pub use conversation::Conversation;
|
||||
pub use edit_log::EditLog;
|
||||
pub use edit_log::EditLogEntry;
|
||||
@@ -46,7 +47,6 @@ pub use repository::SettingsRepository;
|
||||
pub use service::ConversationService;
|
||||
pub use service::MemoryService;
|
||||
pub use service::SettingsService;
|
||||
pub use commands::{NewMemory, SettingsPatch};
|
||||
pub use settings::InternetMode;
|
||||
pub use settings::Settings;
|
||||
pub use settings::SettingsFlags;
|
||||
|
||||
@@ -56,11 +56,7 @@ pub trait ConversationRepository {
|
||||
fn load(&self, session_dir: &Path) -> Result<Conversation, RepositoryError>;
|
||||
|
||||
/// Persist a `Conversation` to the given session directory.
|
||||
fn save(
|
||||
&self,
|
||||
session_dir: &Path,
|
||||
conversation: &Conversation,
|
||||
) -> Result<(), RepositoryError>;
|
||||
fn save(&self, session_dir: &Path, conversation: &Conversation) -> Result<(), RepositoryError>;
|
||||
}
|
||||
|
||||
/// Persistence contract for `Memory` (long-term agent memory entries).
|
||||
|
||||
@@ -44,11 +44,7 @@ pub trait ConversationService {
|
||||
fn save_conversation(&self, conv: &Conversation) -> Result<(), ServiceError>;
|
||||
|
||||
/// Append a single `ChatMessage` to the conversation and persist.
|
||||
fn add_message(
|
||||
&self,
|
||||
conv: &mut Conversation,
|
||||
msg: ChatMessage,
|
||||
) -> Result<(), ServiceError>;
|
||||
fn add_message(&self, conv: &mut Conversation, msg: ChatMessage) -> Result<(), ServiceError>;
|
||||
}
|
||||
|
||||
/// Use-cases for long-term memory management.
|
||||
|
||||
@@ -18,7 +18,6 @@
|
||||
//! - `workflow_max_concurrency` — max parallel hive-mind nodes
|
||||
//! - `hive_mind_node_timeout_ms` — per-node timeout for hive-mind orchestration
|
||||
//! - `flags` — grouped boolean feature toggles
|
||||
//! - `lsp_languages` — list of language IDs for LSP auto-provisioning
|
||||
|
||||
use std::collections::HashMap;
|
||||
|
||||
@@ -49,12 +48,10 @@ pub enum InternetMode {
|
||||
/// ## Fields
|
||||
/// - `review_enabled` — enable automatic inline review after edits
|
||||
/// - `session_archive_enabled` — enable periodic session archiving
|
||||
/// - `lsp_auto_provision` — auto-provision LSP language servers on project open
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct SettingsFlags {
|
||||
pub review_enabled: bool,
|
||||
pub session_archive_enabled: bool,
|
||||
pub lsp_auto_provision: bool,
|
||||
}
|
||||
|
||||
impl Default for SettingsFlags {
|
||||
@@ -63,7 +60,6 @@ impl Default for SettingsFlags {
|
||||
Self {
|
||||
review_enabled: true,
|
||||
session_archive_enabled: true,
|
||||
lsp_auto_provision: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -93,7 +89,6 @@ pub struct Settings {
|
||||
pub workflow_max_concurrency: usize,
|
||||
#[serde(flatten)]
|
||||
pub flags: SettingsFlags,
|
||||
pub lsp_languages: Vec<String>,
|
||||
#[serde(default = "default_hive_mind_node_timeout_ms")]
|
||||
pub hive_mind_node_timeout_ms: u64,
|
||||
}
|
||||
@@ -113,7 +108,6 @@ impl Default for Settings {
|
||||
verify_timeout_ms: 30_000,
|
||||
workflow_max_concurrency: 5,
|
||||
flags: SettingsFlags::default(),
|
||||
lsp_languages: Vec::new(),
|
||||
hive_mind_node_timeout_ms: 600_000,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -335,16 +335,16 @@ impl SseParser {
|
||||
{
|
||||
const MAX_TOOL_CALLS: usize = 64;
|
||||
for tc in tool_calls {
|
||||
let raw_index =
|
||||
tc.get("index").and_then(Value::as_u64).unwrap_or_else(
|
||||
|| {
|
||||
tracing::warn!(
|
||||
"[stream] tool call delta missing index, \
|
||||
let raw_index = tc
|
||||
.get("index")
|
||||
.and_then(Value::as_u64)
|
||||
.unwrap_or_else(|| {
|
||||
tracing::warn!(
|
||||
"[stream] tool call delta missing index, \
|
||||
defaulting to 0"
|
||||
);
|
||||
0
|
||||
},
|
||||
);
|
||||
);
|
||||
0
|
||||
});
|
||||
// Clamp index to prevent out-of-bounds / memory exhaustion
|
||||
let index = usize::try_from(raw_index)
|
||||
.unwrap_or(0)
|
||||
@@ -395,8 +395,7 @@ impl SseParser {
|
||||
if let Some(content) = delta.get("text").and_then(|c| c.as_str()) {
|
||||
d_events.push(StreamEvent::Token(content.to_string()));
|
||||
}
|
||||
if let Some(reasoning) =
|
||||
delta.get("reasoning_content").and_then(|r| r.as_str())
|
||||
if let Some(reasoning) = delta.get("reasoning_content").and_then(|r| r.as_str())
|
||||
{
|
||||
d_events.push(StreamEvent::Reasoning(reasoning.to_string()));
|
||||
}
|
||||
|
||||
@@ -40,9 +40,11 @@ impl Store {
|
||||
///
|
||||
/// Why: paths are computed, not created — call `ensure_dirs` before use.
|
||||
pub fn new() -> Self {
|
||||
let base = if let Some(data_dir) = std::env::var("XDG_DATA_HOME").ok()
|
||||
.or_else(|| std::env::var("HOME").ok().map(|h| format!("{h}/.local/share")))
|
||||
{
|
||||
let base = if let Some(data_dir) = std::env::var("XDG_DATA_HOME").ok().or_else(|| {
|
||||
std::env::var("HOME")
|
||||
.ok()
|
||||
.map(|h| format!("{h}/.local/share"))
|
||||
}) {
|
||||
PathBuf::from(data_dir).join("zesdex")
|
||||
} else {
|
||||
PathBuf::from(".local/share/zesdex")
|
||||
|
||||
+14
-15
@@ -24,33 +24,32 @@
|
||||
//! no framework imports, no side effects. All persistence is expressed
|
||||
//! through repository traits that infrastructure adapters implement.
|
||||
|
||||
pub mod agent;
|
||||
pub mod auth;
|
||||
pub mod cms;
|
||||
pub mod core;
|
||||
pub mod error;
|
||||
pub mod agent;
|
||||
pub mod workflow;
|
||||
pub mod subagent;
|
||||
pub mod workflow;
|
||||
|
||||
// Re-export all public items from each module for ergonomic imports.
|
||||
// Consumers can do `use zesdex_domain::*` for common types.
|
||||
pub use auth::{
|
||||
IamSession, NewSession, OAuthConfig, OAuthToken, OAuthRepository, OAuthService,
|
||||
RepositoryError as AuthRepositoryError, ServiceError as AuthServiceError, Session,
|
||||
SessionId, SessionLock, SessionLockRepository, SessionRepository, SessionService,
|
||||
IamSession, NewSession, OAuthConfig, OAuthRepository, OAuthService, OAuthToken,
|
||||
RepositoryError as AuthRepositoryError, ServiceError as AuthServiceError, Session, SessionId,
|
||||
SessionLock, SessionLockRepository, SessionRepository, SessionService,
|
||||
};
|
||||
pub use cms::{
|
||||
AppConfig, AppConfigRepository, Conversation as CmsConversation,
|
||||
ConversationRepository, ConversationService, EditLog, EditLogEntry,
|
||||
EditLogRepository, InternetMode, Memory, MemoryRepository, MemoryService,
|
||||
ModelRole, NewMemory, ProviderConfig, RepositoryError as CmsRepositoryError,
|
||||
ServiceError as CmsServiceError, Settings, SettingsFlags, SettingsPatch,
|
||||
SettingsRepository, SettingsService,
|
||||
AppConfig, AppConfigRepository, Conversation as CmsConversation, ConversationRepository,
|
||||
ConversationService, EditLog, EditLogEntry, EditLogRepository, InternetMode, Memory,
|
||||
MemoryRepository, MemoryService, ModelRole, NewMemory, ProviderConfig,
|
||||
RepositoryError as CmsRepositoryError, ServiceError as CmsServiceError, Settings,
|
||||
SettingsFlags, SettingsPatch, SettingsRepository, SettingsService,
|
||||
};
|
||||
pub use core::{
|
||||
ChatMessage, ChatRequest, ChatResponse, Choice, Conversation, Delta, Role,
|
||||
SseParser, StreamEvent, StreamOptions, Store, TokenUsage, ToolCall,
|
||||
ToolCallResult, ToolDef, ToolFunction, ToolFunctionDef, UsageStats,
|
||||
ChatMessage, ChatRequest, ChatResponse, Choice, Conversation, Delta, Role, SseParser, Store,
|
||||
StreamEvent, StreamOptions, TokenUsage, ToolCall, ToolCallResult, ToolDef, ToolFunction,
|
||||
ToolFunctionDef, UsageStats,
|
||||
};
|
||||
pub use error::DomainError;
|
||||
|
||||
@@ -60,5 +59,5 @@ pub use agent::*;
|
||||
pub use agent::defaults::*;
|
||||
pub use agent::progress::AgentProgress;
|
||||
pub use agent::prompt::{compaction_prompt, main_agent_prompt, subagent_directive};
|
||||
pub use workflow::*;
|
||||
pub use subagent::*;
|
||||
pub use workflow::*;
|
||||
|
||||
@@ -10,6 +10,6 @@ pub enum AccessTier {
|
||||
Read,
|
||||
/// Read + Write: above plus write, edit, delete, git, memory.
|
||||
Write,
|
||||
/// Full: above plus bash, shell, LSP, workflow, plan tools.
|
||||
/// Full: above plus bash, shell, workflow, plan tools.
|
||||
Full,
|
||||
}
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
//! configuration files plus a seed session for development/testing.
|
||||
//! Invoked as `cargo run --bin seed`.
|
||||
|
||||
|
||||
fn main() -> anyhow::Result<()> {
|
||||
let store = zesdex_domain::core::Store::new();
|
||||
store.ensure_dirs()?;
|
||||
@@ -46,13 +45,11 @@ fn main() -> anyhow::Result<()> {
|
||||
|
||||
// Create a seed session
|
||||
let session_id = uuid::Uuid::new_v4().to_string();
|
||||
let session = zesdex_domain::auth::Session::new(
|
||||
session_id.clone(),
|
||||
"Seed Session".to_string(),
|
||||
);
|
||||
let session = zesdex_domain::auth::Session::new(session_id.clone(), "Seed Session".to_string());
|
||||
// Persist via the session repository
|
||||
use zesdex_domain::SessionRepository;
|
||||
let repo = zesdex_infrastructure::persistence::iam::session_repo::FileSystemSessionRepository::new();
|
||||
let repo =
|
||||
zesdex_infrastructure::persistence::iam::session_repo::FileSystemSessionRepository::new();
|
||||
repo.save_session(&store.base_dir, &session)?;
|
||||
tracing::info!("Seed session created: id={session_id}");
|
||||
|
||||
|
||||
@@ -5,12 +5,12 @@ fn main() {
|
||||
let base_dir = dirs::home_dir().unwrap().join(".local/share/zesdex");
|
||||
let repo = JsonAppConfigRepository::new();
|
||||
let config = repo.load(&base_dir).unwrap();
|
||||
|
||||
|
||||
println!("Providers:");
|
||||
for (k, v) in &config.providers {
|
||||
println!(" - {} (default model: {:?})", k, v.default_model);
|
||||
}
|
||||
|
||||
|
||||
println!("Default provider: {}", config.default_provider);
|
||||
println!("Default model: {}", config.default_model);
|
||||
println!("Model roles:");
|
||||
|
||||
@@ -16,7 +16,10 @@ struct ClaudeSettings {
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let path = dirs::home_dir().unwrap().join(".claude").join("settings.json");
|
||||
let path = dirs::home_dir()
|
||||
.unwrap()
|
||||
.join(".claude")
|
||||
.join("settings.json");
|
||||
println!("Path: {:?}", path);
|
||||
match std::fs::read_to_string(&path) {
|
||||
Ok(content) => {
|
||||
|
||||
@@ -12,7 +12,11 @@ use clap::Parser;
|
||||
|
||||
/// Zesdex — autonomous AI coding agent.
|
||||
#[derive(Parser, Debug)]
|
||||
#[command(name = "zesdex", version, about = "Autonomous AI coding agent with TUI")]
|
||||
#[command(
|
||||
name = "zesdex",
|
||||
version,
|
||||
about = "Autonomous AI coding agent with TUI"
|
||||
)]
|
||||
struct Cli {
|
||||
/// Run as background daemon with IPC socket
|
||||
#[arg(long)]
|
||||
|
||||
@@ -32,7 +32,6 @@ ignore.workspace = true
|
||||
nucleo-matcher.workspace = true
|
||||
futures-util.workspace = true
|
||||
rmcp.workspace = true
|
||||
lsp-types.workspace = true
|
||||
tiktoken-rs.workspace = true
|
||||
similar.workspace = true
|
||||
syntect.workspace = true
|
||||
|
||||
@@ -8,12 +8,27 @@ pub struct JwtClaims {
|
||||
pub sub: String,
|
||||
pub exp: u64,
|
||||
pub iat: u64,
|
||||
/// Token purpose: `"access"` or `"refresh"`.
|
||||
///
|
||||
/// Prevents an access token from being replayed as a refresh token
|
||||
/// (which would otherwise extend a short-lived credential into the
|
||||
/// 7-day refresh window).
|
||||
#[serde(rename = "typ")]
|
||||
pub token_type: TokenType,
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub session_id: Option<String>,
|
||||
}
|
||||
|
||||
/// JWT token purpose.
|
||||
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
|
||||
#[serde(rename_all = "lowercase")]
|
||||
pub enum TokenType {
|
||||
Access,
|
||||
Refresh,
|
||||
}
|
||||
|
||||
impl JwtClaims {
|
||||
pub fn new(sub: String, exp: u64, session_id: Option<String>) -> Self {
|
||||
pub fn new(sub: String, exp: u64, token_type: TokenType, session_id: Option<String>) -> Self {
|
||||
let iat = std::time::SystemTime::now()
|
||||
.duration_since(std::time::UNIX_EPOCH)
|
||||
.unwrap_or_default()
|
||||
@@ -22,6 +37,7 @@ impl JwtClaims {
|
||||
sub,
|
||||
exp,
|
||||
iat,
|
||||
token_type,
|
||||
session_id,
|
||||
}
|
||||
}
|
||||
@@ -48,3 +64,57 @@ pub fn verify_token(secret: &str, token: &str) -> anyhow::Result<JwtClaims> {
|
||||
let token_data = jsonwebtoken::decode::<JwtClaims>(token, &key, &validation)?;
|
||||
Ok(token_data.claims)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn claims(exp_secs_from_now: u64, token_type: TokenType) -> JwtClaims {
|
||||
let now = std::time::SystemTime::now()
|
||||
.duration_since(std::time::UNIX_EPOCH)
|
||||
.unwrap()
|
||||
.as_secs();
|
||||
JwtClaims::new(
|
||||
"user-1".to_string(),
|
||||
now + exp_secs_from_now,
|
||||
token_type,
|
||||
None,
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn access_and_refresh_tokens_roundtrip() {
|
||||
let secret = "test-secret";
|
||||
let access = create_token(secret, claims(3600, TokenType::Access)).unwrap();
|
||||
let refresh = create_token(secret, claims(604800, TokenType::Refresh)).unwrap();
|
||||
|
||||
let acc = verify_token(secret, &access).unwrap();
|
||||
assert_eq!(acc.token_type, TokenType::Access);
|
||||
|
||||
let refr = verify_token(secret, &refresh).unwrap();
|
||||
assert_eq!(refr.token_type, TokenType::Refresh);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn token_type_is_distinct() {
|
||||
let secret = "test-secret";
|
||||
let access = create_token(secret, claims(3600, TokenType::Access)).unwrap();
|
||||
let claims = verify_token(secret, &access).unwrap();
|
||||
assert_ne!(claims.token_type, TokenType::Refresh);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn expired_token_is_rejected() {
|
||||
let secret = "test-secret";
|
||||
// exp well in the past (beyond the library's default 60s leeway) →
|
||||
// verification must fail.
|
||||
let past = std::time::SystemTime::now()
|
||||
.duration_since(std::time::UNIX_EPOCH)
|
||||
.unwrap()
|
||||
.as_secs()
|
||||
.saturating_sub(120);
|
||||
let expired = JwtClaims::new("user-1".to_string(), past, TokenType::Access, None);
|
||||
let token = create_token(secret, expired).unwrap();
|
||||
assert!(verify_token(secret, &token).is_err());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -21,20 +21,13 @@ impl LoopbackServer {
|
||||
format!("http://127.0.0.1:{}/callback", self.port)
|
||||
}
|
||||
|
||||
pub fn wait_for_code(
|
||||
&self,
|
||||
timeout_ms: u64,
|
||||
expected_state: &str,
|
||||
) -> std::io::Result<String> {
|
||||
pub fn wait_for_code(&self, timeout_ms: u64, expected_state: &str) -> std::io::Result<String> {
|
||||
let (mut stream, _) = self.listener.accept()?;
|
||||
stream.set_read_timeout(Some(std::time::Duration::from_millis(timeout_ms)))?;
|
||||
Self::read_callback(&mut stream, expected_state)
|
||||
}
|
||||
|
||||
fn read_callback(
|
||||
stream: &mut TcpStream,
|
||||
expected_state: &str,
|
||||
) -> std::io::Result<String> {
|
||||
fn read_callback(stream: &mut TcpStream, expected_state: &str) -> std::io::Result<String> {
|
||||
let mut buf = [0u8; 4096];
|
||||
let n = stream.read(&mut buf)?;
|
||||
let request = String::from_utf8_lossy(&buf[..n]);
|
||||
@@ -68,7 +61,10 @@ impl LoopbackServer {
|
||||
));
|
||||
}
|
||||
code.ok_or_else(|| {
|
||||
std::io::Error::new(std::io::ErrorKind::InvalidData, "code not found in callback")
|
||||
std::io::Error::new(
|
||||
std::io::ErrorKind::InvalidData,
|
||||
"code not found in callback",
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -59,17 +59,25 @@ pub struct AuditReport {
|
||||
impl AuditReport {
|
||||
/// True if any ERROR-level violations exist.
|
||||
pub fn has_errors(&self) -> bool {
|
||||
self.violations.iter().any(|v| v.severity == Severity::Error)
|
||||
self.violations
|
||||
.iter()
|
||||
.any(|v| v.severity == Severity::Error)
|
||||
}
|
||||
|
||||
/// Number of errors.
|
||||
pub fn error_count(&self) -> usize {
|
||||
self.violations.iter().filter(|v| v.severity == Severity::Error).count()
|
||||
self.violations
|
||||
.iter()
|
||||
.filter(|v| v.severity == Severity::Error)
|
||||
.count()
|
||||
}
|
||||
|
||||
/// Number of warnings.
|
||||
pub fn warning_count(&self) -> usize {
|
||||
self.violations.iter().filter(|v| v.severity == Severity::Warning).count()
|
||||
self.violations
|
||||
.iter()
|
||||
.filter(|v| v.severity == Severity::Warning)
|
||||
.count()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -117,7 +125,6 @@ fn forbidden_imports(layer: &str) -> &'static [&'static str] {
|
||||
"argon2",
|
||||
"jsonwebtoken",
|
||||
"rmcp",
|
||||
"lsp_types",
|
||||
"tiktoken_rs",
|
||||
"syntect",
|
||||
"pulldown_cmark",
|
||||
@@ -152,11 +159,7 @@ fn forbidden_imports(layer: &str) -> &'static [&'static str] {
|
||||
}
|
||||
|
||||
/// Scan a single Rust source file for forbidden imports.
|
||||
fn scan_file(
|
||||
file_path: &Path,
|
||||
layer: &'static str,
|
||||
root: &Path,
|
||||
) -> Vec<Violation> {
|
||||
fn scan_file(file_path: &Path, layer: &'static str, root: &Path) -> Vec<Violation> {
|
||||
let mut violations = Vec::new();
|
||||
let content = match std::fs::read_to_string(file_path) {
|
||||
Ok(c) => c,
|
||||
@@ -185,10 +188,12 @@ fn scan_file(
|
||||
// `use crate::` in domain could reference domain-only items — skip.
|
||||
continue;
|
||||
}
|
||||
if trimmed.starts_with(&pattern) || trimmed.starts_with(&format!("use {forbidden}::")) {
|
||||
if trimmed.starts_with(&pattern)
|
||||
|| trimmed.starts_with(&format!("use {forbidden}::"))
|
||||
{
|
||||
// Skip test code — test modules commonly import outer layers.
|
||||
let is_test = content[..content.len().saturating_sub(1)]
|
||||
.contains("#[cfg(test)]");
|
||||
let is_test =
|
||||
content[..content.len().saturating_sub(1)].contains("#[cfg(test)]");
|
||||
if is_test {
|
||||
continue;
|
||||
}
|
||||
@@ -243,10 +248,7 @@ pub fn audit_layering(root: &Path) -> Result<AuditReport> {
|
||||
}
|
||||
|
||||
// Determine which crate this file belongs to by walking up.
|
||||
let layer = path
|
||||
.ancestors()
|
||||
.skip(1)
|
||||
.find_map(|p| classify_layer(p));
|
||||
let layer = path.ancestors().skip(1).find_map(|p| classify_layer(p));
|
||||
|
||||
if let Some(layer) = layer {
|
||||
files_scanned += 1;
|
||||
@@ -371,7 +373,10 @@ mod tests {
|
||||
fn function_metrics_short_function_ok() {
|
||||
let content = "fn ok() {\n let x = 1;\n}\n";
|
||||
let violations = check_function_metrics(content);
|
||||
let long: Vec<_> = violations.iter().filter(|v| v.message.contains("Function too long")).collect();
|
||||
let long: Vec<_> = violations
|
||||
.iter()
|
||||
.filter(|v| v.message.contains("Function too long"))
|
||||
.collect();
|
||||
assert!(long.is_empty(), "short function should not trigger");
|
||||
}
|
||||
|
||||
@@ -383,7 +388,10 @@ mod tests {
|
||||
}
|
||||
lines.push_str("}\n");
|
||||
let violations = check_function_metrics(&lines);
|
||||
let long: Vec<_> = violations.iter().filter(|v| v.message.contains("Function too long")).collect();
|
||||
let long: Vec<_> = violations
|
||||
.iter()
|
||||
.filter(|v| v.message.contains("Function too long"))
|
||||
.collect();
|
||||
assert!(!long.is_empty(), "long function should trigger warning");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -36,7 +36,9 @@ pub struct CodeQualityReport {
|
||||
|
||||
impl CodeQualityReport {
|
||||
pub fn has_errors(&self) -> bool {
|
||||
self.findings.iter().any(|f| f.severity == super::arch_audit::Severity::Error)
|
||||
self.findings
|
||||
.iter()
|
||||
.any(|f| f.severity == super::arch_audit::Severity::Error)
|
||||
}
|
||||
pub fn count_by_rule(&self) -> Vec<(&'static str, usize)> {
|
||||
let mut counts: std::collections::HashMap<&str, usize> = std::collections::HashMap::new();
|
||||
@@ -147,7 +149,8 @@ pub fn scan_quality_file(file_path: &Path, root: &Path) -> Vec<Finding> {
|
||||
|
||||
// ── Rule: Missing doc comments on pub items ────────────────────
|
||||
if (trimmed.starts_with("pub ") || trimmed.starts_with("pub("))
|
||||
&& !prev_line_doc && !prev_line_empty
|
||||
&& !prev_line_doc
|
||||
&& !prev_line_empty
|
||||
{
|
||||
// Check it's a struct/enum/fn/trait/type/const/mod
|
||||
let is_item = trimmed.starts_with("pub fn ")
|
||||
@@ -246,7 +249,10 @@ mod tests {
|
||||
std::fs::write(&file, "fn x() { let y = foo.unwrap(); }\n").unwrap();
|
||||
|
||||
let findings = scan_quality_file(&file, &dir);
|
||||
let unwrap_findings: Vec<_> = findings.iter().filter(|f| f.rule == "unwrap-in-production").collect();
|
||||
let unwrap_findings: Vec<_> = findings
|
||||
.iter()
|
||||
.filter(|f| f.rule == "unwrap-in-production")
|
||||
.collect();
|
||||
assert!(!unwrap_findings.is_empty(), "should detect unwrap");
|
||||
}
|
||||
|
||||
@@ -262,8 +268,14 @@ mod tests {
|
||||
.unwrap();
|
||||
|
||||
let findings = scan_quality_file(&file, &dir);
|
||||
let unwrap_findings: Vec<_> = findings.iter().filter(|f| f.rule == "unwrap-in-production").collect();
|
||||
assert!(unwrap_findings.is_empty(), "should skip unwrap in test blocks");
|
||||
let unwrap_findings: Vec<_> = findings
|
||||
.iter()
|
||||
.filter(|f| f.rule == "unwrap-in-production")
|
||||
.collect();
|
||||
assert!(
|
||||
unwrap_findings.is_empty(),
|
||||
"should skip unwrap in test blocks"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -274,7 +286,13 @@ mod tests {
|
||||
std::fs::write(&file, "#[allow(clippy::too_many_arguments)]\nfn x() {}\n").unwrap();
|
||||
|
||||
let findings = scan_quality_file(&file, &dir);
|
||||
let bypass_findings: Vec<_> = findings.iter().filter(|f| f.rule == "compiler-bypass").collect();
|
||||
assert!(!bypass_findings.is_empty(), "should detect allow attributes");
|
||||
let bypass_findings: Vec<_> = findings
|
||||
.iter()
|
||||
.filter(|f| f.rule == "compiler-bypass")
|
||||
.collect();
|
||||
assert!(
|
||||
!bypass_findings.is_empty(),
|
||||
"should detect allow attributes"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user