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

Add new options to generate command #8

Open
5 tasks done
yubathom opened this issue Aug 31, 2020 · 4 comments
Open
5 tasks done

Add new options to generate command #8

yubathom opened this issue Aug 31, 2020 · 4 comments
Assignees

Comments

@yubathom
Copy link
Contributor

yubathom commented Aug 31, 2020

Consider adding some options for the users in the generate command?

I was wondering something like:

generate <path>                 Create API documentation
generate [options] <path>

Options:
  -o, --output-path <path>       The documentation markdown file output path
  -u, --update <path>            Update de documentation markdown file
  -n, --no-install               Skip npm install and create only the markdown file
  -r, --request-buttons          Add a request button for each request
  1. -o, --output-path <path>
    Now the default value of path is docs/README.md. Would be nice if we could replace it for some other path.

2. -u, --update
Now if we have a docs folder or a package.json the process is stoped. As the api evolves is common the need to update the documentation. With this option set, the user could just update the existing markdown file.

  1. -n, --no-install
    It is great that the cli create all the doc website and npm install and so on. But in some cases it is more usefull to gerenerate just the plain markdown.

  2. -r, --request-buttons
    Would be nice if in the generated website we could run the requests and easily test the apis.

todo:

hdg generate <options>

  • -o, --output-path <path>
  • update existing doc after response from the user
  • -n, --no-install
  • -r, --request-buttons
  • tests
@jamesgeorge007
Copy link
Member

Good call, I think instead of having the --update flag we can ask the user whether he/she intends to overwrite the existing content.

@yubathom
Copy link
Contributor Author

yubathom commented Sep 3, 2020

I will give a try next weekend

@jamesgeorge007 jamesgeorge007 linked a pull request Sep 26, 2020 that will close this issue
@jamesgeorge007 jamesgeorge007 changed the title generate options Add new options to generate command Sep 26, 2020
@nikhilspy
Copy link

Can you please explain me the task I am unable to understand it. Whether we want a command to add feature or we have to add new command as features.I will be happy to do this once you explain it.

@yubathom
Copy link
Contributor Author

Hey @nikhilspy we already have that command and feature. The missing part is on add support to do the request in the doc website. Check HoppRequest.vue, is very incomplete.. Maybe you could check these supporting more methods and options.

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

No branches or pull requests

3 participants