chore: add instructions for overriding errors

Author: fsdiogo

src/tutorials/boilerplates/boilerplate-file-upload.vue

@@ -5,8 +5,7 @@
     :validate="validate"
     :modules="modules"
     :exercise="exercise"
-    lessonTitle="REPLACEME">
-  </FileLesson>
+    lessonTitle="REPLACEME" />
 </template>
 
 <script>
@@ -17,10 +16,24 @@ import exercise from './REPLACEME-exercise.md'
 
 const validate = async (result, ipfs) => {
   if (result) {
-    return {'success': 'Happy Message!'}
+    return { success: 'Happy Message!' }
   } else {
-    return {'fail': 'Sad but useful message :('}
+    return { fail: 'Sad but useful message :(' }
   }
+
+  /*
+    By default, if any external error occurs its output will be shown.
+    If you want to catch those erros and override them to show something
+    else to the users, add the following attribute in the FileLesson component:
+
+    <FileLesson :overrideErrors="true" ... />
+
+    Here in the `validate` function, add the folowing lines below the validation
+    if you enabled the overriding of errors:
+
+    // Output the default error if we haven't catched any
+    return { error: result.error }
+  */
 }
 
 const code = `const run = async (files) => {
@@ -29,16 +42,14 @@ const code = `const run = async (files) => {
 return run
 `
 
-const modules = {cids: require('cids')}
+const modules = { cids: require('cids') }
 
 export default {
   components: {
     Lesson
   },
   data: () => {
-    return {
-      text, validate, code, modules, exercise
-    }
+    return { text, validate, code, modules, exercise }
   }
 }
 </script>

src/tutorials/boilerplates/boilerplate-no-exercise.vue

@@ -1,8 +1,7 @@
 <template>
   <Lesson
     :text="text"
-    lessonTitle="REPLACEME">
-  </Lesson>
+    lessonTitle="REPLACEME" />
 </template>
 
 <script>
@@ -14,9 +13,7 @@ export default {
     Lesson
   },
   data: () => {
-    return {
-      text
-    }
+    return { text }
   }
 }
 </script>

src/tutorials/boilerplates/boilerplate-standard.vue

@@ -5,8 +5,7 @@
     :validate="validate"
     :modules="modules"
     :exercise="exercise"
-    lessonTitle="REPLACEME">
-  </Lesson>
+    lessonTitle="REPLACEME" />
 </template>
 
 <script>
@@ -16,10 +15,24 @@ import exercise from './REPLACEME-exercise.md'
 
 const validate = async (result, ipfs) => {
   if (result) {
-    return {'success': 'Happy Message!'}
+    return { success: 'Happy Message!' }
   } else {
-    return {'fail': 'Sad but useful message :('}
+    return { fail: 'Sad but useful message :(' }
   }
+
+  /*
+    By default, if any external error occurs its output will be shown.
+    If you want to catch those erros and override them to show something
+    else to the users, add the following attribute in the FileLesson component:
+
+    <FileLesson :overrideErrors="true" ... />
+
+    Here in the `validate` function, add the folowing lines below the validation
+    if you enabled the overriding of errors:
+
+    // Output the default error if we haven't catched any
+    return { error: result.error }
+  */
 }
 
 const code = `const CID = require('cids')
@@ -30,16 +43,14 @@ const run = async () => {
 return run
 `
 
-const modules = {cids: require('cids')}
+const modules = { cids: require('cids') }
 
 export default {
   components: {
     Lesson
   },
   data: () => {
-    return {
-      text, validate, code, modules
-    }
+    return { text, validate, code, modules }
   }
 }
 </script>