Homework 2: Project Scaffolding

Schema

In this assignment you'll be developing a pizza validation package. By the end, you should be able to pass in a JSON file into a command-line interface (CLI) and judge whether that object is a valid pizza or not. What constitutes a valid pizza? Well, we will use the following schema for a pizza:

• size: number- diameter in inches
• crust: string- either stuffed or normal
• isDeepDish: optional boolean- by default should be false (non-deep dish)
• toppings: optional array of strings- should include only valid toppings. You should choose at least 4 toppings that should never go on pizza. (so it's up to you whether you think pineapple should be on pizza!)

We will provide a general order of operations to get you through this assignment. You don't have to follow them exactly- you just need to meet the requirements for this project by the end! See the rubric at the bottom of this assignment for more details.

Be reminded that this assignment is all about finding solutions on your own. You know the tools and knowledge to read and find documentation online. Most the tools you need for this project are well-documented and have plenty of resources online! You don't always need to fall back to asking AI for the answer, though if you do, remember to keep all chat logs to document your conversations. We recommend you use MDN Docs and TypeScript Docs to help you through this assignment, among other library documentations.

At the very least, you will need to following dependencies to develop this application:

• typescript
• eslint
• prettier
• zod
• jest (or another testing framework)

This may not be an exhaustive list of the dependencies you need for this project. You are free to install any other packages that may help for this project, so long as the core of the project still uses TypeScript and Zod.

When setting up your project, be sure to follow the requirements listed in the rubric for what we are looking for in terms of setup. You will need to add a few configuration files and set up some rules and options within them.

Validation Function

Once your project's dependencies are installed, should start by creating your validation function. This pizza validation should use the Zod package in order to validate whether a given input is a pizza. Follow the specifications in the rubric for specific details that we want out of this function. If we don't mention a certain detail, it is up to your discretion on how to implement that feature.

CLI Functionality

Next, you'll set up your command-line interface. This should involve another source file that runs the pizza validator on a selected JSON file containing a pizza object passed in through some manner of input arguments within the command-line. There are a variety of ways to parse input arguments, but we'll direct you to parseArgs from the built-in node:util. You may also find that the package ts-node is good to testing this section, so that you don't have to rebuild your project every time you need to test this code.

Unit Testing

Finally, you set up and write some unit tests for your project. We will be using Jest for this purpose, so look up how to install and use the syntax of Jest in order to prepare your test suite. We'd recommend using ts-jest alongside this it, but feel free to find your own solution if you come across one. Follow the requirements for tests in the rubric below.

Polish & Style

Finally, you should polish up your project and standardize the style within the project. With eslint, add 4 extra style rules beyond any recommended default rules for JavaScript and TypeScript. With prettier, add 2 extra rules beyond the defaults. This process will give you a taste of setting up style checking as part of the production pipeline of projects. Don't just copy the rules from Homework 1 (since some of them require extra dependencies), try branching out a bit and exploring how different rules work!

README

Answer the provided reflection questions within the starter code README file. In this reflection, you will also indicite whether or not you used AI, and also document your usage of AI as well. Please don't forget this step, as it is important feedback for the homework and the content of the course!

Submission

To submit, simply push your commits to the repository generated from GitHub classroom. Make sure your latest commit before the deadline includes all files you worked on during this homework and your README.md file. Make sure the submitted file structure within your GitHub repository is exactly or similar to the file structure you used to run and develop the project. Points will be taken off for malformed project structures in the final submission!

Before you submit, make sure you lint your code for style errors using the command npm run lint. More details on style can be found in the style guide. We will take -1 points for every style error remaining in the submission for the submitted files. Since this project requires you to make your own ESLint, we will use your linting rules instead of the standard rules we would apply, so make sure you pass your own set of style rules!

Rubric

import { validatePizza } from '<package-name>';

const result = validatePizza({ hehehehaw: true });
// there should be no typescript errors below
if (result.isPizza) console.log(result.pizza.crust);
else console.log(result.errors);