vite-plugin-fvtt 0.1.4 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+## [0.2.1] - 2025-09-09
+
+### Fixed
+
+- Fixed language generation to not error out on mixed entries.
+
+## [0.2.0] - 2025-09-08
+
+### Added
+
+- Automatic compiling of packs for watch and build mode, when discovered.
+- Option to skip the automatic compilation of packs `{ buildPacks: false }`.
+- Documenting the changes in a `CHANGELOG.md` for the plugin.
+
+## [0.1.4] - 2025-09-06
+
+### Added
+
+- In watch mode, the plugin now automatically avoids cleaning the output directory, if `emptyOutDir`
+  is not set.
+
+### Fixed
+
+- By using rollupOptions, the output files are now correctly named as specified by the foundry vtt
+  manifest, even in case `{ "type": "module" }` is not set in the `package.json`.
+
+### Changed
+
+- Defaults in case of unspecified `esmodules`, `scripts`, or `styles` in the foundry vtt manifest
+  now default to the folder structure suggested by foundry vtt.
+
+## [0.1.3] - 2025-09-04
+
+### Added
+
+- Manifest and language files not in the public directory are now watched during `--watch`.
+
+### Changed
+
+- Updated the documentation.
+
+### Fixed
+
+- HMR for language files only manually reloads all active translations for the current module.
+- HMR for templates now manually reassigns them on successful compilation instead of using
+  `getTemplate`. This prevents an missing template from appearing after a failed HMR compilation.
+
+## [0.1.2] - 2025-09-03
+
+### Added
+
+- Automatic npm deployment on tag push.
+
+### Changed
+
+- Replaced glob with tinyglobby to match vite's dependencies and not add more unnecessary modules.
+- Default to `bundle.css` if no style file is specified in the manifest, but one was found during
+  compilation as an asset.
+
+### Fixed
+
+- Add typechecks to guard against missing manifest entries.
+
+## [0.1.1] - 2025-09-02
+
+### Added
+
+- Initial Release
+
+[unreleased]: https://github.com/MatyeusM/vite-plugin-fvtt/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/MatyeusM/vite-plugin-fvtt/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/MatyeusM/vite-plugin-fvtt/compare/v0.1.4...v0.2.0
+[0.1.4]: https://github.com/MatyeusM/vite-plugin-fvtt/compare/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/MatyeusM/vite-plugin-fvtt/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/MatyeusM/vite-plugin-fvtt/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/MatyeusM/vite-plugin-fvtt/releases/tag/v0.1.1

package/README.md

@@ -1,83 +1,115 @@
 # **vite-plugin-fvtt**
 
-A [Vite](https://vitejs.dev/) plugin to **streamline and automate** the development of Foundry VTT modules and systems.
+A [Vite](https://vitejs.dev/) plugin to **streamline and automate** the development of Foundry VTT
+modules and systems.
 
-It handles manifest resolution, asset copying, language file composition, and template handling with **minimal setup**, letting you focus on your code.
+It handles manifest resolution, asset copying, language file composition, and template handling with
+**minimal setup**, letting you focus on your code.
 
-The plugin's core goal is to enable a robust HMR workflow via Vite's development server, freeing you from Foundry VTT's native HMR and build watch commands.
+The plugin's core goal is to enable a robust HMR workflow via Vite's development server, freeing you
+from Foundry VTT's native HMR and build watch commands.
+
+[**Changelog**](CHANGELOG.md)
 
 ## **🚀 Getting Started**
 
 ### **Step 1. Setup a Foundry VTT Project**
 
-Create a standard [Foundry VTT module or system](https://foundryvtt.com/article/module-development/).
-Place your `module.json` or `system.json` manifest in either your **project root** or your **public/** directory.
+Create a standard
+[Foundry VTT module or system](https://foundryvtt.com/article/module-development/). Place your
+`module.json` or `system.json` manifest in either your **project root** or your **public/**
+directory.
 
 ### **Step 2. Add the Plugin to your Vite Config**
 
 Install the plugin with `npm i -D vite-plugin-fvtt`.
 
-Add the plugin to your vite.config.js. The **build.lib.entry** field is required; most of the other settings are inferred by the plugin from your Foundry VTT manifest.
+Add the plugin to your vite.config.js. The **build.lib.entry** field is required; most of the other
+settings are inferred by the plugin from your Foundry VTT manifest.
 
 ```js
 // vite.config.js
-import { defineConfig } from 'vite';
-import foundryVTT from 'vite-plugin-fvtt';
+import { defineConfig } from 'vite'
+import foundryVTT from 'vite-plugin-fvtt'
 
 export default defineConfig({
   plugins: [foundryVTT()],
   build: {
     // ⚠️ Required: The entry point for your module/system.
     // This file should import your main CSS/SCSS/LESS file.
-    lib: {
-      entry: './src/main.js',
-    },
+    lib: { entry: './src/main.js' },
     sourcemap: true,
   },
-});
+})
 ```
 
 ## **⚙️ Features**
 
 ### **1. Configuration**
-The plugin needs to know where your Foundry VTT instance is running to proxy and serve assets correctly. If you want to change anything from the defaults `http://localhost:30000`, create a `.env.foundryvtt.local` file in your project.
+
+The plugin needs to know where your Foundry VTT instance is running to proxy and serve assets
+correctly. If you want to change anything from the defaults `http://localhost:30000`, create a
+`.env.foundryvtt.local` file in your project.
+
 ```ini
 FOUNDRY_URL=localhost
 FOUNDRY_PORT=30000
 ```
 
-The Vite dev server will run on `FOUNDRY_PORT + 1`, where you will need to open your browser manually to.
+The Vite dev server will run on `FOUNDRY_PORT + 1`, where you will need to open your browser
+manually to.
 
 ### **2. Manifest & Asset Resolution**
 
-The plugin automatically detects your manifest file (`module.json` or `system.json`) in the project **root** or `public/` folder.
+The plugin automatically detects your manifest file (`module.json` or `system.json`) in the project
+**root** or `public/` folder.
 
-This plugin shapes the output depending on your manifest; it tries to automatically discover the relevant files in the `root`, `source`, and `public` folders to build the output files. The `public` folder is defined by the Vite config file. The plugin determines the `source` directory based on your `lib.entry` path. For example, if your `lib.entry` is './mysource/package/main.js', the `mysource/` directory is considered your source directory.
+This plugin shapes the output depending on your manifest; it tries to automatically discover the
+relevant files in the `root`, `source`, and `public` folders to build the output files. The `public`
+folder is defined by the Vite config file. The plugin determines the `source` directory based on
+your `lib.entry` path. For example, if your `lib.entry` is './mysource/package/main.js', the
+`mysource/` directory is considered your source directory.
 
-💡 Your entry file should always import your main stylesheet; the manifest dictates how everything is named and output.
+💡 Your entry file should always import your main stylesheet; the manifest dictates how everything
+is named and output.
 
 ### **3. ESModules, Scripts & Styles**
 
-`esmodules` and `scripts` declared in your manifest are automatically created from your `lib.entry`. Since Vite compiles the module, the plugin expects the `esmodules` or `scripts` entry in your manifest to only point to a single JavaScript file.
+`esmodules` and `scripts` declared in your manifest are automatically created from your `lib.entry`.
+Since Vite compiles the module, the plugin expects the `esmodules` or `scripts` entry in your
+manifest to only point to a single JavaScript file.
 
-Stylesheets (CSS/SCSS/LESS) should be imported in your entry file; the plugin ensures they are outputted as the correct file.
+Stylesheets (CSS/SCSS/LESS) should be imported in your entry file; the plugin ensures they are
+outputted as the correct file.
 
 ### **4. Template Handling**
 
-Templates work in HMR properly on the development server; they are autodiscovered as discussed in [2. Manifest & Asset Resolution](#2-manifest--asset-resolution). The development server intercepts the websocket traffic and sends the local templates instead of Foundry VTT's, if present. e.g., a template request to `/systems/mysystem/tpl/character-header.hbs` might be rerouted to `public/tpl/character-header.hbs`. Folder structure inside your project is mirrored, apart from the `system`/`module` specific prefix.
+Templates work in HMR properly on the development server; they are autodiscovered as discussed in
+[2. Manifest & Asset Resolution](#2-manifest--asset-resolution). The development server intercepts
+the websocket traffic and sends the local templates instead of Foundry VTT's, if present. e.g., a
+template request to `/systems/mysystem/tpl/character-header.hbs` might be rerouted to
+`public/tpl/character-header.hbs`. Folder structure inside your project is mirrored, apart from the
+`system`/`module` specific prefix.
 
 ### **5. Language File Merging**
 
 Supports both complete and partial translation workflows:
 
-* **Complete files:** Place a complete JSON file (e.g., `public/lang/en.json`) and the plugin will copy it as-is.
-* **Partial files:** Place multiple JSONs inside `src/lang/en/` and the plugin merges them into one `lang/en.json` at build.
+- **Complete files:** Place a complete JSON file (e.g., `public/lang/en.json`) and the plugin will
+  copy it as-is.
+- **Partial files:** Place multiple JSONs inside `src/lang/en/` and the plugin merges them into one
+  `lang/en.json` at build.
 
 Merging follows your manifest’s declared language paths, searching in root or source directories.
 
-⚠️ **Note:** HMR works for language files, but non-English locales may not reload as expected.
+### **6. Packs**
+
+Packs are tried to be auto-discovered in the source directory. If the paths match, they are automatically compiled.
+
+**Note:** Packs are currently not watched for changes.
 
 ### **Example Project Structure**
+
 ```
 my-module/
 ├─ src/

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { Plugin } from "vite";
 
 //#region src/index.d.ts
-declare function foundryVTTPlugin(): Plugin;
+declare function foundryVTTPlugin(options?: {
+  buildPacks: boolean;
+}): Plugin;
 //#endregion
 export { foundryVTTPlugin as default };

package/dist/index.js

@@ -2,6 +2,7 @@ import fs from "fs-extra";
 import posix from "path/posix";
 import dotenv from "dotenv";
 import { globSync } from "tinyglobby";
+import { compilePack } from "@foundryvtt/foundryvtt-cli";
 import { Server } from "socket.io";
 import { io } from "socket.io-client";
 
@@ -390,6 +391,31 @@ function validator() {
 	}
 }
 
+//#endregion
+//#region src/packs/compile-packs.ts
+async function compileManifestPacks() {
+	if (!context.manifest?.packs) return;
+	for (const pack of context.manifest.packs) {
+		const srcCandidates = [posix.resolve(path_utils_default.getSourceDirectory(), pack.path), posix.resolve(path_utils_default.getRoot(), pack.path)];
+		const dest = posix.resolve(path_utils_default.getOutDir(), pack.path);
+		const chosenSrc = srcCandidates.find((candidate) => fs.existsSync(candidate) && fs.statSync(candidate).isDirectory());
+		if (!chosenSrc) {
+			logger_default.warn(`Pack path not found for ${pack.path}, skipped.`);
+			continue;
+		}
+		const entries = fs.readdirSync(chosenSrc, {
+			recursive: true,
+			encoding: "utf8"
+		});
+		const hasYaml = entries.some((entry) => entry.endsWith(".yaml") || entry.endsWith(".yml"));
+		await compilePack(chosenSrc, dest, {
+			yaml: hasYaml,
+			recursive: true
+		});
+		logger_default.info(`Compiled pack ${pack.path} (${hasYaml ? "YAML" : "JSON"}) from ${chosenSrc}`);
+	}
+}
+
 //#endregion
 //#region src/server/trackers/handlebars-tracker.ts
 var HandlebarsTracker = class extends AbstractFileTracker {
@@ -561,7 +587,7 @@ if (import.meta.hot) {
 
 //#endregion
 //#region src/index.ts
-function foundryVTTPlugin() {
+function foundryVTTPlugin(options = { buildPacks: true }) {
 	context.env = loadEnv();
 	return {
 		name: "vite-plugin-fvtt",
@@ -572,28 +598,36 @@ function foundryVTTPlugin() {
 		configResolved(config) {
 			context.config = config;
 		},
-		async writeBundle() {
-			if (!context.config) return;
-			const outDir = path_utils_default.getOutDir();
-			const candidates = ["system.json", "module.json"];
-			for (const file of candidates) {
+		async generateBundle() {
+			const manifestCandidates = ["system.json", "module.json"];
+			for (const file of manifestCandidates) {
 				const src = posix.resolve(file);
-				if (!path_utils_default.getOutDirFile(file) && fs.existsSync(src)) {
+				if (!path_utils_default.getPublicDirFile(file) && fs.existsSync(src)) {
 					this.addWatchFile(src);
-					const dest = posix.join(outDir, file);
-					await fs.copy(src, dest);
-					logger_default.info(`Copied ${file} >>> ${dest}`);
+					const manifest = fs.readJsonSync(src);
+					this.emitFile({
+						type: "asset",
+						fileName: file,
+						source: JSON.stringify(manifest, null, 2)
+					});
 				}
 			}
 			const languages = context.manifest?.languages ?? [];
 			if (languages.length > 0) for (const language of languages) {
-				if (path_utils_default.getOutDirFile(language.path)) continue;
+				if (path_utils_default.getPublicDirFile(language.path)) continue;
 				getLocalLanguageFiles(language.lang).forEach((langFile) => this.addWatchFile(langFile));
 				const languageDataRaw = loadLanguage(language.lang);
 				const languageData = transform(languageDataRaw);
-				fs.writeJSONSync(posix.join(outDir, language.path), languageData);
+				this.emitFile({
+					type: "asset",
+					fileName: posix.join(language.path),
+					source: JSON.stringify(languageData, null, 2)
+				});
 			}
 		},
+		async writeBundle() {
+			if (options.buildPacks) await compileManifestPacks();
+		},
 		closeBundle() {
 			const languages = context.manifest?.languages ?? [];
 			if (languages.length > 0) validator();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-fvtt",
-  "version": "0.1.4",
+  "version": "0.2.1",
   "description": "A Vite plugin for module and system development for Foundry VTT",
   "keywords": [
     "vite",
@@ -22,6 +22,7 @@
   "types": "dist/index.d.ts",
   "files": [
     "dist",
+    "CHANGELOG.md",
     "LICENSE",
     "README.md"
   ],
@@ -41,6 +42,7 @@
     "vite": "*"
   },
   "dependencies": {
+    "@foundryvtt/foundryvtt-cli": "^3.0.0",
     "dotenv": "^17.2.1",
     "fs-extra": "^11.3.1",
     "socket.io": "^4.8.1",