Skip to content

Commit

Permalink
add section to readme to troubleshoot deasync (#43)
Browse files Browse the repository at this point in the history
* add section to readme to troubleshoot deasync

* missing a couple words from non-save
  • Loading branch information
Trevor authored Mar 25, 2019
1 parent 14f0116 commit 233aeef
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
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.

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

0 comments on commit 233aeef

Please sign in to comment.