Differentiate Python 3 goody name from its module name (#154)

The module name needs to be a valid Python 3 module name, whereas in the goody name it might be nice to support other characters. For example, I like calling the goody `int.digits` even though that's not a valid module name.

This also matches with how Java and Kotlin goodies already work.

Author: miorel

tools/adventure-pack/goodies/python3/src/int_digits/goody.json

@@ -0,0 +1,3 @@
+{
+  "name": "int.digits"
+}

tools/adventure-pack/package.json

@@ -24,7 +24,7 @@
     "goodies:kotlin:format": "(cd goodies/kotlin && ./gradlew ktfmtCustom)",
     "goodies:kotlin:install": "javac -version",
     "goodies:kotlin:test": "(cd goodies/kotlin && ./gradlew test)",
-    "goodies:python3:format": "bash goodies/python3/format.sh",
+    "goodies:python3:format": "prettier --write goodies/python3 && bash goodies/python3/format.sh",
     "goodies:python3:install": "bash goodies/python3/install.sh",
     "goodies:python3:test": "bash goodies/python3/test.sh",
     "goodies:typescript:format": "prettier --write goodies/typescript",

tools/adventure-pack/src/app/__tests__/__snapshots__/equip-test.ts.snap

@@ -867,7 +867,7 @@ fun lcm(a: Int, b: Int): Int = a / gcd(a, b) * b
 /////////////////////////// END ADVENTURE PACK CODE ////////////////////////////"
 `;
 
-exports[`App can equip single goody: Python 3 int_digits 1`] = `
+exports[`App can equip single goody: Python 3 int.digits 1`] = `
 "########################## BEGIN ADVENTURE PACK CODE ###########################
 # Adventure Pack commit fake-commit-hash
 # Running at: https://example.com/

tools/adventure-pack/src/app/__tests__/__snapshots__/render-test.ts.snap

@@ -530,7 +530,7 @@ import gcd_int_int.gcd
 fun lcm(a: Int, b: Int): Int = a / gcd(a, b) * b"
 `;
 
-exports[`App can render goody: Python 3 int_digits 1`] = `
+exports[`App can render goody: Python 3 int.digits 1`] = `
 "from typing import Generator
 
 

tools/adventure-pack/src/app/__tests__/equip-test.ts

@@ -17,7 +17,6 @@ function setUnsafe(
   (map as Record<string, unknown>)[properties.at(-1)!] = value;
 }
 
-setUnsafe(globalThis, ["requestIdleCallback"], <T>(fn: () => T): T => fn());
 setUnsafe(globalThis, ["window", "location", "href"], "https://example.com/");
 
 describe("App", () => {
@@ -27,8 +26,7 @@ describe("App", () => {
     for (const language of Object.keys(goodiesByLanguage) as Language[]) {
       const goodies = goodiesByLanguage[language];
       for (const goodyName of Object.keys(goodies)) {
-        // eslint-disable-next-line no-await-in-loop
-        const mergedCode = await mergeCode({
+        const mergedCode = mergeCode({
           commitHash: "fake-commit-hash",
           goodies,
           language,

tools/adventure-pack/src/scripts/package-goodies/java/readGoodies.ts

@@ -7,6 +7,7 @@ import type { JavaGoody } from "../../../app/parsers/javaGoodyParser";
 import { GOODIES_DIRECTORY } from "./constants";
 import { type JavaGoodyBase, readBaseGoody } from "./readBaseGoody";
 import { fillOutImportedByAndSortImports } from "../fillOutImportedByAndSortImports";
+import { normalizeGoodyNameToPackageOrModuleName } from "../normalizeGoodyNameToPackageOrModuleName";
 
 export async function readGoodies(): Promise<Record<string, JavaGoody>> {
   const fileEntries = await fsPromises.readdir(GOODIES_DIRECTORY, {
@@ -26,11 +27,9 @@ export async function readGoodies(): Promise<Record<string, JavaGoody>> {
     // eslint-disable-next-line no-await-in-loop
     const baseGoody = await readBaseGoody(packageName);
 
-    const expectedPackageName = baseGoody.name
-      .replace(/[A-Z]+/g, ([upper]) => "_" + upper.toLowerCase())
-      .replace(/[^a-z0-9]+/gi, "_")
-      .replace(/_$/, "")
-      .replace(/^_/, "");
+    const expectedPackageName = normalizeGoodyNameToPackageOrModuleName(
+      baseGoody.name,
+    );
     invariant(
       packageName === expectedPackageName,
       `Mismatched package name for goody! Expected ${JSON.stringify(expectedPackageName)} based on goody name ${JSON.stringify(baseGoody.name)} but got ${JSON.stringify(packageName)}.`,

tools/adventure-pack/src/scripts/package-goodies/kotlin/readCode.ts

@@ -3,8 +3,8 @@ import path from "node:path";
 
 import { GOODIES_DIRECTORY } from "./constants";
 
-export async function readCode(packageName: string): Promise<string> {
-  return await fsPromises.readFile(
+export function readCode(packageName: string): Promise<string> {
+  return fsPromises.readFile(
     path.join(GOODIES_DIRECTORY, packageName, "Main.kt"),
     "utf8",
   );

tools/adventure-pack/src/scripts/package-goodies/kotlin/readGoodies.ts

@@ -7,6 +7,7 @@ import type { KotlinGoody } from "../../../app/parsers/kotlinGoodyParser";
 import { GOODIES_DIRECTORY } from "./constants";
 import { type KotlinGoodyBase, readBaseGoody } from "./readBaseGoody";
 import { fillOutImportedByAndSortImports } from "../fillOutImportedByAndSortImports";
+import { normalizeGoodyNameToPackageOrModuleName } from "../normalizeGoodyNameToPackageOrModuleName";
 
 export async function readGoodies(): Promise<Record<string, KotlinGoody>> {
   const fileEntries = await fsPromises.readdir(GOODIES_DIRECTORY, {
@@ -26,11 +27,9 @@ export async function readGoodies(): Promise<Record<string, KotlinGoody>> {
     // eslint-disable-next-line no-await-in-loop
     const baseGoody = await readBaseGoody(packageName);
 
-    const expectedPackageName = baseGoody.name
-      .replace(/[A-Z]+/g, ([upper]) => "_" + upper.toLowerCase())
-      .replace(/[^a-z0-9]+/gi, "_")
-      .replace(/_$/, "")
-      .replace(/^_/, "");
+    const expectedPackageName = normalizeGoodyNameToPackageOrModuleName(
+      baseGoody.name,
+    );
     invariant(
       packageName === expectedPackageName,
       `Mismatched package name for goody! Expected ${JSON.stringify(expectedPackageName)} based on goody name ${JSON.stringify(baseGoody.name)} but got ${JSON.stringify(packageName)}.`,

tools/adventure-pack/src/scripts/package-goodies/normalizeGoodyNameToPackageOrModuleName.ts

@@ -0,0 +1,9 @@
+export function normalizeGoodyNameToPackageOrModuleName(
+  goodyName: string,
+): string {
+  return goodyName
+    .replace(/[A-Z]+/g, ([upper]) => "_" + upper.toLowerCase())
+    .replace(/[^a-z0-9]+/gi, "_")
+    .replace(/_$/, "")
+    .replace(/^_/, "");
+}

tools/adventure-pack/src/scripts/package-goodies/python3/constants.ts

@@ -0,0 +1,3 @@
+import path from "node:path";
+
+export const GOODIES_DIRECTORY = path.join("goodies", "python3", "src");