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

Provide CLI feedback for plug-in installation #3109

Closed
infotexture opened this issue Oct 18, 2018 · 4 comments
Closed

Provide CLI feedback for plug-in installation #3109

infotexture opened this issue Oct 18, 2018 · 4 comments
Labels
CLI Command-line interface issues enhancement Changes to an existing feature good first issue More straightforward issue; good candidate to get started as contributor
Projects
Milestone

Comments

@infotexture
Copy link
Member

infotexture commented Oct 18, 2018

Description

The dita --install option currently provides no confirmation when plug-ins are successfully installed (or removed).

This is consistent with the typical "no news is good news" approach for basic UNIX utilities, and tolerable enough when installing or removing a single plug-in.

However, the current behavior is less helpful in situations when the plugins directory is manually modified to add/remove multiple plug-ins at once, or install multiple plug-ins from a single .zip file.

Possible Solution

Since DITA-OT maintains a list of currently installed plug-ins and updates this configuration during the integration process, it would be helpful to compare the before/after states and print a summary to the console upon completion, for example:

$ dita --install
+ Installed com.example.plugin1
- Removed com.example.plugin2

It might also be useful to conclude the integration process by printing the current list of available plug-ins to the console via the dita --plugins option.

Since the plug-in registry changes for #3028 also permit the installation of plug-ins by alias, this would also serve to confirm the user's intent by displaying the plug-in ID that was actually installed via the alias.

This would be more consistent with the feedback provided by other CLI-based package managers.

(See related enhancement #3070).

@infotexture infotexture added enhancement Changes to an existing feature CLI Command-line interface issues labels Oct 18, 2018
@jelovirt
Copy link
Member

install multiple plug-ins from a single .zip file

Does that work? 🤔

@jelovirt jelovirt added the good first issue More straightforward issue; good candidate to get started as contributor label Oct 18, 2018
@infotexture
Copy link
Member Author

My recollection was that multiple plug-ins could be installed simultaneously by passing a .zip file that contained several plug-ins, each in top-level folders of the archive.

But I tested now, and only 1 of the 4 plug-ins in the archive was installed (first in alphabetical order).

@robander Did I dream this, or did it used to work that way?

Having to unpack the archive to the plugins folder first seems like an unnecessary step.

@robander
Copy link
Member

I think I've asked about this in the past but it was never supported - like @jelovirt I was a bit surprised by that in the initial report. It came up for me when first working with some of the D4P and SVG Diagram support, each of which required a bundle of plugins to work. I think I asked about that at the time and it was clearly out of scope for the initial dita --install support, but I hadn't thought about it since.

jelovirt added a commit that referenced this issue Oct 18, 2018
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
@jelovirt jelovirt added this to To do in 3.2 via automation Oct 18, 2018
@jelovirt jelovirt moved this from To do to Review in 3.2 Oct 18, 2018
jelovirt added a commit that referenced this issue Oct 18, 2018
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
jelovirt added a commit that referenced this issue Oct 18, 2018
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
jelovirt added a commit that referenced this issue Oct 18, 2018
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
jelovirt added a commit that referenced this issue Oct 18, 2018
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
jelovirt added a commit that referenced this issue Oct 18, 2018
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
@jelovirt jelovirt moved this from Review to In progress in 3.2 Oct 18, 2018
jelovirt added a commit that referenced this issue Oct 18, 2018
Log added and removed plugins during integration #3109
jelovirt added a commit that referenced this issue Oct 18, 2018
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
@jelovirt jelovirt moved this from In progress to Done in 3.2 Oct 18, 2018
@jelovirt jelovirt added this to the 3.2 milestone Oct 18, 2018
@infotexture
Copy link
Member Author

Resolved in #3110 & a17143c.

infotexture added a commit to dita-ot/docs that referenced this issue Oct 19, 2018
> Added com.example.plugin1
> Removed com.example.plugin2

- dita-ot/dita-ot#3109
- dita-ot/dita-ot#3110
- dita-ot/dita-ot@a17143c

Signed-off-by: Roger Sheen <roger@infotexture.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLI Command-line interface issues enhancement Changes to an existing feature good first issue More straightforward issue; good candidate to get started as contributor
Projects
No open projects
3.2
  
Done
Development

No branches or pull requests

3 participants