mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-14 08:26:46 +02:00
## Thinking Path > - Paperclip is the open source control plane people use to organize and govern AI-agent companies > - Company skills are durable resources that users browse, import, assign, and maintain over time > - A flat skill list plus tags does not provide a stable location or hierarchy for personal, company, project-imported, and bundled skills > - Folder paths need to be canonical, company-scoped, safe to move, and preserved across re-imports without changing skill IDs > - The `/skills` UI also needs traversal, breadcrumbs, move/create flows, and a dedicated My Skills namespace that work on desktop and mobile > - This pull request adds the folder data model and APIs, reserved-root lifecycle, project import behavior, and the folder-first skills experience > - The benefit is a predictable filesystem-like organization model while tags remain available for cross-cutting classification ## Linked Issues or Issue Description Refs #9619 — the reviewed folder foundation was intentionally closed and folded into this combined feature PR. Refs #9026 — earlier flat-folder attempt superseded by this integrated implementation. Refs #3281 — related skill organization proposal; this PR uses canonical persisted folders rather than deriving groups from skill keys, and does not add hidden-skill behavior. **Feature request** - **Problem:** Skills currently lack a canonical hierarchical location, making personal skills, project imports, bundled skills, and company-authored skills difficult to traverse and manage at scale. - **Proposed behavior:** Add nested company-scoped folders with stable paths, reserved My/Projects/Bundled roots, subtree queries, safe move/create operations, and a folder-first `/skills` library UI. - **Import behavior:** New project scans file skills under `projects/<project-slug>`; later imports update content without overriding a user-selected folder. - **Alternatives considered:** Tags alone remain useful for cross-cutting classification, but they do not provide canonical location, nesting, reserved namespaces, or stable import placement. - **Roadmap alignment:** Extends the completed Skills Manager and Scheduled Routines capabilities without duplicating an active roadmap item. ## What Changed - Adds `folders` persistence for routine and skill folders, nested canonical paths, parent/slug/system-key fields, migration backfills, and reapply-safe migrations `0174`–`0175` after current master migrations. - Adds company-scoped folder CRUD, cycle/depth/namespace validation, reserved My/Projects/Bundled lifecycle, item moves, subtree filtering, and folder paths on skill results. - Preserves project-import placement: first import files into the project folder, while re-import keeps user-owned placement and stable skill IDs. - Adds the `/skills` folder tree rail, tags facet, breadcrumbs, subfolder browser, move/new-folder dialog, canonical detail location, inline tag editing, and folder-aware Studio creation. - Keeps bundled skills read-only even when their source metadata is incomplete by detecting the reserved Bundled folder and hiding selection/move actions. - Extends routine folder UI and OpenAPI coverage, and adds regression tests across migrations, services, routes, tree helpers, pages, and Studio creation. ## Verification - `pnpm exec vitest run packages/db/src/nested-skill-folders-migration.test.ts server/src/__tests__/folders-routes.test.ts server/src/__tests__/folders-service.test.ts server/src/__tests__/company-skills-service.test.ts server/src/__tests__/routines-service.test.ts ui/src/components/folders/FolderControls.test.tsx ui/src/components/folders/SkillFolderTree.test.tsx ui/src/components/folders/skill-folder-tree.test.ts ui/src/pages/CompanySkills.test.tsx ui/src/pages/Routines.test.tsx ui/src/pages/SkillStudio.test.tsx ui/src/lib/company-skill-routes.test.ts ui/src/lib/skill-create.test.ts` — 13 files, 192 tests passed. - `pnpm exec vitest run ui/src/pages/CompanySkills.test.tsx ui/src/components/folders/SkillFolderTree.test.tsx` — 2 files, 20 tests passed after preserving the existing PR's bundled-skill fixes. - `pnpm -r typecheck` — passed for all workspace packages. - `pnpm test:run` — passed in an isolated CI-like environment with inherited Paperclip runtime identity and static AWS credential variables removed. - `pnpm build` — production build passed for all workspace packages. - Greptile iteration 2 — 5/5 confidence with zero unresolved threads on commit `ff2d67aa71`. - Latest-head GitHub checks — all success, neutral, or skipped; PR is mergeable with a clean merge state. - `pnpm check:token-gates` — reports nine existing `#9627` comment false positives already present on `master`; this PR introduces no new token violation. ## Risks - **Migration/backfill:** `0174` creates the foundation and `0175` adds nested/reserved semantics. Both are ordered after current master migration `0173`, are covered by numbering/safety checks, and are designed to be reapply-safe. - **Reserved namespaces:** My, Projects, and Bundled roots are service-managed. Regression coverage prevents namespace squatting, cross-company folder use, bundled writes, cycles, and excessive depth. - **Behavioral change:** Project scans choose a project folder only on initial creation; existing skills deliberately retain their current folder during refresh. - **UI scope:** The folder rail applies to the Installed library; Catalog retains the discovery-oriented category sidebar. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI `gpt-5.5` in Codex CLI, medium reasoning mode; runtime did not expose a context-window value. Used repository/file tools, terminal execution, Git/GitHub operations, test execution, and code editing. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
120 lines
3.7 KiB
TypeScript
120 lines
3.7 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import type { CompanySkillDetail } from "@paperclipai/shared";
|
|
import {
|
|
buildBlankSkillDraft,
|
|
buildForkSkillDraft,
|
|
defaultSkillMarkdown,
|
|
normalizeSkillDraftSlug,
|
|
skillCreateDraftToPayload,
|
|
splitCategoryDraft,
|
|
} from "./skill-create";
|
|
|
|
function skill(overrides: Partial<CompanySkillDetail> = {}): CompanySkillDetail {
|
|
return {
|
|
id: "skill-1",
|
|
companyId: "company-1",
|
|
key: "paperclip/demo-skill",
|
|
slug: "demo-skill",
|
|
name: "Demo Skill",
|
|
description: "A demo skill.",
|
|
markdown: "---\nname: Demo Skill\ndescription: Existing\n---\n\n# Demo Skill\n",
|
|
sourceType: "local_path",
|
|
sourceLocator: null,
|
|
sourceRef: null,
|
|
trustLevel: "markdown_only",
|
|
compatibility: "compatible",
|
|
fileInventory: [{ path: "SKILL.md", kind: "skill" }],
|
|
iconUrl: null,
|
|
color: null,
|
|
tagline: "Existing tagline",
|
|
authorName: null,
|
|
homepageUrl: null,
|
|
categories: ["engineering", "review"],
|
|
sharingScope: "company",
|
|
publicShareToken: null,
|
|
forkedFromSkillId: null,
|
|
forkedFromCompanyId: null,
|
|
starCount: 0,
|
|
installCount: 0,
|
|
forkCount: 0,
|
|
currentVersionId: null,
|
|
metadata: null,
|
|
createdAt: new Date("2026-01-01T00:00:00Z"),
|
|
updatedAt: new Date("2026-01-02T00:00:00Z"),
|
|
attachedAgentCount: 0,
|
|
usedByAgents: [],
|
|
editable: true,
|
|
editableReason: null,
|
|
sourceLabel: "Local",
|
|
sourceBadge: "local",
|
|
sourcePath: null,
|
|
currentVersion: null,
|
|
starredByCurrentActor: false,
|
|
existingForks: [],
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
describe("skill create helpers", () => {
|
|
it("normalizes slugs and category drafts", () => {
|
|
expect(normalizeSkillDraftSlug(" My Fancy_SKILL!! ")).toBe("my-fancy-skill");
|
|
expect(splitCategoryDraft(" Review, memory tools, review, , Agent_QA ")).toEqual([
|
|
"Review",
|
|
"memory tools",
|
|
"Agent_QA",
|
|
]);
|
|
});
|
|
|
|
it("keeps commas as draft delimiters while allowing spaces inside category names", () => {
|
|
expect(splitCategoryDraft(" AI Tools, Developer Experience, ai tools, ")).toEqual([
|
|
"AI Tools",
|
|
"Developer Experience",
|
|
]);
|
|
});
|
|
|
|
it("builds blank drafts with default SKILL.md frontmatter", () => {
|
|
const draft = buildBlankSkillDraft();
|
|
|
|
expect(draft.name).toBe("");
|
|
expect(draft.slug).toBe("");
|
|
expect(draft.sharingScope).toBe("company");
|
|
expect(draft.markdown).toContain("name: New Skill");
|
|
expect(draft.markdown).toContain("Describe when agents should use this skill.");
|
|
});
|
|
|
|
it("builds fork drafts from the source skill metadata", () => {
|
|
const draft = buildForkSkillDraft(skill({ color: "#123456", folderId: "bundled-folder" }));
|
|
|
|
expect(draft.name).toBe("Demo Skill Fork");
|
|
expect(draft.slug).toBe("demo-skill-fork");
|
|
expect(draft.color).toBe("#123456");
|
|
expect(draft.categories).toEqual(["engineering", "review"]);
|
|
expect(draft.forkedFromSkillId).toBe("skill-1");
|
|
expect(draft.forkedFromName).toBe("Demo Skill");
|
|
expect(draft.folderId).toBeNull();
|
|
expect(draft.markdown).toContain("name: Demo Skill Fork");
|
|
});
|
|
|
|
it("converts drafts to create payloads with fallback slug and markdown", () => {
|
|
const draft = {
|
|
...buildBlankSkillDraft(),
|
|
name: "Code Review",
|
|
tagline: "Review repository changes.",
|
|
markdown: "",
|
|
categories: ["review"],
|
|
sharingScope: "private" as const,
|
|
};
|
|
|
|
expect(skillCreateDraftToPayload(draft)).toMatchObject({
|
|
name: "Code Review",
|
|
slug: "code-review",
|
|
description: "Review repository changes.",
|
|
tagline: "Review repository changes.",
|
|
categories: ["review"],
|
|
sharingScope: "private",
|
|
forkedFromSkillId: null,
|
|
markdown: defaultSkillMarkdown("Code Review", "Review repository changes."),
|
|
});
|
|
});
|
|
});
|