Skip to content

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

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

Merged
SanderElias merged 3 commits into from
Jul 14, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af2dcff
docs(docsWeb): add faq entry for plugin build error fix
msacket Jul 14, 2020
6cce7be
updated the snapshot
SanderElias Jul 14, 2020
9bdd9e4
Merge pull request #1 from SanderElias/patch-1
msacket Jul 14, 2020
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
19 changes: 19 additions & 0 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ~ * {
Expand Down
84 changes: 84 additions & 0 deletions tests/jest/src/__tests__/__snapshots__/docsThere.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down