Use more conventional TS style in packages/scripts (#313)

- Using `ts-results` didn't make much sense because we weren't doing
anything interesting with the results, such as deferring erroring. We
wanted to error immediately. It added indirection
- I'm not sure why I was using anonymous functions rather than
`function`
- I like putting `export` directly on the function rather than the
bottom of the file

Author: Eric-Arellano

.eslintrc.yml

@@ -17,6 +17,9 @@ overrides:
   - files: ["**/*.test.ts", "**/playwright.config.js"]
     rules:
       "import/no-extraneous-dependencies": "off"
+  - files: ["packages/scripts/**/*.ts"]
+    rules:
+      "no-console": "off"
 
 rules:
   no-unexpected-multiline: off

packages/scripts/package.json

@@ -9,8 +9,7 @@
     "update-lots": "tsx src/update-lots.ts"
   },
   "dependencies": {
-    "@prn-parking-lots/shared": "workspace:*",
-    "ts-results": "^3.3.0"
+    "@prn-parking-lots/shared": "workspace:*"
   },
   "devDependencies": {
     "tsx": "^4.19.2"

packages/scripts/src/add-city.ts

@@ -1,14 +1,9 @@
 import fs from "fs/promises";
 
-import results from "ts-results";
-
 import type { CityId } from "@prn-parking-lots/shared/src/js/model/types.ts";
 import { determineArgs, updateCoordinates, updateParkingLots } from "./base.ts";
 
-const addScoreCard = async (
-  cityId: CityId,
-  cityName: string,
-): Promise<results.Result<void, string>> => {
+async function addScoreCard(cityId: CityId, cityName: string): Promise<void> {
   const newEntry = {
     name: cityName,
     percentage: "FILL ME IN, e.g. 23%",
@@ -31,7 +26,7 @@ const addScoreCard = async (
     originalData = JSON.parse(rawOriginalData);
   } catch (err: unknown) {
     const { message } = err as Error;
-    return results.Err(
+    throw new Error(
       `Issue reading the score card file path ${originalFilePath}: ${message}`,
     );
   }
@@ -45,41 +40,33 @@ const addScoreCard = async (
   });
 
   await fs.writeFile(originalFilePath, JSON.stringify(sortedData, null, 2));
-  return results.Ok.EMPTY;
-};
+}
 
-const main = async () => {
-  const { cityName, cityId } = determineArgs("add-city", process.argv.slice(2))
-    .mapErr((err) => new Error(`Argument error: ${err}`))
-    .unwrap();
+async function main() {
+  const { cityName, cityId } = determineArgs("add-city", process.argv.slice(2));
 
-  (
-    await updateCoordinates(
-      "add-city",
-      cityId,
-      true,
-      "packages/primary/data/city-boundaries.geojson",
-      "city-update.geojson",
-    )
-  ).unwrap();
+  await updateCoordinates(
+    "add-city",
+    cityId,
+    true,
+    "packages/primary/data/city-boundaries.geojson",
+    "city-update.geojson",
+  );
 
-  (
-    await updateParkingLots(
-      cityId,
-      true,
-      "parking-lots-update.geojson",
-      `packages/primary/data/parking-lots/${cityId}.geojson`,
-    )
-  ).unwrap();
+  await updateParkingLots(
+    cityId,
+    true,
+    "parking-lots-update.geojson",
+    `packages/primary/data/parking-lots/${cityId}.geojson`,
+  );
 
-  (await addScoreCard(cityId, cityName)).unwrap();
+  await addScoreCard(cityId, cityName);
 
-  /* eslint-disable-next-line no-console */
   console.log(
     `Almost done! Now, fill in the score card values in packages/primary/data/city-stats.json. Then,
-    run 'npm run fmt'. Then, 'npm start' and see if the site is what you expect.
+    run 'pnpm fmt'. Then, start the server and see if the site is what you expect.
     `,
   );
-};
+}
 
 main();

packages/scripts/src/base.ts

@@ -1,6 +1,5 @@
 import fs from "fs/promises";
 
-import results from "ts-results";
 import {
   FeatureCollection,
   GeoJsonProperties,
@@ -11,42 +10,42 @@ import {
 import { parseCityIdFromJson } from "@prn-parking-lots/shared/src/js/model/cityId.ts";
 import type { CityId } from "@prn-parking-lots/shared/src/js/model/types";
 
-const determineArgs = (
+export function determineArgs(
   scriptCommand: string,
   processArgv: string[],
-): results.Result<{ cityName: string; cityId: CityId }, string> => {
+): { cityName: string; cityId: CityId } {
   if (processArgv.length !== 1) {
-    return new results.Err(
+    throw new Error(
       `Must provide exactly one argument (the city/state name). For example,
        npm run ${scriptCommand} -- 'Columbus, OH'
        `,
     );
   }
   const cityName = processArgv[0];
   const cityId = parseCityIdFromJson(cityName);
-  return results.Ok({ cityName, cityId });
-};
+  return { cityName, cityId };
+}
 
-const updateCoordinates = async (
+export async function updateCoordinates(
   scriptCommand: string,
   cityId: CityId,
   addCity: boolean,
   originalFilePath: string,
   updateFilePath: string,
-): Promise<results.Result<string, string>> => {
+): Promise<void> {
   let newData: FeatureCollection<Polygon, GeoJsonProperties>;
   try {
     const rawNewData = await fs.readFile(updateFilePath, "utf8");
     newData = JSON.parse(rawNewData);
   } catch (err: unknown) {
     const { message } = err as Error;
-    return results.Err(
+    throw new Error(
       `Issue reading the update file path ${updateFilePath}: ${message}`,
     );
   }
 
   if (!Array.isArray(newData.features) || newData.features.length !== 1) {
-    return results.Err(
+    throw new Error(
       "The script expects exactly one entry in `features` because you can only update one city at a time.",
     );
   }
@@ -61,7 +60,7 @@ const updateCoordinates = async (
     originalData = JSON.parse(rawOriginalData);
   } catch (err: unknown) {
     const { message } = err as Error;
-    return results.Err(
+    throw new Error(
       `Issue reading the original data file path ${originalFilePath}: ${message}`,
     );
   }
@@ -78,7 +77,7 @@ const updateCoordinates = async (
       (feature) => feature?.properties?.id === cityId,
     );
     if (!cityOriginalData) {
-      return results.Err(
+      throw new Error(
         `City not found in ${originalFilePath}. To add a new city, run again with the '--add' flag, e.g. npm run ${scriptCommand} -- 'My City, AZ' --add`,
       );
     }
@@ -97,28 +96,27 @@ const updateCoordinates = async (
   });
 
   await fs.writeFile(originalFilePath, JSON.stringify(originalData, null, 2));
-  return results.Ok("File updated successfully!");
-};
+}
 
-const updateParkingLots = async (
+export async function updateParkingLots(
   cityId: CityId,
   addCity: boolean,
   originalFilePath: string,
   updateFilePath: string,
-): Promise<results.Result<string, string>> => {
+): Promise<void> {
   let newData;
   try {
     const rawNewData = await fs.readFile(originalFilePath, "utf8");
     newData = JSON.parse(rawNewData);
   } catch (err: unknown) {
     const { message } = err as Error;
-    return results.Err(
+    throw new Error(
       `Issue reading the update file path parking-lots-update.geojson: ${message}`,
     );
   }
 
   if (!Array.isArray(newData.features) || newData.features.length !== 1) {
-    return results.Err(
+    throw new Error(
       "The script expects exactly one entry in `features` because you can only update one city at a time.",
     );
   }
@@ -133,23 +131,20 @@ const updateParkingLots = async (
       originalData = JSON.parse(rawOriginalData);
     } catch (err: unknown) {
       const { message } = err as Error;
-      return results.Err(
+      throw new Error(
         `Issue reading the original data file path ${updateFilePath}: ${message}`,
       );
     }
     originalData.geometry.coordinates = newCoordinates;
 
     await fs.writeFile(updateFilePath, JSON.stringify(originalData, null, 2));
-    return results.Ok("File updated successfully!");
+    return;
   }
+
   const newFile = {
     type: "Feature",
     properties: { id: cityId },
     geometry: { type: newGeometryType, coordinates: newCoordinates },
   };
   await fs.writeFile(updateFilePath, JSON.stringify(newFile, null, 2));
-
-  return results.Ok("File updated successfully!");
-};
-
-export { determineArgs, updateCoordinates, updateParkingLots };
+}

packages/scripts/src/update-city-boundaries.ts

@@ -1,28 +1,23 @@
 import { determineArgs, updateCoordinates } from "./base.ts";
 
-const main = async (): Promise<void> => {
+async function main(): Promise<void> {
   const { cityId } = determineArgs(
     "update-city-boundaries",
     process.argv.slice(2),
-  )
-    .mapErr((err) => new Error(`Argument error: ${err}`))
-    .unwrap();
-  const value = (
-    await updateCoordinates(
-      "update-city-boundaries",
-      cityId,
-      false,
-      "packages/primary/data/city-boundaries.geojson",
-      "city-update.geojson",
-    )
-  ).unwrap();
+  );
+  await updateCoordinates(
+    "update-city-boundaries",
+    cityId,
+    false,
+    "packages/primary/data/city-boundaries.geojson",
+    "city-update.geojson",
+  );
 
-  /* eslint-disable-next-line no-console */
   console.log(
-    `${value} Now, run 'npm run fmt'. Then, 'npm start' and
+    `File updatad! Now, run 'pnpm fmt'. Then, start the server and
       see if the site is what you expect.
     `,
   );
-};
+}
 
 main();

packages/scripts/src/update-lots.ts

@@ -1,24 +1,19 @@
 import { determineArgs, updateParkingLots } from "./base.ts";
 
-const main = async (): Promise<void> => {
-  const { cityId } = determineArgs("update-lots", process.argv.slice(2))
-    .mapErr((err) => new Error(`Argument error: ${err}`))
-    .unwrap();
-  const value = (
-    await updateParkingLots(
-      cityId,
-      false,
-      "parking-lots-update.geojson",
-      `packages/primary/data/parking-lots/${cityId}.geojson`,
-    )
-  ).unwrap();
+async function main(): Promise<void> {
+  const { cityId } = determineArgs("update-lots", process.argv.slice(2));
+  await updateParkingLots(
+    cityId,
+    false,
+    "parking-lots-update.geojson",
+    `packages/primary/data/parking-lots/${cityId}.geojson`,
+  );
 
-  /* eslint-disable-next-line no-console */
   console.log(
-    `${value} Now, run 'npm run fmt'. Then, 'npm start' and
+    `File updated! Now, run 'pnpm fmt'. Then, start the server and
       see if the site is what you expect.
     `,
   );
-};
+}
 
 main();