@oclif/plugin-plugins

  • Version 4.2.7
  • Published
  • 502 kB
  • 9 dependencies
  • MIT license

Install

npm i @oclif/plugin-plugins
yarn add @oclif/plugin-plugins
pnpm add @oclif/plugin-plugins

Overview

plugins plugin for oclif

Index

Classes

class Plugins

class Plugins {}

    constructor

    constructor(config: Interfaces.Config);

      property config

      config: Interfaces.Config;

        property silent

        silent: boolean;

          property verbose

          verbose: boolean;

            property yarn

            readonly yarn: Yarn;

              method add

              add: (...plugins: Interfaces.PJSON.PluginTypes[]) => Promise<void>;

                method friendlyName

                friendlyName: (name: string) => string;

                  method hasPlugin

                  hasPlugin: (
                  name: string
                  ) => Promise<
                  Interfaces.PJSON.PluginTypes.Link | Interfaces.PJSON.PluginTypes.User | false
                  >;

                    method install

                    install: (
                    name: string,
                    { force, tag }?: { force?: boolean | undefined; tag?: string | undefined }
                    ) => Promise<Interfaces.Config>;
                      link: (
                      p: string,
                      { install }: { install: boolean }
                      ) => Promise<Interfaces.Config>;

                        method list

                        list: () => Promise<
                        (Interfaces.PJSON.PluginTypes.Link | Interfaces.PJSON.PluginTypes.User)[]
                        >;

                          method maybeUnfriendlyName

                          maybeUnfriendlyName: (name: string) => Promise<string>;

                            method pjson

                            pjson: () => Promise<UserPJSON>;

                              method refresh

                              refresh: (
                              options: { all: boolean; prod: boolean },
                              ...roots: string[]
                              ) => Promise<void>;
                              • If a yarn.lock or oclif.lock exists at the root, refresh dependencies by rerunning yarn. If options.prod is true, only install production dependencies.

                                As of v9 npm will always ignore the yarn.lock during npm pack] (see https://github.com/npm/cli/issues/6738). To get around this plugins can rename yarn.lock to oclif.lock before running npm pack using oclif lock.

                                We still check for the existence of yarn.lock since it could be included if a plugin was packed using yarn or v8 of npm. Plugins installed directly from a git url will also have a yarn.lock.

                                Parameter options

                                Parameter roots

                                string[]

                                Returns

                                Promise

                              method remove

                              remove: (name: string) => Promise<void>;

                                method unfriendlyName

                                unfriendlyName: (name: string) => string | undefined;

                                  method uninstall

                                  uninstall: (name: string) => Promise<void>;

                                    method update

                                    update: () => Promise<void>;

                                      Package Files (2)

                                      Dependencies (9)

                                      Dev Dependencies (26)

                                      Peer Dependencies (0)

                                      No peer dependencies.

                                      Badge

                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@oclif/plugin-plugins.

                                      • Markdown
                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@oclif/plugin-plugins)
                                      • HTML
                                        <a href="https://www.jsdocs.io/package/@oclif/plugin-plugins"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>