release: 8.4.0

.gitignore

@@ -2,21 +2,15 @@
 
 
 # generated files from ts sources in specific ts only modules
-**/cli/tutors-html/src/**/*.js
-**/cli/tutors-html/src/**/*.js.map
-**/cli/tutors-html/src/**/*.d.ts
-**/cli/tutors-json/src/**/*.js
-**/cli/tutors-json/src/**/*.js.map
-**/cli/tutors-json/src/**/*.d.ts
-**/cli/tutors-gen/src/**/*.js
-**/cli/tutors-gen/src/**/*.js.map
-**/cli/tutors-gen/src/**/*.d.ts
-**/cli/tutors-time/src/**/*.js
-**/cli/tutors-time/src/**/*.js.map
-**/cli/tutors-time/src/**/*.d.ts
-**/packages/tutors-lib/src/**/*.js
-**/packages/tutors-lib/src/**/*.js.map
-**/packages/tutors-lib/src/**/*.d.ts
+**/cli/tutors-gen-lib/src/**/*.js
+**/cli/tutors-gen-lib/src/**/*.js.map
+**/cli/tutors-gen-lib/src/**/*.d.ts
+**/cli/tutors-publish/src/**/*.js
+**/cli/tutors-publish/src/**/*.js.map
+**/cli/tutors-publish/src/**/*.d.ts
+**/cli/tutors-publish-html/src/**/*.js
+**/cli/tutors-publish-html/src/**/*.js.map
+**/cli/tutors-publish-html/src/**/*.d.ts
 **/test/reference-course/json
 **/test/reference-course/public-site
 

.vscode/launch.json

@@ -2,39 +2,28 @@
   "version": "0.1.0",
   "configurations": [
     {
-      "name": "tutors-json",
-      "program": "${workspaceFolder}//cli/tutors-json/src/tutors-json.js",
+      "name": "tutors-publish",
+      "program": "${workspaceFolder}//cli/tutors-publish/src/tutors-publish.js",
       "request": "launch",
-      "skipFiles": ["<node_internals>/**"],
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
       "type": "node",
-      "cwd": "${workspaceFolder}/test/reference-course"
-    },
-    {
-      "name": "tutors-gen",
-      "program": "${workspaceFolder}//cli/tutors-gen/src/tutors-gen.js",
-      "request": "launch",
-      "skipFiles": ["<node_internals>/**"],
-      "type": "node",
-      "cwd": "${workspaceFolder}/test/reference-course",
+      //"cwd": "${workspaceFolder}/test/reference-course",
+      "cwd": "/Users/edeleastar/repos/tutors/courses/tutors-reference-course",
       "console": "integratedTerminal"
-      // "cwd": "/Users/edeleastar/repos/modules/hdip/2022/course-portfolio-2022"
-      //"cwd": "/Users/edeleastar/repos/modules/hdip/2021/sem-3/full-stack-web-dev-2021"
     },
     {
-      "name": "tutors-html",
-      "program": "${workspaceFolder}//cli/tutors-html/src/tutors-html.js",
+      "name": "tutors-publish-html",
+      "program": "${workspaceFolder}//cli/tutors-publish-html/src/tutors-publish-html.js",
       "request": "launch",
-      "skipFiles": ["<node_internals>/**"],
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
       "type": "node",
-      "cwd": "${workspaceFolder}/test/reference-course"
-    },
-    {
-      "name": "tutors-time",
-      "program": "${workspaceFolder}//cli/tutors-time/src/tutors-time.js",
-      "request": "launch",
-      "skipFiles": ["<node_internals>/**"],
-      "type": "node",
-      "cwd": "${workspaceFolder}/cli/tutors-time"
+      //"cwd": "${workspaceFolder}/test/reference-course",
+      "cwd": "/Users/edeleastar/repos/tutors/courses/tutors-reference-course",
+      "console": "integratedTerminal"
     },
     {
       "type": "chrome",
@@ -54,5 +43,4 @@
     }
   ]
 }
-
-/* /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222 */
+/* /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222 */

.vscode/settings.json

@@ -2,7 +2,9 @@
   "task.allowAutomaticTasks": "on",
   "editor.formatOnSave": true,
   "files.exclude": {
-    "**/*.js": { "when": "$(basename).ts" },
+    "**/*.js": {
+      "when": "$(basename).ts"
+    },
     "**/*.js.map": true,
     "**/*.d.ts": true,
     "**/node_modules": true,
@@ -12,4 +14,4 @@
     "**/package-lock.json": true,
     "**/.github": true
   }
-}
+}

.vscode/tasks.json

@@ -3,58 +3,42 @@
   "tasks": [
     {
       "type": "typescript",
-      "tsconfig": "cli/tutors-json/tsconfig.json",
+      "tsconfig": "cli/tutors-gen-lib/tsconfig.json",
       "option": "watch",
-      "problemMatcher": ["$tsc-watch"],
+      "problemMatcher": [
+        "$tsc-watch"
+      ],
       "group": "build",
-      "label": "tsc: watch - cli/tutors-json/tsconfig.json",
+      "label": "tsc: watch - cli/tutors-gen-lib/tsconfig.json",
       "runOptions": {
         "runOn": "folderOpen"
       }
     },
     {
       "type": "typescript",
-      "tsconfig": "cli/tutors-html/tsconfig.json",
+      "tsconfig": "cli/tutors-publish/tsconfig.json",
       "option": "watch",
-      "problemMatcher": ["$tsc-watch"],
+      "problemMatcher": [
+        "$tsc-watch"
+      ],
       "group": "build",
-      "label": "tsc: watch - cli/tutors-html/tsconfig.json",
+      "label": "tsc: watch - cli/tutors-publish/tsconfig.json",
       "runOptions": {
         "runOn": "folderOpen"
       }
     },
     {
       "type": "typescript",
-      "tsconfig": "cli/tutors-gen/tsconfig.json",
+      "tsconfig": "cli/tutors-publish-html/tsconfig.json",
       "option": "watch",
-      "problemMatcher": ["$tsc-watch"],
+      "problemMatcher": [
+        "$tsc-watch"
+      ],
       "group": "build",
-      "label": "tsc: watch - cli/tutors-gen/tsconfig.json",
-      "runOptions": {
-        "runOn": "folderOpen"
-      }
-    },
-    {
-      "type": "typescript",
-      "tsconfig": "cli/tutors-time/tsconfig.json",
-      "option": "watch",
-      "problemMatcher": ["$tsc-watch"],
-      "group": "build",
-      "label": "tsc: watch - cli/tutors-time/tsconfig.json",
-      "runOptions": {
-        "runOn": "folderOpen"
-      }
-    },
-    {
-      "type": "typescript",
-      "tsconfig": "packages/tutors-lib/tsconfig.json",
-      "option": "watch",
-      "problemMatcher": ["$tsc-watch"],
-      "group": "build",
-      "label": "tsc: watch - packages/tutors-lib/tsconfig.json",
+      "label": "tsc: watch - cli/tutors-publish-html/tsconfig.json",
       "runOptions": {
         "runOn": "folderOpen"
       }
     }
   ]
-}
+}

apps/course/.prettierignore

@@ -1,9 +1,7 @@
 .DS_Store
-.svelte-kit
 node_modules
-.netlify
-apps/course/build
-/test/reference-course
+/build
+/.svelte-kit
 /package
 .env
 .env.*

apps/course/.prettierrc

@@ -1,7 +1,9 @@
 {
-  "singleQuote": false,
+  "useTabs": true,
+  "singleQuote": true,
   "trailingComma": "none",
-  "printWidth": 180,
-  "svelteStrictMode": true,
-  "bracketSameLine": true
+  "printWidth": 100,
+  "plugins": ["prettier-plugin-svelte"],
+  "pluginSearchDirs": ["."],
+  "overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
 }

apps/course/cypress.config.ts

@@ -0,0 +1,36 @@
+import { defineConfig } from "cypress";
+import pkg from 'cy-verify-downloads'; //The cypress-verify-download plugin
+const { verifyDownloadTasks } = pkg;
+
+export default defineConfig({
+  env: {
+    FAIL_FAST_STRATEGY: "run",
+    FAIL_FAST_ENABLED: true
+  },
+  e2e: {
+    async setupNodeEvents(on, config) {
+      // The below is needed to store the downloaded folder/file in the correction location
+      // for the plugin to check if it has downloaded in the correct default location
+      // A known issue with cypress
+      on('before:browser:launch', (browser = {}, options) => {
+        if (browser.family === 'chromium') {
+          options.preferences.default['download'] = { default_directory: config['downloadsFolder'].replace(/\\/g, "\\\\") }
+          return options
+        }
+        if (browser.family === 'firefox') {
+          options.preferences['browser.download.folderList'] = 2;
+          options.preferences['browser.download.dir'] = config['downloadsFolder'].replace(/\\/g, "\\\\");
+          return options;
+        }
+      });
+      on('task', verifyDownloadTasks); //This is for the cy-verify-download plugin
+      const cypressFailFastPlugin = await import("cypress-fail-fast/plugin");
+      cypressFailFastPlugin.default(on, config);
+      return config;
+    },
+    //Replace with the url that you are using
+    //baseUrl: "https://reader.tutors.dev/course/tutors-cypress-testing",
+    baseUrl: "https://tutors-reference-course-html.netlify.app/",
+    specPattern: "cypress/e2e/**/**.cy.ts"
+  }
+});

apps/course/cypress/e2e/tutorsHtmlGenerator.cy.ts

@@ -0,0 +1,80 @@
+/// <reference types="cypress" />
+
+let course: any = null;
+
+describe("Loading the JSON fixture", function () {
+    before(function () {
+        //passing through the tutors json to be ingested and iterate over each objetc and assign out to c
+        cy.fixture("static-tutors.json").then((c: any) => {
+            course = c;
+        });
+        cy.on("fail", (err, runnable) => {
+            cy.log(err.message);
+            return false;
+        });
+    });
+
+    beforeEach('Check: Define the dimensions of the screen being used', function () {
+        //This defines the dimensions of the screen
+        cy.viewport(1440, 1440);
+        //this is a dyamic way of passing through the url which is defined in the
+        //cypress.config.ts file.
+        cy.visit(course.route);
+    });
+
+    /**
+     * This test case is checking that the headers and summary are present on all the
+     * cards. You would expect all to match as it is coming from the JSON fixture
+     */
+    it('Course Reference page', function () {
+        // Test case
+        cy.visit(course.route);
+        cy.wait(500);
+        cy.get('.p-3.shadow-lg.bg-neutral.text-neutral-content.rounded-box.nav-corner.mb-1.justify-start.z-40.flex.mt-2').contains(course.title.trim());
+        cy.wait(1000);
+        cy.get('div.ml-4.flex-nowrap').should('include.text', course.title.trim());
+        course.los.forEach((topic) => {
+            if (!topic.hide) {
+                cy.get('.card-title').should('include.text', topic.title.trim())
+                cy.get('.card-body').should('include.text', topic.summary.trim())
+            }
+        });
+        cy.get('[class="btn btn-sm"]').should("exist");
+        cy.contains('[data-testid="drawer"]').should("not.exist");
+    });
+
+
+    it("Topics", function () {
+        course.los.forEach((topic) => {
+            if (!topic.hide) {
+                console.log(topic);
+                cy.clickStaticCard(topic);
+                cy.wait(500);
+                cy.go("back");
+                cy.wait(500);
+            }
+        });
+    });
+
+    it("Deep Topics", function () {
+
+        course.los.forEach((topic) => {
+            if (!topic.hide) {
+                cy.wait(500);
+                cy.clickStaticCard(topic);
+                topic.los.forEach((lo) => {
+                    cy.clickStaticCard(lo);
+                    lo.los.forEach((l) => {
+                        cy.clickStaticCard(l);
+                    });
+                    cy.clickStaticBreadCrumb(1)
+                });
+                cy.clickStaticBreadCrumb(0)
+            }
+        });
+    });
+
+    it('Verify the folder downloaded', () => {
+        cy.verifyDownload('\\archive.zip', { timeout: 2500 });
+    });
+});