packages/schematics/angular/ai-config/index_spec.ts - main - githubmirror/angular-cli

packages/schematics/angular/ai-config/index_spec.ts
172 строки6 KB
Suguru Inatomi
fix(@schematics/angular): generate CLAUDE.md for Claude Code instead of AGENTS.md
10 авг 2026, 16:22
10 авг 2026, 16:221161e6c
/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
import { parse } from 'jsonc-parser';
import { Schema as WorkspaceOptions } from '../workspace/schema';
import { Schema as ConfigOptions, Tool as ConfigTool } from './schema';

describe('AI Config Schematic', () => {
  const schematicRunner = new SchematicTestRunner(
    '@schematics/angular',
    require.resolve('../collection.json'),
  );

  const workspaceOptions: WorkspaceOptions = {
    name: 'workspace',
    newProjectRoot: 'projects',
    version: '15.0.0',
  };

  let workspaceTree: UnitTestTree;
  function runAiConfigSchematic(tool: ConfigTool[]): Promise<UnitTestTree> {
    return schematicRunner.runSchematic<ConfigOptions>('ai-config', { tool }, workspaceTree);
  }

  beforeEach(async () => {
    workspaceTree = await schematicRunner.runSchematic('workspace', workspaceOptions);
  });

  it('should create Angular MCP server config and CLAUDE.md for Claude Code', async () => {
    const tree = await runAiConfigSchematic([ConfigTool.ClaudeCode]);
    expect(tree.exists('CLAUDE.md')).toBeTruthy();
    expect(tree.exists('.mcp.json')).toBeTruthy();
  });

  it('should create Angular MCP server config and AGENTS.md for Cursor', async () => {
    const tree = await runAiConfigSchematic([ConfigTool.Cursor]);
    expect(tree.exists('AGENTS.md')).toBeTruthy();
    expect(tree.exists('.cursor/mcp.json')).toBeTruthy();
  });

  it('should create Angular MCP server config and GEMINI.md for Gemini CLI', async () => {
    const tree = await runAiConfigSchematic([ConfigTool.GeminiCli]);
    expect(tree.exists('.gemini/GEMINI.md')).toBeTruthy();
    expect(tree.exists('.gemini/settings.json')).toBeTruthy();
  });

  it('should create Angular MCP server config and AGENTS.md for Open AI Codex', async () => {
    const tree = await runAiConfigSchematic([ConfigTool.OpenAiCodex]);
    expect(tree.exists('AGENTS.md')).toBeTruthy();
    expect(tree.exists('.codex/config.toml')).toBeTruthy();
  });

  it('should create Angular MCP server config and AGENTS.md for VS Code', async () => {
    const tree = await runAiConfigSchematic([ConfigTool.Vscode]);
    expect(tree.exists('AGENTS.md')).toBeTruthy();
    expect(tree.exists('.vscode/mcp.json')).toBeTruthy();
  });

  it('should create multiple files when multiple tools are selected', async () => {
    const tree = await runAiConfigSchematic([
      ConfigTool.GeminiCli,
      ConfigTool.Vscode,
      ConfigTool.Cursor,
    ]);
    expect(tree.exists('AGENTS.md')).toBeTruthy();
    expect(tree.exists('.gemini/GEMINI.md')).toBeTruthy();
    expect(tree.exists('.gemini/settings.json')).toBeTruthy();
    expect(tree.exists('.vscode/mcp.json')).toBeTruthy();
    expect(tree.exists('.cursor/mcp.json')).toBeTruthy();
  });

  it('should not create any files if None is selected', async () => {
    const filesCount = workspaceTree.files.length;
    const tree = await runAiConfigSchematic([ConfigTool.None]);
    expect(tree.files.length).toBe(filesCount);
  });

  it('should create for tool if None and an AI host are selected', async () => {
    const tree = await runAiConfigSchematic([ConfigTool.GeminiCli, ConfigTool.None]);
    expect(tree.exists('.gemini/GEMINI.md')).toBeTruthy();
    expect(tree.exists('.gemini/settings.json')).toBeTruthy();
  });

  it('should omit best practices creation, if the file already exists', async () => {
    const customContent = 'custom user content';
    workspaceTree.create('CLAUDE.md', customContent);

    const messages: string[] = [];
    const loggerSubscription = schematicRunner.logger.subscribe((x) => messages.push(x.message));

    try {
      const tree = await runAiConfigSchematic([ConfigTool.ClaudeCode]);

      expect(tree.readContent('CLAUDE.md')).toBe(customContent);
      expect(messages).toContain(
        `Skipping configuration file for 'ClaudeCode' at './CLAUDE.md' because it already exists.\n` +
          'This is to prevent overwriting a potentially customized file. ' +
          'If you want to regenerate it with Angular recommended defaults, please delete the existing file and re-run the command.\n' +
          'You can review the latest recommendations at https://angular.dev/ai/develop-with-ai.\n',
      );
    } finally {
      loggerSubscription.unsubscribe();
    }
  });

  it('should update JSON MCP server config, if the file exists', async () => {
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    const jsonConfig: Record<string, any> = {
      foo: 'bar',
      mcpServers: {
        'baz': {},
      },
    };
    workspaceTree.create('.mcp.json', JSON.stringify(jsonConfig));

    const tree = await runAiConfigSchematic([ConfigTool.ClaudeCode]);

    const modifiedConfig = structuredClone(jsonConfig);
    modifiedConfig.mcpServers = {
      ...modifiedConfig.mcpServers,
      ['angular-cli']: {
        command: 'npx',
        args: ['-y', '@angular/cli', 'mcp'],
      },
    };

    const actualConfig = parse(tree.readContent('.mcp.json'));

    expect(JSON.stringify(actualConfig, null, 2)).toBe(JSON.stringify(modifiedConfig, null, 2));
  });

  it('should update TOML MCP server config, if the file exists', async () => {
    const tomlConfig = '[foo]';
    workspaceTree.create('.codex/config.toml', tomlConfig);

    const tree = await runAiConfigSchematic([ConfigTool.OpenAiCodex]);

    let modifiedConfig = tomlConfig;
    modifiedConfig +=
      '\n\n[mcp_servers.angular-cli]\n' +
      'command = "npx"\n' +
      'args = ["-y", "@angular/cli", "mcp"]\n';

    expect(tree.readContent('.codex/config.toml')).toBe(modifiedConfig);
  });

  it('should omit TOML MCP server config update, if the config already exists', async () => {
    const tomlConfig = '[mcp_servers.angular-cli]';
    workspaceTree.create('.codex/config.toml', tomlConfig);

    const messages: string[] = [];
    const loggerSubscription = schematicRunner.logger.subscribe((x) => messages.push(x.message));

    try {
      const tree = await runAiConfigSchematic([ConfigTool.OpenAiCodex]);

      expect(tree.readContent('.codex/config.toml')).toBe(tomlConfig);
      expect(messages).toContain(
        `Skipping Angular MCP server configuration for 'OpenAiCodex'.\n` +
          `Configuration already exists in '.codex/config.toml'.\n`,
      );
    } finally {
      loggerSubscription.unsubscribe();
    }
  });
});