Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance validation and documentation #10

Merged
merged 7 commits into from
Jun 14, 2024

Conversation

brenoepics
Copy link
Collaborator

@brenoepics brenoepics commented Jun 14, 2024

Related to #2

Implements enhancements to the library's documentation, validation functions, and error handling mechanisms.

  • Documentation Updates:

    • Refines the README.md to improve professionalism and clarity, ensuring a more comprehensive introduction to the library's capabilities and supported languages.
  • Validation Function Enhancements:

    • Updates isEmail.ts with more detailed comments and additional examples for complex use cases, enhancing clarity and usability.
    • Refactors cpfValidator.ts to include a more descriptive comment explaining the function's purpose and to streamline the validation logic for Brazilian CPF numbers, improving readability and maintainability.
  • Error Handling Improvements:

    • Introduces more specific error messages in cpfValidator.ts to aid in debugging and user feedback, ensuring a clearer understanding of validation failures.

For more details, open the Copilot Workspace session.

Copy link

vercel bot commented Jun 14, 2024

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

Name Status Preview Comments Updated (UTC)
multiform-validator ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 14, 2024 9:10pm

Copy link
Member

@gabriel-logan gabriel-logan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cpf validator is not cleaning the string correctly before starting validation, the rest is ok.

Copy link
Member

@gabriel-logan gabriel-logan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chore: redmi update and code documentation, validateCpf refactoring

Copy link
Member

@gabriel-logan gabriel-logan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chrome: README update and code documentation, validateCpf refactoring

Copy link
Member

@gabriel-logan gabriel-logan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chore: README update and code documentation, validateCpf refactoring

@gabriel-logan gabriel-logan merged commit a3d8549 into main Jun 14, 2024
3 checks passed
@brenoepics brenoepics deleted the brenoepics/enhance-validation branch June 23, 2024 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants