Conversation
There was a problem hiding this comment.
Pull request overview
This PR standardizes the repo’s TypeScript/Jest/ESLint configuration and CI workflows to align build + validation behavior across local development and GitHub Actions, alongside broad import hygiene changes (type-only imports / ordering) across src and tests.
Changes:
- Updates TS build/typecheck configuration (module + moduleResolution, build script changes) and adds dedicated ESLint tsconfig.
- Introduces Jest and ESLint flat-config files and adjusts numerous imports across tests/src to satisfy lint/type rules.
- Adds/updates GitHub Actions workflows for release checks and publishing, plus contributor guidance and an
.env.example.
Reviewed changes
Copilot reviewed 67 out of 69 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tsconfig.json | Switches TS module settings and narrows compilation include set to src/**. |
| tsconfig.eslint.json | Adds an ESLint-specific TS project for type-aware linting. |
| package.json | Updates build/typecheck scripts, sets package type, and adjusts dependency versions. |
| jest.config.ts | Adds standalone Jest configuration (migrated from package.json). |
| eslint.config.js | Adds ESLint v9 flat config with TS + import ordering rules. |
| .github/workflows/release-check.yml | Adds PR-time “release checks” CI workflow (format/lint/typecheck/test/build + optional Sonar). |
| .github/workflows/publish.yml | Refines npm publish workflow steps and node version. |
| .github/copilot-instructions.md | Adds a project-specific contributor/developer guide. |
| .env.example | Adds example environment variable template for local/dev setups. |
| src/paymentKit.module.ts | Reorders imports / consolidates stack wiring imports. |
| src/nest/controllers/internal-webhook.controller.ts | Converts some imports to type-only and reorders. |
| src/main.ts | Minor formatting/import spacing changes. |
| src/core/services/webhook-mode.service.ts | Converts imports to type-only and reorders. |
| src/core/services/webhook-event-dispatcher.service.ts | Converts webhook type imports to type-only. |
| src/core/services/payment-engine.service.ts | Reorders imports and converts some to type-only. |
| src/core/services/gateway-registry.service.ts | Converts imports to type-only and adds spacing. |
| src/core/services/error-normalizer.service.ts | Splits type/value imports and reorders. |
| src/core/ports/payment-gateway.port.ts | Converts multiple imports to type-only. |
| src/core/ports/payment-engine.port.ts | Converts import to type-only. |
| src/core/gateways/stripe/stripe.gateway.ts | Reorders imports; normalizes type/value import usage. |
| src/core/gateways/stripe/stripe.client.ts | Converts config import to type-only. |
| src/core/gateways/stripe/stripe-webhook.handler.ts | Converts imports to type-only and reorders. |
| src/core/gateways/stripe/stripe-webhook-normalizer.ts | Converts imports to type-only. |
| src/core/gateways/stripe/stripe-payments.client.ts | Reorders imports; converts some to type-only. |
| src/core/gateways/stripe/stripe-error.mapper.ts | Splits type/value imports; converts GatewayKey to type-only. |
| src/core/gateways/paypal/paypal.gateway.ts | Reorders imports; normalizes type/value import usage. |
| src/core/gateways/paypal/paypal.client.ts | Reorders type-only imports. |
| src/core/gateways/paypal/paypal-webhook.handler.ts | Reorders imports; converts to type-only. |
| src/core/gateways/paypal/paypal-webhook-normalizer.ts | Converts webhook imports to type-only. |
| src/core/gateways/paypal/paypal-payments.client.ts | Reorders imports; converts PaypalClient to type-only. |
| src/core/gateways/paypal/paypal-error.mapper.ts | Splits type/value imports. |
| src/core/entities/payment.entity.ts | Converts entity imports to type-only and reorders. |
| src/core/entities/refund.entity.ts | Converts imports to type-only and reorders. |
| src/config/paymentKit.config.ts | Converts WebhookMode import to type-only. |
| src/config/paymentKit.config-loader.ts | Reorders imports between common/config and gateway-specific configs. |
| src/common/types/webhook.types.ts | Converts GatewayKey import to type-only. |
| src/common/errors/normalized-error.model.ts | Converts GatewayKey import to type-only. |
| test/unit/paymentKit.module.spec.ts | Reorders imports and uses type-only import. |
| test/unit/core/services/webhook/webhook-mode.service.spec.ts | Reorders imports and uses type-only import. |
| test/unit/core/services/webhook/webhook-gateway-router.service.spec.ts | Reorders imports; uses type-only imports consistently. |
| test/unit/core/services/webhook/webhook-gateway-router.normalization.spec.ts | Reorders imports; uses type-only imports consistently. |
| test/unit/core/services/webhook/webhook-event-dispatcher.service.spec.ts | Reorders type-only import. |
| test/unit/core/services/payment-engine.service.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/services/gateway-registry.service.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/services/error-mappers/stripe-error-mapper.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/services/error-mappers/paypal-error-mapper.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/services/error-mappers/error-normalizer.service.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/stripe/stripe.gateway.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/stripe/stripe.client.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/stripe/stripe-webhook.handler.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/stripe/stripe-webhook-verifier.spec.ts | Reorders imports and adds spacing. |
| test/unit/core/gateways/stripe/stripe-payments.client.spec.ts | Reorders imports and adjusts type-only groupings. |
| test/unit/core/gateways/stripe/stripe-error.mapper.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/paypal/paypal.gateway.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/paypal/paypal.client.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/paypal/paypal-webhook.handler.spec.ts | Reorders type-only imports. |
| test/unit/core/gateways/paypal/paypal-webhook-verifier.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/paypal/paypal-payments.client.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/gateways/paypal/paypal-error.mapper.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/core/entities/payment-and-refund.entity.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/controllers/internal-webhook.controller.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/config/paymentKit.config.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/config/paymentKit.config-loader.spec.ts | Reorders imports; normalizes type-only imports. |
| test/unit/common/errors/normalized-error.model.spec.ts | Reorders imports; normalizes type-only imports. |
| test/integration/stripe/stripe-payments.integration.spec.ts | Converts imports to type-only where appropriate and reorders. |
| test/integration/setup.ts | Splits type/value imports and reorders. |
| test/app.e2e-spec.ts | Converts imports to type-only and reorders. |
Comments suppressed due to low confidence (7)
.github/workflows/release-check.yml:52
- This workflow runs
npm run format, which modifies files rather than validating formatting. In CI, that can let unformatted code pass (and can create a dirty working tree). Usenpm run format:check(or an equivalent check-only command) for PR validation.
- name: Format
run: npm run format
- name: Typecheck
run: npm run typecheck
tsconfig.eslint.json:8
tsconfig.eslint.jsonincludes*.jsbut it extendstsconfig.jsonwhich does not enableallowJs. WithparserOptions.project, that can cause TypeScript program/diagnostic issues during linting. Either remove*.jsfrom the include list, or setcompilerOptions.allowJs(and optionallycheckJs) in the ESLint tsconfig if you intend to type-check JS files.
src/core/services/webhook-mode.service.ts:6- Spelling typo in the doc comment (
aruond). Rename toaroundfor readability in generated docs/IDE hints.
src/core/services/error-normalizer.service.ts:10 - The
ErrorNormalizerinterface parameter name has a typo (contexxt). While parameter names don't affect TypeScript assignability, this reduces readability and can propagate into generated docs/IDE hints. Rename it tocontext.
export interface ErrorNormalizer {
normalize(error: unknown, contexxt: { gateway: GatewayKey }): NormalizedError;
}
src/common/types/webhook.types.ts:6
- Spelling in the WebhookMode doc comment has typos (
hendling,PaymekntKit). Please correct these to keep public types/docs polished.
/**
* Webhook hendling mode for PaymekntKit.
*
* - "internal": Webhooks are handled internally by PaymentKit.
.github/copilot-instructions.md:74
- This contributor guide describes a project structure and path aliases (
src/adapters,src/controllers,@adapters/*,@controllers/*) that don't exist in the current repo (the code usessrc/core/gatewaysandsrc/nest/controllers, andtsconfig.jsondefines different aliases like@src/*and@nest/*). Please update the guide to match the actual structure/aliases (or update the codebase to match the documented structure) to avoid misleading contributors.
## 🏗️ PaymentKit Project Structure
PaymentKit uses a Hexagonal Architecture (Ports & Adapters) for gateway abstraction.
src/
index.ts # PUBLIC API exports
paymentKit.module.ts # Main NestJS module
common/
constants.ts # DI tokens, magic strings
errors/ # Error models
types/ # Shared type definitions
utils/ # Helper functions
config/
paymentKit.config.ts # Public config interface
paymentKit.config-loader.ts # Env-based config builder
gateways/ # Gateway-specific configs
stripe.config.ts
paypal.config.ts
core/
entities/ # Domain entities
payment.entity.ts
refund.entity.ts
payment-status.enum.ts
value-objects/
money.value-object.ts
ports/ # Interface contracts (Hexagonal)
payment-gateway.port.ts
payment-engine.port.ts
services/
payment-engine.service.ts # Main orchestrator
gateway-registry.service.ts
error-normalizer.service.ts
adapters/ # Gateway implementations
stripe/
stripe.gateway.ts
stripe-webhook.handler.ts
stripe-payments.client.ts
paypal/
paypal.gateway.ts
paypal-webhook.handler.ts
paypal-payments.client.ts
controllers/
payments.controller.ts # Main API endpoints
webhooks.controller.ts # Internal webhook controller
package.json:19
package.jsonis now marked as ESM ("type": "module"), buttsconfig.jsoncompiles to CommonJS ("module": "commonjs") andmain/exportspoint todist/*.js. That combination will cause Node to treat the emitted CommonJS files as ESM at runtime (e.g.,node dist/main/ consumers importingdist/index.js), which typically fails. Align the package type and TS output (either removetype: module, or switch TS output to ESM and updateexports/file extensions/entrypoints accordingly).
"type": "module",
"description": "Unified payments package for NestJS (Stripe, PayPal).",
"author": "Zaiid Moumni",
"private": false,
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/CISCODE-MA/PaymentKit"
},
"main": "dist/index.js",
"types": "dist/index.d.ts",
"exports": {
".": {
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
}
jest.config.ts
Outdated
| '^@config/(.*)$': '<rootDir>/src/config/$1', | ||
| '^@core/(.*)$': '<rootDir>/src/core/$1', | ||
| '^@adapters/(.*)$': '<rootDir>/src/adapters/$1', | ||
| '^@controllers/(.*)$': '<rootDir>/src/controllers/$1', |
There was a problem hiding this comment.
jest.config.ts is missing path alias mappings that are used throughout the tests (e.g. @src/*, @nest/*, and @gateways/* are in tsconfig.json and referenced in test/**). Without these, Jest will fail module resolution. Add the missing moduleNameMapper entries (or generate them from tsconfig.json paths) so Jest matches the TS compiler resolution.
Suggested change
| '^@controllers/(.*)$': '<rootDir>/src/controllers/$1', | |
| '^@controllers/(.*)$': '<rootDir>/src/controllers/$1', | |
| '^@src/(.*)$': '<rootDir>/src/$1', | |
| '^@nest/(.*)$': '<rootDir>/src/nest/$1', | |
| '^@gateways/(.*)$': '<rootDir>/src/gateways/$1', |
| "@nestjs/cli": "^11.0.0", | ||
| "@nestjs/schematics": "^11.0.0", | ||
| "@nestjs/testing": "^11.0.1", | ||
| "@nestjs/cli": "^7.6.0", |
There was a problem hiding this comment.
@nestjs/cli is pinned to ^7.6.0 while the project depends on Nest v11 (@nestjs/common/core/testing are 11.x). This major-version mismatch can break nest start and other CLI-driven tasks. Update @nestjs/cli to a compatible v11 version (or adjust the Nest dependency versions to match the CLI major).
Suggested change
| "@nestjs/cli": "^7.6.0", | |
| "@nestjs/cli": "^11.0.0", |
- Add changeset config and release note - Move copilot instructions to .github/instructions - Add sonarqube MCP instructions - Update publish workflow - Add Jest path aliases and skip integration tests without env vars
|
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
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.
Standardization Pull Request
Changes
Status