-
Notifications
You must be signed in to change notification settings - Fork 10
Internal Refactoring v1.0 #55
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6c9ebac
to
a605b16
Compare
f6a532e
to
9589cd4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are a tonne of things that I've not been happy with internally.
Phiki is a rather large piece of machinery and TextMate tokenisation is a complex beast, so I think now is a good time to really nail down the internal APIs and get things into a more maintainable state.
This is going to be a progressive task that I'll aim to get done over the next few weeks as there are various bugs or missing features in the package right now that need resolving. To be honest, the internals are becoming rather convoluted and messy which makes fixing these things that bit more difficult.
If I'm struggling to find and fix things, nobody has a chance!
There are technically going to be breaking changes in this PR. I'm now marking certain parts of the API as
@internal
which means they do not adhere to any form of SemVer policy, allowing me to refactor them as I go.In reality though, these parts of the internal codebase are unreachable unless somebody is doing something very wrong (which I hope they're not).