stellar / js-stellar-sdk

Main Stellar client library for the JavaScript language.
https://stellar.github.io/js-stellar-sdk/
Apache License 2.0
615 stars 296 forks source link

Fix documentation rendering #965

Open ElliotFriend opened 1 month ago

ElliotFriend commented 1 month ago

I'm trying to get all the JSDoc rendering to work now that the SDK has had a chance to settle a bit with its inclusion of the Soroban functionality.

Refs: #920

github-actions[bot] commented 1 month ago

Size Change: +72.2 kB (+0.6%)

Total Size: 12.1 MB

Filename Size Change
dist/stellar-sdk.js 6.75 MB +47.5 kB (+0.71%)
dist/stellar-sdk.min.js 5.32 MB +24.7 kB (+0.47%)

compressed-size-action

Shaptic commented 1 month ago

Yo this is absolutely Herculean, you freakin' rock

socket-security[bot] commented 1 month ago

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/clean-jsdoc-theme@4.3.0 filesystem Transitive: environment, network, shell +17 7.89 MB ankdev

View full report↗︎

socket-security[bot] commented 1 month ago

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSource
Network access npm/clean-css@5.3.3
Filesystem access npm/clean-css@5.3.3
Network access npm/clean-css@5.3.3
Network access npm/clean-css@5.3.3
Filesystem access npm/clean-jsdoc-theme@4.3.0

View full report↗︎

Next steps

What is network access?

This module accesses the network.

Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use.

What is filesystem access?

Accesses the file system, and could potentially read sensitive data.

If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

  • @SocketSecurity ignore npm/clean-css@5.3.3
  • @SocketSecurity ignore npm/clean-jsdoc-theme@4.3.0