From bd90ac50d9b1b42472aa32e70f0a41b3d9ec3338 Mon Sep 17 00:00:00 2001 From: Trevor Date: Mon, 25 Mar 2019 12:29:43 -0700 Subject: [PATCH 1/2] add section to readme to troubleshoot deasync --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 9d690a1..d7de0fc 100644 --- a/README.md +++ b/README.md @@ -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 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: From c751213d6a40a008124f125aea16f0c5c680ed8e Mon Sep 17 00:00:00 2001 From: Trevor Date: Mon, 25 Mar 2019 12:56:33 -0700 Subject: [PATCH 2/2] missing a couple words from non-save --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d7de0fc..4c6637e 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Alternatively, you can globally install the package and run directly from the co ### 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 during installation of this project. This has been known to create issues for some Windows users. +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: