Mikkel Georgsen
6c4272ce85
Planning artifacts (milestones v1.0-v1.2.1, v1.3 queue, PROJECT.md, STATE.md, config) now live alongside the code they describe. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
11 KiB
11 KiB
| phase | plan | type | wave | depends_on | files_modified | autonomous | requirements | must_haves | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 01-foundation | 01 | execute | 1 |
|
true |
|
|
Purpose: Isolate all Nexus vocabulary from upstream Paperclip code so that rebase operations never conflict on display strings.
Output: A working, tested @paperclipai/branding package importable by any workspace member.
<execution_context> @$HOME/.claude/get-shit-done/workflows/execute-plan.md @$HOME/.claude/get-shit-done/templates/summary.md </execution_context>
@.planning/PROJECT.md @.planning/ROADMAP.md @.planning/STATE.md @.planning/phases/01-foundation/01-RESEARCH.mdFrom packages/shared/package.json:
{
"name": "@paperclipai/shared",
"version": "0.3.1",
"license": "MIT",
"type": "module",
"exports": {
".": "./src/index.ts",
"./*": "./src/*.ts"
},
"publishConfig": {
"access": "public",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.js"
},
"./*": {
"types": "./dist/*.d.ts",
"import": "./dist/*.js"
}
},
"main": "./dist/index.js",
"types": "./dist/index.d.ts"
},
"files": ["dist"],
"scripts": {
"build": "tsc",
"clean": "rm -rf dist",
"typecheck": "tsc --noEmit"
}
}
From packages/shared/tsconfig.json:
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"rootDir": "src"
},
"include": ["src"]
}
From vitest.config.ts (root):
import { defineConfig } from "vitest/config";
export default defineConfig({
test: {
projects: ["packages/db", "packages/adapters/opencode-local", "server", "ui", "cli"],
},
});
From pnpm-workspace.yaml (confirms packages/* glob):
packages:
- packages/*
- packages/adapters/*
- packages/plugins/*
- packages/plugins/examples/*
- server
- ui
- cli
2. Create `packages/branding/tsconfig.json`:
```json
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"rootDir": "src"
},
"include": ["src"]
}
```
3. Create `packages/branding/vitest.config.ts`:
```typescript
import { defineConfig } from "vitest/config";
export default defineConfig({
test: {
include: ["src/**/*.test.ts"],
},
});
```
4. Create `packages/branding/src/vocab.ts` with the VOCAB constant:
```typescript
export const VOCAB = {
// Entity renames (display only — code identifiers unchanged)
company: "Workspace",
companies: "Workspaces",
ceo: "Project Manager",
board: "Owner",
hire: "Add",
fire: "Remove",
// Brand name
appName: "Nexus",
tagline: "Open-source orchestration for your agents",
} as const;
export type VocabKey = keyof typeof VOCAB;
```
5. Create `packages/branding/src/index.ts`:
```typescript
export { VOCAB, type VocabKey } from "./vocab.js";
```
6. Create `packages/branding/src/vocab.test.ts` — RED first (write tests before verifying they pass):
```typescript
import { describe, it, expect } from "vitest";
import { VOCAB } from "./vocab.js";
describe("VOCAB", () => {
it("maps company to Workspace", () => {
expect(VOCAB.company).toBe("Workspace");
});
it("maps companies to Workspaces", () => {
expect(VOCAB.companies).toBe("Workspaces");
});
it("maps ceo to Project Manager", () => {
expect(VOCAB.ceo).toBe("Project Manager");
});
it("maps board to Owner", () => {
expect(VOCAB.board).toBe("Owner");
});
it("maps hire to Add", () => {
expect(VOCAB.hire).toBe("Add");
});
it("maps fire to Remove", () => {
expect(VOCAB.fire).toBe("Remove");
});
it("has appName as Nexus", () => {
expect(VOCAB.appName).toBe("Nexus");
});
it("has a non-empty tagline", () => {
expect(VOCAB.tagline).toBe("Open-source orchestration for your agents");
});
it("all values are non-empty strings", () => {
for (const [key, value] of Object.entries(VOCAB)) {
expect(typeof value).toBe("string");
expect(value.length).toBeGreaterThan(0);
}
});
});
```
7. Run `pnpm install` from repo root to link the new workspace package.
8. Run tests to confirm GREEN: `pnpm vitest run --project packages/branding`
```typescript
import { defineConfig } from "vitest/config";
export default defineConfig({
test: {
projects: ["packages/db", "packages/adapters/opencode-local", "server", "ui", "cli", "packages/branding"],
},
});
```
The only change is appending `"packages/branding"` to the end of the existing `projects` array.
After editing, run `pnpm vitest run --project packages/branding` to confirm the root config picks up the new project.
<success_criteria>
@paperclipai/brandingpackage exists atpackages/branding/VOCABconstant exports 8 keys: company, companies, ceo, board, hire, fire, appName, tagline- All values are correct Nexus display strings
- Unit tests pass via vitest
- Package is registered in root vitest config </success_criteria>