@gimloader/build
Advanced tools
Comparing version
@@ -21,14 +21,14 @@ export function createHeader(config) { | ||
} | ||
if (config.libs) { | ||
for (let lib of config.libs) { | ||
meta += `\n * @needsLib ${lib}`; | ||
} | ||
} | ||
if (config.optionalLibs) { | ||
for (let lib of config.optionalLibs) { | ||
meta += `\n * @optionalLib ${lib}`; | ||
} | ||
} | ||
if (!config.isLibrary) { | ||
let pluginConfig = config; | ||
if (pluginConfig.libs) { | ||
for (let lib of pluginConfig.libs) { | ||
meta += `\n * @needsLib ${lib}`; | ||
} | ||
} | ||
if (pluginConfig.optionalLibs) { | ||
for (let lib of pluginConfig.optionalLibs) { | ||
meta += `\n * @optionalLib ${lib}`; | ||
} | ||
} | ||
if (pluginConfig.hasSettings) { | ||
@@ -35,0 +35,0 @@ meta += '\n * @hasSettings true'; |
@@ -8,12 +8,2 @@ import type { BuildOptions, Plugin } from "esbuild"; | ||
/** | ||
* A list of libraries that the plugin requires to start. | ||
* Libraries are formatted like "[name]" or "[name] | [downloadUrl]". | ||
*/ | ||
libs: string[]; | ||
/** | ||
* A list of libraries that the plugin will optionally use. | ||
* Libraries are formatted like "[name]" or "[name] | [downloadUrl]". | ||
*/ | ||
optionalLibs: string[]; | ||
/** | ||
* Whether the plugin has a settings menu. | ||
@@ -71,2 +61,12 @@ */ | ||
esbuildOptions?: BuildOptions; | ||
/** | ||
* A list of libraries that the plugin requires to start. | ||
* Libraries are formatted like "[name]" or "[name] | [downloadUrl]". | ||
*/ | ||
libs: string[]; | ||
/** | ||
* A list of libraries that the plugin will optionally use. | ||
* Libraries are formatted like "[name]" or "[name] | [downloadUrl]". | ||
*/ | ||
optionalLibs: string[]; | ||
}; | ||
@@ -73,0 +73,0 @@ export interface GLConfig { |
{ | ||
"name": "@gimloader/build", | ||
"version": "1.0.2", | ||
"version": "1.0.3", | ||
"description": "A package to help build complex plugins for Gimloader", | ||
@@ -19,3 +19,3 @@ "main": "dist/index.js", | ||
"type": "git", | ||
"url": "github.com/TheLazySquid/Gimloader" | ||
"url": "github.com/Gimloader/build" | ||
}, | ||
@@ -22,0 +22,0 @@ "keywords": [ |
# @gimloader/build | ||
This is a package that provides a preconfigured bundler to help build more complex [Gimloader](https://github.com/TheLazySquid/Gimloader) plugins and libraries. | ||
This is a package that provides a preconfigured bundler to help build more complex [Gimloader](https://github.com/Gimloader/Gimloader) plugins and libraries. | ||
@@ -25,7 +25,8 @@ ## Setup | ||
- `esbuildOptions`: Options to pass to esbuild | ||
##### Plugin Fields (Optional) | ||
- `libs`: A list of libraries to load. These strings should look like either "[library name]" or "[library name] | [download url]". | ||
- `optionalLibs`: The same as libs, but the plugin will still be run without these libraries. | ||
##### Plugin Fields (Optional) | ||
- `hasSettings`: Set to true if the plugin has a settings menu, so the button can be shown when it is disabled. | ||
##### Library Fields | ||
@@ -32,0 +33,0 @@ - `isLibrary`: Set to true if you are building a library. |
21131
0.18%44
2.33%