switch to Configurations to support better @plugin macro and template serailization in TOML #254

Roger-luo · 2020-12-04T21:14:13Z

This PR removes Parameters and use Configurations instead, since I think the goal of Configurations fits better for the PkgTemplate use case, and there is not much user interface change, all the old interfaces are the same including @plugin macro.

But you don't need to import @with_kw_noshow anymore, only use @plugin is sufficient since you can select your own code generators in Configurations. I think It makes the implementation of Plugin simpler and better and reduces the maintenance pressure of this package since I'm also going to help Pluto and Comonicon to switch to this configuration package - most of the code in Pluto, Comonicon's configuration structs and PkgTemplates' Plugin are actually similar. So I think this brings a much simpler implementation of Plugin.

A glance at some new features automatically (or by slightly overloading some interfaces of Configurations) enabled by using Configurations

Color, Compact, Copy Pastable Printing

I think currently it is a bit painful to read when all the fields are printed no matter it's just default value or not, now default values are automatically hidden and colors are used to help distinguish between kwargs, Plugin types and values. And you cannot copy pasta the printings back to REPL - this is also not convenient for sharing.

Before

After

Serialization to TOML files and potentially many other formats

now you can use Configurations.to_toml function to convert your templates to a TOML file easily. This makes sharing templates and modifying templates a lot easier and flexible. Also make things easier to read.

can you can read a template from a TOML file by Configurations.from_toml

since you can also convert a Template to OrderedDict using to_dict, it can be serialized to other format you like as well!

codecov · 2020-12-04T21:16:44Z

Codecov Report

Merging #254 (ba7b252) into master (70ba6f7) will decrease coverage by 0.17%.
The diff coverage is 85.89%.

@@            Coverage Diff             @@
##           master     #254      +/-   ##
==========================================
- Coverage   82.18%   82.01%   -0.18%     
==========================================
  Files          19       18       -1     
  Lines         612      606       -6     
==========================================
- Hits          503      497       -6     
  Misses        109      109

Impacted Files	Coverage Δ
src/PkgTemplates.jl	`85.71% <ø> (ø)`
src/plugins/badges.jl	`50.00% <ø> (-16.67%)`	⬇️
src/plugins/develop.jl	`50.00% <ø> (-16.67%)`	⬇️
src/plugins/src_dir.jl	`83.33% <ø> (+3.33%)`	⬆️
src/plugins/license.jl	`86.66% <50.00%> (+5.71%)`	⬆️
src/plugin.jl	`77.77% <66.66%> (-6.10%)`	⬇️
src/template.jl	`88.31% <88.88%> (-2.24%)`	⬇️
src/interactive.jl	`74.35% <100.00%> (ø)`
src/plugins/documenter.jl	`69.84% <100.00%> (+4.62%)`	⬆️
src/plugins/project_file.jl	`63.63% <0.00%> (-6.37%)`	⬇️
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 70ba6f7...ba7b252. Read the comment docs.

Roger-luo · 2020-12-04T21:19:53Z

I'll add some more tests if people like this PR.

christopher-dG · 2020-12-04T21:52:51Z

Holy cow, this is awesome. It'll take me a long time to review this but I definitely support the idea.

Roger-luo · 2020-12-05T02:46:36Z

cool, I'll fix a few issues left first then:

do not expand homedir in serialized format or printings
fix 1.0 compatibility
add some tests for the serialization part

I think I can I assume the rest part should be covered by current test, but I could be wrong.

Roger-luo · 2020-12-05T20:21:10Z

I realize we need to have JuliaLang/TOML.jl#13 fixed to be able to disable and use the default field of specified plugins. So don't merge this until that issue is fixed.

Roger-luo · 2020-12-06T07:22:58Z

TBH I have no idea why the mock test errors in 1.0 (and it is extremely slow on 1.0), if you remove the mock, it seems to work fine, but with the mock, I got the following with a bus error locally. This is fine on other julia versions. I think this PR is ready to review now @christopher-dG .

I've fixed the TOML.jl issue above myself too (so I mark the test here as broken for now, and we could just change it back to @test when my PR is merged to TOML)

julia> mock(PT.version_of => _p -> v"1.2.3") do _i
                   with_pkg(t) do pkg
                       pkg_dir = abspath(expanduser(joinpath(t.dir, pkg)))
                       LibGit2.with(GitRepo(pkg_dir)) do repo
                           commit = GitCommit(repo, "HEAD")
                           @test occursin("PkgTemplates version: 1.2.3", LibGit2.message(commit))
                       end
                   end
               end
[ Info: Running prehooks
[ Info: Running hooks

christopher-dG · 2020-12-29T18:22:57Z

Setting myself a reminder to review this weekend.

christopher-dG · 2021-01-16T22:08:28Z

Sorry I've let this slip again. @nickrobinson251 any chance someone from Invenia would like to review? A big change in internals like this might be a good time for maintainership to pass over more formally to current Invenians.

nickrobinson251 · 2021-01-16T23:12:48Z

@nickrobinson251 any chance someone from Invenia would like to review? A big change in internals like this might be a good time for maintainership to pass over more formally to current Invenians.

Sure! I'll bring it up this week to see who'd be interested :)

fyi @nick-thiessen and @omus

nick-thiessen · 2021-01-27T23:27:35Z

At the moment no one is free to review this, but in the next couple weeks someone might become available and possibly be available to take over maintainership. I'll have to have some conversations about who is interested.

gdalle · 2023-12-19T09:06:52Z

Currently trying to clean up the repo a little. Is this PR still relevant @Roger-luo?

Roger-luo · 2023-12-19T22:02:43Z

Not anymore I've implemented this in rust

gdalle · 2023-12-20T07:22:41Z

My question was badly phrased, I was rather wondering whether it could be brought up to speed with the latest changes to the package?

Roger-luo · 2023-12-21T00:16:32Z

I mean I don't even use this package anymore... I have no motivation to keep working on this PR, at least for myself, my own CLI tool is much easier to use than this package. https://discourse.julialang.org/t/ann-the-ion-command-line-for-julia-developers-written-in-rust/94495

gdalle · 2023-12-21T08:19:55Z

Okay thanks. Still, I might revisit your ideas and try to switch to a better serialization at some point!

Roger-luo added 6 commits December 4, 2020 02:53

use Configurations to support template serialization

3e03241

ignore vscode

e746306

fix test

14106a8

set back test

42793e3

adjust default order to match sort order

93116b6

fix toml conversion

42248e1

Roger-luo added 5 commits December 4, 2020 21:55

fix convert

c41fa98

add compat for configurations

3f444ad

expand user only before creating package

d7ccb6b

polish dict convert

d2e7b78

polish test

5278987

Roger-luo added 13 commits December 5, 2020 16:11

add test & fix toml

a6a9140

update test

1744fd1

fix tests

37b0a32

fix test

cfcebdf

fix tests

052ee4b

fix 1.0 compatibility

d735290

bump configurations version

24ab0d4

fix toml test

4a5d112

fix windows

29b90c2

fix windows test

b31b07d

fix test

2a785e1

fix tests, only dump non default fields for Template

7b34e7a

fix test

4870205

fix test by removing mock

ba7b252

gdalle marked this pull request as draft December 19, 2023 09:06

Roger-luo closed this Dec 21, 2023

Roger-luo deleted the toml branch December 21, 2023 01:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

switch to Configurations to support better @plugin macro and template serailization in TOML #254

switch to Configurations to support better @plugin macro and template serailization in TOML #254

Roger-luo commented Dec 4, 2020 •

edited

Loading

codecov bot commented Dec 4, 2020 •

edited

Loading

Roger-luo commented Dec 4, 2020

christopher-dG commented Dec 4, 2020

Roger-luo commented Dec 5, 2020 •

edited

Loading

Roger-luo commented Dec 5, 2020

Roger-luo commented Dec 6, 2020 •

edited

Loading

christopher-dG commented Dec 29, 2020

christopher-dG commented Jan 16, 2021

nickrobinson251 commented Jan 16, 2021

nick-thiessen commented Jan 27, 2021

gdalle commented Dec 19, 2023

Roger-luo commented Dec 19, 2023

gdalle commented Dec 20, 2023

Roger-luo commented Dec 21, 2023

gdalle commented Dec 21, 2023

switch to Configurations to support better @plugin macro and template serailization in TOML #254

switch to Configurations to support better @plugin macro and template serailization in TOML #254

Conversation

Roger-luo commented Dec 4, 2020 • edited Loading

Color, Compact, Copy Pastable Printing

Serialization to TOML files and potentially many other formats

codecov bot commented Dec 4, 2020 • edited Loading

Codecov Report

Roger-luo commented Dec 4, 2020

christopher-dG commented Dec 4, 2020

Roger-luo commented Dec 5, 2020 • edited Loading

Roger-luo commented Dec 5, 2020

Roger-luo commented Dec 6, 2020 • edited Loading

christopher-dG commented Dec 29, 2020

christopher-dG commented Jan 16, 2021

nickrobinson251 commented Jan 16, 2021

nick-thiessen commented Jan 27, 2021

gdalle commented Dec 19, 2023

Roger-luo commented Dec 19, 2023

gdalle commented Dec 20, 2023

Roger-luo commented Dec 21, 2023

gdalle commented Dec 21, 2023

Roger-luo commented Dec 4, 2020 •

edited

Loading

codecov bot commented Dec 4, 2020 •

edited

Loading

Roger-luo commented Dec 5, 2020 •

edited

Loading

Roger-luo commented Dec 6, 2020 •

edited

Loading