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

Troubleshoting section #1463

Merged
merged 5 commits into from
Mar 30, 2020
Merged

Troubleshoting section #1463

merged 5 commits into from
Mar 30, 2020

Conversation

mackignacio
Copy link
Contributor

@mackignacio mackignacio commented Mar 28, 2020

Changes

  • Add Troubleshooting section in README.md file
  • Add TROUBLESHOOTING.md

@coveralls
Copy link

coveralls commented Mar 28, 2020

Pull Request Test Coverage Report for Build 4253

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 93.009%

Totals Coverage Status
Change from base Build 4252: 0.0%
Covered Lines: 1128
Relevant Lines: 1165

💛 - Coveralls

README.md Outdated Show resolved Hide resolved
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 |
Copy link
Collaborator

Choose a reason for hiding this comment

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

same as above

Copy link
Contributor Author

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
Copy link
Collaborator

Choose a reason for hiding this comment

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

same as above

Copy link
Contributor Author

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)
Copy link
Collaborator

Choose a reason for hiding this comment

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

same as above

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Auto-formatted also.

}
```

- Check if module name is properly mapped and can be referenced by jest. If not add this on your existing jest configuration.
Copy link
Collaborator

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.

Copy link
Contributor Author

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.

module.exports = {
...
moduleNameMapper: {
"^.*shared/(.*)": "<rootDir>/src/shared/$1",
Copy link
Collaborator

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>"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok got it.

@@ -0,0 +1,43 @@
# Troubleshooting

This serves as a troubleshooting guide for any ts-jest related issues.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: ts-jest :)

Copy link
Contributor Author

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.

@ahnpnl
Copy link
Collaborator

ahnpnl commented Mar 29, 2020

Hi @mackignacio , would you please change your PR to only contain the new TROUBLESHOOTING.md file + uncomment the troubleshooting line.

<!--
[<img src="./docs/assets/img/troubleshooting.png" align="left" height="24"> Before reporting any issue, be sure to check the troubleshooting page](https://kulshekhar.github.io/ts-jest/user/troubleshooting)
-->

@mackignacio
Copy link
Contributor Author

@ahnpnl I already applied the changes on the reviews.

Copy link
Collaborator

@ahnpnl ahnpnl left a comment

Choose a reason for hiding this comment

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

thanks LGTM 👍

@ahnpnl ahnpnl requested a review from kulshekhar March 29, 2020 16:33
@ahnpnl ahnpnl merged commit b8ebf36 into kulshekhar:master Mar 30, 2020
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.

4 participants