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

CLI: update command line 'report' options #443

Merged
merged 1 commit into from
Sep 9, 2019

Conversation

rnjudge
Copy link
Contributor

@rnjudge rnjudge commented Sep 6, 2019

Tern's command line is a bit cluttered. This commit attempts to
re-structure some of the {report} positional arguments. Namely:

  • Use '-f REPORT_FORMAT' to denote report format instead of '-m'
  • Use '-o FILE' to denote an report output file instead of '-f'
  • Shorten '--keep-working-dir' option to '--keep-wd'
  • Change '-V' to '-v' in order to get the version

There are a few other various style imorovemenets to the 'tern -h'
output such as changing ';' to '.' and removing an indentation.

This commit also updates the README documenation to reflect the
updated command line options, updates the invocation of the tests in
ci/test_files_touched.py and updates tern/report/report.py to reflect
the updated argument name values where applicable.

Since this commit changes Tern's user interface, it will break API and
not be compatible with downstream versions.

Resolves #390

Signed-off-by: Rose Judge [email protected]

@nishakm
Copy link
Contributor

nishakm commented Sep 6, 2019

@rnjudge looks really good! Can you remove the { and } from the commit title and body? I've had issues with parsing messages in python using the curly braces and I don't want this one commit to mess up automation ;)

@rnjudge rnjudge changed the title CLI: update command line {report} options CLI: update command line 'report' options Sep 9, 2019
@rnjudge
Copy link
Contributor Author

rnjudge commented Sep 9, 2019

@rnjudge looks really good! Can you remove the { and } from the commit title and body? I've had issues with parsing messages in python using the curly braces and I don't want this one commit to mess up automation ;)

Done!

Tern's command line is a bit cluttered. This commit attempts to
re-structure some of the {report} positional arguments. Namely:

- Use '-f REPORT_FORMAT' to denote report format instead of '-m'
- Use '-o FILE' to denote an report output file instead of '-f'
- Shorten '--keep-working-dir' option to '--keep-wd'
- Change '-V' to '-v' in order to get the version

There are a few other various style imorovemenets to the 'tern -h'
output such as changing ';' to '.' and removing an indentation.

This commit also updates the README documenation to reflect the
updated command line options, updates the invocation of the tests in
ci/test_files_touched.py and updates tern/report/report.py to reflect
the updated argument name values where applicable.

Since this commit changes Tern's user interface, it will break API and
not be compatible with downstream versions.

Resolves tern-tools#390

Signed-off-by: Rose Judge <[email protected]>
@nishakm nishakm merged commit 98737a8 into tern-tools:master Sep 9, 2019
@rnjudge rnjudge deleted the cli-issue-390 branch October 25, 2019 21:03
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.

Revisit CLI options
2 participants