133 lines
3.9 KiB
JavaScript
133 lines
3.9 KiB
JavaScript
const Command = require("../structures/Command")
|
|
const { CommandWords } = require("../constants")
|
|
const { getSkeleton, fleshOutSkeleton } = require("./skeleton")
|
|
const questions = require("../questions")
|
|
const fs = require("fs")
|
|
const { PLUGIN_TYPE_ARR } = require("@budibase/types")
|
|
const { validate } = require("@budibase/backend-core/plugins")
|
|
const { runPkgCommand } = require("../exec")
|
|
const { join } = require("path")
|
|
const { success, error, info } = require("../utils")
|
|
|
|
function checkInPlugin() {
|
|
if (!fs.existsSync("package.json")) {
|
|
throw new Error(
|
|
"Please run in a plugin directory - must contain package.json"
|
|
)
|
|
}
|
|
if (!fs.existsSync("schema.json")) {
|
|
throw new Error(
|
|
"Please run in a plugin directory - must contain schema.json"
|
|
)
|
|
}
|
|
}
|
|
|
|
async function init(opts) {
|
|
const type = opts["init"] || opts
|
|
if (!type || !PLUGIN_TYPE_ARR.includes(type)) {
|
|
console.log(
|
|
error(
|
|
"Please provide a type to init, either 'component' or 'datasource'."
|
|
)
|
|
)
|
|
return
|
|
}
|
|
console.log(info("Lets get some details about your new plugin:"))
|
|
const name = await questions.string("Name", `budibase-${type}`)
|
|
if (fs.existsSync(name)) {
|
|
console.log(
|
|
error("Directory by plugin name already exists, pick a new name.")
|
|
)
|
|
return
|
|
}
|
|
const desc = await questions.string(
|
|
"Description",
|
|
`An amazing Budibase ${type}!`
|
|
)
|
|
const version = await questions.string("Version", "1.0.0")
|
|
// get the skeleton
|
|
console.log(info("Retrieving project..."))
|
|
await getSkeleton(type, name)
|
|
await fleshOutSkeleton(type, name, desc, version)
|
|
console.log(info("Installing dependencies..."))
|
|
await runPkgCommand("install", join(process.cwd(), name))
|
|
console.log(info(`Plugin created in directory "${name}"`))
|
|
}
|
|
|
|
async function verify() {
|
|
// will throw errors if not acceptable
|
|
checkInPlugin()
|
|
console.log(info("Verifying plugin..."))
|
|
const schema = fs.readFileSync("schema.json", "utf8")
|
|
const pkg = fs.readFileSync("package.json", "utf8")
|
|
let name, version
|
|
try {
|
|
const schemaJson = JSON.parse(schema)
|
|
const pkgJson = JSON.parse(pkg)
|
|
if (!pkgJson.name || !pkgJson.version || !pkgJson.description) {
|
|
throw new Error(
|
|
"package.json is missing one of 'name', 'version' or 'description'."
|
|
)
|
|
}
|
|
name = pkgJson.name
|
|
version = pkgJson.version
|
|
validate(schemaJson)
|
|
return { name, version }
|
|
} catch (err) {
|
|
if (err && err.message && err.message.includes("not valid JSON")) {
|
|
console.log(error(`schema.json is not valid JSON: ${err.message}`))
|
|
} else {
|
|
console.log(error(`Invalid schema/package.json: ${err.message}`))
|
|
}
|
|
}
|
|
}
|
|
|
|
async function build() {
|
|
const verified = await verify()
|
|
if (!verified.name) {
|
|
return
|
|
}
|
|
console.log(success("Verified!"))
|
|
console.log(info("Building plugin..."))
|
|
await runPkgCommand("build")
|
|
const output = join("dist", `${verified.name}-${verified.version}.tar.gz`)
|
|
console.log(success(`Build complete - output in: ${output}`))
|
|
}
|
|
|
|
async function watch() {
|
|
const verified = await verify()
|
|
if (!verified.name) {
|
|
return
|
|
}
|
|
const output = join("dist", `${verified.name}-${verified.version}.tar.gz`)
|
|
console.log(info(`Watching - build in: ${output}`))
|
|
try {
|
|
await runPkgCommand("watch")
|
|
} catch (err) {
|
|
// always errors when user escapes
|
|
console.log(success("Watch exited."))
|
|
}
|
|
}
|
|
|
|
const command = new Command(`${CommandWords.PLUGIN}`)
|
|
.addHelp(
|
|
"Custom plugins for Budibase, init, build and verify your components and datasources with this tool."
|
|
)
|
|
.addSubOption(
|
|
"--init [type]",
|
|
"Init a new plugin project, with a type of either component or datasource.",
|
|
init
|
|
)
|
|
.addSubOption(
|
|
"--build",
|
|
"Build your plugin, this will verify and produce a final tarball for your project.",
|
|
build
|
|
)
|
|
.addSubOption(
|
|
"--watch",
|
|
"Automatically build any changes to your plugin.",
|
|
watch
|
|
)
|
|
|
|
exports.command = command
|