feat(): migration to esm #12

Karnaukhov-kh · 2025-08-22T20:15:41Z

ESM Migration and Dependency Consolidation

Summary

Migrates the Angular MCP Toolkit from CommonJS to ES Modules (ESM) and consolidates dependencies by adopting @code-pushup/* packages to replace internal shared libraries.

Technical Changes

Module System Migration

Root Configuration: Added "type": "module" to root package.json
Jest Configuration: Migrated jest.preset.js → jest.preset.mjs with ESM export syntax
Webpack Configuration: Renamed webpack.config.js → webpack.config.cjs to maintain CommonJS compatibility
TypeScript Configuration: Updated tsconfig.json files to remove CommonJS-specific settings

Dependency Consolidation

External Dependencies: Migrated from internal @push-based/* packages to @code-pushup/* equivalents:
- @push-based/models → @code-pushup/models
- @push-based/utils → @code-pushup/utils
- Internal utilities consolidated under @code-pushup/core
Package Removal: Eliminated packages/shared/angular-cli-utils package (149 lines removed)
Models Cleanup: Removed extensive test suites and implementation files from packages/shared/models (3,000+ lines removed)

Import Statement Updates

Import Syntax: Updated all import statements across 85+ TypeScript files to use new package paths
Schema Imports: Updated Zod schema imports in component contract and validation modules
Tool Imports: Refactored MCP server tool imports to use consolidated packages

Build System Changes

Package Configurations: Updated package.json files across all workspace packages to reflect new dependencies
TypeScript Compilation: Adjusted tsconfig.lib.json files for ESM compatibility
Jest Configuration: Updated test configurations for ESM module resolution

Files Modified

Configuration Files: 15 package.json, 8 tsconfig files, jest configurations
Source Code: 85+ TypeScript files with import statement updates
Build Tools: Webpack, Jest, and TypeScript compiler configurations

Impact

Bundle Size: Reduced overall codebase by ~4,100 lines through dependency consolidation
Build Performance: Improved build times through external dependency usage
Module Compatibility: Full ESM compliance for modern Node.js environments
Maintenance: Reduced maintenance overhead by leveraging external packages

Breaking Changes

Requires Node.js environments with ESM support
Internal package imports must be updated to use @code-pushup/* packages
Jest configurations require ESM-compatible setup

BioPhoton · 2025-08-22T23:00:50Z

.cursor/mcp.json

      "args": [
        "./packages/angular-mcp/dist/main.js",
-        "--workspaceRoot=/home/spoltorak/projects/x-mcp",
+        "--workspaceRoot=/Users/kyrylokarnaukhov/Documents/projects/angular-mcp-toolkit",


Lets avoid using local paths in the source

Done. Local MCP is not tracked anymore, example file available

BioPhoton · 2025-08-22T23:01:40Z

docs/architecture-internal-design.md

 | **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:


I would not tia everything to CP.. The reason we have out own models and utils is to decouple a bit

All tools are sharing @push-based/models ToolsConfig. Import name fixed.

BioPhoton · 2025-08-22T23:02:14Z

docs/writing-custom-tools.md

 ```ts
 import { z } from 'zod';
-import { ToolSchemaOptions, ToolsConfig } from '@push-based/models';
+import { ToolSchemaOptions, ToolsConfig } from '@code-pushup/models';


This definitely should be '@push-based/models';

BioPhoton · 2025-08-22T23:04:09Z

packages/angular-mcp-server/src/lib/tools/ds/component/utils/deprecated-css-helpers.ts

+  const module = await import(absPath);

-  // Handle both ES modules (export default) and CommonJS (module.exports)
-  // Support: export default dsComponents, module.exports = { dsComponents }, or direct module.exports = dsComponents
-  const dsComponents = module.default || module.dsComponents || module;
+  // Pure ESM: use export default
+  const dsComponents = module.default;


This seems quickly added instead of thought through

Open for suggestion, only thing that was not breaking tools.

If its needed to make it work, we could think of some reusable thing or docs on the WHY.
The case module.default || module; e.g. ise repeated module.dsComponents not.

It will help to establish a pattern that others can follow more easily.

Created a helper function in utils. Updated docs. see 720d27f & 775be79

BioPhoton · 2025-08-22T23:05:15Z

packages/angular-mcp-server/src/lib/validation/ds-components-file-loader.validation.ts


-    // Handle both ES modules (export default) and CommonJS (module.exports)
-    const rawData = module.default || module.dsComponents || module;
+    // Pure ESM: use export default


Could we avoid those kind of polluting comments pls

Fixed 1f4a181

BioPhoton · 2025-08-22T23:05:38Z

packages/angular-mcp-server/src/lib/validation/ds-components-file.validation.ts


-    // Handle both ES modules (export default) and CommonJS (module.exports)
-    dsComponents = module.default || module.dsComponents || module;
+    // Pure ESM: use export default


remove pls. Same on all other places

Fixed 1f4a181

packages/shared/models/ai/API.md

BioPhoton

Added some Comments.

In general the PR was quite big which makes it harder to review and it takes longer. Also the quality of the review drops at a certain volumr of changes.

The first and best thing is to:

chunck big PR into smaller pieces
do a self revirew before commiting code or asking for feedback

Karnaukhov-kh · 2025-08-23T13:36:49Z

Commits focus description for easier navigation

@4d92340 - Initial ESM migration attempt
@0f112f9 - Remove unused angular-cli-utils dependency
@c972a86 - Update cpu/core dependency version
@7422b59 - Integrate cpu/models imports throughout codebase
@9a538d2 - Clean up model definitions and structure
@5535a89 - Update documentation and remove obsolete tests
@4dcadc1 - Replace imports with cpu/utils where applicable
@b1eab19 - Package maintenance and updates
@4d59481 - Documentation improvements
@7674b0f - Fix build system issues
@1f4a181 - Address code review feedback and cleanup
@2950e39 - Improve import documentation
@8205922 - Clean up local MCP configuration files
@720d27f - Add default-export-loader utility function
@775be79 - Final utils documentation adjustments

BioPhoton

Added comments

BioPhoton · 2025-08-23T13:51:56Z

.cursor/mcp.json

@@ -1,22 +0,0 @@
-{


Why do we remove the setup? I think it's quite helpful for testing too.. maybe a postinstall?

We have example file for this that should be copied and renamed to mcp.json by developer who want to use it, having just mcp.json causes override hell from dev to dev.

Karnaukhov-kh added 10 commits August 22, 2025 23:00

feat(): migration to esm, maybe

4d92340

chore(): remove angular-cli-utils

0f112f9

chore(): bump cpu/core

c972a86

feat(): add cpu/models imports where possible

7422b59

refactor(): cleanup models

9a538d2

refactor(): update docs, remove tests

5535a89

refactor(): switch to cpu/utils where possible

4dcadc1

chore(): update packages

b1eab19

chore(): update docs

4d59481

chore(): test build fix

7674b0f

Karnaukhov-kh changed the title ~~feat(): migration to esm, maybe~~ feat(): migration to esm Aug 22, 2025

Karnaukhov-kh requested review from AdrianRomanski, BioPhoton, poltorak and rapczynska August 22, 2025 22:52

BioPhoton reviewed Aug 22, 2025

View reviewed changes

packages/shared/models/ai/API.md Show resolved Hide resolved

BioPhoton requested changes Aug 22, 2025

View reviewed changes

Karnaukhov-kh added 5 commits August 23, 2025 14:55

fix(): address comments feedback

1f4a181

fix(): address import documentation feedback

2950e39

fix(): remove local mcp.json file

8205922

feat(): add default-export-loader util

720d27f

feat(): adjust utils documentation

775be79

Karnaukhov-kh requested a review from BioPhoton August 23, 2025 13:37

BioPhoton reviewed Aug 23, 2025

View reviewed changes

Karnaukhov-kh added 3 commits August 23, 2025 17:42

fix(): small readme module.exports fix

6365132

Merge branch 'main' into feature/esm-migration

d279287

fix(): fix report-all-violations after merge

4819333

Karnaukhov-kh requested a review from BioPhoton September 1, 2025 07:32

Karnaukhov-kh added 2 commits October 3, 2025 13:27

Merge branch 'main' into feature/esm-migration

a516abf

fix(angular-mcp-server): builder import fix

0e9ae2b

Karnaukhov-kh merged commit 3b9e9d6 into main Oct 10, 2025
1 check passed

Karnaukhov-kh deleted the feature/esm-migration branch October 10, 2025 11:20

feat(): migration to esm #12

feat(): migration to esm #12

Uh oh!

Conversation

Karnaukhov-kh commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ESM Migration and Dependency Consolidation

Summary

Technical Changes

Module System Migration

Dependency Consolidation

Import Statement Updates

Build System Changes

Files Modified

Impact

Breaking Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Karnaukhov-kh Aug 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BioPhoton left a comment

Choose a reason for hiding this comment

Uh oh!

Karnaukhov-kh commented Aug 23, 2025

Uh oh!

BioPhoton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Karnaukhov-kh commented Aug 22, 2025 •

edited

Loading

Karnaukhov-kh Aug 23, 2025 •

edited

Loading