create-lt-adventure 0.0.16 → 0.1.3

package/README.md

@@ -1,85 +1,85 @@
-# create-lt-adventure
-
-A CLI scaffolding tool for creating Foundry VTT modules.
-
-## Installation
-
-### Global Installation (for end users)
-
-Once published to npm, you can run the script via Bun:
-
-```bash
-bunx create-lt-adventure 
-```
-
-Then run it from anywhere:
-
-```bash
-create-lt-adventure
-```
-
-Update the package using
-
-```bash
-bun update create-lt-adventure -g --latest
-```
-
-### Development Installation
-
-For development purposes:
-
-```bash
-git clone https://github.com/Loot-Foundry/create-lt-adventure
-cd create-lt-adventure
-bun install
-bun run dev
-```
-### Development
-
-```bash
-# Install dependencies
-bun install
-
-# Run in development mode (requires Bun)
-bun run dev
-
-# Watch for TypeScript changes
-bun run build:watch
-```
-
-## Scripts
-
-- `bun run build` - Compile TypeScript to JavaScript
-- `bun run build:watch` - Watch TypeScript files and rebuild on changes
-- `bun run dev` - Run the CLI in development mode (requires Bun)
-- `bun run prepublishOnly` - Automatically run before publishing
-
-## System Support
-
-Currently supports:
-- **dnd5e** - Dungeons & Dragons 5th Edition
-- **pf2e** - Pathfinder 2nd Edition
-
-Additional systems can be added in `src/options.ts`.
-
-## Resources
-
-### Foundry VTT Documentation
-- [dnd5e System Wiki](https://github.com/foundryvtt/dnd5e/wiki)
-- [dnd5e Module Registration](https://github.com/foundryvtt/dnd5e/wiki/Module-Registration)
-- [PF2e Wiki](https://github.com/foundryvtt/pf2e/wiki)
-
-### Module Development
-- [Foundry VTT Module Development](https://foundryvtt.com/article/modules/)
-
-## License
-
-MIT
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit pull requests.
-
-## Issues
-
-Found a bug? Please open an issue on [GitHub](https://github.com/Loot-Foundry/create-lt-adventure/issues).
+# create-lt-adventure
+
+A CLI scaffolding tool for creating Foundry VTT modules.
+
+## Installation
+
+### Global Installation (for end users)
+
+Once published to npm, you can run the script via Bun:
+
+```bash
+bunx create-lt-adventure
+```
+
+Updating the package:
+
+```bash
+create-lt-adventure
+```
+
+Update the package using
+
+```bash
+bun update create-lt-adventure -g --latest
+```
+
+### Development Installation
+
+For development purposes:
+
+```bash
+git clone https://github.com/Loot-Foundry/create-lt-adventure
+cd create-lt-adventure
+bun install
+bun run dev
+```
+### Development
+
+```bash
+# Install dependencies
+bun install
+
+# Run in development mode (requires Bun)
+bun run dev
+
+# Watch for TypeScript changes
+bun run build:watch
+```
+
+## Scripts
+
+- `bun run build` - Compile TypeScript to JavaScript
+- `bun run build:watch` - Watch TypeScript files and rebuild on changes
+- `bun run dev` - Run the CLI in development mode (requires Bun)
+- `bun run prepublishOnly` - Automatically run before publishing
+
+## System Support
+
+Currently supports:
+- **dnd5e** - Dungeons & Dragons 5th Edition
+- **pf2e** - Pathfinder 2nd Edition
+
+Additional systems can be added in `src/options.ts`.
+
+## Resources
+
+### Foundry VTT Documentation
+- [dnd5e System Wiki](https://github.com/foundryvtt/dnd5e/wiki)
+- [dnd5e Module Registration](https://github.com/foundryvtt/dnd5e/wiki/Module-Registration)
+- [PF2e Wiki](https://github.com/foundryvtt/pf2e/wiki)
+
+### Module Development
+- [Foundry VTT Module Development](https://foundryvtt.com/article/modules/)
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit pull requests.
+
+## Issues
+
+Found a bug? Please open an issue on [GitHub](https://github.com/Loot-Foundry/create-lt-adventure/issues).

package/addons/github-workflow/addon.json

@@ -1,5 +1,5 @@
-{
-	"name": "Github Workflow",
-	"description": "Adds support for automated releases via Github workflows",
-	"default": true
-}
+{
+	"name": "Github Workflow",
+	"description": "Adds support for automated releases via Github workflows",
+	"default": true
+}

package/addons/github-workflow/main.yml

@@ -1,48 +1,96 @@
-name: Release Creation
-
-on:
-    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
+name: Release Creation
+
+on:
+  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 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}

@@ -1,112 +1,115 @@
-// Creates a .github/workflows/main.yml file.
-// Additional options include:
-// - Support for prereleases (requires a seperate branch)
-// - Supports for uploading via FTP to external servers
-// - Discord webhook notifications
-
-import * as p from "@clack/prompts";
-import { cyan } from "kolorist";
-import { mkdir } from "fs/promises";
-
-const data = await p.group(
-	{
-		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) },
-);
-
-// Grab main.yml template
-const addonDir = import.meta.dir;
-const mainYmlTemplate = await Bun.file(`${addonDir}/main.yml`).text();
-
-// Get the module directory from environment variable
-const moduleDir = process.env.MODULE_DIR || process.cwd();
-
-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 += `
-            # 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"
-
-            - name: Get Module ID
-              id: module_id
-              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"
-`;
-}
-
-if (data.features.includes("ftp")) {
-	mainYml += `
-            - 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}}
-`;
-}
-
-if (data.features.includes("discord")) {
-	mainYml += `
-            - 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}}\`!"
-`;
-}
-
-// Create main.yml file
-const workflowDir = `${moduleDir}/.github/workflows`;
-await mkdir(workflowDir, { recursive: true });
-await Bun.write(`${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.";
-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")}.`;
-
-p.note(note, "Github Workflow");
+// Creates a .github/workflows/main.yml file.
+// Additional options include:
+// - Support for prereleases (requires a seperate branch)
+// - Supports for uploading via FTP to external servers
+// - Discord webhook notifications
+
+import * as p from "@clack/prompts";
+import { cyan } from "kolorist";
+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"],
+        required: false,
+        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 mainYmlTemplate = await readFile(`${__dirname}/main.yml`, "utf8");
+
+// Get the module directory from environment variable
+const moduleDir = process.env.MODULE_DIR || process.cwd();
+
+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 += `
+            # 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
+
+            - name: Get Module ID
+              id: module_id
+              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
+`;
+}
+
+if (data.features.includes("ftp")) {
+  mainYml += `
+            - 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}}
+`;
+}
+
+if (data.features.includes("discord")) {
+  mainYml += `
+            - 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}}\`!"
+`;
+}
+
+// Create main.yml file
+const workflowDir = `${moduleDir}/.github/workflows`;
+await mkdir(workflowDir, { recursive: true });
+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.";
+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")}.`;
+
+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
+}