PeerTube/server/lib/plugins/yarn.ts

74 lines
2.2 KiB
TypeScript
Raw Normal View History

2021-04-12 10:10:48 +02:00
import { outputJSON, pathExists } from 'fs-extra'
import { join } from 'path'
2019-07-05 15:28:49 +02:00
import { execShell } from '../../helpers/core-utils'
import { isNpmPluginNameValid, isPluginStableOrUnstableVersionValid } from '../../helpers/custom-validators/plugins'
2021-04-12 10:10:48 +02:00
import { logger } from '../../helpers/logger'
2019-07-05 15:28:49 +02:00
import { CONFIG } from '../../initializers/config'
2021-04-12 10:10:48 +02:00
import { getLatestPluginVersion } from './plugin-index'
2019-07-05 15:28:49 +02:00
2021-04-12 10:10:48 +02:00
async function installNpmPlugin (npmName: string, versionArg?: string) {
2019-07-05 15:28:49 +02:00
// Security check
2019-07-19 10:37:35 +02:00
checkNpmPluginNameOrThrow(npmName)
2021-04-12 10:10:48 +02:00
if (versionArg) checkPluginVersionOrThrow(versionArg)
const version = versionArg || await getLatestPluginVersion(npmName)
2019-07-19 10:37:35 +02:00
let toInstall = npmName
if (version) toInstall += `@${version}`
2019-07-05 15:28:49 +02:00
2019-07-19 14:36:04 +02:00
const { stdout } = await execYarn('add ' + toInstall)
logger.debug('Added a yarn package.', { yarnStdout: stdout })
2019-07-05 15:28:49 +02:00
}
async function installNpmPluginFromDisk (path: string) {
await execYarn('add file:' + path)
}
async function removeNpmPlugin (name: string) {
checkNpmPluginNameOrThrow(name)
await execYarn('remove ' + name)
}
async function rebuildNativePlugins () {
await execYarn('install --pure-lockfile')
}
2019-07-05 15:28:49 +02:00
// ############################################################################
export {
installNpmPlugin,
installNpmPluginFromDisk,
rebuildNativePlugins,
2019-07-05 15:28:49 +02:00
removeNpmPlugin
}
// ############################################################################
async function execYarn (command: string) {
try {
const pluginDirectory = CONFIG.STORAGE.PLUGINS_DIR
const pluginPackageJSON = join(pluginDirectory, 'package.json')
// Create empty package.json file if needed
if (!await pathExists(pluginPackageJSON)) {
await outputJSON(pluginPackageJSON, {})
}
2019-07-19 14:36:04 +02:00
return execShell(`yarn ${command}`, { cwd: pluginDirectory })
2019-07-05 15:28:49 +02:00
} catch (result) {
logger.error('Cannot exec yarn.', { command, err: result.err, stderr: result.stderr })
throw result.err
}
}
function checkNpmPluginNameOrThrow (name: string) {
if (!isNpmPluginNameValid(name)) throw new Error('Invalid NPM plugin name to install')
}
function checkPluginVersionOrThrow (name: string) {
if (!isPluginStableOrUnstableVersionValid(name)) throw new Error('Invalid NPM plugin version to install')
2019-07-05 15:28:49 +02:00
}