@adg Thanks, that's helpful.

Dependencies have costs. They introduce fragility and complexity. When adding a dependency on another repository, we must weigh up whether that cost is justified.

So, if we can avoid having the sanitized_anchor_name dependency in blackfriday, the cost of importing blackfriday into people's projects would be lowered.

The sanitized_anchor_name is a tiny piece of functionality, IMO undeserving of its own repository (in this context).

I agree. If we can find a good way to make it no longer be a separate repository, that would be improvement (although it has a cost of making the change, but likely worth it).

I suggest that blackfriday either copy this function or vendor the repository. The former is preferable to the latter.

I'd really like to avoid making a copy of the function, because that would go against its purpose. The point of sanitized_anchor_name.Create is that it's guaranteed to generate a matching id for a given text. Users of that functionality can be sure it won't ever go out of sync with the logic that blackfriday uses, and maintainers of blackfriday won't have to remember to update 2 pieces of code.

However, we can move the package into the blackfriday repository. It'd still be a separate package, but no longer a separate repository, so the original goal of reducing the cost of importing blackfriday would be satisfied (by some positive amount).

By moving the package, I mean we'd create a copy inside blackfriday repository, and deprecate the current github.com/shurcooL/sanitized_anchor_name.

Users of `sanitized_anchor_name`

Looking at the current known importers of github.com/shurcooL/sanitized_anchor_name, there aren't many. If we filter out all the forks of blackfriday itself, it leaves:

github.com/9uuso/vertigo/databases/sqlx         Package sqlx is PostgreSQL and SQLite database access layer (DAL) for users and posts.
github.com/chaseadamsio/goorgeous               A go org syntax parser to html
github.com/shurcooL/frontend/table-of-contents
github.com/shurcooL/github_flavored_markdown    Package github_flavored_markdown provides a GitHub Flavored Markdown renderer with fenced code block highlighting, clickable heading anchor links.
github.com/shurcooL/home/idiomaticgo            Package idiomaticgo contains functionality for rendering /idiomatic-go page.
github.com/shurcooL/play/63
github.com/shurcooL/play/74

I've looked over them, and pretty much each user of sanitized_anchor_name also imports blackfriday (sometimes indirectly):

sqlx uses sanitized_anchor_name in two places to create post.Slug from post.Title, and it imports blackfriday in the same .go file:
```
"github.com/russross/blackfriday"
slug "github.com/shurcooL/sanitized_anchor_name"
```
goorgeous uses sanitized_anchor_name to create headlineID in a generateHeadline method. It imports both sanitized_anchor_name and blackfriday right next to each other as well.
github.com/shurcooL/frontend/table-of-contents doesn't use blackfriday directly, but it's meant to be used in a context where blackfriday is used anyway.
github.com/shurcooL/github_flavored_markdown is a blackfriday.Renderer implementation, it therefore uses blackfriday.
github.com/shurcooL/home/idiomaticgo uses sanitized_anchor_name to create anchors matching output of github_flavored_markdown, which in turn depends on blackfriday.
github.com/shurcooL/play/... are just one-off experimental snippets and don't matter.

So, given all/most users of sanitized_anchor_name package also import blackfriday package, it shouldn't be a big cost for them if we move the package from github.com/shurcooL/sanitized_anchor_name to something like github.com/russross/blackfriday/sanitized_anchor_name. I can even make PRs to update them.

Proposal

Based on the above, my proposal is the following:

Move github.com/shurcooL/sanitized_anchor_name package from a standalone repository to blackfriday repository, making its import path something like github.com/russross/blackfriday/sanitized_anchor_name.
Deprecate old copy of github.com/shurcooL/sanitized_anchor_name, remove it after some time, after its users have had a chance to migrate.

This will not be a breaking change for blackfriday users, but it will be for sanitized_anchor_name users. But there aren't that many of them.

Since it's a breaking change, we can use the opportunity to finally remove the unidiomatic underscores from the import path (the package is so old, it predates me knowing how to name Go packages well):

github.com/russross/blackfriday/sanitizedanchorname

It might be better to give it an even shorter name. I'm open to suggestions.

How does that sound?

Users of sanitized_anchor_name

Proposal

Users of `sanitized_anchor_name`

copy sanitized_anchor_name to blackfriday #350

Description

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions