server/lib/plugins/yarn.ts

   1 import { outputJSON, pathExists } from 'fs-extra'
   2 import { join } from 'path'
   3 import { execShell } from '../../helpers/core-utils'
   4 import { isNpmPluginNameValid, isPluginVersionValid } from '../../helpers/custom-validators/plugins'
   5 import { logger } from '../../helpers/logger'
   6 import { CONFIG } from '../../initializers/config'
   7 import { getLatestPluginVersion } from './plugin-index'
   8
   9 async function installNpmPlugin (npmName: string, versionArg?: string) {
  10   // Security check
  11   checkNpmPluginNameOrThrow(npmName)
  12   if (versionArg) checkPluginVersionOrThrow(versionArg)
  13
  14   const version = versionArg || await getLatestPluginVersion(npmName)
  15
  16   let toInstall = npmName
  17   if (version) toInstall += `@${version}`
  18
  19   const { stdout } = await execYarn('add ' + toInstall)
  20
  21   logger.debug('Added a yarn package.', { yarnStdout: stdout })
  22 }
  23
  24 async function installNpmPluginFromDisk (path: string) {
  25   await execYarn('add file:' + path)
  26 }
  27
  28 async function removeNpmPlugin (name: string) {
  29   checkNpmPluginNameOrThrow(name)
  30
  31   await execYarn('remove ' + name)
  32 }
  33
  34 // ############################################################################
  35
  36 export {
  37   installNpmPlugin,
  38   installNpmPluginFromDisk,
  39   removeNpmPlugin
  40 }
  41
  42 // ############################################################################
  43
  44 async function execYarn (command: string) {
  45   try {
  46     const pluginDirectory = CONFIG.STORAGE.PLUGINS_DIR
  47     const pluginPackageJSON = join(pluginDirectory, 'package.json')
  48
  49     // Create empty package.json file if needed
  50     if (!await pathExists(pluginPackageJSON)) {
  51       await outputJSON(pluginPackageJSON, {})
  52     }
  53
  54     return execShell(`yarn ${command}`, { cwd: pluginDirectory })
  55   } catch (result) {
  56     logger.error('Cannot exec yarn.', { command, err: result.err, stderr: result.stderr })
  57
  58     throw result.err
  59   }
  60 }
  61
  62 function checkNpmPluginNameOrThrow (name: string) {
  63   if (!isNpmPluginNameValid(name)) throw new Error('Invalid NPM plugin name to install')
  64 }
  65
  66 function checkPluginVersionOrThrow (name: string) {
  67   if (!isPluginVersionValid(name)) throw new Error('Invalid NPM plugin version to install')
  68 }