-
Notifications
You must be signed in to change notification settings - Fork 455
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
Troubleshoting section #1463
Troubleshoting section #1463
Conversation
Pull Request Test Coverage Report for Build 4253
💛 - Coveralls |
README.md
Outdated
| **Installing** | `npm i -D ts-jest @types/jest` | `yarn add --dev ts-jest @types/jest` | | ||
| **Creating config** | `npx ts-jest config:init` | `yarn ts-jest config:init` | | ||
| **Running tests** | `npm t` or `npx jest` | `yarn test` or `yarn jest` | | ||
| | using npm | using yarn | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Auto-formatted also.
README.md
Outdated
* [TypeScript](https://www.typescriptlang.org/) - JavaScript that scales | ||
* [Jest](https://jestjs.io/) - Delightful JavaScript Testing | ||
* [`ts-jest`](https://kulshekhar.github.io/ts-jest) - Jest processor for TypeScript _(yes, `ts-jest` uses itself for its tests)_ | ||
- [TypeScript](https://www.typescriptlang.org/) - JavaScript that scales |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Auto-formatted also.
README.md
Outdated
* **Gustav Wengel** - [GeeWee](https://github.com/GeeWee) | ||
* **Ahn** - [ahnpnl](https://github.com/ahnpnl) | ||
* **Huafu Gandon** - [huafu](https://github.com/huafu) | ||
- **Kulshekhar Kabra** - [kulshekhar](https://github.com/kulshekhar) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Auto-formatted also.
TROUBLESHOOTING.md
Outdated
} | ||
``` | ||
|
||
- Check if module name is properly mapped and can be referenced by jest. If not add this on your existing jest configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we can change the text to Check if module name is properly mapped and can be referenced by jest. If not, you can define
moduleNameMapper for your jest configuration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok I will change this line.
TROUBLESHOOTING.md
Outdated
module.exports = { | ||
... | ||
moduleNameMapper: { | ||
"^.*shared/(.*)": "<rootDir>/src/shared/$1", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we use placeholder example here, something like "<import-path>": "<rootDir>/<real-physical-path>"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok got it.
TROUBLESHOOTING.md
Outdated
@@ -0,0 +1,43 @@ | |||
# Troubleshooting | |||
|
|||
This serves as a troubleshooting guide for any ts-jest related issues. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: ts-jest
:)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok I will remove this line.
Hi @mackignacio , would you please change your PR to only contain the new
|
@ahnpnl I already applied the changes on the reviews. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks LGTM 👍
Changes
Troubleshooting
section in README.md file