chore: adds lesson REAME details

Author: anthonydmays

.github/workflows/check_lesson_03_pr.yaml

@@ -25,7 +25,7 @@ jobs:
       working-directory: ./lib/typescript/codedifferently-instructional
       run: npm ci
 
-    - name: Build Lesson 02 with Node.js
+    - name: Build Lesson 03 with Node.js
       working-directory: ./lesson_03/quiz
       run: |
         npm run lint

lesson_03/README.md

@@ -9,4 +9,50 @@ Please review the following resources before lecture:
 
 ## Homework
 
-TODO(anthonydmays): Add this
+- [ ] Review [important reminders below](#important-reminders).
+- [ ] Create [new quiz questions](#creating-new-quiz-questions).
+- [ ] Do pre-work for [lesson 04](/lesson_04/).
+
+### Important reminders
+
+* Make sure to sync your fork before creating a branch in order to pull in the latest changes.
+* Sync your branch often to avoid merge conflicts and execute `git pull` to bring the latest changes to your machine.
+* If your branch is too far behind or you run into too many issues, feel free to delete and re-create your repository. Make sure to review the article linked at the bottom of the [lesson_00](/lesson_00/README.md) README for instructions on how to create your fork and branch properly.
+* Remember, you should not reuse a branch you've used to submit a pull request. If you need to make changes, create a new branch and work from there after you've updated your fork to the latest.
+
+### Creating new quiz questions
+
+Now's your chance to quiz the instructor! In this assignment, you will modify the quiz project to include three quiz questions based on the content you've learned in this course so far. Feel free to choose any topic for your questions.
+
+1. Navigate to the [quiz][quiz-folder] directory and install the required dependencies.
+```bash
+cd lesson_03/quiz
+npm install --prefix ../../lib/typescript/codedifferently-instructional
+npm install
+npm start
+```
+2. You will create a quiz file in the [quizzes folder][quizzes-folder]. You should model yours after the example provided in [anthony_mays_quiz.ts][quiz-example]. Note that the name of the file you create should match the name of the class in the file.
+3. Make sure to provide a unique provider name for your questions provider. You'll need this name to provide answers in step 4.
+```typescript
+  getProviderName(): string {
+    return '<your unique name goes here>';
+  }
+```
+4. Make at least three questions for your quiz and _leave them unanswered_.
+5. To provide answers, you will need to update the [quiz.yaml][test-config-file] file in the test directory. You can copy the example in the file to get started, but you must provide your own answers. To generate an encrypted answer, use [bcrypt.online](https://bcrypt.online).
+6. Before attempting to submit your quiz, make sure to run the formatter on the code and run the tests to ensure that you've updated things correctly. These commands must be run from the [quiz][quiz-folder] sub-folder just like the previous assignment:
+```bash
+npm run lint
+npm run test
+```
+7. Once everything passes, submit a PR.
+
+**Note: If you want to check that you've encoded your answers correctly, you can update you quiz with the real answers and then run the tests using the command below. 
+```bash
+RUN_SKIPPED=true npm run test
+```
+
+[quizzes-folder]: ./quiz/src/quizzes/
+[quiz-folder]: ./quiz/
+[quiz-example]: ./quiz/src/quizzes/anthony_mays_quiz.ts
+[test-config-file]: ./quiz/quiz.yaml

lesson_03/quiz/.editorconfig

@@ -8,3 +8,4 @@ charset = utf-8
 insert_final_newline = true
 organize_imports = true
 trim_trailing_whitespace = true
+quote_type = single

lesson_03/quiz/eslint.config.js

@@ -1,21 +1,28 @@
 // @ts-check
 
-import eslint from "@eslint/js";
-import tseslint from "typescript-eslint";
-import eslintConfigPrettier from "eslint-config-prettier";
+import eslint from '@eslint/js';
+import stylistic from '@stylistic/eslint-plugin';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import tseslint from 'typescript-eslint';
 
 export default tseslint.config(
   eslint.configs.recommended,
   ...tseslint.configs.strict,
   ...tseslint.configs.stylistic,
   eslintConfigPrettier,
   {
-    ignores: ["build"],
+    ignores: ['build'],
+    plugins: { '@stylistic': stylistic },
     rules: {
-      "@typescript-eslint/interface-name-prefix": "off",
-      "@typescript-eslint/explicit-function-return-type": "off",
-      "@typescript-eslint/no-explicit-any": "off",
-      "@typescript-eslint/no-extraneous-class": "off",
+      '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-extraneous-class': 'off',
+      '@stylistic/quotes': [
+        'error',
+        'single',
+        { avoidEscape: true, allowTemplateLiterals: false },
+      ],
     },
   },
 );

lesson_03/quiz/jest.config.js

@@ -1,11 +1,11 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} **/
 export default {
-  testEnvironment: "node",
+  testEnvironment: 'node',
   transform: {
-    "^.+.tsx?$": ["ts-jest", { useESM: true }],
+    '^.+.tsx?$': ['ts-jest', { useESM: true }],
   },
   moduleNameMapper: {
-    "^(\\.\\.?\\/.+)\\.js$": "$1",
+    '^(\\.\\.?\\/.+)\\.js$': '$1',
   },
-  extensionsToTreatAsEsm: [".ts"],
+  extensionsToTreatAsEsm: ['.ts'],
 };

lesson_03/quiz/package-lock.json

@@ -20,6 +20,7 @@
     "@alfonso-presa/soft-assert": "^0.6.0",
     "@eslint/js": "^9.11.1",
     "@nestjs/testing": "^10.4.4",
+    "@stylistic/eslint-plugin": "^2.8.0",
     "@types/eslint__js": "^8.42.3",
     "@types/jest": "^29.5.13",
     "@types/node": "20.12.7",
@@ -41,4 +42,4 @@
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1"
   }
-}
+}

lesson_03/quiz/package.json

@@ -1,5 +1,5 @@
-import { Module } from "@nestjs/common";
-import { QuizzesModule } from "./quizzes/quizzes.module.js";
+import { Module } from '@nestjs/common';
+import { QuizzesModule } from './quizzes/quizzes.module.js';
 
 @Module({
   imports: [QuizzesModule],

lesson_03/quiz/src/app.module.ts

@@ -1,21 +1,22 @@
-import { flush, proxy } from "@alfonso-presa/soft-assert";
-import { beforeAll, describe, expect, it } from "@jest/globals";
-import { Test, TestingModule } from "@nestjs/testing";
+import { flush, proxy } from '@alfonso-presa/soft-assert';
+import { beforeAll, describe, expect, it } from '@jest/globals';
+import { Test, TestingModule } from '@nestjs/testing';
 import {
   AnswerChoice,
   QuizConfig,
   QuizQuestion,
-} from "codedifferently-instructional";
-import path from "path";
-import { fileURLToPath } from "url";
-import { AppModule } from "./app.module.js";
-import { Quizzes } from "./quizzes/quizzes.module.js";
+} from 'codedifferently-instructional';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { AppModule } from './app.module.js';
+import { Quizzes } from './quizzes/quizzes.module.js';
 
 const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file
 const __dirname = path.dirname(__filename); // get the name of the directory
 const softExpect = proxy(expect);
+const maybeIt = process.env.RUN_SKIPPED ? it : it.skip;
 
-describe("Lesson3Test", () => {
+describe('Lesson3Test', () => {
   let moduleFixture: TestingModule;
   let quizConfig: QuizConfig;
   let quizQuestionsByProvider: Map<string, QuizQuestion[]>;
@@ -25,7 +26,7 @@ describe("Lesson3Test", () => {
       imports: [AppModule],
     }).compile();
 
-    quizConfig = new QuizConfig(path.resolve(__dirname, "../quiz.yaml"));
+    quizConfig = new QuizConfig(path.resolve(__dirname, '../quiz.yaml'));
 
     makeQuestions();
   });
@@ -47,7 +48,7 @@ describe("Lesson3Test", () => {
     flush();
   });
 
-  it("assembles questions correctly", async () => {
+  it('assembles questions correctly', async () => {
     for (const quizQuestions of quizQuestionsByProvider.values()) {
       // Expect the right number of questions.
       expect(quizQuestions.length).toBe(2);
@@ -59,7 +60,7 @@ describe("Lesson3Test", () => {
     }
   });
 
-  it("checks for unique prompts", async () => {
+  it('checks for unique prompts', async () => {
     for (const quizQuestions of quizQuestionsByProvider.values()) {
       const questionPrompts = new Set(
         quizQuestions.map((q) => q.getQuestionPrompt()),
@@ -68,13 +69,13 @@ describe("Lesson3Test", () => {
     }
   });
 
-  it("checks correct number of answers are configured", async () => {
+  it('checks correct number of answers are configured', async () => {
     for (const [providerName, questions] of quizQuestionsByProvider) {
       expect(quizConfig.size(providerName)).toBe(questions.length);
     }
   });
 
-  it("checks for correct answers", async () => {
+  maybeIt('checks for correct answers', async () => {
     for (const [providerName, questions] of quizQuestionsByProvider) {
       for (const question of questions) {
         const actualAnswer = question.getAnswer();

lesson_03/quiz/src/lesson3.test.ts

@@ -1,8 +1,8 @@
-import { INestApplicationContext } from "@nestjs/common";
-import { NestFactory } from "@nestjs/core";
-import { QuizPrinter, QuizQuestion } from "codedifferently-instructional";
-import { AppModule } from "./app.module.js";
-import { Quizzes } from "./quizzes/quizzes.module.js";
+import { INestApplicationContext } from '@nestjs/common';
+import { NestFactory } from '@nestjs/core';
+import { QuizPrinter, QuizQuestion } from 'codedifferently-instructional';
+import { AppModule } from './app.module.js';
+import { Quizzes } from './quizzes/quizzes.module.js';
 
 async function bootstrap() {
   const app = await NestFactory.createApplicationContext(AppModule);
@@ -14,7 +14,7 @@ function run(app: INestApplicationContext) {
   const quizzes = app.get(Quizzes);
 
   for (const quiz of quizzes) {
-    console.log("\nQuestions by " + quiz.getProviderName() + ":");
+    console.log('\nQuestions by ' + quiz.getProviderName() + ':');
     printQuiz(quiz.makeQuizQuestions());
   }
 }