-
Notifications
You must be signed in to change notification settings - Fork 11.9k
feat(@angular-devkit/schematics): add schematics to generate ai context files. #30763
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
<% if (frontmatter) { %><%= frontmatter %> | ||
|
||
<% } %>You are an expert in TypeScript, Angular, and scalable web application development. You write maintainable, performant, and accessible code following Angular and TypeScript best practices. | ||
|
||
## TypeScript Best Practices | ||
- Use strict type checking | ||
- Prefer type inference when the type is obvious | ||
- Avoid the `any` type; use `unknown` when type is uncertain | ||
|
||
## Angular Best Practices | ||
- Always use standalone components over NgModules | ||
- Do NOT set `standalone: true` inside the `@Component`, `@Directive` and `@Pipe` decorators | ||
- Use signals for state management | ||
- Implement lazy loading for feature routes | ||
- Use `NgOptimizedImage` for all static images. | ||
- Do NOT use the `@HostBinding` and `@HostListener` decorators. Put host bindings inside the `host` object of the `@Component` or `@Directive` decorator instead | ||
|
||
## Components | ||
- Keep components small and focused on a single responsibility | ||
- Use `input()` and `output()` functions instead of decorators | ||
- Use `computed()` for derived state | ||
- Set `changeDetection: ChangeDetectionStrategy.OnPush` in `@Component` decorator | ||
- Prefer inline templates for small components | ||
- Prefer Reactive forms instead of Template-driven ones | ||
- Do NOT use `ngClass`, use `class` bindings instead | ||
- DO NOT use `ngStyle`, use `style` bindings instead | ||
|
||
## State Management | ||
- Use signals for local component state | ||
- Use `computed()` for derived state | ||
- Keep state transformations pure and predictable | ||
- Do NOT use `mutate` on signals, use `update` or `set` instead | ||
|
||
## Templates | ||
- Keep templates simple and avoid complex logic | ||
- Use native control flow (`@if`, `@for`, `@switch`) instead of `*ngIf`, `*ngFor`, `*ngSwitch` | ||
- Use the async pipe to handle observables | ||
|
||
## Services | ||
- Design services around a single responsibility | ||
- Use the `providedIn: 'root'` option for singleton services | ||
- Use the `inject()` function instead of constructor injection |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,6 +11,7 @@ import { | |
SchematicsException, | ||
apply, | ||
applyTemplates, | ||
chain, | ||
filter, | ||
mergeWith, | ||
move, | ||
|
@@ -30,6 +31,8 @@ export default function (options: ConfigOptions): Rule { | |
return addKarmaConfig(options); | ||
case ConfigType.Browserslist: | ||
return addBrowserslistConfig(options); | ||
case ConfigType.Ai: | ||
return addAiContextFile(options); | ||
default: | ||
throw new SchematicsException(`"${options.type}" is an unknown configuration file type.`); | ||
} | ||
|
@@ -103,3 +106,77 @@ function addKarmaConfig(options: ConfigOptions): Rule { | |
); | ||
}); | ||
} | ||
|
||
interface ContextFileInfo { | ||
rulesName: string; | ||
directory: string; | ||
frontmatter?: string; | ||
} | ||
|
||
function addAiContextFile(options: ConfigOptions): Rule { | ||
const files: ContextFileInfo[] = []; | ||
|
||
const geminiFile: ContextFileInfo = { rulesName: 'GEMINI.md', directory: '.gemini' }; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider: Would it make more sense to invert this relationship and make templates for |
||
const copilotFile: ContextFileInfo = { | ||
rulesName: 'copilot-instructions.md', | ||
directory: '.github', | ||
}; | ||
const claudeFile: ContextFileInfo = { rulesName: 'CLAUDE.md', directory: '.claude' }; | ||
const windsurfFile: ContextFileInfo = { | ||
rulesName: 'guidelines.md', | ||
directory: path.join('.windsurf', 'rules'), | ||
}; | ||
|
||
// Cursor file is a bit different, it has a front matter section. | ||
const cursorFile: ContextFileInfo = { | ||
rulesName: 'cursor.mdc', | ||
directory: path.join('.cursor', 'rules'), | ||
frontmatter: `---\ncontext: true\npriority: high\nscope: project\n---`, | ||
}; | ||
|
||
switch (options.tool) { | ||
case 'gemini': | ||
files.push(geminiFile); | ||
break; | ||
case 'claude': | ||
files.push(claudeFile); | ||
break; | ||
case 'copilot': | ||
files.push(copilotFile); | ||
break; | ||
case 'cursor': | ||
files.push(cursorFile); | ||
break; | ||
case 'windsurf': | ||
files.push(windsurfFile); | ||
break; | ||
case 'all': | ||
default: | ||
files.push(geminiFile, claudeFile, copilotFile, cursorFile, windsurfFile); | ||
} | ||
|
||
return async (host) => { | ||
const workspace = await readWorkspace(host); | ||
const project = workspace.projects.get(options.project); | ||
if (!project) { | ||
throw new SchematicsException(`Project name "${options.project}" doesn't not exist.`); | ||
} | ||
|
||
const rules = files.map(({ rulesName, directory, frontmatter }) => | ||
mergeWith( | ||
apply(url('./files'), [ | ||
// Keep only the single source template | ||
filter((p) => p.endsWith('__rulesName__.template')), | ||
applyTemplates({ | ||
...strings, | ||
rulesName, | ||
frontmatter: frontmatter ?? '', | ||
}), | ||
move(directory), | ||
]), | ||
), | ||
); | ||
|
||
return chain(rules); | ||
}; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,12 +16,17 @@ | |
"type": { | ||
"type": "string", | ||
"description": "Specifies the type of configuration file to generate.", | ||
"enum": ["karma", "browserslist"], | ||
"enum": ["karma", "browserslist", "ai"], | ||
"x-prompt": "Which type of configuration file would you like to create?", | ||
"$default": { | ||
"$source": "argv", | ||
"index": 0 | ||
} | ||
}, | ||
"tool": { | ||
"type": "string", | ||
"description": "Specifies the AI tool to configure when type is 'ai'.", | ||
"enum": ["gemini", "copilot", "claude", "cursor", "windsurf", "all"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider: Should we throw if |
||
} | ||
}, | ||
"required": ["project", "type"] | ||
JeanMeche marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
Uh oh!
There was an error while loading. Please reload this page.