[Plugins] : Independent Test Solution for plugins
- Dominant language
- JavaScript
- Stars
- 31.5k
- Forks
- 5.8k
- Avg merge
- 9d 8h
- Merged PRs (30d)
- 2
Description
This is more like a way or solution request for plugins to independently tests with docsify.
Currently, the official plugins and most of the third-party plugins (all of them which I saw) don't have test for their plugins. Unit testing for the logic method of a plugin can be done seamlessly but for integration testing with docsify core, it's quite tough from my end.
This is required as in future release there can be some changes in the core regarding the compiler part or the hooks part or any other changes. And it is to ensure that plugins don't break.
This issue is to document the testing guide for the plugins independently. As I am not so good with testing this deep I can't document that myself.
You can either submit a PR in this repo regarding updating the docs about testing the plugins.
Before submitting PR, it would be nice to have a comment here about your approach and also to have a demo by either testing any plugins from this repo or any other plugin.
Contributor guide
Research direction
The issue does not name a documentation file, test command, or plugin entry point. Start by reviewing how docsify core compiler and hooks interact with an existing plugin, then document a reproducible independent integration-testing guide and demonstrate it with a plugin. Done means the guide explains how to detect plugin breakage after core changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100