princesseuh / astro-component-tester Goto Github PK

Dear Contributors,

I hope this message finds you well. I am writing to propose an enhancement to the astro-component-tester utility, which I have found to be an invaluable tool in the development of Astro components. The utility's ability to create an isolated testing environment is commendable; however, I have encountered a limitation that I believe could be addressed to further refine the testing experience.

Issue Description

The current implementation of astro-component-tester constructs an isolated environment for building components, which, while effective for most scenarios, does not account for context-specific variables such as Astro.request. This limitation becomes apparent when attempting to test components that rely on such context for their functionality. The absence of a mocking mechanism for these variables means that certain component behaviours cannot be accurately tested or replicated.

Proposed Solution

To enhance the utility's testing capabilities, I propose the introduction of a mocking framework that allows developers to simulate context-specific variables. This would enable a more comprehensive testing environment that can mimic the various states and conditions a component might encounter in a production setting.

Potential Implementation

A potential approach to this could involve:

• Extending the getComponentOutput function to accept an additional parameter for context mocks.
• Implementing a simple key-value mapping that the build process can utilise to replace context-specific variables with developer-provided mock data.
• Providing documentation and examples on how to effectively use the mocking feature to simulate different scenarios.

Benefits

The inclusion of a mocking feature would provide several benefits:

• It would allow for more thorough testing of components that depend on global context variables.
• It would increase the confidence in the component's behaviour across different use cases.
• It would align astro-component-tester with other testing frameworks that offer similar mocking capabilities, thereby enhancing its utility.

I am keen to hear your thoughts on this proposal and would be delighted to contribute to the implementation should there be consensus on its potential value.

Thank you for considering this enhancement. I look forward to a fruitful discussion.

Best regards,
yihong1120

This is missing documentation at the moment. I'd like to provide something similar to the Docs.md file available in my other projects, ex: https://github.com/Princesseuh/astro-eleventy-img/blob/main/Docs.md

While the project currently does work on all versions of Astro, some features are not supported. For instance, it is not possible to add integrations.

 WARN  Issues with peer dependencies found
.
└─┬ astro-component-tester 0.6.0
└── ✕ unmet peer astro@^1.0.0-rc.1: found 3.3.4