feat(logger):⚡add logger utility and update types

lehuygiang28 commented 4 months ago

Pull Request Description

Refactor from const to enum
Add eslint & prettier config
Add logger features
Add tests for verifyIpnCall

Type of Change

Please check the type of change your PR introduces:

[ ] Bugfix
[x] New feature
[x] Code style update (formatting, renaming)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] Documentation content changes
[ ] Other (please describe):

Does this introduce a breaking change?

[x] Yes
[ ] No

If yes, please describe the impact and migration path for existing applications:

import ProductCode, VnpLocale, VnpCurrCode to use as enum instead

Summary by CodeRabbit

New Features
- Introduced new constants response-map.constant, api-endpoint.constant, ipn-result-for-vnpay.constant, and regex.constant.
- Converted constants to enums for UrlService, HashAlgorithm, VnpCurrCode, VnpLocale, and added VnpCardType.
- Added new types BuildPaymentUrlLogger, BuildPaymentUrlOptions, GlobalConfig, and DefaultConfig.
- Added types for logging functions, data, and options.
- Introduced tests for logging functionalities and IPN call verification.
Refactor
- Updated type definitions and imports for consistency.
- Consolidated and refactored enum usage for improved code maintainability.
Chores
- Updated configurations for better code quality and formatting.

vercel[bot] commented 4 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
vnpay	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 21, 2024 7:33am

coderabbitai[bot] commented 4 months ago

[!WARNING]

Review Failed

The head commit changed during the review from 7a08a1577d9a1ac3553cbfe14244e19eb7c72f68 to d5fda876349c5a37ee2a45c407fb8e2e91823ff2.

Walkthrough

The update primarily focuses on refactoring the codebase to improve type safety and code clarity by replacing string literals with enums, consolidating imports, and enhancing logging capabilities. It also includes configuration and formatting changes to support ESLint and Prettier for better code quality. Additionally, new types and utilities were introduced to streamline VNPay integration and logging functionalities.

Changes

File(s)	Change Summary
`src/constants/index.ts`	Removed export of `product-code.constant`, retained other constants.
`src/enums/index.ts`, `src/enums/product-code.enum.ts`	Converted constants to enums, added `ProductCode` enum.
`src/types/...`	Refactored types to use new enums and configurations, introduced new types for logging and configuration.
`src/utils/index.ts`, `src/utils/logger.ts`	Added export for logger module, introduced `consoleLogger` and `fileLogger` functions.
`src/vnpay.ts`	Added `ProductCode` import, updated configurations and logging functionalities.
`test/build-payment-url.test.ts`	Updated tests to reflect new enums and logging features.
`.coderabbit.yaml`, `.eslintignore`, `.eslintrc`, `.prettierignore`	Added configurations for ESLint, Prettier, and YAML language server.
`docs/...`	Formatting and indentation adjustments in various documentation files.
`package.json`	Added new scripts for linting and formatting, updated dependencies for ESLint and Prettier.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

lehuygiang28 commented 4 months ago

@coderabbitai review

coderabbitai[bot] commented 4 months ago

Actions Performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

lehuygiang28 / vnpay