Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add plugin: Collapsible Code Blocks #5260

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bwya77
Copy link
Contributor

@bwya77 bwya77 commented Jan 29, 2025

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/bwya77/collapsible-code-blocks

Release Checklist

  • I have tested the plugin on
    • Windows
    • macOS
    • Linux
    • Android (if applicable)
    • iOS (if applicable)
  • My GitHub release contains all required files (as individual files, not just in the source.zip / source.tar.gz)
    • main.js
    • manifest.json
    • styles.css (optional)
  • GitHub release name matches the exact version number specified in my manifest.json (Note: Use the exact version number, don't include a prefix v)
  • The id in my manifest.json matches the id in the community-plugins.json file.
  • My README.md describes the plugin's purpose and provides clear usage instructions.
  • I have read the developer policies at https://docs.obsidian.md/Developer+policies, and have assessed my plugins's adherence to these policies.
  • I have read the tips in https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines and have self-reviewed my plugin to avoid these common pitfalls.
  • I have added a license in the LICENSE file.
  • My project respects and is compatible with the original license of any code from other plugins that I'm using.
    I have given proper attribution to these other projects in my README.md.

@ObsidianReviewBot
Copy link
Collaborator

Thank you for your submission, an automated scan of your plugin code's revealed the following issues:

Required

[1][2][3][4][5][6][7]:You should avoid assigning styles via JavaScript or in HTML and instead move all these styles into CSS so that they are more easily adaptable by themes and snippets.

[1][2][3]:Using innerHTML, outerHTML or similar API's is a security risk. Instead, use the DOM API or the Obsidian helper functions: https://docs.obsidian.md/Plugins/User+interface/HTML+elements


Do NOT open a new PR for re-validation.
Once you have pushed all of the required changes to your repo, the bot will update the labels on this PR within 6 hours.
If you think some of the required changes are incorrect, please comment with /skip and the reason why you think the results are incorrect.

@ObsidianReviewBot ObsidianReviewBot added Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made and removed Ready for review labels Jan 30, 2025
@bwya77
Copy link
Contributor Author

bwya77 commented Feb 2, 2025

Moved the styling over to styles.css, changes to DOM API, edited the gitignore to exclude main.ts

@ObsidianReviewBot ObsidianReviewBot added Ready for review and removed Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made labels Feb 2, 2025
@ObsidianReviewBot ObsidianReviewBot removed their assignment Feb 2, 2025
@ObsidianReviewBot
Copy link
Collaborator

Changes requested by bot have been made, ready for additional review by human.

@Zachatoo Zachatoo self-assigned this Feb 16, 2025
@Zachatoo Zachatoo added Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made and removed Ready for review labels Feb 16, 2025
@ObsidianReviewBot ObsidianReviewBot added Ready for review and removed Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made labels Feb 18, 2025
@ObsidianReviewBot
Copy link
Collaborator

Changes requested by Zachatoo have been made, assigning additional human for additional review

@joethei
Copy link
Collaborator

joethei commented Feb 18, 2025

.markdown-preview-view pre code::-webkit-scrollbar:vertical {, body.horizontal-scroll .markdown-preview-view pre:not(.collapsed) code {, .HyperMD-codeblock {
Please don't overwrite core styling in a plugin, add another class/data attribute so it only applies to your plugin.

private sanitizeIcon(icon: string): string {
This is not sanitizating anything, Obsidian has some API's that can help with this like the addIcon / setIcon API's

let reloadButton: ButtonComponent | null = null;
Settings should automatically apply without such a button.

@joethei joethei added Changes requested Minor changes requested PR can be merged after some final changes have been requested and removed Ready for review labels Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changes requested Minor changes requested PR can be merged after some final changes have been requested plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants