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.

Sign up for GitHub

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

Jump to bottom

add section to readme to troubleshoot deasync #43

Merged
merged 2 commits into from
Mar 25, 2019
Merged

add section to readme to troubleshoot deasync #43

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd90ac5
add section to readme to troubleshoot deasync
Mar 25, 2019
c751213
missing a couple words from non-save
Mar 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,19 @@ Update your project's unit testing script in package.json to execute `lwc-jest`:

Alternatively, you can globally install the package and run directly from the command line.

### Troubleshooting `deasync` Installation Errors

This project has a transitive dependency on `deasync` to compile Lightning web components during test runs. Depending on your operating system and Node version combination, `deasync` may attempt to compile C++ code during installation of this project. This has been known to create issues for some Windows users.
Copy link
Contributor

Choose a reason for hiding this comment

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

i would add a link to deasync


The most common solution on Windows is to globally install `windows-build-tools`. Run the following as administrator:

```bash
npm install --global --production windows-build-tools
```

If that does not work or you are on a different operating system, follow the instructions in the installation section of the `deasync` [README](https://github.com/abbr/deasync#installation).


## Updating .forceignore

After adding Jest tests, pushing your local files to a scratch org causes errors because the `__tests__` directory isn't recognized. To ignore these test files, add this entry to your `.forceignore` file:
Expand Down