docs(docsWeb): add faq entry for plugin build error fix (scullyio#741)

* docs(docsWeb): add faq entry for plugin build error fix * updated the snapshot Co-authored-by: Sander Elias <[email protected]>
burke-software · Jul 14, 2020 · 86899e7 · 86899e7
1 parent 8795116
commit 86899e7
Show file tree

Hide file tree

Showing 2 changed files with 103 additions and 0 deletions.
diff --git a/docs/faq.md b/docs/faq.md
@@ -98,6 +98,25 @@ registerPlugin(
 
 </details>
 
+<details>
+<summary>How do I fix plugin build errors related to the `express-serve-static-core` module?</summary>
+
+Building a plugin results in a fatal error `Cannot find module 'express-serve-static-core'`, originating from `node_modules/@scullyio/scully/lib/utils/serverstuff/staticServer.d.ts`
+
+To correct this, add the `skipLibCheck` and `skipDefaultLibCheck` flags to your `tsconfig.json` => `compilerOptions` like this:
+
+```json
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true
+  }
+}
+```
+
+</details>
+
 <style>
 
 details[open] summary ~ * {

diff --git a/tests/jest/src/__tests__/__snapshots__/docsThere.spec.ts.snap b/tests/jest/src/__tests__/__snapshots__/docsThere.spec.ts.snap
@@ -4811,6 +4811,90 @@ For example, if you want to ignore all undefined routes you can do:
                   </code>
                 </pre>
               </details>
+              <details ="">
+                <summary ="">
+                  How do I fix plugin build errors related to the \`express-serve-static-core\` module?
+                </summary>
+                <p ="">
+                  Building a plugin results in a fatal error
+                  <code ="">
+                    Cannot find module 'express-serve-static-core'
+                  </code>
+                  , originating from
+                  <code ="">
+                    node_modules/@scullyio/scully/lib/utils/serverstuff/staticServer.d.ts
+                  </code>
+                </p>
+                <p ="">
+                  To correct this, add the
+                  <code ="">
+                    skipLibCheck
+                  </code>
+                  and
+                  <code ="">
+                    skipDefaultLibCheck
+                  </code>
+                  flags to your
+                  <code ="">
+                    tsconfig.json
+                  </code>
+                  =&gt;
+                  <code ="">
+                    compilerOptions
+                  </code>
+                  like this:
+                </p>
+                <pre ="">
+                  <code class="language-json"
+                        =""
+                  >
+                    {
+                    <span class="hljs-attr"
+                          =""
+                    >
+                      "compileOnSave"
+                    </span>
+                    :
+                    <span class="hljs-literal"
+                          =""
+                    >
+                      false
+                    </span>
+                    ,
+                    <span class="hljs-attr"
+                          =""
+                    >
+                      "compilerOptions"
+                    </span>
+                    : {
+                    <span class="hljs-attr"
+                          =""
+                    >
+                      "skipLibCheck"
+                    </span>
+                    :
+                    <span class="hljs-literal"
+                          =""
+                    >
+                      true
+                    </span>
+                    ,
+                    <span class="hljs-attr"
+                          =""
+                    >
+                      "skipDefaultLibCheck"
+                    </span>
+                    :
+                    <span class="hljs-literal"
+                          =""
+                    >
+                      true
+                    </span>
+                    }
+}
+                  </code>
+                </pre>
+              </details>
               <style ="">
                 details[open] summary ~ * {
   animation: sweep .5s ease-in-out;