roadmap to v1.0

[johnnychen94]

I believe this package has proved its usefulness, and I'd like to push it to its 1.0 stage.

Here are what I have in mind that needs to be done before it's ready:

Core & API changes:

• Split out and implement match_reference that returns a Bool Fails should be fails and not errors #9 [WIP] Fail rather than error if can't regenerate #12
• support multiple references in match_reference #47
• deprecate @test_reference
• expose the post-processing handlers to users
• improve the does-not-match handlers

Extensions:

• provide a way to write extensions for other file types
• support image rendering using in vscode/atom enable image display using ImageShow #41
• support AbstractArray{<:Colorant}, currently it's restricted to 2D matrix
• ignore whitespace for AbstractArray{<:Number}(and maybe more) types

Etc:

• more illustrative documentation
• test coverage for large data to make sure everything is rendered correctly and efficiently

Please comment if you have any other ideas.

[mauro3]

How about dropping the dependencies on the image-packages? They make this package a heavy dependency for users which do not use Images. Could maybe be hidden behind Requires.jl?

[johnnychen94]

Yes, we did consider separating out ImageReferenceTest to JuliaImages. Just that this package isn't targeted to end-users so with limited time contributing codes, I have to target higher priority tasks... 😢 If this dependency matters a lot and if you want to help with this, I can create an empty project in JuliaImages and maybe you can help it there?

[mauro3]

No worries. What is the time frame on getting to 1.0? I probably don't have time right now, but it's definitely an itch I'd like to scratch.

[johnnychen94]

No worries. What is the time frame on getting to 1.0?

Hmmm... It's probably never unless we get a bigger Julia community 🤣 . Just that this package isn't of very high priority on my to-do list and my main focus is still on JuliaImages. Hope you can understand...

[mauro3]

Excellent, that means that I can take time to scratch my itch ;-)

And no worries, I do not expect you to do anything; after all, I'm not paying you!