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

Resolves #37, add the CLI version and the Asciidoctor.js version #39

Merged
merged 1 commit into from
Dec 1, 2018

Conversation

ggrossetie
Copy link
Member

@ggrossetie ggrossetie commented Nov 27, 2018

CLI version 1.5.6-rc.1
Asciidoctor.js 1.5.9 (built using Asciidoctor 1.5.8) [https://asciidoctor.org]
Runtime Environment (node v8.11.1 on linux)

Should we keep (built using Asciidoctor 1.5.8) ?
I think the CLI version is important but maybe it's confusing ?

[EDIT]

What about:

asciidoctorjs version 1.5.6-rc.1
Asciidoctor.js 1.5.9 [https://asciidoctor.org]
Runtime Environment (Asciidoctor 1.5.8)(node v8.11.1 on linux)

@thom4parisot
Copy link
Member

What's confusing is there are 3 Asciidoctor references. Whereas there are 3 different purposes:

  1. the CLI tool I can refer to, to report usability bugs
  2. the tool which does the conversion (useful for API, compat, and other stuff?)
  3. the Ruby runtime it's based on (does it have an impact during the conversion or is it an information which is implied by 2.?)

@mojavelinux
Copy link
Member

mojavelinux commented Nov 27, 2018

I don't really think the CLI version is necessary. It really should be just a thin wrapper that rarely, if ever, needs to be referenced. (If so, you can check the deps tree). What matters is the version of Asciidoctor.js and which Asciidoctor core version it's using. I might also rephrase "built from" to be "powered by" or "compliant with". The user doesn't care what it's built with, but rather what it is running. So it's all in how we frame it.

@ggrossetie
Copy link
Member Author

I don't really think the CLI version is necessary. It really should be just a thin wrapper that rarely, if ever, needs to be referenced. (If so, you can check the deps tree).

I somewhat agree but as mentioned by @oncletom it can be useful for bug reports. It may be because we are at an early stage but the CLI is still evolving and has a few bugs/missing features.

What's confusing is there are 3 Asciidoctor references. Whereas there are 3 different purposes:
the CLI tool I can refer to, to report usability bugs
the tool which does the conversion (useful for API, compat, and other stuff?)
the Ruby runtime it's based on (does it have an impact during the conversion or is it an information which is implied by 2.?)

Since Asciidoctor.js is not a direct dependency anymore, we can't infer the version of Asciidoctor.js from the CLI version. But we can infer the version of Asciidoctor Ruby from the version of Asciidoctor.js.

What matters is the version of Asciidoctor.js and which Asciidoctor core version it's using. I might also rephrase "built from" to be "powered by" or "compliant with". The user doesn't care what it's built with, but rather what it is running. So it's all in how we frame it.

The version of Asciidoctor core can be infer (from Asciidoctor.js) and it might be confusing.
New proposal:

Asciidoctor.js 1.5.9 [https://asciidoctor.org]
Runtime Environment (node v8.11.1 on linux)
CLI version 2.0.0

(I'm using version 2.0.0 because the version of the CLI is not aligned on the version of Asciidoctor.js anymore)

@mojavelinux
Copy link
Member

mojavelinux commented Nov 27, 2018 via email

@ggrossetie
Copy link
Member Author

What do you think @oncletom of the last proposal ?

@ggrossetie
Copy link
Member Author

Done:

./bin/asciidoctorjs -V                
Asciidoctor.js 1.5.9 [https://asciidoctor.org]
Runtime Environment (node v8.10.0 on linux)
CLI version 1.5.6-rc.1

@ggrossetie ggrossetie merged commit d3eace9 into asciidoctor:master Dec 1, 2018
@ggrossetie ggrossetie deleted the issue-37-version branch December 2, 2018 15:01
@ggrossetie ggrossetie restored the issue-37-version branch December 2, 2018 15:01
@ggrossetie ggrossetie deleted the issue-37-version branch December 2, 2018 15:02
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

Successfully merging this pull request may close these issues.

3 participants