Geex Schematics is a vscode extension designed to generate code scaffolding based on templates provided by the Geex framework. With this extension, you can quickly create modules, aggregates, and other components by leveraging pre-built templates through a simple user interface.
Features
Generate Code Scaffolding: Quickly generate schematics and modules based on predefined templates.
GraphQL API Integration: The extension interacts with the Geex GraphQL API to create templates.
Customizable Templates: Choose from several template options like client_admin, module, solution, and more.
Download and Unzip: Automatically downloads generated ZIP files from the Geex server and unzips them in the selected directory.
Requirements
vscode version 1.93.0 or above.
Getting Started
Usage
Right-click on a folder in the Explorer view and select the option Geex: Generate Schematics.
You will be prompted to provide the following information:
Organization Name: The name of your organization.
Module Name: The module name you want to create.
Aggregate Name: The aggregate name related to the module.
Select a template from the available options:
client_admin
client_docs
module
schematics_admin_module
solution
The extension will invoke the Geex GraphQL API to generate the template files.
The generated ZIP file will be downloaded, extracted, and saved to the selected folder.
Example
Right-click on a folder in the VSCode Explorer panel.
Select Geex: Generate Schematics.
Input the following information when prompted:
Organization Name: MyOrg
Module Name: MyModule
Aggregate Name: MyAggregate
Choose a template, for example, module.
Wait for the extension to download and unzip the generated code.
The code will be extracted into the folder you selected.
Dependencies
The extension uses the following dependencies:
TypeScript: TypeScript is used to write the extension code.
GraphQL Request: Interacts with the Geex GraphQL API.
Adm-Zip: For extracting the downloaded ZIP files.
Vite: Used for building the extension.
Development
To contribute to the development of this extension, follow these steps:
Clone the repository.
Install dependencies with pnpm install.
Run pnpm watch to automatically build the extension during development.
Scripts
pnpm build: Build the extension using Vite.
pnpm watch: Watch for file changes and rebuild.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
Thank you for using Geex Schematics! For any issues, feel free to report them on the GitHub repository.
