docsifyjs / docsifyjs/docsify

[Plugins] : Independent Test Solution for plugins

Open
#1,021 0 comments 0 reactions 0 assignees View on GitHub
help wanted pinned
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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.