-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add PluginLoader class * chore: remove semver dep
- Loading branch information
1 parent
19b280b
commit b31665d
Showing
6 changed files
with
174 additions
and
136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| import * as path from 'path' | ||
|
|
||
| import {Options, Plugin as IPlugin} from '../interfaces/plugin' | ||
| import * as Plugin from './plugin' | ||
| import {loadJSON, Debug} from './util' | ||
| import {isProd} from '../util' | ||
| import {Performance} from '../performance' | ||
|
|
||
| // eslint-disable-next-line new-cap | ||
| const debug = Debug() | ||
|
|
||
| type PluginLoaderOptions = { | ||
| root: string; | ||
| plugins?: IPlugin[] | PluginsMap; | ||
| } | ||
|
|
||
| type LoadOpts = { | ||
| devPlugins?: boolean; | ||
| userPlugins?: boolean; | ||
| dataDir: string; | ||
| rootPlugin: IPlugin; | ||
| force?: boolean; | ||
| } | ||
|
|
||
| type PluginsMap = Map<string, IPlugin> | ||
|
|
||
| export default class PluginLoader { | ||
| public plugins: PluginsMap = new Map() | ||
| public errors: (string | Error)[] = [] | ||
| private pluginsProvided = false | ||
|
|
||
| constructor(public options: PluginLoaderOptions) { | ||
| if (options.plugins) { | ||
| this.pluginsProvided = true | ||
| this.plugins = Array.isArray(options.plugins) ? new Map(options.plugins.map(p => [p.name, p])) : options.plugins | ||
| } | ||
| } | ||
|
|
||
| public async loadRoot(): Promise<IPlugin> { | ||
| let rootPlugin: IPlugin | ||
| if (this.pluginsProvided) { | ||
| const plugins = [...this.plugins.values()] | ||
| rootPlugin = plugins.find(p => p.root === this.options.root) ?? plugins[0] | ||
| } else { | ||
| rootPlugin = new Plugin.Plugin({root: this.options.root}) | ||
| await rootPlugin.load() | ||
| } | ||
|
|
||
| this.plugins.set(rootPlugin.name, rootPlugin) | ||
| return rootPlugin | ||
| } | ||
|
|
||
| public async loadChildren(opts: LoadOpts): Promise<{plugins: PluginsMap; errors: (string | Error)[]}> { | ||
| if (!this.pluginsProvided || opts.force) { | ||
| await this.loadUserPlugins(opts) | ||
| await this.loadDevPlugins(opts) | ||
| await this.loadCorePlugins(opts) | ||
| } | ||
|
|
||
| return {plugins: this.plugins, errors: this.errors} | ||
| } | ||
|
|
||
| private async loadCorePlugins(opts: LoadOpts): Promise<void> { | ||
| if (opts.rootPlugin.pjson.oclif.plugins) { | ||
| await this.loadPlugins(opts.rootPlugin.root, 'core', opts.rootPlugin.pjson.oclif.plugins) | ||
| } | ||
| } | ||
|
|
||
| private async loadDevPlugins(opts: LoadOpts): Promise<void> { | ||
| if (opts.devPlugins !== false) { | ||
| // do not load oclif.devPlugins in production | ||
| if (isProd()) return | ||
| try { | ||
| const devPlugins = opts.rootPlugin.pjson.oclif.devPlugins | ||
| if (devPlugins) await this.loadPlugins(opts.rootPlugin.root, 'dev', devPlugins) | ||
| } catch (error: any) { | ||
| process.emitWarning(error) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private async loadUserPlugins(opts: LoadOpts): Promise<void> { | ||
| if (opts.userPlugins !== false) { | ||
| try { | ||
| const userPJSONPath = path.join(opts.dataDir, 'package.json') | ||
| debug('reading user plugins pjson %s', userPJSONPath) | ||
| const pjson = await loadJSON(userPJSONPath) | ||
| if (!pjson.oclif) pjson.oclif = {schema: 1} | ||
| if (!pjson.oclif.plugins) pjson.oclif.plugins = [] | ||
| await this.loadPlugins(userPJSONPath, 'user', pjson.oclif.plugins.filter((p: any) => p.type === 'user')) | ||
| await this.loadPlugins(userPJSONPath, 'link', pjson.oclif.plugins.filter((p: any) => p.type === 'link')) | ||
| } catch (error: any) { | ||
| if (error.code !== 'ENOENT') process.emitWarning(error) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private async loadPlugins(root: string, type: string, plugins: (string | { root?: string; name?: string; tag?: string })[], parent?: Plugin.Plugin): Promise<void> { | ||
| if (!plugins || plugins.length === 0) return | ||
| const mark = Performance.mark(`config.loadPlugins#${type}`) | ||
| debug('loading plugins', plugins) | ||
| await Promise.all((plugins || []).map(async plugin => { | ||
| try { | ||
| const name = typeof plugin === 'string' ? plugin : plugin.name! | ||
| const opts: Options = { | ||
| name, | ||
| type, | ||
| root, | ||
| } | ||
| if (typeof plugin !== 'string') { | ||
| opts.tag = plugin.tag || opts.tag | ||
| opts.root = plugin.root || opts.root | ||
| } | ||
|
|
||
| if (this.plugins.has(name)) return | ||
| const pluginMarker = Performance.mark(`plugin.load#${name}`) | ||
| const instance = new Plugin.Plugin(opts) | ||
| await instance.load() | ||
| pluginMarker?.addDetails({ | ||
| hasManifest: instance.hasManifest, | ||
| commandCount: instance.commands.length, | ||
| topicCount: instance.topics.length, | ||
| type: instance.type, | ||
| usesMain: Boolean(instance.pjson.main), | ||
| name: instance.name, | ||
| }) | ||
| pluginMarker?.stop() | ||
|
|
||
| this.plugins.set(instance.name, instance) | ||
| if (parent) { | ||
| instance.parent = parent | ||
| if (!parent.children) parent.children = [] | ||
| parent.children.push(instance) | ||
| } | ||
|
|
||
| await this.loadPlugins(instance.root, type, instance.pjson.oclif.plugins || [], instance) | ||
| } catch (error: any) { | ||
| this.errors.push(error) | ||
| } | ||
| })) | ||
|
|
||
| mark?.addDetails({pluginCount: plugins.length}) | ||
| mark?.stop() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.