create-lt-adventure 0.0.15 → 0.1.0

package/README.md

@@ -9,10 +9,10 @@ A CLI scaffolding tool for creating Foundry VTT modules.
 Once published to npm, you can run the script via Bun:
 
 ```bash
-bunx create-lt-adventure 
+bunx create-lt-adventure
 ```
 
-Then run it from anywhere:
+Updating the package:
 
 ```bash
 create-lt-adventure

package/addons/github-workflow/main.yml

@@ -1,48 +1,96 @@
 name: Release Creation
 
 on:
-    release:
-        types: [published]
+  release:
+    types: [published]
 
 jobs:
-    build:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-            - uses: oven-sh/setup-bun@v2
-
-            - name: Extract version from tag without the v
-              id: get-version
-              run: echo "v=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
-
-            - name: Substitute Manifest and Download Links For Versioned Ones
-              id: sub_manifest_link_version
-              uses: microsoft/variable-substitution@v1
-              with:
-                  files: module.json
-              env:
-                  flags.canUpload: false
-                  version: ${{ steps.get-version.outputs.v }}
-
-            - name: Install packages
-              run: bun ci
-
-            - name: Build distribution
-              run: bun run build
-
-              # Create a zip file with all files required by the module to add to the release.
-            - name: Bundle into ZIP file
-              run: zip -r ./module.zip module.json assets/ dist/ packs/
-
-              # Create a release for this specific version.
-            - name: Update Release with Files
-              id: create_version_release
-              uses: ncipollo/release-action@v1
-              with:
-                  allowUpdates: true # Set this to false if you want to prevent updating existing releases.
-                  name: ${{ github.event.release.name }}
-                  tag: ${{ github.event.release.tag_name }}
-                  body: ${{ github.event.release.body }}
-                  artifacts: "./module.json, ./module.zip"
-                  omitDraftDuringUpdate: true
-                  omitPrereleaseDuringUpdate: true
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+
+      - name: Extract version from tag without the v
+        id: get-version
+        run: echo "v=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
+
+      - name: Substitute Manifest and Download Links For Versioned Ones
+        id: sub_manifest_link_version
+        uses: microsoft/variable-substitution@v1
+        with:
+          files: module.json
+        env:
+          flags.canUpload: false
+          version: ${{ steps.get-version.outputs.v }}
+
+      - name: Install packages
+        run: bun i --frozen-lockfile
+
+      - name: Build distribution
+        run: bun run build
+
+        # Create a zip file with all files required by the module to add to the release.
+      - name: Bundle into ZIP file
+        run: zip -r ./module.zip module.json assets/ dist/ packs/ lang/
+
+        # Create a release for this specific version.
+      - name: Update Release with Files
+        id: create_version_release
+        uses: ncipollo/release-action@v1
+        with:
+          allowUpdates: true # Set this to false if you want to prevent updating existing releases.
+          name: ${{ github.event.release.name }}
+          tag: ${{ github.event.release.tag_name }}
+          body: ${{ github.event.release.body }}
+          artifacts: "./module.json, ./module.zip"
+          omitDraftDuringUpdate: true
+          omitPrereleaseDuringUpdate: true
+
+      # https://stackoverflow.com/questions/61919141/read-json-file-in-github-actions
+      - id: set_var
+        run: echo "PACKAGE_JSON=$(jq -c . < module.json)" >> "$GITHUB_OUTPUT"
+
+      - name: Get Module ID
+        id: module_id
+        run: echo "module_id=${{ fromJson(steps.set_var.outputs.PACKAGE_JSON).id }}" >> "$GITHUB_OUTPUT"
+
+      - name: Get FTP Path
+        id: ftp
+        run: echo "ftp=${{ fromJson(steps.set_var.outputs.PACKAGE_JSON).flags.ftpPath || format('NEW/{0}', steps.module_id.outputs.module_id) }}" >> "$GITHUB_OUTPUT"
+
+      - name: Get Module Title
+        id: title
+        run: echo "title=${{fromJson(steps.set_var.outputs.PACKAGE_JSON).title}}" >> "$GITHUB_OUTPUT"
+
+      - name: Put Files into FTP Folder
+        env:
+          FTP_PASSWORD: ${{ secrets.FTP_PASSWORD }}
+        if: ${{ env.FTP_PASSWORD != '' }}
+        run: |
+          ls
+          mkdir _ftp
+          cp module.json _ftp/
+          cp module.zip _ftp/
+          mkdir _ftp/${{steps.module_id.outputs.module_id}}
+          cp module.json _ftp/${{steps.module_id.outputs.module_id}}/
+
+      - name: Upload FTP
+        uses: sebastianpopp/ftp-action@releases/v2
+        env:
+          FTP_PASSWORD: ${{ secrets.FTP_PASSWORD }}
+        if: ${{ env.FTP_PASSWORD != '' }}
+        with:
+          host: ${{ secrets.FTP_SERVER }}
+          user: ${{ secrets.FTP_USERNAME }}
+          password: ${{ env.FTP_PASSWORD }}
+          localDir: _ftp
+          remoteDir: ${{steps.ftp.outputs.ftp}}
+
+      - name: Send Discord Ping
+        uses: Ilshidur/action-discord@0.3.2
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
+        if: ${{ env.DISCORD_WEBHOOK != '' && !github.event.release.prerelease }}
+        with:
+          args: "${{steps.title.outputs.title}} has been updated to version `${{github.event.release.tag_name}}`!"

package/addons/github-workflow/{setup.ts → setup.mjs}

@@ -6,28 +6,31 @@
 
 import * as p from "@clack/prompts";
 import { cyan } from "kolorist";
-import { mkdir } from "fs/promises";
+import { mkdir, readFile, writeFile } from "fs/promises";
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 const data = await p.group(
-	{
-		features: () =>
-			p.multiselect({
-				message: "Additional features?",
-				initialValues: ["ftp", "discord"],
+  {
+    features: () =>
+      p.multiselect({
+        message: "Additional features?",
+        initialValues: ["ftp", "discord"],
         required: false,
-				options: [
-					// { label: "Prereleases", value: "prereleases" },
-					{ label: "Uploading via FTP", value: "ftp" },
-					{ label: "Discord webhook on updates", value: "discord" },
-				],
-			}),
-	},
-	{ onCancel: () => process.exit(0) },
+        options: [
+          // { label: "Prereleases", value: "prereleases" },
+          { label: "Uploading via FTP", value: "ftp" },
+          { label: "Discord webhook on updates", value: "discord" },
+        ],
+      }),
+  },
+  { onCancel: () => process.exit(0) },
 );
 
 // Grab main.yml template
-const addonDir = import.meta.dir;
-const mainYmlTemplate = await Bun.file(`${addonDir}/main.yml`).text();
+const mainYmlTemplate = await readFile(`${__dirname}/main.yml`, "utf8");
 
 // Get the module directory from environment variable
 const moduleDir = process.env.MODULE_DIR || process.cwd();
@@ -36,27 +39,27 @@ let mainYml = mainYmlTemplate;
 
 // I should probably just make this a JSON and convert it to accursed YAML at the end step...
 if (data.features.includes("discord") || data.features.includes("ftp")) {
-	mainYml += `
+  mainYml += `
             # https://stackoverflow.com/questions/61919141/read-json-file-in-github-actions
             - id: set_var
               run: echo "PACKAGE_JSON=$(jq -c . < module.json)" >> $GITHUB_OUTPUT
 
             - name: Get FTP Path
               id: ftp
-              run: echo "ftp=\${{fromJson(steps.set_var.outputs.PACKAGE_JSON).flags.ftpPath}}" >> "$GITHUB_OUTPUT"
+              run: echo "ftp=\${{fromJson(steps.set_var.outputs.PACKAGE_JSON).flags.ftpPath}}" >> $GITHUB_OUTPUT
 
             - name: Get Module ID
               id: module_id
-              run: echo "module_id=\${{fromJson(steps.set_var.outputs.PACKAGE_JSON).id}}" >> "$GITHUB_OUTPUT"
+              run: echo "module_id=\${{fromJson(steps.set_var.outputs.PACKAGE_JSON).id}}" >> $GITHUB_OUTPUT
 
             - name: Get Module Title
               id: title
-              run: echo "title=\${{fromJson(steps.set_var.outputs.PACKAGE_JSON).title}}" >> "$GITHUB_OUTPUT"
+              run: echo "title=\${{fromJson(steps.set_var.outputs.PACKAGE_JSON).title}}" >> $GITHUB_OUTPUT
 `;
 }
 
 if (data.features.includes("ftp")) {
-	mainYml += `
+  mainYml += `
             - name: Put Files into FTP Folder
               env:
                 FTP_PASSWORD: \${{ secrets.FTP_PASSWORD }}
@@ -84,7 +87,7 @@ if (data.features.includes("ftp")) {
 }
 
 if (data.features.includes("discord")) {
-	mainYml += `
+  mainYml += `
             - name: Send Discord Ping
               uses: Ilshidur/action-discord@0.3.2
               env:
@@ -98,15 +101,15 @@ if (data.features.includes("discord")) {
 // Create main.yml file
 const workflowDir = `${moduleDir}/.github/workflows`;
 await mkdir(workflowDir, { recursive: true });
-await Bun.write(`${workflowDir}/main.yml`, mainYml);
+await writeFile(`${workflowDir}/main.yml`, mainYml);
 
 let note = "✅ Installed!";
 note += "\nThe Github workflow is triggered by making a new release. To make a new release go to your repository's Releases page which can be found in the sidebar on the right and press \"Draft a new release.\" Fill in the version number and you're done!"
 
 if (data.features.includes("discord"))
-	note +=
-		"\n - For the Discord integration, make sure to create a DISCORD_WEBHOOK secret with the webhook url.";
+  note +=
+    "\n - For the Discord integration, make sure to create a DISCORD_WEBHOOK secret with the webhook url.";
 if (data.features.includes("ftp"))
-	note += `\n - For the FTP integration, make sure to include the FTP_SERVER, FTP_USERNAME, and FTP_PASSWORD secrets.\n\tThe module JSON also can include a flag stating its subdirectory on the FTP server under ${cyan("flags.ftpPath")}.`;
+  note += `\n - For the FTP integration, make sure to include the FTP_SERVER, FTP_USERNAME, and FTP_PASSWORD secrets.\n\tThe module JSON also can include a flag stating its subdirectory on the FTP server under ${cyan("flags.ftpPath")}.`;
 
 p.note(note, "Github Workflow");

package/addons/sf2e-pf2e-redirects/addon.json

@@ -0,0 +1,5 @@
+{
+	"name": "SF2e <=> PF2e UUID Redirects",
+	"description": "Adds UUID redirects for modules that support both SF2e and PF2e. Skipped if module doesn't support both systems.",
+	"default": false
+}

package/addons/sf2e-pf2e-redirects/setup.mjs

@@ -0,0 +1,119 @@
+// Creates a uuid-redirects.js file that redirects sf2e compendium UUIDs to pf2e equivalents.
+// This addon only activates when both sf2e and pf2e systems are selected.
+
+import * as p from "@clack/prompts";
+import { cyan } from "kolorist";
+import { readFile, writeFile, mkdir } from "fs/promises";
+import { existsSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+// Get the module directory from environment variable
+const moduleDir = process.env.MODULE_DIR || process.cwd();
+
+// Read the module.json to get module ID and packs
+const moduleJsonPath = join(moduleDir, "module.json");
+if (!existsSync(moduleJsonPath)) {
+  p.log.warn("⚠️ module.json not found, skipping SF2e to PF2e UUID redirects");
+  process.exit(0);
+}
+
+const moduleJson = JSON.parse(await readFile(moduleJsonPath, "utf8"));
+const moduleId = moduleJson.id;
+const systems = (moduleJson.relationships?.systems || []).map(s => s.id);
+const packs = moduleJson.packs || [];
+
+// Check if both sf2e and pf2e are selected
+if (!systems.includes("sf2e") || !systems.includes("pf2e")) {
+  p.note("⏭️ Skipped - both sf2e and pf2e systems must be selected", "SF2e to PF2e UUID Redirects");
+  process.exit(0);
+}
+
+// Find base pack names (e.g., "items", "actors") that have both sf2e and pf2e variants
+const sf2ePackNames = packs.filter(p => p.system === "sf2e").map(p => p.name.replace("sf2e-", ""));
+const pf2ePackNames = packs.filter(p => p.system === "pf2e").map(p => p.name.replace("pf2e-", ""));
+const commonPackNames = sf2ePackNames.filter(name => pf2ePackNames.includes(name));
+
+if (commonPackNames.length === 0) {
+  p.note("⏭️ Skipped - no common packs found between sf2e and pf2e", "SF2e to PF2e UUID Redirects");
+  process.exit(0);
+}
+
+// Build the UUID_REDIRECTS object
+const redirects = {};
+for (const packName of commonPackNames) {
+  redirects[`Compendium.${moduleId}.sf2e-${packName}`] = `Compendium.${moduleId}.pf2e-${packName}`;
+}
+
+// Generate the uuid-redirects.js content
+const redirectsContent = `// Auto-generated by create-fvtt-module - sf2e-pf2e-redirects addon
+// Redirects sf2e compendium UUIDs to their pf2e equivalents
+
+const UUID_REDIRECTS = {
+${Object.entries(redirects).map(([from, to]) => `  "${from}": "${to}"`).join(",\n")}
+};
+
+for (const [from, to] of Object.entries(UUID_REDIRECTS)) {
+  CONFIG.compendium.uuidRedirects[from] = to;
+}
+`;
+
+// Check if src directory exists
+const srcDir = join(moduleDir, "src");
+const srcExists = existsSync(srcDir);
+
+// Check for index files
+const indexTs = join(srcDir, "index.ts");
+const indexJs = join(srcDir, "index.js");
+const indexTsExists = existsSync(indexTs);
+const indexJsExists = existsSync(indexJs);
+
+if (srcExists) {
+  // Determine file extension based on existing index files
+  const useTypeScript = indexTsExists;
+  const redirectFileName = useTypeScript ? "uuid-redirects.ts" : "uuid-redirects.js";
+  const importFileName = useTypeScript ? "uuid-redirects.js" : "uuid-redirects.js"; // Always import as .js (TS compilers handle this)
+  const redirectsPath = join(srcDir, redirectFileName);
+  
+  await writeFile(redirectsPath, redirectsContent);
+  p.log.success(`Created ${cyan("src/" + redirectFileName)}`);
+
+  // Try to import into index.ts or index.js
+  const importStatement = `import "./${importFileName}";`;
+  
+  if (indexTsExists) {
+    const indexContent = await readFile(indexTs, "utf8");
+    // Check if import already exists
+    if (!indexContent.includes("uuid-redirects")) {
+      const newIndexContent = `${importStatement}\n${indexContent}`;
+      await writeFile(indexTs, newIndexContent);
+      p.log.success(`Imported ${redirectFileName} into ${cyan("src/index.ts")}`);
+    } else {
+      p.log.info(`Import already exists in ${cyan("src/index.ts")}`);
+    }
+  } else if (indexJsExists) {
+    const indexContent = await readFile(indexJs, "utf8");
+    if (!indexContent.includes("uuid-redirects")) {
+      const newIndexContent = `${importStatement}\n${indexContent}`;
+      await writeFile(indexJs, newIndexContent);
+      p.log.success(`Imported ${redirectFileName} into ${cyan("src/index.js")}`);
+    } else {
+      p.log.info(`Import already exists in ${cyan("src/index.js")}`);
+    }
+  } else {
+    p.log.warn(`⚠️ No index.ts or index.js found in src/. Please manually add ${cyan(importStatement)} to your main entry file.`);
+  }
+} else {
+  // No src directory - write to module root and warn
+  const redirectsPath = join(moduleDir, "uuid-redirects.js");
+  await writeFile(redirectsPath, redirectsContent);
+  p.log.warn(`⚠️ No src/ directory found. Created ${cyan("uuid-redirects.js")} in module root.`);
+  p.log.warn(`⚠️ Please manually add ${cyan('import "./uuid-redirects.js";')} to your module's main entry point.`);
+}
+
+let note = "✅ Installed!";
+note += `\n${commonPackNames.length} pack(s) configured for sf2e → pf2e redirect: ${cyan(commonPackNames.join(", "))}`;
+
+p.note(note, "SF2e to PF2e UUID Redirects");