Skip to content
This repository has been archived by the owner on Jun 22, 2022. It is now read-only.

Graviton-Code-Editor/graviton-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

81 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧵 Graviton SDK

SDK to develop plugins for Graviton Editor

It makes use of Webpack, ts-loader and babel under the hood.

✍ Usage

Installation:

npm install --save-dev @gveditor/sdk

Develop plugin for development:

gvsdk --project ./ --target plugin --mode dev

Build plugin for production:

gvsdk --project ./ --target plugin --mode release

📜 Usage

Manifest file (package.json) should have the property mainSrc which indicates where the entry file (aka main file) is located.

Example:

{
	"name": "plugin-example",
	"type":"plugin",
	"version": "1.0.0",
	"mainSrc": "src/main.js",
	"main": "main.js",
	"license": "MIT"
}

CLI parameters:

  • --project: Path of the Plugin's folder where the manifest (package.json) is located
  • --target: Target type:
    • plugin ( aka Dynamic or JavaScript plugin )
    • iconpack ( Icons pack )
    • theme ( UI themes )
  • --mode: Build type (dev, release)
  • --platform: Any webpack target, it defaults to 'node'

Example:

gvsdk --target plugin --project . --mode release

This will generate a release of the plugin you are located in.

🤖 Where is this being used?

And Graviton Editor itself.