Function loadPluginFromDirectory

src/loaders/plugin-loader.ts:17–96

(directory: string, options: Options = {})

 * @param options Additional options to customize the loading process.
 */
export function loadPluginFromDirectory(directory: string, options: Options = {}): Plugin {
  const plugin = new Plugin()

  const {
    brand = 'gluegun',
    commandFilePattern = [`*.{js,ts}`, `!*.test.{js,ts}`],
    extensionFilePattern = [`*.{js,ts}`, `!*.test.{js,ts}`],
    hidden = false,
    name,
  } = options

  plugin.hidden = Boolean(options.hidden)

  if (!strings.isBlank(name)) {
    plugin.name = name
  }

  // directory check
  if (filesystem.isNotDirectory(directory)) {
    throw new Error(`Error: couldn't load plugin (not a directory): ${directory}`)
  }

  plugin.directory = directory

  // the directory is the default name (unless we were told what it was)
  if (strings.isBlank(name)) {
    plugin.name = jetpack.inspect(directory).name
  }

  const jetpackPlugin = jetpack.cwd(plugin.directory)

  // load any default commands passed in
  plugin.commands = (options.preloadedCommands || []).map(loadCommandFromPreload)

  // load the commands found in the commands sub-directory
  const commandSearchDirectories = ['commands', 'build/commands']
  commandSearchDirectories.forEach((dir) => {
    if (jetpackPlugin.exists(dir) === 'dir') {
      const commands = jetpackPlugin.cwd(dir).find({ matching: commandFilePattern, recursive: true })

      plugin.commands = plugin.commands.concat(
        commands.map((file) => loadCommandFromFile(path.join(directory, dir, file))),
      )
    }
  })

  // load the extensions found in the extensions sub-directory
  const extensionSearchDirectories = ['extensions', 'build/extensions']
  extensionSearchDirectories.forEach((dir) => {
    if (jetpackPlugin.exists(dir) === 'dir') {
      const extensions = jetpackPlugin.cwd(dir).find({ matching: extensionFilePattern, recursive: false })

      plugin.extensions = plugin.extensions.concat(
        extensions.map((file) => loadExtensionFromFile(`${directory}/${dir}/${file}`)),
      )
    }
  })