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.

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

fix: more readable and usable error message when a render error occurs #154

Merged
merged 2 commits into from
Jan 29, 2025

Conversation

ext
Copy link
Contributor

@ext ext commented Jan 29, 2025

Den här ändringen gör inget mer än att göra fel från rendering mer begripliga genom att ta bort allt brus. Man ser inte längre vilken mall (och vilken rad/kolumn i mallen) men personligen tycker jag det är irrelevant (men ni behöver inte hålla med)

Från:

When running processor "nunjucks-renderer":
Error: Failed to render "docs/functions/cypress/pageobjects/FProgressbarPageObject/FProgressbarPageObject-progress-status.md": (/path/to/project/node_modules/@forsakringskassan/docs-generator/templates/article.template.html) [Line 8, Column 3]
  Error: Errors occured when trying to parse docs/functions/cypress/pageobjects/FProgressbarPageObject/FProgressbarPageObject-progress-status.vue.
    at render (/path/to/project/node_modules/@forsakringskassan/docs-generator/dist/index.js:2020:11)
    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
    at async Object.handler (/path/to/project/node_modules/@forsakringskassan/docs-generator/dist/index.js:2101:28)
    at async stage (/path/to/project/node_modules/@forsakringskassan/docs-generator/dist/index.js:2380:22)
    at async Generator.build (/path/to/project/node_modules/@forsakringskassan/docs-generator/dist/index.js:2622:7)
    at async file:///path/to/project/generate-docs.mjs:160:5 {
  [cause]: Template render error: (/path/to/project/node_modules/@forsakringskassan/docs-generator/templates/article.template.html) [Line 8, Column 3]
    Error: Errors occured when trying to parse docs/functions/cypress/pageobjects/FProgressbarPageObject/FProgressbarPageObject-progress-status.vue.
      at Object._prettifyError (/path/to/project/node_modules/nunjucks/src/lib.js:32:11)
      at /path/to/project/node_modules/nunjucks/src/environment.js:464:19
      at eval (eval at _compile (/path/to/project/node_modules/nunjucks/src/environment.js:527:18), <anonymous>:199:12)
      at b_content (eval at _compile (/path/to/project/node_modules/nunjucks/src/environment.js:527:18), <anonymous>:69:3)
      at eval (eval at _compile (/path/to/project/node_modules/nunjucks/src/environment.js:527:18), <anonymous>:198:86)
      at b_sidenav (eval at _compile (/path/to/project/node_modules/nunjucks/src/environment.js:527:18), <anonymous>:53:1)
      at eval (eval at _compile (/path/to/project/node_modules/nunjucks/src/environment.js:527:18), <anonymous>:104:86)
      at eval (eval at _compile (/path/to/project/node_modules/nunjucks/src/environment.js:527:18), <anonymous>:100:1)
      at fn (/path/to/project/node_modules/a-sync-waterfall/index.js:26:24)
      at /path/to/project/node_modules/a-sync-waterfall/index.js:66:22

Till:

When running processor "nunjucks-renderer":
An error occured when rendering a document.
  Document: "docs/functions/cypress/pageobjects/FProgressbarPageObject/FProgressbarPageObject-progress-status.md".
  Message: Errors occured when trying to parse docs/functions/cypress/pageobjects/FProgressbarPageObject/FProgressbarPageObject-progress-status.vue.

EDIT:

La även till att vi visar ursprungsfelet när Vue's compiler inte kan parsa filen så ovan blir då:

When running processor "nunjucks-renderer":
An error occured when rendering a document.
  Document: "docs/functions/cypress/pageobjects/FProgressbarPageObject/FProgressbarPageObject-progress-status.md".
  Message: Errors occured when trying to parse "docs/functions/cypress/pageobjects/FProgressbarPageObject/FProgressbarPageObject-progress-status.vue": At least one <template> or <script> is required in a single file component. docs/functions/cypress/pageobjects/FProgressbarPageObject/FProgressbarPageObject-progress-status.vue

Nu innehåller alltså Vue's Error också filnamnet i slutet så lite kaka på kaka men vet inte om det är värt att massera bort det? Eller det är väl bara en string replace men jag vet inte. Åsikter?

Copy link

github-actions bot commented Jan 29, 2025

PR Preview Action v1.6.0
Preview removed because the pull request was closed.
2025-01-29 18:28 UTC

@ext ext requested a review from mitra-Re January 29, 2025 13:37
@Ivette-FK
Copy link

För min del blev detta tydligare och enklare att förstå än hur det var från början. Även om det är lite kaka på kaka med filnamnet i slutet så tycker jag att det är bättre.

@ext ext merged commit 0097db7 into main Jan 29, 2025
14 checks passed
@ext ext deleted the feature/pretty-nunjucks-error branch January 29, 2025 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants