@learnpack/learnpack 5.0.21 → 5.0.22

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.21 win32-x64 node-v20.16.0
+@learnpack/learnpack/5.0.22 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -75,7 +75,7 @@ DESCRIPTION
        12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 ```
 
-_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -90,7 +90,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -108,7 +108,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -140,7 +140,7 @@ OPTIONS
   -y, --yes      Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -158,7 +158,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -176,7 +176,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -307,7 +307,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -329,7 +329,7 @@ OPTIONS
   -y, --yes                           Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -346,7 +346,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -360,7 +360,7 @@ OPTIONS
   -y, --yes  Skip all prompts and initialize an empty project
 ```
 
-_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.21/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.22/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/utils/audit.d.ts

@@ -9,7 +9,7 @@ declare const _default: {
     checkLearnpackClean: (configObj: IConfigObj, errors: IAuditErrors[]) => void;
     findInFile: (types: string[], content: string) => IFindings;
     checkUrl: (config: IConfigObj, filePath: string, fileName: string, exercise: IExercise | undefined, errors: IAuditErrors[], warnings: IAuditErrors[], counter: ICounter | undefined) => Promise<boolean>;
-    writeFile: (content: string, filePath: string) => Promise<void>;
+    writeFile: (filePath: string, content: string) => void;
     showErrors: (errors: IAuditErrors[], counter: ICounter | undefined) => Promise<unknown>;
     showWarnings: (warnings: IAuditErrors[]) => Promise<unknown>;
 };

package/lib/utils/audit.js

@@ -1,8 +1,8 @@
 "use strict";
+/* eslint-disable no-await-in-loop, @typescript-eslint/no-non-null-asserted-optional-chain, no-promise-executor-return */
 Object.defineProperty(exports, "__esModule", { value: true });
 const console_1 = require("./console");
 const fs = require("fs");
-const path = require("path");
 // eslint-disable-next-line
 const fetch = require("node-fetch");
 // eslint-disable-next-line
@@ -92,9 +92,34 @@ const findInFile = (types, content) => {
     }
     return findings;
 };
-// This function checks that each of the url's are working.
+const checkLinkWithRetry = async (url, retries = 3, delay = 1000) => {
+    for (let attempt = 1; attempt <= retries; attempt++) {
+        try {
+            let res = await fetch(url, { method: "HEAD" });
+            if (res.status === 429) {
+                await new Promise(resolve => setTimeout(resolve, delay));
+                delay *= 2; // Exponential backoff
+                continue;
+            }
+            if (res.status === 403) {
+                return { isValid: false, status: 403 };
+            }
+            if (!res.ok) {
+                res = await fetch(url, { method: "GET" });
+                if (!res.ok) {
+                    return { isValid: false, status: res.status };
+                }
+            }
+            return { isValid: true };
+        }
+        catch (error) {
+            console.debug(`Error checking link ${url}:`, error);
+            return { isValid: false, status: 429 };
+        }
+    }
+    return { isValid: false, status: 429 };
+};
 const checkUrl = async (config, filePath, fileName, exercise, errors, warnings, counter) => {
-    var _a, _b, _c, _d;
     if (!fs.existsSync(filePath))
         return false;
     const content = fs.readFileSync(filePath).toString();
@@ -109,95 +134,51 @@ const checkUrl = async (config, filePath, fileName, exercise, errors, warnings,
         if (Object.prototype.hasOwnProperty.call(frontmatter.attributes, attribute) &&
             (attribute === "intro" || attribute === "tutorial")) {
             counter && counter.links.total++;
-            try {
-                // eslint-disable-next-line
-                let res = await fetch(frontmatter.attributes[attribute], {
-                    method: "HEAD",
-                });
-                if (!res.ok) {
+            const url = frontmatter.attributes[attribute];
+            const { isValid, status } = await checkLinkWithRetry(url);
+            if (!isValid) {
+                if (status === 429 || status === 403) {
+                    warnings.push({
+                        exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
+                        msg: `Warning: This link might be temporarily inaccessible (${status}): ${url}`,
+                    });
+                }
+                else {
                     counter && counter.links.error++;
                     errors.push({
                         exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                        msg: `This link is broken (${res.ok}): ${frontmatter.attributes[attribute]}`,
+                        msg: `This link is broken: ${url}`,
                     });
                 }
             }
-            catch (_e) {
-                counter && counter.links.error++;
-                errors.push({
-                    exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                    msg: `This link is broken: ${frontmatter.attributes[attribute]}`,
-                });
-            }
         }
     }
-    // Check url's of each README file.
+    // Check URLs in README files
     const findings = findInFile(["relativeImages", "externalImages", "markdownLinks"], content);
     for (const finding in findings) {
         if (Object.prototype.hasOwnProperty.call(findings, finding)) {
             const obj = findings[finding];
-            // Valdites all the relative path images.
-            if (finding === "relativeImages" && Object.keys(obj).length > 0) {
-                for (const img in obj) {
-                    if (Object.prototype.hasOwnProperty.call(obj, img)) {
-                        // Validates if the image is in the assets folder.
-                        counter && counter.images.total++;
-                        const relativePath = path
-                            .relative(exercise ? exercise.path.replace(/\\/gm, "/") : "./", `${(_a = config.config) === null || _a === void 0 ? void 0 : _a.dirPath}/assets/${obj[img].relUrl}`)
-                            .replace(/\\/gm, "/");
-                        if (relativePath !== obj[img].absUrl.split("?").shift()) {
-                            counter && counter.images.error++;
-                            errors.push({
-                                exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                msg: `This relative path (${obj[img].relUrl}) is not pointing to the assets folder.`,
-                            });
-                        }
-                        if (!fs.existsSync(`${(_b = config.config) === null || _b === void 0 ? void 0 : _b.dirPath}/assets/${obj[img].relUrl}`)) {
-                            counter && counter.images.error++;
-                            errors.push({
-                                exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                msg: `The file ${obj[img].relUrl} doesn't exist in the assets folder.`,
-                            });
-                        }
-                    }
-                }
-            }
-            else if (finding === "externalImages" && Object.keys(obj).length > 0) {
-                // Valdites all the aboslute path images.
+            if (finding === "externalImages" && Object.keys(obj).length > 0) {
                 for (const img in obj) {
                     if (Object.prototype.hasOwnProperty.call(obj, img)) {
                         counter && counter.images.total++;
-                        if (fs.existsSync(`${(_c = config.config) === null || _c === void 0 ? void 0 : _c.dirPath}/assets${obj[img].mdUrl
-                            .split("?")
-                            .shift()}`)) {
-                            const relativePath = path
-                                .relative(exercise ? exercise.path.replace(/\\/gm, "/") : "./", `${(_d = config.config) === null || _d === void 0 ? void 0 : _d.dirPath}/assets/${obj[img].mdUrl}`)
-                                .replace(/\\/gm, "/");
-                            warnings.push({
-                                exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                msg: `On this exercise you have an image with an absolute path "${obj[img].absUrl}". We recommend you to replace it by the relative path: "${relativePath}".`,
-                            });
-                        }
-                        try {
-                            // eslint-disable-next-line
-                            let res = await fetch(obj[img].absUrl, {
-                                method: "HEAD",
-                            });
-                            if (!res.ok) {
+                        const url = obj[img].absUrl;
+                        const { isValid, status } = await checkLinkWithRetry(url);
+                        if (!isValid) {
+                            if (status === 429 || status === 403) {
+                                warnings.push({
+                                    exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
+                                    msg: `Warning: This image link might be temporarily inaccessible (${status}): ${url}`,
+                                });
+                            }
+                            else {
                                 counter && counter.images.error++;
                                 errors.push({
                                     exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                    msg: `This link is broken: ${obj[img].absUrl}`,
+                                    msg: `This image link is broken: ${url}`,
                                 });
                             }
                         }
-                        catch (_f) {
-                            counter && counter.images.error++;
-                            errors.push({
-                                exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                msg: `This link is broken: ${obj[img].absUrl}`,
-                            });
-                        }
                     }
                 }
             }
@@ -205,27 +186,24 @@ const checkUrl = async (config, filePath, fileName, exercise, errors, warnings,
                 for (const link in obj) {
                     if (Object.prototype.hasOwnProperty.call(obj, link)) {
                         counter && counter.links.total++;
-                        if (!obj[link].mdUrl.includes("twitter")) {
-                            try {
-                                // eslint-disable-next-line
-                                let res = await fetch(obj[link].mdUrl, {
-                                    method: "HEAD",
-                                });
-                                if (res.status > 399 && res.status < 500) {
+                        const url = obj[link].mdUrl;
+                        if (!url.includes("twitter")) {
+                            const { isValid, status } = await checkLinkWithRetry(url);
+                            if (!isValid) {
+                                if (status === 429 || status === 403) {
+                                    warnings.push({
+                                        exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
+                                        msg: `Warning: This markdown link might be temporarily inaccessible (${status}): ${url}`,
+                                    });
+                                }
+                                else {
                                     counter && counter.links.error++;
                                     errors.push({
                                         exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                        msg: `This link is broken: ${obj[link].mdUrl}`,
+                                        msg: `This markdown link is broken: ${url}`,
                                     });
                                 }
                             }
-                            catch (_g) {
-                                counter && counter.links.error++;
-                                errors.push({
-                                    exercise: exercise === null || exercise === void 0 ? void 0 : exercise.title,
-                                    msg: `This link is broken: ${obj[link].mdUrl}`,
-                                });
-                            }
                         }
                     }
                 }
@@ -234,10 +212,10 @@ const checkUrl = async (config, filePath, fileName, exercise, errors, warnings,
     }
     return true;
 };
-// This function writes a given file with the given content.
-const writeFile = async (content, filePath) => {
+// This function writes a file in the given path.
+const writeFile = (filePath, content) => {
     try {
-        await fs.promises.writeFile(filePath, content);
+        fs.writeFileSync(filePath, content);
     }
     catch (error) {
         if (error)

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.21","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[]}}}
+{"version":"5.0.22","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[preview, extension]","options":["extension","preview"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Skip all prompts and initialize an empty project","allowNo":false}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Seamlessly build, sell and/or take interactive & auto-graded tutorials, start learning now or build a new tutorial to your audience.",
-  "version": "5.0.21",
+  "version": "5.0.22",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/utils/audit.ts

@@ -1,393 +1,372 @@
-import { IAuditErrors } from "../models/audit"
-import { IConfigObj } from "../models/config"
-import { ICounter } from "../models/counter"
-import { IFindings } from "../models/findings"
-import { IExercise } from "../models/exercise-obj"
-import { IFrontmatter } from "../models/front-matter"
-import Console from "./console"
-import * as fs from "fs"
-import * as path from "path"
-
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-// eslint-disable-next-line
-const fm = require("front-matter");
-
-// This function checks if a url is valid.
-const isUrl = async (
-  url: string,
-  errors: IAuditErrors[],
-  counter: ICounter
-) => {
-  const regexUrl = /(https?:\/\/[\w./-]+)/gm
-  counter.links.total++
-  if (!regexUrl.test(url)) {
-    counter.links.error++
-    errors.push({
-      exercise: undefined,
-      msg: `The repository value of the configuration file is not a link: ${url}`,
-    })
-    return false
-  }
-
-  const res = await fetch(url, { method: "HEAD" })
-  if (!res.ok) {
-    counter.links.error++
-    errors.push({
-      exercise: undefined,
-      msg: `The link of the repository is broken: ${url}`,
-    })
-  }
-
-  return true
-}
-
-const checkForEmptySpaces = (str: string) => {
-  const isEmpty = true
-  for (const letter of str) {
-    if (letter !== " ") {
-      return false
-    }
-  }
-
-  return isEmpty
-}
-
-const checkLearnpackClean = (configObj: IConfigObj, errors: IAuditErrors[]) => {
-  if (
-    (configObj.config?.outputPath &&
-      fs.existsSync(configObj.config?.outputPath)) ||
-    fs.existsSync(`${configObj.config?.dirPath}/_app`) ||
-    fs.existsSync(`${configObj.config?.dirPath}/reports`) ||
-    fs.existsSync(`${configObj.config?.dirPath}/resets`) ||
-    fs.existsSync(`${configObj.config?.dirPath}/app.tar.gz`) ||
-    fs.existsSync(`${configObj.config?.dirPath}/config.json`) ||
-    fs.existsSync(`${configObj.config?.dirPath}/vscode_queue.json`) ||
-    fs.existsSync(`${configObj.config?.dirPath}/telemetry.json`)
-  ) {
-    errors.push({
-      exercise: undefined,
-      msg: "You have to run learnpack clean command",
-    })
-  }
-}
-
-const findInFile = (types: string[], content: string) => {
-  const regex: any = {
-    relativeImages:
-      /!\[.*]\s*\((((\.\/)?(\.{2}\/){1,5})(.*\/)*(.[^\s/]*\.[A-Za-z]{2,4})\S*)\)/gm,
-    externalImages: /!\[.*]\((https?:\/(\/[^)/]+)+\/?)\)/gm,
-    markdownLinks: /(\s)+\[.*]\((https?:\/(\/[^)/]+)+\/?)\)/gm,
-    url: /(https?:\/\/[\w./-]+)/gm,
-    uploadcare: /https:\/\/ucarecdn.com\/(?:.*\/)*([\w./-]+)/gm,
-  }
-
-  const validTypes = Object.keys(regex)
-  if (!Array.isArray(types)) 
-types = [types]
-
-  const findings: IFindings = {}
-  type findingsType =
-    | "relativeImages"
-    | "externalImages"
-    | "markdownLinks"
-    | "url"
-    | "uploadcare";
-
-  for (const type of types) {
-    if (!validTypes.includes(type)) 
-throw new Error("Invalid type: " + type)
-    else 
-findings[type as findingsType] = {}
-  }
-
-  for (const type of types) {
-    let m: RegExpExecArray
-    while ((m = regex[type].exec(content)) !== null) {
-      // This is necessary to avoid infinite loops with zero-width matches
-      if (m.index === regex.lastIndex) {
-        regex.lastIndex++
-      }
-
-      // The result can be accessed through the `m`-variable.
-      // m.forEach((match, groupIndex) => values.push(match));
-
-      findings[type as findingsType]![m[0]] = {
-        content: m[0],
-        absUrl: m[1],
-        mdUrl: m[2],
-        relUrl: m[6],
-      }
-    }
-  }
-
-  return findings
-}
-
-// This function checks that each of the url's are working.
-const checkUrl = async (
-  config: IConfigObj,
-  filePath: string,
-  fileName: string,
-  exercise: IExercise | undefined,
-  errors: IAuditErrors[],
-  warnings: IAuditErrors[],
-  counter: ICounter | undefined
-) => {
-  if (!fs.existsSync(filePath)) 
-return false
-  const content: string = fs.readFileSync(filePath).toString()
-  const isEmpty = checkForEmptySpaces(content)
-  if (isEmpty || !content)
-    errors.push({
-      exercise: exercise?.title!,
-      msg: `This file (${fileName}) doesn't have any content inside.`,
-    })
-
-  const frontmatter: IFrontmatter = fm(content)
-  for (const attribute in frontmatter.attributes) {
-    if (
-      Object.prototype.hasOwnProperty.call(frontmatter.attributes, attribute) &&
-      (attribute === "intro" || attribute === "tutorial")
-    ) {
-      counter && counter.links.total++
-      try {
-        // eslint-disable-next-line
-        let res = await fetch(frontmatter.attributes[attribute], {
-          method: "HEAD",
-        })
-        if (!res.ok) {
-          counter && counter.links.error++
-          errors.push({
-            exercise: exercise?.title!,
-            msg: `This link is broken (${res.ok}): ${frontmatter.attributes[attribute]}`,
-          })
-        }
-      } catch {
-        counter && counter.links.error++
-        errors.push({
-          exercise: exercise?.title,
-          msg: `This link is broken: ${frontmatter.attributes[attribute]}`,
-        })
-      }
-    }
-  }
-
-  // Check url's of each README file.
-  const findings: IFindings = findInFile(
-    ["relativeImages", "externalImages", "markdownLinks"],
-    content
-  )
-  type findingsType =
-    | "relativeImages"
-    | "externalImages"
-    | "markdownLinks"
-    | "url"
-    | "uploadcare";
-  for (const finding in findings) {
-    if (Object.prototype.hasOwnProperty.call(findings, finding)) {
-      const obj = findings[finding as findingsType]
-      // Valdites all the relative path images.
-      if (finding === "relativeImages" && Object.keys(obj!).length > 0) {
-        for (const img in obj) {
-          if (Object.prototype.hasOwnProperty.call(obj, img)) {
-            // Validates if the image is in the assets folder.
-            counter && counter.images.total++
-            const relativePath = path
-              .relative(
-                exercise ? exercise.path.replace(/\\/gm, "/") : "./",
-                `${config!.config?.dirPath}/assets/${obj[img].relUrl}`
-              )
-              .replace(/\\/gm, "/")
-            if (relativePath !== obj[img].absUrl.split("?").shift()) {
-              counter && counter.images.error++
-              errors.push({
-                exercise: exercise?.title,
-                msg: `This relative path (${obj[img].relUrl}) is not pointing to the assets folder.`,
-              })
-            }
-
-            if (
-              !fs.existsSync(
-                `${config!.config?.dirPath}/assets/${obj[img].relUrl}`
-              )
-            ) {
-              counter && counter.images.error++
-              errors.push({
-                exercise: exercise?.title,
-                msg: `The file ${obj[img].relUrl} doesn't exist in the assets folder.`,
-              })
-            }
-          }
-        }
-      } else if (finding === "externalImages" && Object.keys(obj!).length > 0) {
-        // Valdites all the aboslute path images.
-        for (const img in obj) {
-          if (Object.prototype.hasOwnProperty.call(obj, img)) {
-            counter && counter.images.total++
-            if (
-              fs.existsSync(
-                `${config!.config?.dirPath}/assets${obj[img].mdUrl
-                  .split("?")
-                  .shift()}`
-              )
-            ) {
-              const relativePath = path
-                .relative(
-                  exercise ? exercise.path.replace(/\\/gm, "/") : "./",
-                  `${config!.config?.dirPath}/assets/${obj[img].mdUrl}`
-                )
-                .replace(/\\/gm, "/")
-              warnings.push({
-                exercise: exercise?.title,
-                msg: `On this exercise you have an image with an absolute path "${obj[img].absUrl}". We recommend you to replace it by the relative path: "${relativePath}".`,
-              })
-            }
-
-            try {
-              // eslint-disable-next-line
-              let res = await fetch(obj[img].absUrl, {
-                method: "HEAD",
-              })
-              if (!res.ok) {
-                counter && counter.images.error++
-                errors.push({
-                  exercise: exercise?.title,
-                  msg: `This link is broken: ${obj[img].absUrl}`,
-                })
-              }
-            } catch {
-              counter && counter.images.error++
-              errors.push({
-                exercise: exercise?.title,
-                msg: `This link is broken: ${obj[img].absUrl}`,
-              })
-            }
-          }
-        }
-      } else if (finding === "markdownLinks" && Object.keys(obj!).length > 0) {
-        for (const link in obj) {
-          if (Object.prototype.hasOwnProperty.call(obj, link)) {
-            counter && counter.links.total++
-            if (!obj[link].mdUrl.includes("twitter")) {
-              try {
-                // eslint-disable-next-line
-                let res = await fetch(obj[link].mdUrl, {
-                  method: "HEAD",
-                })
-                if (res.status > 399 && res.status < 500) {
-                  counter && counter.links.error++
-                  errors.push({
-                    exercise: exercise?.title,
-                    msg: `This link is broken: ${obj[link].mdUrl}`,
-                  })
-                }
-              } catch {
-                counter && counter.links.error++
-                errors.push({
-                  exercise: exercise?.title,
-                  msg: `This link is broken: ${obj[link].mdUrl}`,
-                })
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-
-  return true
-}
-
-// This function writes a given file with the given content.
-const writeFile = async (content: string, filePath: string) => {
-  try {
-    await fs.promises.writeFile(filePath, content)
-  } catch (error) {
-    if (error)
-      Console.error(
-        `We weren't able to write the file in this path "${filePath}".`,
-        error
-      )
-  }
-}
-
-// This function checks if there are errors, and show them in the console at the end.
-const showErrors = (errors: IAuditErrors[], counter: ICounter | undefined) => {
-  return new Promise((resolve, reject) => {
-    if (errors) {
-      if (errors.length > 0) {
-        Console.log("Checking for errors...")
-        for (const [i, error] of errors.entries())
-          Console.error(
-            `${i + 1}) ${error.msg} ${
-              error.exercise ? `(Exercise: ${error.exercise})` : ""
-            }`
-          )
-        if (counter) {
-          Console.error(
-            ` We found ${errors.length} error${
-              errors.length > 1 ? "s" : ""
-            } among ${counter.images.total} images, ${
-              counter.links.total
-            } link, ${counter.readmeFiles} README files and ${
-              counter.exercises
-            } exercises.`
-          )
-        } else {
-          Console.error(
-            ` We found ${errors.length} error${
-              errors.length > 1 ? "s" : ""
-            } related with the project integrity.`
-          )
-        }
-
-        process.exit(1)
-      } else {
-        if (counter) {
-          Console.success(
-            `We didn't find any errors in this repository among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`
-          )
-        } else {
-          Console.success(`We didn't find any errors in this repository.`)
-        }
-
-        process.exit(0)
-      }
-    } else {
-      reject("Failed")
-    }
-  })
-}
-
-// This function checks if there are warnings, and show them in the console at the end.
-const showWarnings = (warnings: IAuditErrors[]) => {
-  return new Promise((resolve, reject) => {
-    if (warnings) {
-      if (warnings.length > 0) {
-        Console.log("Checking for warnings...")
-        for (const [i, warning] of warnings.entries())
-          Console.warning(
-            `${i + 1}) ${warning.msg} ${
-              warning.exercise ? `File: ${warning.exercise}` : ""
-            }`
-          )
-      }
-
-      resolve("SUCCESS")
-    } else {
-      reject("Failed")
-    }
-  })
-}
-
-export default {
-  isUrl,
-  checkForEmptySpaces,
-  checkLearnpackClean,
-  findInFile,
-  checkUrl,
-  writeFile,
-  showErrors,
-  showWarnings,
-}
+/* eslint-disable no-await-in-loop, @typescript-eslint/no-non-null-asserted-optional-chain, no-promise-executor-return */
+
+import { IAuditErrors } from "../models/audit"
+import { IConfigObj } from "../models/config"
+import { ICounter } from "../models/counter"
+import { IFindings } from "../models/findings"
+import { IExercise } from "../models/exercise-obj"
+import { IFrontmatter } from "../models/front-matter"
+import Console from "./console"
+import * as fs from "fs"
+import * as path from "path"
+
+// eslint-disable-next-line
+const fetch = require("node-fetch")
+// eslint-disable-next-line
+const fm = require("front-matter")
+
+// This function checks if a url is valid.
+const isUrl = async (
+  url: string,
+  errors: IAuditErrors[],
+  counter: ICounter
+) => {
+  const regexUrl = /(https?:\/\/[\w./-]+)/gm
+  counter.links.total++
+  if (!regexUrl.test(url)) {
+    counter.links.error++
+    errors.push({
+      exercise: undefined,
+      msg: `The repository value of the configuration file is not a link: ${url}`,
+    })
+    return false
+  }
+
+  const res = await fetch(url, { method: "HEAD" })
+  if (!res.ok) {
+    counter.links.error++
+    errors.push({
+      exercise: undefined,
+      msg: `The link of the repository is broken: ${url}`,
+    })
+  }
+
+  return true
+}
+
+const checkForEmptySpaces = (str: string) => {
+  const isEmpty = true
+  for (const letter of str) {
+    if (letter !== " ") {
+      return false
+    }
+  }
+
+  return isEmpty
+}
+
+const checkLearnpackClean = (configObj: IConfigObj, errors: IAuditErrors[]) => {
+  if (
+    (configObj.config?.outputPath &&
+      fs.existsSync(configObj.config?.outputPath)) ||
+    fs.existsSync(`${configObj.config?.dirPath}/_app`) ||
+    fs.existsSync(`${configObj.config?.dirPath}/reports`) ||
+    fs.existsSync(`${configObj.config?.dirPath}/resets`) ||
+    fs.existsSync(`${configObj.config?.dirPath}/app.tar.gz`) ||
+    fs.existsSync(`${configObj.config?.dirPath}/config.json`) ||
+    fs.existsSync(`${configObj.config?.dirPath}/vscode_queue.json`) ||
+    fs.existsSync(`${configObj.config?.dirPath}/telemetry.json`)
+  ) {
+    errors.push({
+      exercise: undefined,
+      msg: "You have to run learnpack clean command",
+    })
+  }
+}
+
+const findInFile = (types: string[], content: string) => {
+  const regex: any = {
+    relativeImages:
+      /!\[.*]\s*\((((\.\/)?(\.{2}\/){1,5})(.*\/)*(.[^\s/]*\.[A-Za-z]{2,4})\S*)\)/gm,
+    externalImages: /!\[.*]\((https?:\/(\/[^)/]+)+\/?)\)/gm,
+    markdownLinks: /(\s)+\[.*]\((https?:\/(\/[^)/]+)+\/?)\)/gm,
+    url: /(https?:\/\/[\w./-]+)/gm,
+    uploadcare: /https:\/\/ucarecdn.com\/(?:.*\/)*([\w./-]+)/gm,
+  }
+
+  const validTypes = Object.keys(regex)
+  if (!Array.isArray(types)) 
+types = [types]
+
+  const findings: IFindings = {}
+  type findingsType =
+    | "relativeImages"
+    | "externalImages"
+    | "markdownLinks"
+    | "url"
+    | "uploadcare"
+
+  for (const type of types) {
+    if (!validTypes.includes(type)) 
+throw new Error("Invalid type: " + type)
+    else 
+findings[type as findingsType] = {}
+  }
+
+  for (const type of types) {
+    let m: RegExpExecArray
+    while ((m = regex[type].exec(content)) !== null) {
+      // This is necessary to avoid infinite loops with zero-width matches
+      if (m.index === regex.lastIndex) {
+        regex.lastIndex++
+      }
+
+      // The result can be accessed through the `m`-variable.
+      // m.forEach((match, groupIndex) => values.push(match));
+
+      findings[type as findingsType]![m[0]] = {
+        content: m[0],
+        absUrl: m[1],
+        mdUrl: m[2],
+        relUrl: m[6],
+      }
+    }
+  }
+
+  return findings
+}
+
+const checkLinkWithRetry = async (
+  url: string,
+  retries = 3,
+  delay = 1000
+): Promise<{ isValid: boolean; status?: number }> => {
+  for (let attempt = 1; attempt <= retries; attempt++) {
+    try {
+      let res = await fetch(url, { method: "HEAD" })
+
+      if (res.status === 429) {
+        await new Promise(resolve => setTimeout(resolve, delay))
+        delay *= 2 // Exponential backoff
+        continue
+      }
+
+      if (res.status === 403) {
+        return { isValid: false, status: 403 }
+      }
+
+      if (!res.ok) {
+        res = await fetch(url, { method: "GET" })
+
+        if (!res.ok) {
+          return { isValid: false, status: res.status }
+        }
+      }
+
+      return { isValid: true }
+    } catch (error) {
+      console.debug(`Error checking link ${url}:`, error)
+      return { isValid: false, status: 429 }
+    }
+  }
+
+  return { isValid: false, status: 429 }
+}
+
+const checkUrl = async (
+  config: IConfigObj,
+  filePath: string,
+  fileName: string,
+  exercise: IExercise | undefined,
+  errors: IAuditErrors[],
+  warnings: IAuditErrors[],
+  counter: ICounter | undefined
+) => {
+  if (!fs.existsSync(filePath)) 
+return false
+  const content: string = fs.readFileSync(filePath).toString()
+  const isEmpty = checkForEmptySpaces(content)
+  if (isEmpty || !content)
+    errors.push({
+      exercise: exercise?.title!,
+      msg: `This file (${fileName}) doesn't have any content inside.`,
+    })
+
+  const frontmatter: IFrontmatter = fm(content)
+  for (const attribute in frontmatter.attributes) {
+    if (
+      Object.prototype.hasOwnProperty.call(frontmatter.attributes, attribute) &&
+      (attribute === "intro" || attribute === "tutorial")
+    ) {
+      counter && counter.links.total++
+      const url = frontmatter.attributes[attribute]
+
+      const { isValid, status } = await checkLinkWithRetry(url)
+
+      if (!isValid) {
+        if (status === 429 || status === 403) {
+          warnings.push({
+            exercise: exercise?.title!,
+            msg: `Warning: This link might be temporarily inaccessible (${status}): ${url}`,
+          })
+        } else {
+          counter && counter.links.error++
+          errors.push({
+            exercise: exercise?.title!,
+            msg: `This link is broken: ${url}`,
+          })
+        }
+      }
+    }
+  }
+
+  // Check URLs in README files
+  const findings: IFindings = findInFile(
+    ["relativeImages", "externalImages", "markdownLinks"],
+    content
+  )
+  type findingsType = "relativeImages" | "externalImages" | "markdownLinks"
+
+  for (const finding in findings) {
+    if (Object.prototype.hasOwnProperty.call(findings, finding)) {
+      const obj = findings[finding as findingsType]
+
+      if (finding === "externalImages" && Object.keys(obj!).length > 0) {
+        for (const img in obj) {
+          if (Object.prototype.hasOwnProperty.call(obj, img)) {
+            counter && counter.images.total++
+            const url = obj[img].absUrl
+
+            const { isValid, status } = await checkLinkWithRetry(url)
+
+            if (!isValid) {
+              if (status === 429 || status === 403) {
+                warnings.push({
+                  exercise: exercise?.title,
+                  msg: `Warning: This image link might be temporarily inaccessible (${status}): ${url}`,
+                })
+              } else {
+                counter && counter.images.error++
+                errors.push({
+                  exercise: exercise?.title,
+                  msg: `This image link is broken: ${url}`,
+                })
+              }
+            }
+          }
+        }
+      } else if (finding === "markdownLinks" && Object.keys(obj!).length > 0) {
+        for (const link in obj) {
+          if (Object.prototype.hasOwnProperty.call(obj, link)) {
+            counter && counter.links.total++
+            const url = obj[link].mdUrl
+
+            if (!url.includes("twitter")) {
+              const { isValid, status } = await checkLinkWithRetry(url)
+
+              if (!isValid) {
+                if (status === 429 || status === 403) {
+                  warnings.push({
+                    exercise: exercise?.title,
+                    msg: `Warning: This markdown link might be temporarily inaccessible (${status}): ${url}`,
+                  })
+                } else {
+                  counter && counter.links.error++
+                  errors.push({
+                    exercise: exercise?.title,
+                    msg: `This markdown link is broken: ${url}`,
+                  })
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+
+  return true
+}
+
+// This function writes a file in the given path.
+const writeFile = (filePath: string, content: string) => {
+  try {
+    fs.writeFileSync(filePath, content)
+  } catch (error) {
+    if (error)
+      Console.error(
+        `We weren't able to write the file in this path "${filePath}".`,
+        error
+      )
+  }
+}
+
+// This function checks if there are errors, and show them in the console at the end.
+const showErrors = (errors: IAuditErrors[], counter: ICounter | undefined) => {
+  return new Promise((resolve, reject) => {
+    if (errors) {
+      if (errors.length > 0) {
+        Console.log("Checking for errors...")
+        for (const [i, error] of errors.entries())
+          Console.error(
+            `${i + 1}) ${error.msg} ${
+              error.exercise ? `(Exercise: ${error.exercise})` : ""
+            }`
+          )
+        if (counter) {
+          Console.error(
+            ` We found ${errors.length} error${
+              errors.length > 1 ? "s" : ""
+            } among ${counter.images.total} images, ${
+              counter.links.total
+            } link, ${counter.readmeFiles} README files and ${
+              counter.exercises
+            } exercises.`
+          )
+        } else {
+          Console.error(
+            ` We found ${errors.length} error${
+              errors.length > 1 ? "s" : ""
+            } related with the project integrity.`
+          )
+        }
+
+        process.exit(1)
+      } else {
+        if (counter) {
+          Console.success(
+            `We didn't find any errors in this repository among ${counter.images.total} images, ${counter.links.total} link, ${counter.readmeFiles} README files and ${counter.exercises} exercises.`
+          )
+        } else {
+          Console.success(`We didn't find any errors in this repository.`)
+        }
+
+        process.exit(0)
+      }
+    } else {
+      reject("Failed")
+    }
+  })
+}
+
+// This function checks if there are warnings, and show them in the console at the end.
+const showWarnings = (warnings: IAuditErrors[]) => {
+  return new Promise((resolve, reject) => {
+    if (warnings) {
+      if (warnings.length > 0) {
+        Console.log("Checking for warnings...")
+        for (const [i, warning] of warnings.entries())
+          Console.warning(
+            `${i + 1}) ${warning.msg} ${
+              warning.exercise ? `File: ${warning.exercise}` : ""
+            }`
+          )
+      }
+
+      resolve("SUCCESS")
+    } else {
+      reject("Failed")
+    }
+  })
+}
+
+export default {
+  isUrl,
+  checkForEmptySpaces,
+  checkLearnpackClean,
+  findInFile,
+  checkUrl,
+  writeFile,
+  showErrors,
+  showWarnings,
+}