Picoloom v2 migration and upcoming repo rename #3
Pinned
alnah
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
From go-md2pdf/md2pdf to Picoloom
Hello, everyone! Picoloom is now the official name of the project.
The
v2release aligns the repo, Go module, public package, and CLI under one identity. Why? I did not want to keep a generic name. It was not memorable, and I did not like having a binary name that differed from the repo name. Those were small but real mistakes on my side.So now there is one identity for everything. I know this is a breaking change driven mostly by naming, but I would rather do it now than later. My intention is for this name to remain stable for the repo, the tool, and the library for the long run.
I also think it is better to do this before the CLI and library get more traction, because I plan to communicate more about the project very soon as part of showing my work as a programmer and open-source maintainer.
So, to summarize:
alnah/picoloomgithub.com/alnah/picoloom/v2picoloompicoloomBreaking change for Go users
If you import the library, migrate from:
github.com/alnah/go-md2pdfto:
github.com/alnah/picoloom/v2Typical change:
CLI transition
The official CLI name is now:
picoloomLegacy
md2pdfcompatibility is still supported for transition paths, along with legacy config and env fallbacks such as:md2pdf.yamlMD2PDF_*~/.config/go-md2pdf/Migration helper
A conservative migration helper is available for mechanical rewrites:
go run github.com/alnah/picoloom/v2/cmd/picoloom-migrate@latest .Use
--writeto apply changes in place.Why the name
piccolomeans "small" in Italian, which fits because the project started as a small tool. It is also the name of my dog, who is usually staring at me while I am programming without having any idea what is going on. So thank you, Piccolo, for being so loyal.loomrefers to the layering and composition side of the pipeline. I removed onecto make the name easier to write. Nobody wants to stop and think, "Wait, is this with one or two c's?" Sopico + loomfelt natural and memorable to me.What happens next
The repo itself will be renamed very soon, possibly today. But I wanted to get the module, package, CLI, and migration path in place first so the transition would be explicit.
If you hit migration issues, reply here.
Beta Was this translation helpful? Give feedback.
All reactions