Skip to content

feat: improve component-scaffold skill score 10% → 89% #474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yogesh-tessl wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

feat: improve component-scaffold skill score 10% → 89% #474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions ...plates/nextjs-app-router/.agents/skills/content-sdk-component-scaffold/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: content-sdk-component-scaffold
description: Creates new Sitecore components with correct file structure, props interface, and placement under src/components/. Use when adding a new component from scratch or scaffolding a component. App Router: decide Server vs Client and register in the appropriate map.
description: "Creates new Sitecore components with correct file structure, props interface, and placement under src/components/. Use when adding a new component from scratch, scaffolding a component, or creating a React component for Sitecore layout placeholders. App Router uses separate server (.sitecore/component-map.ts) and client (.sitecore/component-map.client.ts) component maps."
---

# Content SDK Component Scaffold (App Router)
Expand All @@ -13,11 +13,37 @@ Scaffold new Sitecore components so they integrate with the layout and editing p
- Task involves creating a new React component that will be rendered from Sitecore layout/placeholders.
- User mentions "new component," "add component," or "component file structure."

## How to perform
## How to Perform

- Create a new file under `src/components/` (or existing feature folder). Define props (fields, params), export a single default component.
- Decide Server vs Client: default Server; add `'use client'` only if the component needs hooks or event handlers.
- Register the component in the correct map (content-sdk-component-registration). Run `npm run build` to verify.
1. Create a new file under `src/components/` (or an existing feature folder).
2. Define a props interface with the component's fields and params, then export a single default component:

```tsx
import { Text, Field } from '@sitecore-content-sdk/react';

interface HeroBannerProps {
fields: {
heading: Field<string>;
subheading: Field<string>;
};
params: { [key: string]: string };
}

export default function HeroBanner({ fields, params }: HeroBannerProps) {
return (
<div className={`component ${params.styles || ''}`}>
<Text field={fields.heading} tag="h1" />
<Text field={fields.subheading} tag="p" />
</div>
);
}
```

3. Decide Server vs Client: default to Server Component. Add `'use client'` only if the component needs hooks, event handlers, or browser APIs.
4. Register the component in the correct map (see content-sdk-component-registration):
- Server components → `.sitecore/component-map.ts`
- Client components → `.sitecore/component-map.client.ts`
5. Run `npm run build` and confirm the component resolves in layout preview or editing mode.

## Hard Rules

Expand Down
33 changes: 29 additions & 4 deletions ...app/src/templates/nextjs/.agents/skills/content-sdk-component-scaffold/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: content-sdk-component-scaffold
description: Creates new Sitecore components with correct file structure, props interface, and placement under src/components/. Use when adding a new component from scratch or scaffolding a component. Pages Router: register in .sitecore/component-map.ts only.
description: "Creates new Sitecore components with correct file structure, props interface, and placement under src/components/. Use when adding a new component from scratch, scaffolding a component, or creating a React component for Sitecore layout placeholders. Pages Router uses a single component map at .sitecore/component-map.ts."
---

# Content SDK Component Scaffold (Pages Router)
Expand All @@ -13,9 +13,34 @@ Scaffold new Sitecore components so they integrate with the layout and editing p
- Task involves creating a new React component that will be rendered from Sitecore layout/placeholders.
- User mentions "new component," "add component," or "component file structure."

## How to perform

- Create a new file under `src/components/` (or existing feature folder). Define props (fields, params), export a single default component. Register in `.sitecore/component-map.ts` (content-sdk-component-registration). Run `npm run build` to verify.
## How to Perform

1. Create a new file under `src/components/` (or an existing feature folder).
2. Define a props interface with the component's fields and params, then export a single default component:

```tsx
import { Text, Field } from '@sitecore-content-sdk/react';

interface HeroBannerProps {
fields: {
heading: Field<string>;
subheading: Field<string>;
};
params: { [key: string]: string };
}

export default function HeroBanner({ fields, params }: HeroBannerProps) {
return (
<div className={`component ${params.styles || ''}`}>
<Text field={fields.heading} tag="h1" />
<Text field={fields.subheading} tag="p" />
</div>
);
}
```

3. Register the component in `.sitecore/component-map.ts` (see content-sdk-component-registration).
4. Run `npm run build` and confirm the component resolves in layout preview or editing mode.

## Hard Rules

Expand Down