Paq 2.0 #157
Merged
Paq 2.0 #157
Conversation
This file contains 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
Instead of having of having a separate key to evaluate if the directory is installed or not I've made the following changes to status enum: - INSTALLED: equivalent to the old exists key - LISTED: a package is in the paq list but it isn't yet been installed - CLONED: equivalent to what installed used to mean, a package was recently cloned (aka installed) on the machine. Also to simplify the filtering of packaging based on the status I've made a new table called 'filters' that help filter packages both in 'vim.tbl_filter' and regular if statements.
Instead of saving the state on the function 'exe_op' I save the state on every individual function that alter the state. I find this to be more reliable.
Public API: - Rename `run` option to `build`. - Rename `PaqRunHook` command to `PaqBuild`. Paq will print a deprecation notice if the old names are used. The reason for renaming these is explained in #143. Internals: - Refactor build related functions to ensure builds are executed after all packages have been installed/updated and loaded: - If the hook is a function, it might require a module inside a recently installed package. - If a is package is installed successfully and the build fails, it's better to notify that in two separate messages, instead of notifying the install failed. - Rename `run_hook` to `run_build`, and refactor to make it clear there's 3 possible cases: function, ex command, shell commmand. - Refactor `new_counter` to take a callback (passed in `exe_op`).
- Refactor `report` and `counter` to have (almost) the same signature. - Refactor the weird logic used to handle `PaqSync` messages.
Since sync needs a reference to self, it must be called with the ':'. This makes it impossible to reference it in a table.
When a branch or a remote is changed, Paq will remove the old plugin and reinstall the new one with the appropriate changes. I've opted for this solution because there are too many variables when dealing with git, so easiest solution is just to reinstall the plugin.
Now we have a clear distinction between the `Lock` and `Diff` table. Now they both have their own set of functions to deal specifically with them. For example all function that mutates `Lock` are prefixed with `lock_*`.
Now the file is categorize in 'sections' by using 'foldmethod=marker'.
Yeah, fortunately the public API is rather small. I'd really like for Paq to be one file, but not even vim-plug embeds the docs. I don't think this is blocking, and I'll move the doc ideas out of the tracking issue. |
|
Hi @savq, |
|
Pretty happy with the result. I think we are ready to ship it. |
savq
requested changes
Oct 20, 2023
savq
approved these changes
Oct 20, 2023
|
Thank you @saccarosium for all the work you've done. I don't think there's any more breaking changes or big changes to make, so we can continue working on smaller stuff in separate PRs. |
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.
BREAKING CHANGES:
runoption is deprecated. Usebuildinstead.PaqRunHookis deprecated in favor ofPaqBuild.paq/registerfunction was removed.I think we are ready to ship paq 2.0. We need to made some small modifications but I think we are there.
I have some questions regarding the documentation. If we are gonna annotate the source with emmylua comment, what documentation generator we'll going to use? mini.doc or lemmy-help?
When I've tried do documentation with emmylua comments, I found myself unwrapping a lot of the code since parsers didn't play nicely with things such as metatables. Also is worth noting that most of the documentation, found in the
paq-nvim.txt, doesn't really belong anywhere in the codebase. Leading to having pretty big wall of comments at the begin and end of the file and nothing in the middle.PaqSyncdoesn't re-install plugins whenbranchis changed #80