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

Add introduce about "useBabelrc" and ES import #270

Merged
merged 3 commits into from
Jul 17, 2017

Conversation

whitetrefoil
Copy link
Contributor

See #265

README.md Outdated
```

Notice, by default `ts-jest` will not use project .babelrc, so `"useBabelrc": true` must be set.
```json
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there's no need to repeat this code snippet again. We can reference the main one here IMO.

Copy link
Contributor

@morajabi morajabi left a comment

Choose a reason for hiding this comment

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

I think it's OK.

@morajabi morajabi merged commit 7924a5d into kulshekhar:master Jul 17, 2017
@whitetrefoil
Copy link
Contributor Author

Just FYI, I added the second section because this problem seems only exist when using ts-jest. Without ts-jest the project's. babelrc will be used so as long as the project can be built the tests can be run. But when ts-jest is used, the tests will fail even the code can be built, and the error message just helps nothing. This may confuse newbies.

And so sorry for my English skill, I should be more careful when writing documents since I'm not a native English speaker.

@kulshekhar
Copy link
Owner

kulshekhar commented Jul 17, 2017

Just FYI, I added the second section because this problem seems only exist when using ts-jest. Without ts-jest the project's. babelrc will be used so as long as the project can be built the tests can be run. But when ts-jest is used, the tests will fail even the code can be built, and the error message just helps nothing. This may confuse newbies.

The first section addresses this issue. The configuration details for .babelrc aren't specific to ts-jest. Including documentation for that here could be more confusing, for example, when something babel specific changes.

Currently, anyone who wants to use a custom .babelrc can refer to the babel documentation to see how to do it. That documentation is more likely to be more accurate over a period of time.

And so sorry for my English skill, I should be more careful when writing documents since I'm not a native English speaker.

We really appreciate all contributions so don't worry about this 😄. English isn't the first language for a lot of us so we understand!

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.

3 participants