refactor: move some functions and module-level state into classes as private methods and properties to start to encapsulate Docsify - Githubissues

docsifyjs / docsify

🃏 A magical documentation site generator.

https://docsify.js.org

MIT License

27.78k stars 5.68k forks source link

refactor: move some functions and module-level state into classes as private methods and properties to start to encapsulate Docsify #2136

Closed trusktr closed 1 year ago

trusktr commented 1 year ago

Summary

Also some small tweaks:

move initGlobalAPI out of Docsify.js to start to encapsulate Docsify
move ajax to utils folder
fix some type definitions and improve content in some JSDoc comments
use concise class field syntax in some spots
consolidate duplicate docsify-ignore comment removal code

Related issues

This handles a task in

https://github.com/docsifyjs/docsify/issues/2104

as well as works towards

https://github.com/docsifyjs/docsify/issues/2135

Continues from PR

https://github.com/docsifyjs/docsify/pull/2134

What kind of change does this PR introduce?

Code style update Refactor

For any code change,

[x] Related documentation has been updated if needed
[x] Related tests have been updated or tests have been added

Does this PR introduce a breaking change? (check one)

No

If yes, please describe the impact and migration path for existing applications:

Tested in the following browsers:

[x] Chrome
[x] Firefox
[x] Safari
[x] Edge

vercel[bot] commented 1 year ago

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

Name	Status	Preview	Comments	Updated (UTC)
docsify-preview	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 31, 2023 6:00am

Koooooo-7 commented 1 year ago

Closed since no changes detect (weird).