✨ feat: verify project structures and fix tsconfigs (#122)

* ✨ feat: verify project structures and fix tsconfigs

* Fix jest-haste-map issues

* Progress: chapter file verification

* Start verifying project categories

* Progress: verifying package.json in projects

* Finished standardizing contents

* Remove added tsconfig.json files

Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

Author: JoshuaKGoldberg

.github/workflows/tests.yml

@@ -0,0 +1,20 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+          cache: "npm"
+      - run: npm ci
+      - name: Run unit tests on the repo
+        run: npm run test

jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+	transform: {
+		"^.+\\.(t|j)sx?$": ["@swc/jest"],
+	},
+};

package-lock.json

@@ -3,6 +3,7 @@
 		"@commitlint/cli": "^17.0.2",
 		"@swc/core": "^1.2.197",
 		"@swc/jest": "^0.2.21",
+		"capital-case": "^1.0.4",
 		"commitlint-config-gitmoji": "^2.2.5",
 		"cross-env": "7.0.3",
 		"husky": "^8.0.0",
@@ -11,6 +12,7 @@
 		"prettier": "^2.6.2",
 		"prettier-plugin-sh": "^0.11.0",
 		"pretty-quick": "^3.1.3",
+		"title-case": "^3.0.3",
 		"ts-jest": "28.0.4",
 		"tsd": "0.20.0",
 		"typescript": "4.6.2"
@@ -27,7 +29,8 @@
 	"name": "learning-typescript-projects",
 	"scripts": {
 		"format": "prettier --write \"**/*\" --ignore-unknown",
-		"prepare": "husky install"
+		"prepare": "husky install",
+		"test": "jest test/"
 	},
 	"version": "0.0.1"
 }

package.json

@@ -13,17 +13,18 @@ We'll walk you through each of the functions you need to write.
 
 ## Setup
 
-In one terminal, start the TypeScript compiler in watch mode:
+In one terminal, run the TypeScript compiler via the `tsc` script within whichever step you're working on.
+For example, to start the TypeScript compiler on the first step in watch mode:
 
 ```shell
-tsc --watch
+npm run tsc -- --project 01-shallow-equality --watch
 ```
 
-In another terminal, run Jest on whichever step you're working on.
-For example, to run tests for the first step in watch mode:
+In another terminal, run Jest via the `test` script on whichever step you're working on.
+For example, to start tests for the first step in watch mode:
 
 ```shell
-npm test -- 1 --watch
+npm run test -- 1 --watch
 ```
 
 ## Steps

projects/arrays/analyzing-dna/README.md

@@ -2,6 +2,7 @@
 	"name": "analyzing-dna",
 	"scripts": {
 		"test": "jest",
-		"test:solutions": "cross-env TEST_SOLUTIONS=1 jest"
+		"test:solutions": "cross-env TEST_SOLUTIONS=1 jest",
+		"tsc": "tsc"
 	}
 }

projects/arrays/analyzing-dna/package.json

@@ -20,17 +20,18 @@ Can you type this text processor up for me, fellow typography practitioner?
 
 ## Setup
 
-In one terminal, start the TypeScript compiler in watch mode:
+In one terminal, run the TypeScript compiler via the `tsc` script.
+For example, to start the TypeScript compiler in watch mode:
 
 ```shell
-tsc --watch
+npm run tsc -- --watch
 ```
 
 In another terminal, run Jest via the `test` script.
-For example, to run tests in watch mode:
+For example, to start tests in watch mode:
 
 ```shell
-npm test -- --watch
+npm run test -- --watch
 ```
 
 ## Specification

projects/arrays/text-processor/README.md

@@ -2,6 +2,7 @@
 	"name": "text-processor",
 	"scripts": {
 		"test": "jest",
-		"test:solutions": "cross-env TEST_SOLUTIONS=1 jest"
+		"test:solutions": "cross-env TEST_SOLUTIONS=1 jest",
+		"tsc": "tsc"
 	}
 }

projects/arrays/text-processor/package.json

@@ -13,17 +13,18 @@ Can you please help us classify our creatures?
 
 ## Setup
 
-In one terminal, start the TypeScript compiler in watch mode:
+In one terminal, run the TypeScript compiler via the `tsc` script within whichever step you're working on.
+For example, to start the TypeScript compiler on the first step in watch mode:
 
 ```shell
-tsc --watch
+npm run tsc -- --project 01-polly-parrots-properties --watch
 ```
 
-In another terminal, run Jest on whichever step you're working on.
-For example, to run tests for the first step in watch mode:
+In another terminal, run Jest via the `test` script on whichever step you're working on.
+For example, to start tests for the first step in watch mode:
 
 ```shell
-npm test -- 1 --watch
+npm run test -- 1 --watch
 ```
 
 ## Steps

projects/classes/classifying-creatures/README.md

@@ -1,7 +1,8 @@
 {
-	"name": "analyzing-dna",
+	"name": "classifying-creatures",
 	"scripts": {
 		"test": "jest",
-		"test:solutions": "cross-env TEST_SOLUTIONS=1 jest"
+		"test:solutions": "cross-env TEST_SOLUTIONS=1 jest",
+		"tsc": "tsc"
 	}
 }