Update js-beautify CLI options in README #1089

Merged
merged 1 commit into from Jan 3, 2017

Projects

None yet

2 participants

@olsonpm
Contributor
olsonpm commented Dec 29, 2016

fixes #1047

  • update cli options with exact output from $ js-beautify --help
  • add missing json defaults found in the CLI
  • reorder json defaults to correspond with CLI output
  • remove 'keep_function_indentation' from documentation since it is unused
  • remove html beautifier specific defaults (updating that section is out of
    scope for this commit)
  • separate defaults exposed by the cli and those which aren't
  • reword the compatibility notice as a result of the default separation
@olsonpm
Contributor
olsonpm commented Dec 29, 2016

This is a little more than what #1047 called for, but I wanted to update that section as a whole. Let me know if it's too much and I'll keep the commit limited to the operator_position

@bitwiseman

You have the right instinct. Make it match the output from help. Might as well add fixing up the help output to this.

README.md
- -s, --indent-size Indentation size [4]
- -c, --indent-char Indentation character [" "]
- -e, --eol character(s) to use as line terminators. (default newline - "\\n")');
+ -s, --indent-size Indentation size [4]
@bitwiseman
bitwiseman Dec 30, 2016 Contributor

How about fixing the output from --help to make this indentation even?

@olsonpm
olsonpm Dec 30, 2016 edited Contributor

Because I didn't think it was broken haha. My understanding of the pattern was a loosely tiered "match your neighbor's indentation". I take it you don't want the options under "CLI Options" to be pushed over, just those under "Beautifier Options"? I'll update it to whatever you think looks good.

@olsonpm
olsonpm Dec 30, 2016 Contributor

Oh whoops - I have no idea how that indentation changed. I definitely didn't do that on purpose, I'll have to check to see if my editor is being smarter than it should be.

Sorry for that

@olsonpm
Contributor
olsonpm commented Dec 30, 2016

the indentation should be fixed with that push -f.

@bitwiseman
Contributor

@abbotto - Does this fully address your concerns from #1047?

@olsonpm
Contributor
olsonpm commented Dec 30, 2016

@bitwiseman

  • ah, I remembered why the indentation changed:

http://pix.toile-libre.org/upload/original/1483098688.png

That's from a fresh npm i -g js-beautify

Should I even out the indentation in the CLI as well?

@bitwiseman
Contributor

@olsonpm - yes, please go ahead and even that out while you're at it. Thanks!

@olsonpm
Contributor
olsonpm commented Jan 2, 2017

I'm not understanding why appveyor and travis are tripping up.

Ensuring no changes visible to git have been made to '' ...

ERROR: Post-build git status check - FAILED.

?

@bitwiseman
Contributor
@bitwiseman bitwiseman closed this Jan 2, 2017
@bitwiseman bitwiseman reopened this Jan 2, 2017
@bitwiseman
Contributor

Ah, I see. Run ./build and then amend your commit.

@olsonpm olsonpm Update js-beautify CLI options in README
fixes #1047

 - update cli options with exact output from `$ js-beautify --help`
 - even out indentation under CLI "Beautifier Options"
 - add missing json defaults found in the CLI
 - reorder json defaults to correspond with CLI output
 - remove 'keep_function_indentation' from documentation since it is unused
 - remove html beautifier specific defaults (updating that section is out of
   scope for this commit)
 - separate defaults exposed by the cli and those which aren't
 - reword the compatibility notice as a result of the default separation
2dcb0fa
@olsonpm
Contributor
olsonpm commented Jan 2, 2017

thanks

@bitwiseman
Contributor

@olsonpm - Thanks you!

@bitwiseman bitwiseman merged commit 1546edf into beautify-web:master Jan 3, 2017

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment