feat(@angular-devkit/schematics): add schematics to generate ai context files. #30763
+313
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
angular-robot
bot
added
detected: feature
JeanMeche
force-pushed
the
generate-ai-file
branch
from
b3aef30 to
736c88d
Compare
alan-agius4
reviewed
Jul 22, 2025
JeanMeche
force-pushed
the
generate-ai-file
branch
2 times, most recently
from
70ae7ec to
288dcfd
Compare
alan-agius4
reviewed
Jul 23, 2025
| throw new SchematicsException(`Project name "${options.project}" doesn't not exist.`); | ||
| } | ||
|
|
||
| // Keep this file in sync with the one presented here https://angular.dev/ai/develop-with-ai |
There was a problem hiding this comment.
We should do something automatted or document it on the FW side, since when there is a change there, a PR needs to be opened here.
There was a problem hiding this comment.
Let's handle that as a follow-up when we have a better picture what we need to sync (we might have multiple schematics).
alan-agius4
reviewed
Jul 23, 2025
alan-agius4
reviewed
Jul 23, 2025
alan-agius4
reviewed
Jul 23, 2025
alan-agius4
reviewed
Jul 23, 2025
alan-agius4
reviewed
Jul 23, 2025
alan-agius4
reviewed
Jul 23, 2025
JeanMeche
force-pushed
the
generate-ai-file
branch
from
288dcfd to
53d6719
Compare
dgp1130
reviewed
Jul 24, 2025
JeanMeche
force-pushed
the
generate-ai-file
branch
from
53d6719 to
7fd0e75
Compare
JeanMeche
force-pushed
the
generate-ai-file
branch
from
7fd0e75 to
c94f532
Compare
dgp1130
approved these changes
Jul 31, 2025
dgp1130
added
action: review
JeanMeche
force-pushed
the
generate-ai-file
branch
2 times, most recently
from
3dc7023 to
5ae2b77
Compare
clydin
requested changes
Aug 1, 2025
packages/schematics/angular/config/files/__rulesName__.template
Outdated
Show resolved
Hide resolved
| "x-prompt": "Which type of configuration file would you like to create?", | ||
| "$default": { | ||
| "$source": "argv", | ||
| "index": 0 | ||
| } | ||
| }, | ||
| "tool": { |
There was a problem hiding this comment.
Should this be a multi-select prompt?
We could still default to having them all selected. Would need to change the type to a string array though. But it's probably unlikely that everyone would want all available tools when not specifying the option. Especially since the option may not be known to even exist.
There was a problem hiding this comment.
As mentionned by @alan-agius4 here, the prompt would show for the others options. Or do you have an alternative in mind ?
JeanMeche
force-pushed
the
generate-ai-file
branch
2 times, most recently
from
048a5d7 to
19858e9
Compare
JeanMeche
force-pushed
the
generate-ai-file
branch
from
a59bed2 to
75b1fee
Compare
JeanMeche
commented
Aug 6, 2025
| const configOptions: ConfigOptions = { | ||
| project: options.name, | ||
| type: ConfigType.Ai, | ||
| tool: options.aiConfig as unknown as AiTool, |
There was a problem hiding this comment.
I'm not sure why I couldn't get the enums to match. It works fine for the packageManager above for example. (Yes I also tried with removing "none" from the enum here in ng-new).
JeanMeche
force-pushed
the
generate-ai-file
branch
2 times, most recently
from
bbe0c40 to
614ed54
Compare
|
How does it work if there is already a rule file in the project? Can it merge them into the single file? |
JeanMeche
force-pushed
the
generate-ai-file
branch
from
614ed54 to
9b6c275
Compare
|
@lacolaco Currently it would fail with a "merge" conflict. We plan to address the "update" of those files in a follow-up PR. |
JeanMeche
force-pushed
the
generate-ai-file
branch
2 times, most recently
from
64e512a to
49a02e0
Compare
JeanMeche
commented
Aug 11, 2025
| @@ -60,11 +61,17 @@ export default function (options: NgNewOptions): Rule { | |||
| zoneless: options.zoneless, | |||
| }; | |||
|
|
|||
| const configOptions: ConfigOptions = { | |||
| project: options.name, | |||
| tool: [options.aiConfig as unknown as AiTool], | |||
There was a problem hiding this comment.
Not exactly sure why this type assertion was necessary.
There was a problem hiding this comment.
This is due to the “none” value.
There was a problem hiding this comment.
Even without it, the types mismatch. 🤔
JeanMeche
force-pushed
the
generate-ai-file
branch
from
49a02e0 to
215b802
Compare
alan-agius4
reviewed
Aug 11, 2025
alan-agius4
reviewed
Aug 11, 2025
…xt files. * `ng generate ai-config` to prompt support tools. * `ng generate config ai --tool=gemini` to specify the tool. * `ng new --aiConfig=gemini` to create a new project with AI configuration. Supported ai tools: gemini, claude, copilot, windsurf, cursor.
JeanMeche
force-pushed
the
generate-ai-file
branch
from
215b802 to
67eed64
Compare
dgp1130
approved these changes
Aug 11, 2025
| "items": { | ||
| "type": "string", | ||
| "enum": ["gemini", "copilot", "claude", "cursor", "windsurf"] | ||
| } |
There was a problem hiding this comment.
Question: Do we need x-prompt here too to show up as a prompt for just ng new?
There was a problem hiding this comment.
If we want to show the prompt here, we'd need to remove the default and run the schematic directly and not conditionally.
alan-agius4
reviewed
Aug 12, 2025
Comment on lines
+25
to
+49
| const geminiFile: ContextFileInfo = { rulesName: 'GEMINI.md', directory: '.gemini' }; | ||
| 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---`, | ||
| }; | ||
|
|
||
| const AI_TOOLS = { | ||
| 'gemini': geminiFile, | ||
| 'claude': claudeFile, | ||
| 'copilot': copilotFile, | ||
| 'cursor': cursorFile, | ||
| 'windsurf': windsurfFile, | ||
| }; |
There was a problem hiding this comment.
NIT, but I think it makes the code more readable.
Suggested change
| const geminiFile: ContextFileInfo = { rulesName: 'GEMINI.md', directory: '.gemini' }; | |
| 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---`, | |
| }; | |
| const AI_TOOLS = { | |
| 'gemini': geminiFile, | |
| 'claude': claudeFile, | |
| 'copilot': copilotFile, | |
| 'cursor': cursorFile, | |
| 'windsurf': windsurfFile, | |
| }; | |
| const AI_TOOLS = { | |
| gemini: { | |
| rulesName: 'GEMINI.md', | |
| directory: '.gemini' | |
| }, | |
| claude: { | |
| rulesName: 'CLAUDE.md', | |
| directory: '.claude' | |
| }, | |
| copilot: { | |
| rulesName: 'copilot-instructions.md', | |
| directory: '.github', | |
| }, | |
| windsurf: { | |
| rulesName: 'guidelines.md', | |
| directory: path.join('.windsurf', 'rules'), | |
| }, | |
| // Cursor file has a front matter section. | |
| cursor: { | |
| rulesName: 'cursor.mdc', | |
| directory: path.join('.cursor', 'rules'), | |
| frontmatter: `---\ncontext: true\npriority: high\nscope: project\n---`, | |
| }, | |
| }; |
alan-agius4
reviewed
Aug 12, 2025
| frontmatter?: string; | ||
| } | ||
|
|
||
| function addAiContextFile(options: ConfigOptions): Rule { |
There was a problem hiding this comment.
Suggested change
| function addAiContextFile(options: ConfigOptions): Rule { | |
| export default function(options: ConfigOptions): Rule { |
alan-agius4
reviewed
Aug 12, 2025
Comment on lines
+51
to
+54
| export default function (options: ConfigOptions): Rule { | ||
| return addAiContextFile(options); | ||
| } | ||
|
|
There was a problem hiding this comment.
Suggested change
| export default function (options: ConfigOptions): Rule { | |
| return addAiContextFile(options); | |
| } |
alan-agius4
reviewed
Aug 12, 2025
Comment on lines
+67
to
+73
| 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.`); | ||
| } | ||
|
|
There was a problem hiding this comment.
This workspace logic seems unused.
Suggested change
| 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.`); | |
| } | |
| return (host) => { | |
alan-agius4
reviewed
Aug 12, 2025
Comment on lines
+74
to
+82
| 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 ?? '', |
There was a problem hiding this comment.
NIT:
Suggested change
| 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 ?? '', | |
| 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, |
alan-agius4
reviewed
Aug 12, 2025
Comment on lines
+93
to
+95
| expect(tree.readContent('.gemini/GEMINI.md').length).toBeGreaterThan(0); | ||
| expect(tree.readContent('.github/copilot-instructions.md').length).toBeGreaterThan(0); | ||
| expect(tree.readContent('.cursor/rules/cursor.mdc').length).toBeGreaterThan(0); |
There was a problem hiding this comment.
Suggested change
| expect(tree.readContent('.gemini/GEMINI.md').length).toBeGreaterThan(0); | |
| expect(tree.readContent('.github/copilot-instructions.md').length).toBeGreaterThan(0); | |
| expect(tree.readContent('.cursor/rules/cursor.mdc').length).toBeGreaterThan(0); | |
| expect(tree.exists('.gemini/GEMINI.md')).toBeTrue(); | |
| expect(tree.exists('.github/copilot-instructions.md')).toBeTrue(); | |
| expect(tree.exists('.cursor/rules/cursor.mdc')).toBeTrue(); |
alan-agius4
reviewed
Aug 12, 2025
| ); | ||
| }); | ||
|
|
||
| it('should create a GEMINI.MD file', async () => { |
There was a problem hiding this comment.
In most of the cases here, we can replace tree.readContent with tree.exists as we are not checking for text that is generated.
alan-agius4
reviewed
Aug 12, 2025
| "additionalProperties": false, | ||
| "description": "Generates configuration files for your project. These files control various aspects of your project's build process, testing, and browser compatibility. This schematic helps you create or update essential configuration files with ease.", | ||
| "properties": { | ||
| "project": { |
There was a problem hiding this comment.
This option seems to be redundant, as the config is not generated for a project but for a workspace.
alan-agius4
reviewed
Aug 12, 2025
| "title": "Angular Config File Options Schema", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "description": "Generates configuration files for your project. These files control various aspects of your project's build process, testing, and browser compatibility. This schematic helps you create or update essential configuration files with ease.", |
There was a problem hiding this comment.
The description seems wrong.
alan-agius4
reviewed
Aug 12, 2025
| const configOptions: ConfigOptions | undefined = options.aiConfig?.length | ||
| ? { | ||
| project: options.name, | ||
| tool: options.aiConfig as unknown as AiTool[], |
There was a problem hiding this comment.
casting should not longer be needed.
Suggested change
| tool: options.aiConfig as unknown as AiTool[], | |
| tool: options.aiConfig, |
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
alan-agius4
added
the
action: cleanup
alan-agius4
requested changes
Aug 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ng generate ai-configto prompt support tools.ng generate ai-config --tool=geminito specify the tool. (multiple args accepted)ng new --ai-config geminito create a new project with AI configuration. (multiple args accepted)Supported ai tools: gemini, claude, copilot, windsurf, cursor.