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 README.md #7140

Merged
merged 6 commits into from
Jan 3, 2018
Merged

Update README.md #7140

merged 6 commits into from
Jan 3, 2018

Conversation

eladchen
Copy link
Contributor

@eladchen eladchen commented Jan 1, 2018

The previous version of the api allowed passing ignore option as a function, which now can only be an array of regex / functions.

The current docs are somewhat ambiguous with regards to this breaking change.
Anyway I did some editing, let me know if this is ok with you guys.

[skip ci]

The previous version of the api allowed passing ignore options as a function, which now can only be an array of regex / functions.

The current docs are somewhat ambiguous with regards to this breaking change.
Anyway I did some editing, let me know if this is ok with you guys.
@babel-bot
Copy link
Collaborator

babel-bot commented Jan 1, 2018

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/6421/

@babel-bot
Copy link
Collaborator

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/6399/

@Qantas94Heavy Qantas94Heavy added the PR: Docs 📝 A type of pull request used for our changelog categories label Jan 1, 2018
if (filename === "/path/to/es6-file.js") {
return false;
} else {
// Optional ignore array
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe you could add something to make it clear that the file will be ignored if it matches any of the ignore entries?

Copy link
Contributor Author

@eladchen eladchen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Qantas94Heavy Let me know if that works.

} else {
// Array of ignore conditions ( Optional )
// A condition can be either a regex, or a function.
// When a file path **matchs** this regex then then it is **not** compiled.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

// When a file path matches this regex then it is not compiled.

if (filename === "/path/to/es6-file.js") {
return false;
} else {
// Array of ignore conditions ( Optional )
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit remove spaces surrounding Optional

return true;
}
}],
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's fix this indention

@existentialism
Copy link
Member

@eladchen thanks for the PR!

@existentialism existentialism merged commit 82c6ca2 into babel:master Jan 3, 2018
@eladchen
Copy link
Contributor Author

eladchen commented Jan 3, 2018

@existentialism My pleasure.

@lock lock bot added the outdated A closed issue/PR that is archived due to age. Recommended to make a new issue label Oct 5, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Oct 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated A closed issue/PR that is archived due to age. Recommended to make a new issue pkg: register PR: Docs 📝 A type of pull request used for our changelog categories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants