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

Test/add unit tests #183

Merged
merged 6 commits into from
Jan 28, 2024
Merged

Test/add unit tests #183

merged 6 commits into from
Jan 28, 2024

Conversation

felix-berlin
Copy link
Owner

No description provided.

@felix-berlin felix-berlin self-assigned this Jan 28, 2024
Copy link

socket-security bot commented Jan 28, 2024

Copy link

cloudflare-workers-and-pages bot commented Jan 28, 2024

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: eff6b2c
Status: ✅  Deploy successful!
Preview URL: https://07fde936.astro-breadcrumbs-docs.pages.dev
Branch Preview URL: https://test-add-unit-tests.astro-breadcrumbs-docs.pages.dev

View logs

Copy link

what-the-diff bot commented Jan 28, 2024

PR Summary

  • Incorporation of Unit Testing Workflow
    A new file, which contains a workflow for unit testing, has been added to increase the reliability and sustainability of the project.

  • Update to Project File Ignorance
    The .gitignore file has been updated to also disregard the coverage directory. This keeps the directory, which holds data about code coverage, away from the version control system, thus making it cleaner.

  • Introduction of Prettier Configuration
    A new Prettier configuration file has been added. This will result in uniform code formatting, making it easier for fellow developers to read and understand the codebase.

  • Display of Codecov Badge on Readme
    The README.md file now includes a Codecov badge. This badge shows the project's overall code coverage, providing an indicator to readers about the project's testing thoroughness.

  • Package Updates in Documentation
    The docs/package.json file has been modified, thus the astro-breadcrumbs package version has been updated. This assures the documentation will be using the latest version.

  • Addition of Scripts for Unit Testing
    The package file has been updated to include new scripts for running unit tests and calculating code coverage. This makes running tests and obtaining coverage information more effortless and quicker.

  • Improvements to Breadcrumbs Generation
    The code in the src/Breadcrumbs.astro file has been adjusted for more effective generation of breadcrumbs and schema JSON. These changes also make it simpler to import and export related code.

  • Breadcrumbs Utility Functions and Test Files
    New utility functions for handling breadcrumbs have been added, along with appropriate test files. This enhances the testability and maintainability of the codebase.

  • Structured Data Generation Feature
    A new function has been added that generates JSON-LD (a format for structured data). This improves the website's SEO (Search Engine Optimization) and overall visibility.

  • Typescript Configuration Update
    The tsconfig.json file has been updated to exclude test files and utilize the stricter astro/tsconfigs/strict configuration. This makes the codebase more robust and minimizes possible errors.

  • Addition of Vitest Test Runner Configuration
    A new file has been added to configure Vitest, a test runner. This enables easy customization of how the tests are run.

Copy link

codecov bot commented Jan 28, 2024

Welcome to Codecov 🎉

Once merged to your default branch, Codecov will compare your coverage reports and display the results in this comment.

Thanks for integrating Codecov - We've got you covered ☂️

@felix-berlin felix-berlin merged commit e826dc9 into main Jan 28, 2024
5 checks passed
@felix-berlin felix-berlin deleted the test/add-unit-tests branch January 28, 2024 20:55
@felix-berlin
Copy link
Owner Author

🎉 This PR is included in version 1.10.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant