chore(): update docs

Author: Karnaukhov-kh

README.md

@@ -24,7 +24,7 @@ A Model Context Protocol (MCP) server that provides Angular project analysis and
 
 ### Prerequisites
 
-- Node.js (version 18 or higher)
+- Node.js (version 18 or higher) with ESM support
 
 ### Installation & Setup
 
@@ -96,6 +96,7 @@ const dsComponents = [
   }
 ];
 
+// Note: Use CommonJS export for configuration files
 module.exports = dsComponents;
 ```
 

docs/architecture-internal-design.md

@@ -83,7 +83,7 @@ packages/angular-mcp-server/
 | **Prompt** | `prompts/prompt-registry.ts` | 1. Append schema to `PROMPTS`. <br>2. Provide implementation in `PROMPTS_IMPL`. |
 | **Resource Provider** | `registerResources()` | Extend logic to aggregate custom docs or design-system assets. |
 
-All tools share the `ToolsConfig` interface (`@push-based/models`) that bundles:
+All tools share the `ToolsConfig` interface (`@code-pushup/models`) that bundles:
 - `schema` (name, description, arguments, return type)
 - `handler(request)` async function.
 

docs/writing-custom-tools.md

@@ -24,7 +24,7 @@ File name **must** end with `.tool.ts` so tests & registries can auto-discover i
 
 ```ts
 import { z } from 'zod';
-import { ToolSchemaOptions, ToolsConfig } from '@push-based/models';
+import { ToolSchemaOptions, ToolsConfig } from '@code-pushup/models';
 import { createHandler, RESULT_FORMATTERS } from '../shared/utils/handler-helpers.js';
 
 // 1️⃣ Schema

packages/shared/DEPENDENCIES.md

@@ -6,7 +6,7 @@ This document provides an AI-friendly overview of the shared libraries in the `/
 
 ### Foundation Layer (No Internal Dependencies)
 
-#### `@push-based/models`
+#### `@code-pushup/models`
 
 - **Purpose**: Core types, interfaces, and Zod schemas for the entire ecosystem
 - **Key Exports**: Issue, AuditOutput, PluginConfig, CategoryConfig, ToolSchemaOptions
@@ -22,7 +22,7 @@ This document provides an AI-friendly overview of the shared libraries in the `/
 
 ### Intermediate Layer (Single Foundation Dependency)
 
-#### `@push-based/utils`
+#### `@code-pushup/utils`
 
 - **Purpose**: General utility functions and file system operations
 - **Key Exports**: findFilesWithPattern, resolveFile
@@ -63,18 +63,18 @@ This document provides an AI-friendly overview of the shared libraries in the `/
 ## Dependency Graph
 
 ```
-models (foundation)
-├── utils
+@code-pushup/models (foundation)
+├── @code-pushup/utils
 ├── styles-ast-utils
 └── angular-ast-utils
-    ├── models
-    ├── utils
+    ├── @code-pushup/models
+    ├── @code-pushup/utils
     ├── typescript-ast-utils
     └── styles-ast-utils
 
 ds-component-coverage (most complex)
-├── models
-├── utils
+├── @code-pushup/models
+├── @code-pushup/utils
 ├── styles-ast-utils
 └── angular-ast-utils
 ```
@@ -128,7 +128,7 @@ Based on dependencies, the correct build order is:
 import { Issue, AuditOutput } from '@code-pushup/models';
 
 // File operations
-import { resolveFile, findFilesWithPattern } from '@push-based/utils';
+import { resolveFile, findFilesWithPattern } from '@code-pushup/utils';
 
 // Angular component parsing
 import {

packages/shared/LLMS.md

@@ -24,7 +24,7 @@ Each library provides three types of AI documentation:
 
 ## 🏗️ Foundation Layer <a id="foundation-layer"></a>
 
-### @push-based/models <a id="models"></a>
+### @code-pushup/models <a id="models"></a>
 
 Core types, interfaces, and Zod schemas for the entire ecosystem.
 
@@ -42,7 +42,7 @@ TypeScript AST parsing and manipulation utilities.
 
 ## 🔧 Intermediate Layer <a id="intermediate-layer"></a>
 
-### @push-based/utils <a id="utils"></a>
+### @code-pushup/utils <a id="utils"></a>
 
 General utility functions and file system operations.
 

packages/shared/models/ai/API.md

@@ -5,7 +5,7 @@ Simple **TypeScript types** for Angular MCP toolkit shared interfaces and utilit
 ## Minimal usage
 
 ```ts
-import { type CliArgsObject, type ToolsConfig } from '@push-based/models';
+import { type CliArgsObject, type ToolsConfig } from '@code-pushup/models';
 
 // CLI argument types
 const args: CliArgsObject = {

packages/shared/models/ai/EXAMPLES.md

@@ -5,7 +5,7 @@
 > Type-safe handling of command line arguments.
 
 ```ts
-import { type CliArgsObject, type ArgumentValue } from '@push-based/models';
+import { type CliArgsObject, type ArgumentValue } from '@code-pushup/models';
 
 // Basic CLI arguments
 const args: CliArgsObject = {
@@ -45,7 +45,7 @@ console.log(`Analyzing ${typedArgs.componentName} in ${typedArgs.directory}`);
 > Build Model Context Protocol tools with proper typing.
 
 ```ts
-import { type ToolsConfig, type ToolSchemaOptions } from '@push-based/models';
+import { type ToolsConfig, type ToolSchemaOptions } from '@code-pushup/models';
 
 // Define a simple MCP tool
 const reportViolationsTool: ToolsConfig = {
@@ -106,7 +106,7 @@ console.log(`Tool: ${reportViolationsTool.schema.name}`);
 > Create objects that can report issues and diagnostics.
 
 ```ts
-import { type DiagnosticsAware } from '@push-based/models';
+import { type DiagnosticsAware } from '@code-pushup/models';
 
 class ComponentAnalyzer implements DiagnosticsAware {
   private issues: Array<{ code?: number; message: string; severity: string }> = [];
@@ -166,7 +166,7 @@ console.log(`Issues after clear: ${analyzer.getIssues().length}`); // → 0
 import {
   type ToolsConfig,
   type ToolHandlerContentResult,
-} from '@push-based/models';
+} from '@code-pushup/models';
 
 const buildComponentContractTool: ToolsConfig = {
   schema: {
@@ -224,4 +224,4 @@ async function generateContract(params: any) {
 }
 ```
 
-These examples demonstrate the practical usage patterns of the `@push-based/models` library for building type-safe CLI tools, MCP integrations, and diagnostic utilities in the Angular MCP toolkit.
+These examples demonstrate the practical usage patterns of the `@code-pushup/models` library for building type-safe CLI tools, MCP integrations, and diagnostic utilities in the Angular MCP toolkit.

packages/shared/utils/ai/API.md

@@ -11,7 +11,7 @@ import {
   resolveFileCached,
   slugify,
   objectToCliArgs,
-} from '@push-based/utils';
+} from '@code-pushup/utils';
 
 // Execute a process with observer
 const result = await executeProcess({

packages/shared/utils/ai/EXAMPLES.md

@@ -5,7 +5,7 @@
 > Execute commands with live output streaming and error handling.
 
 ```ts
-import { executeProcess, ProcessObserver } from '@push-based/utils';
+import { executeProcess, ProcessObserver } from '@code-pushup/utils';
 
 // Create an observer to handle process events
 const observer: ProcessObserver = {
@@ -53,7 +53,7 @@ import {
   findFilesWithPattern,
   findInFile,
   resolveFileCached,
-} from '@push-based/utils';
+} from '@code-pushup/utils';
 
 // Find all TypeScript files containing 'Component'
 const componentFiles = await findFilesWithPattern('./src', 'Component');
@@ -100,7 +100,7 @@ if (componentFiles.length > 0) {
 > Format commands with colors and context for better development experience.
 
 ```ts
-import { formatCommandLog, isVerbose, calcDuration } from '@push-based/utils';
+import { formatCommandLog, isVerbose, calcDuration } from '@code-pushup/utils';
 
 // Set verbose mode for demonstration
 process.env['NG_MCP_VERBOSE'] = 'true';
@@ -159,7 +159,7 @@ if (isVerbose()) {
 > Convert objects to command-line arguments for process execution.
 
 ```ts
-import { objectToCliArgs, executeProcess } from '@push-based/utils';
+import { objectToCliArgs, executeProcess } from '@code-pushup/utils';
 
 // Simple configuration object
 const config = {
@@ -226,7 +226,7 @@ complexArgs.forEach((arg) => console.log(`  ${arg}`));
 > Handle process errors gracefully with comprehensive error information.
 
 ```ts
-import { executeProcess, ProcessError } from '@push-based/utils';
+import { executeProcess, ProcessError } from '@code-pushup/utils';
 
 async function robustProcessExecution() {
   const commands = [
@@ -329,7 +329,7 @@ import {
   accessContent,
   getLineHits,
   isExcludedDirectory,
-} from '@push-based/utils';
+} from '@code-pushup/utils';
 
 // Custom file finder with filtering
 async function findLargeTypeScriptFiles(
@@ -435,4 +435,4 @@ if (largeFiles.length > 0) {
 
 
 
-These examples demonstrate the comprehensive capabilities of the `@push-based/utils` library for process execution, file operations, string manipulation, and development tooling in Node.js applications.
+These examples demonstrate the comprehensive capabilities of the `@code-pushup/utils` library for process execution, file operations, string manipulation, and development tooling in Node.js applications.