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

BREAKING: rename the syncronous lintText method to lintTextSync #159

Merged
merged 1 commit into from
Apr 4, 2017

Conversation

feross
Copy link
Member

@feross feross commented Apr 4, 2017

Fixes: standard/standard#807

  • BREAKING: rename the synchronous lintText method to lintTextSync
  • Add an asyncronous lintText method (that just calls lintTextSync
    internally)

This effectively undoes the breaking change introduced in 6.0.0, making it safe to upgrade from standard-engine 5.x to 7.x without introducing any breaking changes.

But we also keep the new option to lint source text synchronously, just under a new lintTextSync() method. This is better than overloading lintText to behave differently depending on whether a callback is passed in or not, IMO.

Related: #156

Fixes: standard/standard#807

- BREAKING: rename the syncronous `lintText` method to `lintTextSync`
- Add an asyncronous `lintText` method (that just calls `lintTextSync`
internally)

This effectively undoes the breaking change introduced in 6.0.0, making
it safe to
upgrade from `standard-engine` 5.x to 7.x without introducing any
breaking changes.

Related: #156
@feross feross requested a review from Flet April 4, 2017 16:45
@feross
Copy link
Member Author

feross commented Apr 4, 2017

Also, @Flet, looks like @bcomnes is not a collaborator on this repo. Want to add him?

@Flet
Copy link
Member

Flet commented Apr 4, 2017

Invited @bcomnes to the repo

@feross
Copy link
Member Author

feross commented Apr 4, 2017

@Flet By the way, the context for this is that I want to upgrade from 5.x to 7.x in the standard 10.0.0 release but I don't want to break any of the editor plugins.

@feross feross merged commit f6b7049 into master Apr 4, 2017
@feross feross deleted the feross/lint-text branch April 4, 2017 16:56
@Flet
Copy link
Member

Flet commented Apr 4, 2017

@feross makes a ton of sense! Thanks!

@bcomnes
Copy link
Member

bcomnes commented Apr 4, 2017

lgtm!

@feross
Copy link
Member Author

feross commented Apr 4, 2017

7.0.0

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

Successfully merging this pull request may close these issues.

What is the effect of making lintText synchronous?
3 participants