Skip to content

Conversation

steffkes
Copy link
Contributor

usage tells you

Usage: swagger --project-path PATH [--output-path PATH]...

  -p, --project-path     Path containing the php files with Swagger annotations

if you go with --project-path you'll get an error which is telling you, that --project-dir must be provided. since we have everything ending on path i changed all the occurrences of project-dir into project-path

@steffkes
Copy link
Contributor Author

Hum, the same goes for output-path vs. output-dir .. not sure which way to go? ofc i'd like to change both, the main question .. to ..-path or ..-dir which one do you like more @zircote @bfanger ?

@bfanger
Copy link
Collaborator

bfanger commented Jun 23, 2013

Some thoughts on the CLI parameters:

  • Remove "-path" and "-dir" from the options go with just "--output", "--exclude", etc.
  • Remove the --project option. Example: $ swagger.phar /path/to/my-project/ -o docs
  • Rename -f --format to "--pretty-print" to avoid confusion (I associate -f with force and format with xml/json)
  • Rename -i --include to "-b --bootstrap" to avoid confusion with the sematics of the -exclude option.

What do you think?

@zircote
Copy link
Owner

zircote commented Jun 23, 2013

I agree with and support all of these.

@ghost ghost assigned bfanger Jun 23, 2013
@bfanger
Copy link
Collaborator

bfanger commented Jun 29, 2013

I've changed the cli parameters in the 0.7 branch (as it's a breaking change)
Testing and feedback is appreciated.

But I think 0.7 needs more features (like #90) before releasing it as 0.7.0

@bfanger bfanger closed this Jun 29, 2013
@steffkes steffkes deleted the project-dir-vs-project-path branch July 9, 2013 15:49
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