Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Naming convention for Asciidoctor extensions #6

Open
djencks opened this issue Jan 5, 2021 · 0 comments
Open

Naming convention for Asciidoctor extensions #6

djencks opened this issue Jan 5, 2021 · 0 comments

Comments

@djencks
Copy link

djencks commented Jan 5, 2021

This certainly applies to processor extensions, and presumably also to converter, template, and highlighter extensions.

In order to encourage 3rd party extensions to release to ruby gems, it would be helpful to have a suggested naming convention that avoided collisions and credited the 3rd party.

In javascript, npm has namespaces. Thus I can release a @djencks/asciidoctor-openblock processor extension that won't collide with anyone else's asciidoctor-openblock extension. RubyGems apparently has no such namespace facility.

As a starting point for discussion, I suggest a pattern of <orgname>-asciidoctor-<extensionpurpose>. This doesn't fit with the advice that would indicate that this relates to Orgname::Asciidoctor::Extensionpurpose, but the existing extensions such as asciidoctor-mathematical don't do this either.

With this proposed convention, my ruby extension gem name would be djencks-asciidoctor-openblock.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant