From fea0d098d109df7290fbd7a3a895d2ea930c45f3 Mon Sep 17 00:00:00 2001 From: Mees van der Wijk Date: Thu, 28 Aug 2025 00:26:25 +0200 Subject: [PATCH] Updated specs --- V1ModuleStructure.md | 2 +- V2ModuleStructure.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/V1ModuleStructure.md b/V1ModuleStructure.md index 9f45d15..8406cee 100644 --- a/V1ModuleStructure.md +++ b/V1ModuleStructure.md @@ -1,6 +1,6 @@ # V1 Module Structure -V1 modules represent the legacy approach to building Getiyo modules. They have several limitations: all TypeScript files are combined into a single global scope, modern JavaScript standards like import/export statements aren't supported, and there's no capability to import external Node packages. These constraints make development less efficient and maintainable. Additionally [gmt watch](./GetiyoModuleTool#watch) is not supported for V1 modules. For a significantly improved development experience with modern features, we strongly recommend using [V2 modules](./V2ModuleStructure) for all new module development. +V1 modules represent the legacy approach to building Getiyo modules. They can be identified by having a `module.json` file. They have several limitations: all TypeScript files are combined into a single global scope, modern JavaScript standards like import/export statements aren't supported, and there's no capability to import external Node packages. These constraints make development less efficient and maintainable. Additionally [gmt watch](./GetiyoModuleTool#watch) is not supported for V1 modules. For a significantly improved development experience with modern features, we strongly recommend using [V2 modules](./V2ModuleStructure) for all new module development. Each module in Getiyo comprises four key components: module.json, a server-side script, a user page, and optionally a control/external page. The detailed structure of each component is outlined below. You can automatically set up this file structure by using the [GetiyoModuleTool](./GetiyoModuleTool), as described in the ["Setting up a development environment]"(./ModuleEnvironment) section of the documentation. diff --git a/V2ModuleStructure.md b/V2ModuleStructure.md index 7f61182..52359d4 100644 --- a/V2ModuleStructure.md +++ b/V2ModuleStructure.md @@ -1,6 +1,6 @@ # V2 Module Structure -V2 modules represent the modern approach to building Getiyo modules, offering significant improvements over V1 modules. They support modern JavaScript features like import/export statements and allow the use of external Node packages, making development more efficient and maintainable. Each module comprises four key components: module.ts, a server-side script, a user page, and optionally a control/external page. The detailed structure of each component is outlined below. You can automatically set up this file structure by using the [GetiyoModuleTool](./GetiyoModuleTool), as described in the ["Setting up a development environment"](./ModuleEnvironment) section of the documentation. +V2 modules represent the modern approach to building Getiyo modules, offering significant improvements over V1 modules. They can be identified by having a `module.ts` file. They support modern JavaScript features like import/export statements and allow the use of external Node packages, making development more efficient and maintainable. Each module comprises four key components: module.ts, a server-side script, a user page, and optionally a control/external page. The detailed structure of each component is outlined below. You can automatically set up this file structure by using the [GetiyoModuleTool](./GetiyoModuleTool), as described in the ["Setting up a development environment"](./ModuleEnvironment) section of the documentation. ``` Module Root