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

Update docs to remove standard-format references #606

Closed
heapwolf opened this issue Aug 29, 2016 · 11 comments

Comments

@heapwolf
Copy link

commented Aug 29, 2016

I recently started using the vim integration and realized a behavior that I'm not sure is correct.

I have vim set up to use standard-format when I save. Some code that looks like this...

SomeModule.someMethod({ foo }, cb)

It is re-written as...

SomeModule.someMethod({ foo}, cb)

But then I also get a message saying...

Expected consistent spacing (standard/object-curly-even-spacing)

@dcousens dcousens added the bug label Aug 29, 2016

@dcousens

This comment has been minimized.

Copy link
Member

commented Aug 29, 2016

Latest version?

@heapwolf

This comment has been minimized.

Copy link
Author

commented Aug 29, 2016

Yes

@Flet

This comment has been minimized.

Copy link
Member

commented Aug 30, 2016

This would be an issue with standard-format.

I believe there are a few open issues regarding this kind of spacing:
https://github.com/maxogden/standard-format/issues?utf8=%E2%9C%93&q=spacing

You may want to try the latest version of standard and use standard --fix instead. It uses eslint's fix flag which seems to be a bit more consistent (but does not cover as many things).

Closing this issue as it should already be covered over at standard-format 👍

@Flet Flet closed this Aug 30, 2016

@timoxley

This comment has been minimized.

Copy link
Contributor

commented Aug 30, 2016

@0x00A there's a bunch of issues with standard-format and modern syntax. I suggest perhaps adjusting your vim integration to use standard --fix instead.

@heapwolf

This comment has been minimized.

Copy link
Author

commented Aug 30, 2016

@Flet Maybe the standard-format module is broken. The real problem though, is that the documentation advises using something that directly conflicts/breaks the standard module. Maybe the fix is to just update the documentation?

@LinusU

This comment has been minimized.

Copy link
Member

commented Aug 30, 2016

@0x00A Standard v8 (current release) recommends using --fix instead of the standalone standard-format

@heapwolf

This comment has been minimized.

Copy link
Author

commented Aug 30, 2016

@LinusU hey, i'm already on the current release and you are the second person in this thread to suggest using --fix (#606 (comment)). But that's not the issue. The issue is that the documentation is wrong (https://github.com/feross/standard/blob/master/README.md#vim).

@LinusU

This comment has been minimized.

Copy link
Member

commented Aug 30, 2016

Didn't realize that there where vim-specific instructions, yes those should probably be updated...

@feross

This comment has been minimized.

Copy link
Member

commented Sep 10, 2016

Re-opening this issue since the documentation should not encourage use of standard-format going forward. It's too much of a maintenance burden IMO and standard --fix works better with ES6+ syntax. Thanks for pointing this out, @0x00A, and sorry for the trouble.

Would a vim user be kind enough to update the docs to use standard --fix, confirm everything works, and send a PR?

@feross feross reopened this Sep 10, 2016

@feross feross added help wanted question and removed bug labels Sep 10, 2016

@feross feross changed the title Should standard be aware of Object Shorthand? Update docs to remove standard-format references Sep 10, 2016

@mgonzaleza

This comment has been minimized.

Copy link

commented Jan 9, 2017

@feross You already updated the doc for VIM on commit 4c82bc8. Looks good to close.

@feross

This comment has been minimized.

Copy link
Member

commented Jan 19, 2017

@mgonzaleza Thanks for pointing out. This issue can be closed now.

@feross feross closed this Jan 19, 2017

@lock lock bot locked as resolved and limited conversation to collaborators May 10, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
7 participants
You can’t perform that action at this time.