create-fvtt-module 0.0.1

package/templates/vite/module.json

@@ -0,0 +1,36 @@
+{
+	"id": "module-template",
+	"title": "Module Template",
+	"description": "",
+	"authors": [
+		{
+			"name": "Vauxs",
+			"discord": "vauxs",
+			"twitter": "@ThatVauxs",
+			"email": "mrvauxs@gmail.com",
+			"ko-fi": "MrVauxs",
+			"patreon": "MrVauxs"
+		}
+	],
+	"version": "dev",
+	"compatibility": {
+		"minimum": "13",
+		"verified": "13"
+	},
+	"esmodules": [],
+	"styles": [],
+	"relationships": {},
+	"packs": [],
+	"packFolders": [],
+	"flags": {
+		"canUpload": true,
+		"hotReload": {
+			"extensions": ["css", "json"],
+			"paths": ["styles"]
+		}
+	},
+	"url": "",
+	"bugs": "",
+	"manifest": "",
+	"download": ""
+}

package/templates/vite/package.json

@@ -0,0 +1,25 @@
+{
+	"name": "new-module",
+	"type": "module",
+	"private": true,
+	"license": "MIT",
+	"scripts": {
+		"build": "vite build",
+		"dev": "vite",
+		"extract": "node scripts/extractPacks.mjs",
+		"symlink": "node scripts/symlink.mjs"
+	},
+	"devDependencies": {
+		"@foundryvtt/foundryvtt-cli": "^3.0.2",
+		"foundryvtt-sync": "https://github.com/MrVauxs/FoundryVTT-Sync",
+		"postcss-preset-env": "^10.6.0",
+		"@clack/prompts": "^1.0.0-alpha.9",
+		"kolorist": "^1.8.0",
+		"vite": "^7.3.0",
+		"dotenv": "^17.2.3"
+	},
+	"browserslist": [
+		">5%",
+		"not IE 11"
+	]
+}

package/templates/vite/scripts/extractPacks.mjs

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+import { existsSync } from "node:fs";
+import fs from "node:fs/promises";
+import path from "node:path";
+import * as p from "@clack/prompts";
+import { extractPack } from "@foundryvtt/foundryvtt-cli";
+import { yellow } from "kolorist";
+// import moduleJSON from "../module.json" with { type: "json" };
+
+const foundryDataDir = "packs/";
+const jsonDataDir = "data/";
+
+p.intro(`Extracting ${foundryDataDir} into ${jsonDataDir}...`)
+
+const outDir = path.resolve(process.cwd());
+const packsCompiled = path.resolve(outDir, foundryDataDir);
+if (!existsSync(packsCompiled)) {
+	p.log.warn("Packs directory does not exist in the build!")
+}
+
+const packFolders = await fs.readdir(packsCompiled);
+
+if (packFolders.length === 0) p.log.info("No packs to extract!")
+
+await p.tasks(
+	packFolders.map(pack => ({
+		title: `Extracting ${pack}...`,
+		task: async () => {
+			if (!existsSync(`${jsonDataDir}/${pack}`)) {
+				await fs.mkdir(`${jsonDataDir}/${pack}`);
+			}
+			await extractPack(
+				path.resolve(packsCompiled, pack),
+				`${jsonDataDir}/${pack}`,
+				{
+					expandAdventures: true,
+					omitVolatile: true,
+					folders: false,
+					clean: true,
+					log: false
+				},
+			);
+			return `Extracted ${yellow(pack)}!`
+		}
+	})),
+	{}
+);
+
+p.outro("Finished!");

package/templates/vite/scripts/onCreate.mjs

@@ -0,0 +1,14 @@
+const mod = (await Bun.file("../module.json").json());
+const pack = (await Bun.file("../package.json").json());
+
+// Module
+mod.esmodules = [`dist/${mod.id}.js`];
+mod.styles = [`dist/${mod.id}.css`];
+
+// Package
+pack.name = mod.id;
+
+await Bun.write("../module.json", JSON.stringify(mod, null, "\t"));
+await Bun.write("../package.json", JSON.stringify(pack, null, "\t"));
+
+export { };

package/templates/vite/scripts/symlink.mjs

@@ -0,0 +1,79 @@
+import { lstatSync, rmSync, symlinkSync, unlinkSync, readFileSync, writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { homedir } from "node:os";
+import process from "node:process";
+import * as p from "@clack/prompts";
+import moduleJSON from "../module.json" with { type: "json" };
+import { yellow } from "kolorist";
+
+p.intro(`${moduleJSON.id} symlink script`)
+
+// Store config in user's home directory
+const configPath = resolve(homedir(), ".foundry-symlink-config.json");
+
+// Load last known path from config
+let lastPath = null;
+try {
+	const config = JSON.parse(readFileSync(configPath, "utf-8"));
+	lastPath = config.dataPath;
+} catch {
+	// Config doesn't exist yet, that's fine
+}
+
+const windowsInstructions = process.platform === "win32" ? " Start with a drive letter (\"C:\\\")." : "";
+const lastFolder = lastPath ? `(last: ${lastPath})` : "";
+const promptPath = await p.text({
+	message: `Enter the full path to your Foundry data folder.${windowsInstructions}`,
+	placeholder: lastPath,
+	initialValue: lastPath,
+	validate(val) {
+		const value = val.replace(/\W*$/, "").trim();
+		if (!value || !/\bData$/.test(value)) {
+			return (`"${value}" does not contain ${yellow('/Data')}`);
+		}
+	}
+});
+
+let dataPath = promptPath.replace(/\W*$/, "").trim();
+
+if (dataPath !== lastPath) {
+	// Ask if user wants to save the path
+	const shouldSave = await p.confirm({
+		initialValue: true,
+		message: `Save "${dataPath}" for future use?`,
+	});
+
+	if (shouldSave) {
+		writeFileSync(configPath, JSON.stringify({ dataPath }, null, 2));
+	}
+}
+
+const symlinkPath = resolve(dataPath, "modules", moduleJSON.id);
+const symlinkStats = lstatSync(symlinkPath, { throwIfNoEntry: false });
+if (symlinkStats) {
+	const atPath = symlinkStats.isDirectory() ? "folder" : symlinkStats.isSymbolicLink() ? "symlink" : "file";
+	const proceed = await p.confirm({
+		initialValue: false,
+		message: `A "${moduleJSON.id}" ${atPath} already exists in the "modules" subfolder. Replace with new symlink?`,
+	});
+	if (!proceed) {
+		p.cancel("Aborting.");
+		process.exit(0);
+	}
+}
+
+try {
+	if (symlinkStats?.isDirectory()) {
+		rmSync(symlinkPath, { recursive: true, force: true });
+	} else if (symlinkStats) {
+		unlinkSync(symlinkPath);
+	}
+	symlinkSync(resolve(process.cwd()), symlinkPath);
+} catch (error) {
+	if (error instanceof Error) {
+		console.error(`An error was encountered trying to create a symlink: ${error.message}`);
+		process.exit(1);
+	}
+}
+
+p.outro(`Symlink successfully created at "${symlinkPath}"!`);

package/templates/vite/src/index.ts

@@ -0,0 +1 @@
+import "./module.css";

package/templates/vite/vite.config.ts

@@ -0,0 +1,100 @@
+import type { Plugin, UserConfig } from "vite";
+import path from "node:path";
+import fs from 'node:fs';
+import vttSync from "foundryvtt-sync";
+import { defineConfig } from "vite";
+import moduleJSON from "./module.json" with { type: "json" };
+import postcssPresetEnv from "postcss-preset-env";
+import 'dotenv/config'
+
+const target = "es2022"; // Build target for the vinal bundle.
+const foundryPort = Number(process.env.FOUNDRY_PORT || 30000); // Which port your FoundryVTT instance is hosted at.
+const devPort = Number(process.env.DEV_PORT || 30001); // Which port you want to use for development.
+const libEntry = "index.ts"; // The main entry file to begin crawling from (root being `src/`).
+
+const postcss = {
+	inject: false,
+	sourceMap: true,
+	extensions: [".css"],
+	plugins: [postcssPresetEnv],
+};
+
+const PACKAGE_ID = `modules/${moduleJSON.id}`;
+
+console.log(`Running foundry port ${foundryPort} -> dev port ${devPort}`)
+
+export default defineConfig(({ mode: _mode }) => {
+	return {
+		root: "src/", // Source location / esbuild root.
+		base: `/${PACKAGE_ID}/dist`, // Base module path.
+		publicDir: false, // No public resources to copy.
+		cacheDir: "../.vite-cache", // Relative from root directory.
+
+		resolve: {
+			conditions: ["browser", "import", "default"], // Only use browser-compatible exports from node modules.
+			alias: {
+				$lib: path.resolve(__dirname, "./src/lib"),
+				moduleJSON: path.resolve(__dirname, "./module.json"),
+			},
+		},
+
+		esbuild: { target }, // https://esbuild.github.io/api/#transform
+
+		css: { postcss }, // https://vite.dev/config/shared-options#css-postcss
+
+		server: {
+			port: devPort,
+			open: "/game",
+			proxy: {
+				// Serves static files from main Foundry server.
+				[`^(/${PACKAGE_ID}/(assets|lang|packs))`]: `http://localhost:${foundryPort}`,
+
+				// All other paths besides package ID path are served from main Foundry server.
+				[`^(?!/${PACKAGE_ID}/)`]: `http://localhost:${foundryPort}`,
+
+				// Rewrite incoming `module-id.js` request from Foundry to the dev server libEntry.
+				[`/${PACKAGE_ID}/dist/${moduleJSON.id}.js`]: {
+					target: `http://localhost:${devPort}/${PACKAGE_ID}/dist`,
+					rewrite: () => libEntry,
+				},
+
+				// Enable socket.io from main Foundry server.
+				"/socket.io": { target: `ws://localhost:${foundryPort}`, ws: true },
+			},
+		},
+		build: {
+			outDir: "../dist", // The output directory.
+			emptyOutDir: false,
+			sourcemap: true, // Provide a publicly available sourcemap for debuggin purposes.
+			target,
+			lib: {
+				entry: "./" + libEntry,
+				formats: ["es"],
+				fileName: moduleJSON.id,
+			},
+			rollupOptions: {
+				output: {
+					// Rewrite the default style.css to a more recognizable file name.
+					assetFileNames: assetInfo =>
+						assetInfo.name === "style.css" ? `${moduleJSON.id}.css` : assetInfo.name as string,
+				},
+			},
+		},
+
+		plugins: [
+			vttSync(moduleJSON, {}) as Plugin[], // Build the database from JSON files on build
+			{
+				name: 'create-dist-files', // Create dummy files for Foundry's tests to pass
+				apply: 'serve',
+				buildStart() {
+					if (!fs.existsSync('dist')) fs.mkdirSync('dist');
+
+					const files = [...moduleJSON.esmodules, ...moduleJSON.styles];
+					for (const name of files) {
+						fs.writeFileSync(name, '', { flag: 'a' });
+					}
+				},
+			},
+		],
+	} satisfies UserConfig;
+});