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

Move Default Auto-Correct Misspellings to Separate File #1185

Merged
merged 6 commits into from
Oct 10, 2024

Conversation

pjkaufman
Copy link
Collaborator

There has been a push to make plugins more performant for the Obsidian app. The main.js for the Linter is about 1.4MB in size. Most of the bundled size (.9MB) comes from the default misspellings. However this is really only needed if auto-correct common misspellings is enabled. I suspect that not all users are using this rule, but it is causing the bundle to be so large that it is slowing down the load time of the plugin which thus impacts the load time of the user's vault. To help speed this up, it is being moved to its own Markdown file. This Markdown file should be installed once when the rule is enabled or if it is missing. This also allows for the auto-correct file to be loaded when the layout is ready. This also greatly helps improve the loading time of the plugin.

The zip file generated as part of release should now include the default Markdown file to help manual installations work well.

@pjkaufman pjkaufman added enhancement New feature or request obsidian Obsidian specific syntax issue or feature github labels Oct 7, 2024
@pjkaufman pjkaufman self-assigned this Oct 7, 2024
@pjkaufman
Copy link
Collaborator Author

I need to update where it is pointing for the default misspellings list on the settings page, but after that this should be clear to be merged.

@pjkaufman pjkaufman merged commit 64a94f5 into platers:master Oct 10, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request github obsidian Obsidian specific syntax issue or feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant