Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-58121

Use -- for long flags

XMLWordPrintable

      It would be good to use long flags like how most other CLI tools use them

      See:

      https://blog.heroku.com/cli-flags-get-started-with-oclif

      https://www.mankier.com/1/kubectl-create

      i.e. 

      --

      instead of

      -

      Usage could look something like:

      jenkins-plugin-manager --file plugins.txt --jenkins-war jenkins.war --plugin blah --plugin plugin2 --plugin-directory plugins/

      A couple of examples of how short flags could look:

      jenkins-plugin-manager -f new-plugins.txt 
      jenkins-plugin-manager -p slack

          [JENKINS-58121] Use -- for long flags

          Tim Jacomb created issue -
          Natasha Stopa made changes -
          Epic Link New: JENKINS-53767 [ 194275 ]

          Jon Brohauge added a comment - - edited

          It is considered best practice for shell-based commands to use a single dash followed by a single character, and two dashes followed by a word. One of the reasons being is that using multiple characters after a single dash can be confused for a value after the single character. I.e. `-f file` and `-ffile` can mean the same, so `-file` can be interpreted as `-f ile`.

           

          Jon Brohauge added a comment - - edited It is considered best practice for shell-based commands to use a single dash followed by a single character, and two dashes followed by a word. One of the reasons being is that using multiple characters after a single dash can be confused for a value after the single character. I.e. `-f file` and `-ffile` can mean the same, so `-file` can be interpreted as `-f ile`.  
          Natasha Stopa made changes -
          Status Original: Open [ 1 ] New: In Progress [ 3 ]
          Natasha Stopa made changes -
          Status Original: In Progress [ 3 ] New: In Review [ 10005 ]

          Natasha Stopa added a comment -

          Fixed and merged in with https://github.com/jenkinsci/plugin-installation-manager-tool/pull/24

          Natasha Stopa added a comment - Fixed and merged in with  https://github.com/jenkinsci/plugin-installation-manager-tool/pull/24
          Natasha Stopa made changes -
          Resolution New: Fixed [ 1 ]
          Status Original: In Review [ 10005 ] New: Resolved [ 5 ]
          Mark Waite made changes -
          Status Original: Resolved [ 5 ] New: Closed [ 6 ]

            stopalopa Natasha Stopa
            timja Tim Jacomb
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: