Support async plugins / extensions

Code I’d like to write:

import { ghauth } from "../util/promised_ghauth"
import { Context } from "../context"

const setGithubCredentials = async (context: Context) => {
  context.githubAuth = await ghauth()
}

module.exports = setGithubCredentials

and

import { getSettings } from "../util/settings"
import { Context } from "../context"

const setSettings = async (context: Context) => {
  context.settings = await getSettings()
}

module.exports = setSettings

The GH Auth prompt does a bunch of pre-requisite work, it’s feasible that I can add a function to handle it per-command but it’s basically something I want on the first time user flow anyway.

I took a quick look at this and it seems like it’d add async code everywhere so opted to not PR right now and to move it to a function my command can handle as I only have one 😉

Opened so people can decide if this is something you want

[RichiCoder1]

I really like the idea of is-outdated being built in to Gluegun. Perhaps on toolbox.meta.outdated() as an async function?

Indeed! I like it. Though it might also be good to have it on builder too. Something like:

// ready
const { build } = require('gluegun')
const package = require('../package.json')

// aim
const movieCLI = build('movie')
  .src(`${__dirname}/core-plugins`)
  .plugins('node_modules', { matching: 'movie-*' })
  .help()
  .version()
  .checkForUpdates(package.name, package.version)
  .defaultCommand()
  .create()

// fire!
movieCLI.run()

Probably worth it’s own issue.

[RichiCoder1]

I’m realizing that my use case may be slightly different than the authors. But the idea would be like this: https://github.com/infinitered/gluegun/pull/449

Basically so I can have an extension like: companySettings.ts which has

import { getSettingsAsync } from "../my/helper";

function async setupPluginRemoteConfig(toolbox: MyCompanyToolbox) {
    const settings = await getSettingsAsync();
    toolbox.plugin = ((plugin) => {
        plugin.settings = settings;
    })(toolbox.plugin || {}):    
}
export default setupPluginRemoteConfig;

Edit: or something like updateCheck.ts

import { isOutdated } from 'is-outdated';
const  = require('./package.json');
 
function async checkForNewVersion(toolbox) {
    const { version, outdated } = await isOutdated(pkg.name, pkg.version);
    const { print: { warn } } = toolbox;
    if (outdated) {
        warn('The latest version of this app is %s', res.version);
        warn(`Please updated it with: npm update -g ${pkg.name}`);
    }
}
export default checkForNewVersion;

Though there’s an argument to be made for the latter being in gluegun itself.