Open pat-alt opened 2 months ago
Attention: Patch coverage is 61.81818%
with 42 lines
in your changes missing coverage. Please review.
Project coverage is 90.19%. Comparing base (
a007c9e
) to head (62f9ed4
).
Files | Patch % | Lines |
---|---|---|
src/fixup.jl | 0.00% | 18 Missing :warning: |
src/plugins/git.jl | 25.00% | 6 Missing :warning: |
src/plugins/readme.jl | 63.63% | 4 Missing :warning: |
src/interactive.jl | 87.50% | 2 Missing :warning: |
src/plugins/documenter.jl | 75.00% | 2 Missing :warning: |
src/plugins/formatter.jl | 0.00% | 2 Missing :warning: |
src/plugins/license.jl | 50.00% | 2 Missing :warning: |
src/plugins/project_file.jl | 50.00% | 2 Missing :warning: |
src/PkgTemplates.jl | 50.00% | 1 Missing :warning: |
src/plugin.jl | 88.88% | 1 Missing :warning: |
... and 2 more |
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Thank you for these contributions! I just want to point out that @oxinabox and I chatted at JuliaCon, and agreed that BestieTemplate.jl might be the best way forward to replace PkgTemplates.jl, precisely because it includes an update mechanism from the get go. We haven't made any formal announcement yet but I encourage you to check it out before you spend too much effort here.
Ah ok, good to know, thanks! I'm also now seeing #478
@abelsiqueira I've dabbled a bit with BestieTemplate.jl and having the update functionality is definitely a huge win. Maybe I'll abuse this thread here to ask a few questions/add some thoughts:
To elaborate a bit on (1), I've found it very easy to add functionality here since it's all Julia and the docs for devs are comprehensive. To give you a concrete example, how easy do you think it would be to contribute something like #482 to Bestie?
As for point (2), it says in Bestie's docs:
PkgTemplates.jl is a project generator. This means that if you want to programmatically create templates inside Julia, this is the best solution. The questions (user interface) are implemented by the package, which then translates that into the answers for the engine.
I think this is a great feature and it would be a shame to lose it entirely. For example, I have been trying to leverage this functionality here to add a custom package template for Taija. I've continued to work on this even after hearing about Bestie at JuliaCon, because it seemed to me like the most straightforward pure-Julia approach.
Happy to instead focus my efforts on Bestie, these are just a few questions/concerns I've had so far, so what be great to hear your thoughts :)
@pat-alt can you maybe put this comment and continue the discussion with Abel on #478 instead?
Trying to reanimate #288 here to add support for a
fixup
function. I've tried to address the suggestions made here:Additions
fixup
function now backs up the current state of the package in a temporary directory, instead of solely relying on Git.fixup
is added with a_fixed.md
suffix. The user will receive an info message that they may need to move contents from the existing README into the new one and then overwrite the existing file with the new file.JuliaFormatter.format("src")
).Point (2) is clearly not optimal: ideally
fixup
would overwrite/add whatever is necessary to comply with the new template and keep existing content. I am not sure this can be done though and personally think it would be better to have mediocrefixup
functionality than none at all?