Skip to content

Commit 5535a89

Browse files
committed
refactor(): update docs, remove tests
1 parent 9a538d2 commit 5535a89

File tree

9 files changed

+210
-498
lines changed

9 files changed

+210
-498
lines changed

packages/shared/DEPENDENCIES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Based on dependencies, the correct build order is:
125125

126126
```typescript
127127
// Foundation types
128-
import { Issue, AuditOutput } from '@push-based/models';
128+
import { Issue, AuditOutput } from '@code-pushup/models';
129129

130130
// File operations
131131
import { resolveFile, findFilesWithPattern } from '@push-based/utils';

packages/shared/models/.spec.swcrc

Lines changed: 0 additions & 22 deletions
This file was deleted.

packages/shared/models/ai/API.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,41 @@
11
# Models
22

3-
Comprehensive **Zod schemas and TypeScript types** for Code PushUp configuration, reports, and data validation.
3+
Simple **TypeScript types** for Angular MCP toolkit shared interfaces and utilities.
44

55
## Minimal usage
66

77
```ts
8-
import { auditSchema, reportSchema } from '@push-based/models';
9-
10-
const audit = auditSchema.parse({
11-
slug: 'performance-audit',
12-
title: 'Performance Audit',
13-
});
14-
15-
const isValidReport = reportSchema.safeParse(reportData).success;
8+
import { type CliArgsObject, type ToolsConfig } from '@push-based/models';
9+
10+
// CLI argument types
11+
const args: CliArgsObject = {
12+
directory: './src',
13+
componentName: 'DsButton',
14+
_: ['command'],
15+
};
16+
17+
// MCP tool configuration
18+
const toolConfig: ToolsConfig = {
19+
schema: {
20+
name: 'my-tool',
21+
description: 'A custom tool',
22+
inputSchema: {
23+
type: 'object',
24+
properties: {},
25+
},
26+
},
27+
handler: async (request) => {
28+
return { content: [{ type: 'text', text: 'Result' }] };
29+
},
30+
};
1631
```
1732

1833
## Key Features
1934

20-
- **Zod Schema Validation**: Comprehensive validation schemas for all Code PushUp data structures
21-
- **TypeScript Types**: Full type safety with proper TypeScript definitions
22-
- **Configuration Models**: Schemas for core config, plugins, categories, and groups
23-
- **Report Models**: Complete report structure validation and types
24-
- **Audit Models**: Detailed audit output and metadata schemas
25-
- **MCP Integration**: Model Context Protocol tool schema definitions
26-
- **Table Models**: Flexible table data structures for reports
27-
- **Diff Models**: Report comparison and difference tracking
35+
- **CLI Types**: Type-safe command line argument handling
36+
- **MCP Integration**: Model Context Protocol tool schema definitions and handlers
37+
- **Diagnostics**: Interface for objects that can report issues and diagnostics
38+
- **Lightweight**: Minimal dependencies, focused on essential shared types
2839

2940
## Documentation map
3041

0 commit comments

Comments
 (0)